RELAY RESTAddresses

Create an address

View as Markdown

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.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.
labelstringRequired<=250 characters
A friendly name given to the address to help distinguish and search for different addresses within your project.
countrystringRequired
The ISO 3166 Alpha 2 country code.
first_namestringRequired<=250 characters
First name of the occupant associated with this address.
last_namestringRequired<=250 characters
Last name of the occupant associated with this address.
street_numberstringRequired<=250 characters
The number portion of the street address.
street_namestringRequired<=250 characters
The name portion of the street address.
citystringRequired<=250 characters
The city portion of the street address.
statestringRequired

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

postal_codestringRequired<=250 characters
The postal code of the street address.
address_typeenumOptional

If the address is divided into multiple sub-addresses, this identifies how the address is divided. Possible values are: Apartment, Basement, Building, Department, Floor, Office, Penthouse, Suite, Trailer, Unit.

address_numberstringOptional

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

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
The unique identifier of the Address on SignalWire.
labelstring
A friendly name given to the address to help distinguish and search for different addresses within your project.
countrystring
The ISO 3166 Alpha 2 country code.
first_namestring
First name of the occupant associated with this address.
last_namestring
Last name of the occupant associated with this address.
street_numberstring
The number portion of the street address.
street_namestring
The name portion of the street address.
address_typeenum or null

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

address_numberstring or null

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

citystring
The city portion of the street address.
statestring

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

postal_codestring
The postal code of the street address.
zip_codestring

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

Errors