Skip to navigation
EnterpriseBranches

Delete Branch

Enqueue an async task to delete a branch.

Returns 202 Accepted with a task envelope — not 204. Poll GET /sites/{site_id}/branches/tasks/{task_id} until the task finishes.

Enterprise Only
This endpoint requires an Enterprise workspace with the page branching entitlement.

Required scope | branches:delete

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 deletion task accepted
taskIdstringformat: "uuid"
statusstring

Task state at enqueue time (typically queued).

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