Phone Number ManagementE911 Addresses

Update E911 address

View as MarkdownOpen in Claude
Updates an Address that has been previously created. When `emergency_enabled=true` and the address is in the US (`country` = `US`), the address is validated against the carrier. A valid or auto-corrected address is stored (`validated: true`). An address the carrier cannot validate — or a correctable address when `auto_correct_address=false` — is rejected with a `422` whose body includes an `errors` array and a `candidates` array of suggested addresses (each with `street_number`, `street_name`, `city`, `state`, `postal_code`). Carrier validation applies to US addresses only: a non-US address is stored normally, with `emergency_enabled` returned as `false`. Requests without `emergency_enabled` are stored without carrier validation. #### 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](/docs/platform/your-signalwire-api-space).

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) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the address.

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. When the address is assigned to a phone number for E911, this label is also sent to the carrier as the caller name. The emergency network limits that field to 32 characters, so longer labels are truncated to the first 32 characters before being sent. Truncation affects only the name shown to the dispatcher, never the address used to route the call.
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.

emergency_enabledbooleanOptionalDefaults to false

Applies to US addresses only. When true and country is US, the address is validated against the carrier before it is stored. For any other country the flag is ignored and the response returns emergency_enabled: false. Defaults to false, which stores the address without carrier validation.

auto_correct_addressbooleanOptionalDefaults to true

When the carrier suggests a corrected version of the address, true (the default) stores the corrected address; false rejects the request with the suggestion returned as candidates.

Response

The request has succeeded.
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.

emergency_enabledboolean

Whether E911 emergency calling is enabled for this address (carrier-validated when created/updated with emergency_enabled=true for a US address).

validatedboolean

Whether the address was validated by the carrier (true when the carrier returned a valid or auto-corrected match).

validated_atstring or null

The RFC 3339 / ISO 8601 timestamp of the last successful carrier validation, or null if never validated.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error