Skip to main content
PATCH
/
v3
/
documents
/
{document_id}
/
relationships
/
folder
Update the folder that a document is in
curl --request PATCH \
  --url https://api.ctrl-hub.com/v3/documents/{document_id}/relationships/folder \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>"
  }
}
'
{
  "id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
  "status": "400",
  "title": "A validation error was encountered",
  "source": {
    "parameter": "include"
  },
  "meta": {
    "resource": "wrong_value"
  }
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

​
document_id
string<uuid>
required

The unique identifier for the document.

Body

application/vnd.api+json

The updated documents parent folder. When data is set to null, the document will be moved to the root.

​
data
object
required

Response

Document folder updated successfully