Addresses

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 have the following properties:

Name Type Read-Only Mandatory Comments
id integer yes no Automatically assigned upon creation
name string no yes The name of the address
street string no yes The street of the address
zip string no yes The zip code of the address
city string no no The city of the address
state string no yes The state of the address
province string no yes The province of the address
country_code string no yes The ISO code of the country for this address
Example
{
  "address": {
    "id": 12345,
    "name": "Address name",
    "street": "Address street",
    "zip": "12345",
    "city": "Dublin",
    "state": null,
    "province": "Dublin",
    "country_code": "IE"
  }
}

List Addresses

GET /api/v2/channels/voice/addresses.json

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 Success
{
  "addresses": [
    {
      "address": {
        "id": 12345,
        "name": "Address name",
        "street": "Address street",
        "zip": "12345",
        "city": "Dublin",
        "state": null,
        "province": "Dublin",
        "country_code": "IE"
      }
    }
  ],
  "next_page": null,
  "previous_page": null,
  "count": 1
}

Create Address

POST /api/v2/channels/voice/addresses.json

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses.json \
  -d '{"address":{"name":"Address name","street":"address street","zip":"12345","city":"Address city","province":"Dublin","country_code":"IE"}}' \
  -H "Content-Type: application/json" -X POST \
  -v -u {email_address}:{password}
Example Response
Status: 201 Created

{
  "address": {
    "id": 12345,
    "name": "Address name",
    "street": "Address street",
    "zip": "12345",
    "city": "Dublin",
    "state": null,
    "province": "Dublin",
    "country_code": "IE"
  }
}

Update Address

PUT /api/v2/channels/voice/addresses/{id}.json

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses.json \
  -d '{"address": {"name": "New address name"}}' \
  -H "Content-Type: application/json" -X PUT \
  -v -u {email_address}:{password}
Example Response
Status: 200 Success

{
  "address": {
    "id": 12345,
    "name": "New address name",
    "street": "Address street",
    "zip": "12345",
    "city": "Dublin",
    "state": null,
    "province": "Dublin",
    "country_code": "IE"
  }
}

Show Address

GET /api/v2/channels/voice/addresses/{id}.json

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses/{id}.json \
  -v -u {email_address}:{password}
Example Response
Status: 200 Success

{
  "address": {
    "id": 12345,
    "name": "Address name",
    "street": "Address street",
    "zip": "12345",
    "city": "Dublin",
    "state": null,
    "province": "Dublin",
    "country_code": "IE"
  }
}

Delete Address

DELETE /api/v2/channels/voice/addresses/{id}.json

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/addresses/{id}.json \
  -X DELETE -v -u {email_address}:{password}
Example Response
Status: 200 Success