Skip to main content

Create an address

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

Request Body REQUIRED
label string

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

country string

The ISO 3166 Alpha 2 country code.

first_name string

First name of the occupant associated with this address.

last_name string

Last name of the occupant associated with this address.

street_number string

The number portion of the street address.

street_name string

The name portion of the street address.

address_type string

(Optional) If the address is divided into multiple sub-addresses, such as an apartment or office building, this identifies how the address is divided. If the address is a single occupant address, address_type may be omitted. Possible values are: Apartment, Basement, Building, Department, Floor, Office, Penthouse, Suite, Trailer, Unit.

address_number string

(Optional) If the address is divided into multiple sub-addresses, such as an apartment or office building, this identifies the particular sub-address. If the address is a single occupant address, address_number may be omitted.

city string

The city portion of the street address.

state string

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

postal_code string

The postal code of the street address.

Responses
201

CREATED

Schema
id uuid

The unique identifier of the Address on SignalWire. This can be used to show or delete the address programmatically.

label string

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

country string

The ISO 3166 Alpha 2 country code.

first_name string

First name of the occupant associated with this address.

last_name string

Last name of the occupant associated with this address.

street_number string

The number portion of the street address.

street_name string

The name portion of the street address.

address_type string

(Optional) If the address is divided into multiple sub-addresses, such as an apartment or office building, this identifies how the address is divided. If the address is a single occupant address, address_type may be omitted. Possible values are: Apartment, Basement, Building, Department, Floor, Office, Penthouse, Suite, Trailer, Unit.

address_number string

(Optional) If the address is divided into multiple sub-addresses, such as an apartment or office building, this identifies the particular sub-address. If the address is a single occupant address, address_number may be omitted.

city string

The city portion of the street address.

state string

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

postal_code string

The postal code of the street address.