Skip to main content
POST
Merge a branch into its parent

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Project UUID, not a slug. Resolve a slug with GET /project/slug/{slug} using the same workspace and credentials, then pass the returned id.

id
string
required

Body

application/json
bypass_review
boolean
default:false

Admin-only force merge. Overrides known review, stage-policy, editor-group, and merge-conflict blockers once, while preserving structural, branch-check, and incomplete-check protections. Requires review_bypass_reason.

review_bypass_reason
string

Required when bypass_review is true. The justification and execution-time blocker snapshot are preserved as an immutable review event on the merge baseline.

Maximum string length: 1000

Response

200 - application/json
attempts
number
required
branch_id
string
required
enqueued_at
string
required
id
string
required
progress_percent
number
required
project_id
string
required
replayed_diff_count
number
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
total_diff_count
number
required
updated_at
string
required
completed_at
string
last_error
string
last_error_reference
string
started_at
string