v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
projects

Partially update project

Partially update a project; only provided keys will be changed. For institutions with item-type based metadata enabled, send the keys to update inside fields:{} — keys not present are preserved. funding_list entries accept {"id": <int>} or {"title": "..."}. Unrecognised field names inside fields (e.g. a typo) are rejected with 422.

patch/account/projects/{project_id}

Path parameters

project_idinteger required

Project unique identifier

Request body

titlestring

The title for this project - mandatory. 3 - 1000 characters.

descriptionstring

Project description

fundingstring

Grant number or organization(s) that funded this project. Up to 2000 characters permitted.

custom_fieldsobject

List of key, values pairs to be associated with the project

Example request

{
  "title": "project title",
  "description": "project description",
  "custom_fields": {
    "defined_key": "value for it"
  },
  "custom_fields_list": [
    {
      "name": "key"
    }
  ]
}

Response

Reset Content