Skip to main content

Create an address

POST 
/addresses

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

Permissions​

The API token must include the following scopes: Numbers.

Request​

Body

required

    label stringrequired

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

    country stringrequired

    The ISO 3166 Alpha 2 country code.

    first_name stringrequired

    First name of the occupant associated with this address.

    last_name stringrequired

    Last name of the occupant associated with this address.

    street_number stringrequired

    The number portion of the street address.

    street_name stringrequired

    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 stringrequired

    The city portion of the street address.

    state stringrequired

    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 stringrequired

    The postal code of the street address.

Responses​

CREATED

Schema

    id uuidrequired

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

    label stringrequired

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

    country stringrequired

    The ISO 3166 Alpha 2 country code.

    first_name stringrequired

    First name of the occupant associated with this address.

    last_name stringrequired

    Last name of the occupant associated with this address.

    street_number stringrequired

    The number portion of the street address.

    street_name stringrequired

    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 stringrequired

    The city portion of the street address.

    state stringrequired

    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 stringrequired

    The postal code of the street address.

Loading...