Sign in
API Package Documentation

Move API Package Documentation

This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.

post/v3/api-packages/{packageId}/documents/{documentId}/move

Request body

parent_document_idstring uuid

parent document id

indexinteger

index of the document in the parent document's children

Example request

{
  "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  "index": 1
}

Response

Document for the API Package was moved successfully.

Changes

Changed in 1 of the 75 revisions of this API.1