Skip to content

Modify document

Modify document metadata

Endpoint - /documents/<documentId\>

HTTP Method – PUT

Request

Headers

ParameterDescription
clientname(mandatory) Portfolio name
authorization(mandatory) Authentication token
projectId(mandatory) Project identifier
select(optional) List of fields to include into the result

Body

JSON of the document metadata

Media type : application/json

Example:

{
    "Id": "841054dd-ce63-4e93-b176-0753ff2ec1eb",
    "Name": "2012-03-23-Duplex-Programming.xlsx",
    "Category": {
        "Id": "734e44c5-fcf8-e011-b8c2-00101832264b"
    }
}

Note

  • The ID in the JSON and ID in the endpoint must be the same
  • The Select header is used to specify what properties must be updated. This approach allows you to specify only the fields you want to update without passing other properties. In case if one or another property is not updated, please check it is included to the select
  • You cannot specify that custom field must be updated. In case if you update one custom field, need to specify "CustomFields" in the header and pass all custom field values in JSON.

Response

HTTP status code 204