Update a project

Replaces all of the project's mutable fields with the body — send the complete desired state on every call. name is required and must not be blank. Labels and text metadata are replaced with exactly the set you send, so omitting label or projectMeta removes all of them. File metadata is preserved automatically; do not include FILE entries in the body — they are rejected with 400, and each projectMeta entry must state metaType explicitly (entries without one are treated as FILE). Omitting active keeps the project's current active state. Changes to name or longname are recorded in the project's journal log, and labels no longer used by any project or protocol in the group are deleted. Use the PATCH call to change only part of the project.

The name field sets the Internal Project ID shown in eLab (the field integrations usually key on), while longname sets the project's display name.

Example body:

{
  "name": "PRJ-001",
  "longname": "My updated project",
  "description": "updated description",
  "notes": "updated notes",
  "active": true,
  "label": ["label1", "label2"],
  "projectMeta": [
    { "name": "testmeta", "value": "test meta value", "metaType": "TEXT" }
  ]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Body Params
string
string
string
string
boolean
label
array of strings
label
projectMeta
array of objects
projectMeta
Headers
string
Defaults to Swagger
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Your query has malformed parameters

401

You are not logged in

403

You don't have permission to update this project

404

No project exists with the given projectID within your groups

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json