Skip to main content
POST
Create Branch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required

The tenant ID this branch belongs to

name
string
required

Branch name

Minimum string length: 3
timezone
string
required

IANA timezone identifier

Minimum string length: 3
default

Set as default branch (1 = yes, 0 = no)

Available options:
1

Response

Created branch

id
number
required

Branch ID

name
string
required

Branch name

default
number
required

Whether this is the default branch (1 = yes, 0 = no)

timezone
string | null
required

IANA timezone identifier

tenant
object | null
required

Parent tenant