Skip to main content
PATCH
/
v2
/
admin
/
phonebooks
/
{id}
Update Phonebook
curl --request PATCH \
  --url https://api.voxo.co/v2/admin/phonebooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "provisioning": 0,
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "routeTo": "<string>",
      "speedDial": "<string>"
    }
  ]
}
'
{
  "id": 123,
  "tenant": {
    "id": 123,
    "name": "<string>"
  },
  "name": "<string>",
  "includeExt": "<string>",
  "provisioning": 123,
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "routeTo": "<string>",
      "speedDial": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Phonebook ID

Pattern: ^[1-9]\d*$

Body

application/json
​
name
string

Phonebook name

Required string length: 1 - 255
​
includeExt
enum<string>

Include tenant extensions in the phonebook (yes/no)

Available options:
yes,
no
​
provisioning
integer

Provision this phonebook to hardware (1) or not (0)

Required range: 0 <= x <= 1
​
contacts
object[]

Full replacement of the phonebook's contacts. When present, all existing entries are deleted and rebuilt from this array (empty array clears all contacts). Omit to leave contacts untouched.

Response

Updated phonebook

​
id
number
required

Phonebook ID

​
tenant
object
required

Owning tenant

​
name
string
required

Phonebook name

​
includeExt
string
required

Whether tenant extensions are included

​
provisioning
number
required

Provisioning flag (1/0)

​
contacts
object[]
required

Contacts in this phonebook