Skip to navigation

Update Branch

Enqueue an async task to pull the latest main changes into a branch.

When conflicts exist, include a resolutions entry for every conflict from GET .../conflicts, matched by (type, id). Uncovered conflicts return 400 invalid_resolution with those conflicts listed in details.

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

Required scope | branches:update

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

Request

This endpoint expects an object.
resolutionslist of objectsOptional

Required when conflicts exist. Include one resolution for every conflict from GET .../conflicts, matched by (type, id). IDs like default-body are valid — not every conflict id is an ObjectId.

Response

Branch update 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
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error