Update Branch

Update an existing branch

PATCH /v2/admin/branches/{id}

Update Branch

cURL

curl --request PATCH \
  --url https://api.voxo.co/v2/admin/branches/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default": 1,
  "name": "<string>",
  "timezone": "<string>"
}
'

200

{
  "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.

Path Parameters

id · number · required

Branch ID

Required range: x > 0

Body

application/json

default · Option 1 · enum<number> Option 2 · enum<number>

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

Available options: 1

name · string

Branch name

Minimum string length: 3

timezone · string

IANA timezone identifier

Minimum string length: 3

Response

200

application/json

Updated 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

Show child attributes