Creates an address

Creates a new address on your account from the provided details, for use with services that require a physical address such as emergency calling and regulatory compliance.

By default, the new record is validated for emergency use at creation time. If the address fails validation, no record is created and the request is rejected with a 422 response; the errors array includes a suggested value for each offending field when one is available.

Set validate_address to false to skip validation at creation, for example when the address was already validated with the Validate an address action. The record is then created without emergency validation: if it is not valid it will not be able to be used for emergency services (such as a phone number’s emergency address), and because address records cannot be updated, a new record has to be created to correct it.

POST

addresses

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const address = await client.addresses.create({
  business_name: "Toy-O'Kon",
  country_code: 'US',
  first_name: 'Alfred',
  last_name: 'Foster',
  locality: 'Austin',
  street_address: '600 Congress Avenue',
});

console.log(address.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
address = client.addresses.create(
    business_name="Toy-O'Kon",
    country_code="US",
    first_name="Alfred",
    last_name="Foster",
    locality="Austin",
    street_address="600 Congress Avenue",
)
print(address.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	address, err := client.Addresses.New(context.TODO(), telnyx.AddressNewParams{
		BusinessName:  "Toy-O'Kon",
		CountryCode:   "US",
		FirstName:     "Alfred",
		LastName:      "Foster",
		Locality:      "Austin",
		StreetAddress: "600 Congress Avenue",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", address.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.addresses.AddressCreateParams;
import com.telnyx.sdk.models.addresses.AddressCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AddressCreateParams params = AddressCreateParams.builder()
            .businessName("Toy-O'Kon")
            .countryCode("US")
            .firstName("Alfred")
            .lastName("Foster")
            .locality("Austin")
            .streetAddress("600 Congress Avenue")
            .build();
        AddressCreateResponse address = client.addresses().create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

address = telnyx.addresses.create(
  business_name: "Toy-O'Kon",
  country_code: "US",
  first_name: "Alfred",
  last_name: "Foster",
  locality: "Austin",
  street_address: "600 Congress Avenue"
)

puts(address)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $address = $client->addresses->create(
    businessName: 'Toy-O\'Kon',
    countryCode: 'US',
    firstName: 'Alfred',
    lastName: 'Foster',
    locality: 'Austin',
    streetAddress: '600 Congress Avenue',
    addressBook: false,
    administrativeArea: 'TX',
    borough: 'Guadalajara',
    customerReference: 'MY REF 001',
    extendedAddress: '14th Floor',
    neighborhood: 'Ciudad de los deportes',
    phoneNumber: '+12125559000',
    postalCode: '78701',
    validateAddress: true,
  );

  var_dump($address);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx addresses create \
  --api-key 'My API Key' \
  --business-name "Toy-O'Kon" \
  --country-code US \
  --first-name Alfred \
  --last-name Foster \
  --locality Austin \
  --street-address '600 Congress Avenue'

curl --request POST \
  --url https://api.telnyx.com/v2/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "first_name": "Alfred",
  "last_name": "Foster",
  "business_name": "Toy-O'Kon",
  "street_address": "600 Congress Avenue",
  "locality": "Austin",
  "country_code": "US",
  "customer_reference": "MY REF 001",
  "phone_number": "+12125559000",
  "extended_address": "14th Floor",
  "administrative_area": "TX",
  "neighborhood": "Ciudad de los deportes",
  "borough": "Guadalajara",
  "postal_code": "78701",
  "address_book": false,
  "validate_address": true
}
EOF

{
  "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"
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The street address provided is invalid.",
      "source": {
        "pointer": "/street_address"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Parameters that can be defined during address creation

first_name

string

required

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

Example:

"Alfred"

last_name

string

required

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

Example:

"Foster"

business_name

string

required

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

Example:

"Toy-O'Kon"

street_address

string

required

The primary street address information about the address.

Example:

"600 Congress Avenue"

locality

string

required

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

Example:

"Austin"

country_code

string

required

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

Example:

"US"

customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

phone_number

string

The phone number associated with the address.

Example:

"+12125559000"

extended_address

string

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

Example:

"14th Floor"

administrative_area

string

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

Example:

"TX"

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"

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"

postal_code

string

The postal code of the address.

Example:

"78701"

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

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. In an address record, this flag indicates whether emergency validation was performed at creation: true means the record passed emergency validation before it was created; false means validation was skipped during this creation request, and the address may have been validated separately. This flag is not a current validity status; emergency use still requires a valid address.

Example:

true

Response

Successful response. validate_address on the returned record indicates whether it was validated for emergency use at creation: created with the default true, the record passed emergency validation; created with false, validation was skipped during this creation request, and the address may have been validated separately. This flag is not a current validity status; emergency use still requires a valid address.

data

Address · object

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const address = await client.addresses.create({
  business_name: "Toy-O'Kon",
  country_code: 'US',
  first_name: 'Alfred',
  last_name: 'Foster',
  locality: 'Austin',
  street_address: '600 Congress Avenue',
});

console.log(address.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
address = client.addresses.create(
    business_name="Toy-O'Kon",
    country_code="US",
    first_name="Alfred",
    last_name="Foster",
    locality="Austin",
    street_address="600 Congress Avenue",
)
print(address.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	address, err := client.Addresses.New(context.TODO(), telnyx.AddressNewParams{
		BusinessName:  "Toy-O'Kon",
		CountryCode:   "US",
		FirstName:     "Alfred",
		LastName:      "Foster",
		Locality:      "Austin",
		StreetAddress: "600 Congress Avenue",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", address.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.addresses.AddressCreateParams;
import com.telnyx.sdk.models.addresses.AddressCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AddressCreateParams params = AddressCreateParams.builder()
            .businessName("Toy-O'Kon")
            .countryCode("US")
            .firstName("Alfred")
            .lastName("Foster")
            .locality("Austin")
            .streetAddress("600 Congress Avenue")
            .build();
        AddressCreateResponse address = client.addresses().create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

address = telnyx.addresses.create(
  business_name: "Toy-O'Kon",
  country_code: "US",
  first_name: "Alfred",
  last_name: "Foster",
  locality: "Austin",
  street_address: "600 Congress Avenue"
)

puts(address)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $address = $client->addresses->create(
    businessName: 'Toy-O\'Kon',
    countryCode: 'US',
    firstName: 'Alfred',
    lastName: 'Foster',
    locality: 'Austin',
    streetAddress: '600 Congress Avenue',
    addressBook: false,
    administrativeArea: 'TX',
    borough: 'Guadalajara',
    customerReference: 'MY REF 001',
    extendedAddress: '14th Floor',
    neighborhood: 'Ciudad de los deportes',
    phoneNumber: '+12125559000',
    postalCode: '78701',
    validateAddress: true,
  );

  var_dump($address);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx addresses create \
  --api-key 'My API Key' \
  --business-name "Toy-O'Kon" \
  --country-code US \
  --first-name Alfred \
  --last-name Foster \
  --locality Austin \
  --street-address '600 Congress Avenue'

curl --request POST \
  --url https://api.telnyx.com/v2/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "first_name": "Alfred",
  "last_name": "Foster",
  "business_name": "Toy-O'Kon",
  "street_address": "600 Congress Avenue",
  "locality": "Austin",
  "country_code": "US",
  "customer_reference": "MY REF 001",
  "phone_number": "+12125559000",
  "extended_address": "14th Floor",
  "administrative_area": "TX",
  "neighborhood": "Ciudad de los deportes",
  "borough": "Guadalajara",
  "postal_code": "78701",
  "address_book": false,
  "validate_address": true
}
EOF

{
  "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"
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The street address provided is invalid.",
      "source": {
        "pointer": "/street_address"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Account & Billing

Video

SETI

Fax

OAuth

Bot Signup

For AI Agents

Creates an address

Authorizations

Body

Response