Telnyx

{ "data": { "id": "1293384261075731499", "record_type": "address", "customer_reference": "MY REF 001", "first_name": "Alfred", "last_name": "Foster", "business_name": "Toy-O'Kon", "phone_number": "+12125559000", "street_address": "600 Congress Avenue", "extended_address": "14th Floor", "locality": "Austin", "administrative_area": "TX", "neighborhood": "Ciudad de los deportes", "borough": "Guadalajara", "postal_code": "78701", "country_code": "US", "address_book": false, "validate_address": true, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } }

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

address ID

Response

Successful response

data

Address · object

Show child attributes

data.id

string<int64>

Uniquely identifies the address.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"address"

data.customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

data.first_name

string

The first name associated with the address. An address must have either a first last name or a business name.

Example:

"Alfred"

data.last_name

string

The last name associated with the address. An address must have either a first last name or a business name.

Example:

"Foster"

data.business_name

string

The business name associated with the address. An address must have either a first last name or a business name.

Example:

"Toy-O'Kon"

data.phone_number

string

The phone number associated with the address.

Example:

"+12125559000"

data.street_address

string

The primary street address information about the address.

Example:

"600 Congress Avenue"

data.extended_address

string

Additional street address information about the address such as, but not limited to, unit number or apartment number.

Example:

"14th Floor"

data.locality

string

The locality of the address. For US addresses, this corresponds to the city of the address.

Example:

"Austin"

data.administrative_area

string

The locality of the address. For US addresses, this corresponds to the state of the address.

Example:

"TX"

data.neighborhood

string

The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.

Example:

"Ciudad de los deportes"

data.borough

string

The borough of the address. This field is not used for addresses in the US but is used for some international addresses.

Example:

"Guadalajara"

data.postal_code

string

The postal code of the address.

Example:

"78701"

data.country_code

string

The two-character (ISO 3166-1 alpha-2) country code of the address.

Example:

"US"

data.address_book

boolean

default:true

Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.

Example:

false

data.validate_address

boolean

default:true

Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of true unless you have used the /addresses/actions/validate endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services.

Example:

true

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup