When you purchase a phone number in Talk, some countries have regulations that require you to provide an address to verify your business. For more information, see Zendesk Talk and Zendesk Text number address requirements in the Talk Help Center.

JSON Format

Addresses are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
city string false true The city of the address
country_code string false true The ISO code of the country for this address
id integer true false Automatically assigned upon creation
name string false true The name of the address
provider_reference string false false The provider reference of the address
province string false true The province of the address
state string false false The state of the address
street string false true The street of the address
zip string false true The zip of the address

Example

{  "city": "San Francisco",  "country_code": "US",  "id": 900000076706,  "name": "Zendesk",  "provider_reference": "AD499983e566f656f862549f965ec10e36",  "province": "California",  "state": null,  "street": "1019 Market Street",  "zip": "94103"}

List Addresses

  • GET /api/v2/channels/voice/addresses

Allowed For

  • Agents

Using curl

curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses.json  -v -u {email_address}:{password}

Example Response

Status 200 OK
{  "addresses": [    {      "city": "San Francisco",      "country_code": "US",      "id": 900000076706,      "name": "Zendesk",      "province": "California",      "state": null,      "street": "1019 Market Street",      "zip": "94103"    }  ],  "count": 1,  "next_page": null,  "previous_page": null}

Show Address

  • GET /api/v2/channels/voice/addresses/{address_id}

Allowed For

  • Agents

Parameters

Name Type In Required Description
address_id integer Path true ID of an address

Using curl

curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses/{address_id}.json \  -v -u {email_address}:{password}

Example Response

Status 200 OK
{  "address": {    "city": "San Francisco",    "country_code": "US",    "id": 900000076706,    "name": "Zendesk",    "province": "California",    "state": null,    "street": "1019 Market Street",    "zip": "94103"  }}

Create Address

  • POST /api/v2/channels/voice/addresses

Allowed For

  • Agents

Example Body

{  "address": {    "city": "San Francisco",    "country_code": "US",    "name": "Zendesk",    "province": "California",    "street": "1019 Market Street",    "zip": "94103"  }}

Using curl

curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses.json \  -d '{"address":{"name":"Zendesk","street":"1019 Market Street","zip":"94103","city":"San Francisco","province":"California","country_code":"US"}}' \  -H "Content-Type: application/json" -X POST \  -v -u {email_address}:{password}

Example Response

Status 201 Created
{  "address": {    "city": "San Francisco",    "country_code": "US",    "id": 900000076706,    "name": "Zendesk",    "province": "California",    "state": null,    "street": "1019 Market Street",    "zip": "94103"  }}

Update Address

  • PUT /api/v2/channels/voice/addresses/{address_id}

Allowed For

  • Agents

Parameters

Name Type In Required Description
address_id integer Path true ID of an address

Example Body

{  "address": {    "name": "New address name"  }}

Using curl

curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses/{address_id}.json \  -v -u {email_address}:{password}

Example Response

Status 200 OK
{  "address": {    "city": "San Francisco",    "country_code": "US",    "id": 900000076706,    "name": "Zendesk",    "province": "California",    "state": null,    "street": "1019 Market Street",    "zip": "94103"  }}

Delete Address

  • DELETE /api/v2/channels/voice/addresses/{address_id}

Allowed For

  • Agents

Parameters

Name Type In Required Description
address_id integer Path true ID of an address

Using curl

curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses/{address_id}.json \  -X DELETE -v -u {email_address}:{password}

Example Response

Status 200 OK