Skip to main content
DELETE
/
v1
/
documents
/
{documentId}
/
draft
Archive draft
curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "message": "Draft deleted successfully"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
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.

Body

application/json
​
branchId
string<uuid>

The UUID of the branch the draft is attached to.

Response

Draft archived successfully

​
message
string
Example:

"Draft deleted successfully"