OMomni
Documents

Create draft

Changed on
<Warning> This endpoint is deprecated. Use the [Documents v2 API](/api/documents-v2/create-draft-and-patch-document) instead. </Warning> <Note> This endpoint requires **Editor** permissions or higher on the specified document. </Note>

Create a draft of the specified document. Drafts are isolated copies of a document - including its workbook and dashboard - that can be modified without impacting the published version.

To create a draft on a branch, include a branchId in the request body. Each branch can have one draft per document.

If a draft already exists for the document (or branch, if specified), the existing draft is returned instead of creating a new one.

post/v1/documents/{documentId}/draft

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/documents/{documentId}/draft
  • Auth
    HTTP bearer

Path parameters

documentIdstring 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.

Request body

branchIdstring 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)

identifierstring

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 response

{
  "identifier": "93874a87"
}

Changes

  • 43290040f88fRevision changes
    • warning

      the optional response header Deprecation removed for the status 200

    • warning

      the optional response header Link removed for the status 200

    • warning

      the optional response header Sunset removed for the status 200