Publish Branch

Enqueue an async task to publish the branch page preview to its configured staging domain. This does **not** publish production domains or merge the branch into main. Poll the returned `taskId` until the publish task finishes. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace with the page branching entitlement.</Warning> Required scope | `branches:publish`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
branch_idstringRequiredformat: "objectid"
Unique identifier for a Branch

Response

Branch publish task accepted
taskIdstringformat: "uuid"
statusstring
stagingDomainstring
Staging domain the branch preview will publish to.
publishedOnstringformat: "date-time"

Timestamp when the publish was triggered (not when the queued job finished).

nextActionslist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error