Move Document

Move a document in the TOC.

POST /api/v1/documents/{document_id}/move

Move Document

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/documents/{document_id}/move \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "parent_id": "<string>",
  "position": 123
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/documents/{document_id}/move"

payload = {
    "parent_id": "<string>",
    "position": 123
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({parent_id: '<string>', position: 123})
};

fetch('https://{tenant_id}.api.useago.com/api/v1/documents/{document_id}/move', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "position": 123,
  "object": "document",
  "parent_id": "<string>"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

document_id · string · required

Body

application/json

Schema for moving a document.

parent_id · string | null

position · integer | null

Response

200 - application/json

OK

Response schema for document move operation.

id · string · required

position · integer · required

object · string · default: document

parent_id · string | null