Create Branch

Enqueue an async task to create a branch from a page. The branch does not exist until the task finishes. Poll `GET /sites/{site_id}/branches/tasks/{task_id}` until `status` is `finished`, then read `branchId` from the task response. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace with the page branching entitlement.</Warning> Required scope | `branches:create`

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

Request

This endpoint expects an object.
pageIdstringRequiredformat: "objectid"
ID of the page to branch from. Only one active branch per page is allowed.

Response

Branch creation task accepted
taskIdstringformat: "uuid"
statusstring

Task state at enqueue time (typically queued).

nextActionslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error