Sign in
E911 Addresses

Create E911 address

To create a new Address, make a POST request to the Address resource.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

post/api/relay/rest/addresses

Request body

labelstring required

A friendly name given to the address to help distinguish and search for different addresses within your project.

countrystring required

The ISO 3166 Alpha 2 country code.

first_namestring required

First name of the occupant associated with this address.

last_namestring required

Last name of the occupant associated with this address.

street_numberstring required

The number portion of the street address.

street_namestring required

The name portion of the street address.

address_type'Apartment' | 'Basement' | 'Building' | 'Department' | 'Floor' | 'Office' | 'Penthouse' | 'Suite' | 'Trailer' | 'Unit'

Address type for sub-addresses.

address_numberstring

If the address is divided into multiple sub-addresses, this identifies the particular sub-address.

citystring required

The city portion of the street address.

statestring required

The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form.

postal_codestring required

The postal code of the street address.

Example request

{
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "address_number": "42",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905"
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required

Universal Unique Identifier.

labelstring required

A friendly name given to the address to help distinguish and search for different addresses within your project.

countrystring required

The ISO 3166 Alpha 2 country code.

first_namestring required

First name of the occupant associated with this address.

last_namestring required

Last name of the occupant associated with this address.

street_numberstring required

The number portion of the street address.

street_namestring required

The name portion of the street address.

address_type'Apartment' | 'Basement' | 'Building' | 'Department' | 'Floor' | 'Office' | 'Penthouse' | 'Suite' | 'Trailer' | 'Unit' required

Address type for sub-addresses.

address_numberstring nullable required

If the address is divided into multiple sub-addresses, this identifies the particular sub-address.

citystring required

The city portion of the street address.

statestring required

The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form.

postal_codestring required

The postal code of the street address.

zip_codestring required

The postal code of the street address. Alias for postal_code for backwards compatibility.

Example response

{
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "address_number": "42",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905",
  "zip_code": "91905"
}

Changes