Modify document¶
Modify document metadata¶
Endpoint - /documents/<documentId\>
HTTP Method – PUT
Request¶
Headers¶
| Parameter | Description |
|---|---|
| clientname | (mandatory) Portfolio name |
| authorization | (mandatory) Authentication token |
| projectId | (mandatory) Project identifier |
| select | (optional) List of fields to include in 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 body must match the ID in the endpoint path.
- Use the select header to specify which properties to update. This lets you pass only the fields you want to change. If a property is not updated, verify that it is included in the select header.
- You cannot update a single custom field individually. To update any custom field, include
CustomFieldsin the select header and pass all custom field values in the JSON body.
Response¶
HTTP status code 204