Move document

Move a document to another project and/or directory you can write to. Purely organizational: URLs, revisions, and sharing are untouched (though project membership of the destination then applies). Documents can only live in projects owned by the document's owner.

post/api/v1/move_document

Request

  • Base URL: https://offprint.io
  • URL: https://offprint.io/api/v1/move_document
  • Auth: HTTP bearer

Request body

document_idstring uuid

The document's id, from publish_document or list_documents. Pass this or slug.

slugstring

The document's slug, e.g. 'roadmap-k3n8qz'. Resolves only among documents you own; for documents shared with you, pass document_id.

projectstring

Destination project (name or id). Defaults to your Default project.

directory_pathstring

Destination directory path; missing directories are created. Omit for the project root.

Response

Success.

document_idstring required
movedboolean required
projectstring nullable required

Name of the project the document is filed in.

directory_pathstring nullable required

Directory path inside the project; null at the project root.

Changes

No recorded changes to this operation across all 1 revision of this API.