Skip to main content
POST
/
v2
/
admin
/
phonebooks
/
Create Phonebook
curl --request POST \
  --url https://api.voxo.co/v2/admin/phonebooks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 123,
  "name": "<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.

Body

application/json
tenantId
integer
required

Tenant ID

Required range: x <= 9007199254740991
name
string
required

Phonebook name

Required string length: 1 - 255
includeExt
enum<string>
default:no

Include tenant extensions in the phonebook (yes/no)

Available options:
yes,
no
provisioning
integer
default:1

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

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

Contacts to seed the phonebook with

Response

Newly created 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