Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Documents

Archive draft

Archive the current draft of the specified document. Archived drafts are placed in the Archived section of the Drafts drawer in the document's workbook and retained for 30 days.

If a branch is specified, the current draft on the branch is archived.

delete/v1/documents/{documentId}/draft

Path parameters

documentIdstring required

The ID of the document to archive the draft from. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Request body

branchIdstring uuid

The UUID of the branch the draft is attached to. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

Response

Draft archived successfully

messagestring

Example response

{
  "message": "Draft deleted successfully"
}