Skip to main content
POST
/
v2
/
admin
/
branches
Create Branch
curl --request POST \
  --url https://api.voxo.co/v2/admin/branches/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1,
  "name": "<string>",
  "timezone": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "default": 123,
  "timezone": "<string>",
  "tenant": {
    "id": 123,
    "name": "<string>"
  }
}

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

Required range: x > 0
​
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
required

Parent tenant