FIfigshare
projects

Update project

Changed on

Update a project by passing full body parameters. Institutions with item-type based metadata enabled wrap metadata in a fields object; the legacy flat-payload form is also accepted for institutions without item-type based metadata. funding_list entries accept {"id": <int>} or {"title": "..."}.

put/account/projects/{project_id}

Request

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

Changes

  • 5806e3dd43b2Revision changes
    • breaking

      added the new path request parameter project_id

    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status