---
title: "Move a document"
method: POST
path: "/documents.move"
tags: ["Documents"]
---

# Move a document

`POST /documents.move`

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

## Request body

- object
  - `id` string, required — Unique identifier for the document. Either the UUID or the urlId is acceptable.
  - `collectionId` string, uuid
  - `parentDocumentId` string, uuid

## Response `200`

OK

- object
  - `data` object
    - `documents` Document[]
      - `id` string, uuid — Unique identifier for the object.
      - `collectionId` string, uuid — Identifier for the associated collection.
      - `parentDocumentId` string, uuid — Identifier for the document this is a child of, if any.
      - `title` string — The title of the document.
      - `fullWidth` boolean — Whether this document should be displayed in a full-width view.
      - `emoji` string — An emoji associated with the document.
      - `text` string — The text content of the document, contains markdown formatting
      - `urlId` string — A short unique ID that can be used to identify the document as an alternative to the UUID
      - `collaborators` User[]
        - `id` string, uuid — Unique identifier for the object.
        - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
        - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `role` 'admin' | 'member' | 'viewer' | 'guest'
        - `isSuspended` boolean — Whether this user has been suspended.
        - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
        - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.
      - `pinned` boolean — Whether this document is pinned in the collection
      - `template` boolean — Whether this document is a template
      - `templateId` string, uuid — Unique identifier for the template this document was created from, if any
      - `revision` number — A number that is auto incrementing with every revision of the document that is saved
      - `createdAt` string, date-time — The date and time that this object was created
      - `createdBy` User
        - `id` string, uuid — Unique identifier for the object.
        - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
        - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `role` 'admin' | 'member' | 'viewer' | 'guest'
        - `isSuspended` boolean — Whether this user has been suspended.
        - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
        - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.
      - `updatedAt` string, date-time — The date and time that this object was last changed
      - `updatedBy` User
        - `id` string, uuid — Unique identifier for the object.
        - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
        - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `role` 'admin' | 'member' | 'viewer' | 'guest'
        - `isSuspended` boolean — Whether this user has been suspended.
        - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
        - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.
      - `publishedAt` string, date-time, nullable — The date and time that this object was published
      - `archivedAt` string, date-time — The date and time that this object was archived
      - `deletedAt` string, date-time, nullable — The date and time that this object was deleted
    - `collections` Collection[]
      - `id` string, uuid — Unique identifier for the object.
      - `name` string — The name of the collection.
      - `description` string — A description of the collection, may contain markdown formatting
      - `sort` object — The sort of documents in the collection. Note that not all API responses respect this and it is left as a frontend concern to implement.
        - `field` string
        - `direction` 'asc' | 'desc'
      - `index` string — The position of the collection in the sidebar
      - `color` string — A color representing the collection, this is used to help make collections more identifiable in the UI. It should be in HEX format including the #
      - `icon` string — A string that represents an icon in the outline-icons package
      - `permission` 'read' | 'read_write'
      - `createdAt` string, date-time — The date and time that this object was created
      - `updatedAt` string, date-time — The date and time that this object was last changed
      - `deletedAt` string, date-time, nullable — The date and time that this object was deleted
  - `policies` Policy[]
    - `id` string, uuid — Unique identifier for the object this policy references.
    - `abilities` object
      - `create` boolean
      - `read` boolean
      - `update` boolean
      - `delete` boolean
      - `restore` boolean
      - `star` boolean
      - `unstar` boolean
      - `share` boolean
      - `download` boolean
      - `pin` boolean
      - `unpin` boolean
      - `move` boolean
      - `archive` boolean
      - `unarchive` boolean
      - `createChildDocument` boolean

## Other responses

- `400` — The request failed one or more validations.
- `401` — The API key is missing or otherwise invalid.
- `403` — The current API key is not authorized to perform this action.
- `404` — The specified resource was not found.
- `429` — The request was rate limited.

## Changes

- **2024-10-18** `fdf2ec9c9df4` — 1 info
  - added the non-success response with the status `429`
- **2024-07-06** `7b33b538cd7d` — 12 info
  - added the optional property `data` to the response with the `400` status
  - added the optional property `data` to the response with the `401` status
  - added the optional property `data` to the response with the `403` status
  - added the optional property `data` to the response with the `404` status
  - …8 more

[Change history](https://skmtc.dev/defaulr/apis/outline-api/changes/documents.move/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) · [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/defaulr/outline-api/revisions/fdf2ec9c9df4/schema)