Documents

Move a document

Move a document to a new location or collection. If no parent document is provided, the document will be moved to the collection root.

post/documents.move

Request body

idstring required

Unique identifier for the document. Either the UUID or the urlId is acceptable.

collectionIdstring uuid

parentDocumentIdstring uuid

Example request

{
  "id": "hDYep1TPAM"
}

Response

Example response

{
  "data": {
    "documents": [
      {
        "title": "🎉 Welcome to Acme Inc",
        "emoji": "🎉",
        "text": "…",
        "urlId": "hDYep1TPAM",
        "collaborators": [
          {
            "name": "Jane Doe"
          }
        ],
        "createdBy": {
          "name": "Jane Doe"
        },
        "updatedBy": {
          "name": "Jane Doe"
        }
      }
    ],
    "collections": [
      {
        "name": "Human Resources",
        "index": "P",
        "color": "#123123"
      }
    ]
  }
}

Changes

Changed in 2 of the 6 revisions of this API.13

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d12See the full diff
- ○
  added the optional property data to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 404 status
  response-optional-property-added

Full history