Skip to main content
POST
Error

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

Force merge. The organization review policy (Settings → Reviews) decides who may use it: nobody when merge override is off, project admins (the default), or project admins plus the owner of the branch's direct parent (never for merges into Base). Overrides known review, branch-check, stage-policy, and merge-conflict blockers once; editor-group blockers are overridden only for project admins. Structural and incomplete-scan protections are preserved. Requires review_bypass_reason.

​
expected_rebase_ids
string[]

The ids of the live sub-branches the merge-rebase preview said this merge would rebase onto the merge target. When present, the merge refuses with 409 if the set of live sub-branches differs at merge time, so a sub-branch is never rebased unseen. Omit to rebase whatever live sub-branches exist then.

​
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