Skip to main content
POST
Create a new branch

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.

Body

application/json
branch_number
number
Required range: x >= 1
branch_number_reservation
string<uuid>
description
string
is_variant
boolean
labels
object[]

Branch tags to assign when the branch is created. Existing project tag names reuse their fixed casing, colour, and symbol.

Maximum array length: 20
name
string
parent_id
string
ready_for_review
boolean

Response

201 - application/json
id
string
required
number
number
required