Create domain address

Creates an emergency (E911) address in a domain. Without user in the body it is a domain-level address that every user in the domain can see. Send a site name in user to create a site address.

Requires Office Manager or Site Manager scope for your own domain, Reseller scope for the domains in your territory, or Super User scope. Site Manager scope is not limited to its own site here: it reaches every address in the domain.

address-name and address-line-1 are required. emergency-address-id is optional: without it the API generates one, a- followed by 13 hexadecimal characters. An ID already used in any domain returns 409. To add an address the carrier has checked, call POST /domains/{domain}/addresses/validate first, then send its emergency-address-id, address-formatted-pidflo, and carrier with the other fields. address-formatted-pidflo is used only together with a supported carrier: bandwidth, brightlink, inteliquent, or voipinno. Without one, the address is saved with an empty address-formatted-pidflo.

Returns 200 with the address as stored. The address is stored shortly after the response, so a read straight after may not show it yet. Users, devices, and domains already assigned this ID get the new location. Send address-postal-code as a string so leading zeros are kept.

To use an address, set its emergency-address-id on a device, a user, a site, or the domain. A device without one uses its user's address, a user without one uses its site's, and a site without one uses the domain's. User and device reads report where the address came from in emergency-address-source: user_level, site_level, or domain_level.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//addresses' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "address-name": "Main Office", "caller-name": "Front Desk", "address-line-1": "123 Example St", "address-line-2": "Suite 100", "address-city": "Example City", "address-state-province-abbreviation": "CA", "address-postal-code": "90210", "address-country-abbreviation": "US", "address-location-description": "Front desk", "emergency-address-id": "a-6525c1ae9d7ff", "ip-address-public": "203.0.113.30", "address-formatted-pidflo": { "HouseNumber": "123", "StreetName": "EXAMPLE", "StreetSuffix": "ST", "City": "EXAMPLE CITY", "StateCode": "CA", "Zip": "90210", "PlusFour": "1234", "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-6525c1ae9d7ff", "ValidationStatus": "VALID", "Adjusted": "true" }, "carrier": "bandwidth" }'

{ "domain": "example.com", "user": "*", "emergency-address-id": "a-6525c1ae9d7ff", "address-name": "Main Office", "caller-name": "Front Desk", "address-line-1": "123 Example St", "address-line-2": "Suite 100", "address-city": "Example City", "address-state-province-abbreviation": "CA", "address-postal-code": "90210", "address-country-abbreviation": "US", "address-location-description": "Front desk", "ip-address-public": "203.0.113.30", "carrier": "bandwidth" }

Request

Responses