Skip to main content
POST
/
v1
/
documents
/
{documentId}
/
draft
Create draft
curl --request POST \
  --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"
}
'
{
  "identifier": "93874a87"
}

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 create a draft for. 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 to create the draft on. Required when creating a draft on a branch. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

Response

Draft created successfully (or existing draft returned)

​
identifier
string

Identifier of the new draft. If a draft already exists for the document or branch specified, this will be the identifier of the existing draft.

Example:

"93874a87"