Skip to main content
POST
/
v2
/
documents
/
{documentId}
/
draft
/
publish
Publish draft
curl --request POST \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/publish \
  --header 'Authorization: Bearer <token>'
{
  "identifier": "q2-revenue",
  "name": "Q2 Revenue (final)",
  "description": "Quarterly revenue review"
}

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 published document's URL slug (e.g. abc123) or its canonical workbook UUID.

Response

Draft published successfully.

identifier
string
required

Published document identifier.

name
string
required

Document name.

description
string | null
required

Document description.