DEdefaulr
Documents

Move a document

Changed on

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

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.move
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring required

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

collectionIdstring uuid
parentDocumentIdstring uuid
indexnumber

The position index in the collection structure

Example request

{
  "id": "hDYep1TPAM"
}

Response

OK

Example response

{
  "data": {
    "documents": [
      {
        "title": "Welcome to Acme Inc",
        "icon": "🎉",
        "text": "…",
        "urlId": "hDYep1TPAM",
        "createdBy": {
          "name": "Jane Doe"
        },
        "updatedBy": {
          "name": "Jane Doe"
        },
        "deletedBy": {
          "name": "Jane Doe"
        }
      }
    ],
    "collections": [
      {
        "urlId": "hDYep1TPAM",
        "name": "Human Resources",
        "index": "P",
        "color": "#123123",
        "archivedBy": {
          "name": "Jane Doe"
        }
      }
    ]
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 5ddf01ffba84Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      response property data/documents/items/url deprecated

  • c09b7940e788Revision changes
    • info

      added the optional property /// to the response with the status