Skip to main content
POST
Promote and publish a workbook
Promote the current workbook atomically if its source hash still matches the preview. Repeated promotions update the linked copy, including its deployment-scoped slug. Override replaces destination edits, never source validation or permissions. An idempotency key makes retries safe.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
workbookId
number
required

Body

application/json

ApplyWorkbookPromotionInput

expectedSourceHash
string
required
Pattern: ^[a-f0-9]{64}$
idempotencyKey
string<uuid>
required
targetDeploymentId
integer
required
Required range: x >= 1
expectedDestinationHash
string | null
Pattern: ^[a-f0-9]{64}$
override
boolean | null
targetFolderId
integer | null
Required range: x >= 1

Response

200 - application/json
completedAt
required
destinationChangedSincePreview
boolean
required
destinationWasDiverged
boolean
required
id
integer
required
outcome
enum<string>
required
Available options:
created,
updated,
unchanged
overrideRequested
boolean
required
performedBy
object
required
targetDashboardVersionId
integer
required
source
object | null
target
object | null