Update Address Endpoint

PUT

/domains/{domain}/addresses/endpoints/{endpoint}

Last modified:2023-12-21 20:52:14

OperationId:UpdateAddressEndpoint

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

domain

string

required

Example:

sampleDomain

endpoint

string

required

The callback number of the address.

Example:

8585551234

Body Params application/json

address-name

string

required

This is the name label for the address

caller-name

string

required

This is the caller's name for the address

address-line-1

string

optional

This is the address line 1 for the address

address-line-2

string | null

optional

This is the address line 2 for the address

address-city

string

optional

This is the city for the address

address-state-province-abbreviation

string

optional

This is the state or province (Canadian) abbreviation for the address

address-postal-code

string

optional

This is the postal code for the address

address-country-abbreviation

string

optional

This is the country appreviation for the address

address-location-description

string | null

optional

This is an optional location description for the address

address-formatted-pidflo

object | null

optional

This is a return value of the formatted PIDFLO standardized value for the address. For create/update either location-id or address-formatted-pidflo is needed. If address-formatted-pidflo is used, fill in address-line-1, address-city, etc for address information

carrier

string | null

optional

This is the carrier name for the address

location-id

string | null

optional

This is the address-id in cases for creation using an existing address. For create/update either location-id or address-formatted-pidflo is needed

Example

{
    "address-name": "WeWork Office",
    "caller-id-number": "WeWork Secretary UPDATED",
    "address-line-1": "8910 UNIVERSITY CENTER LN",
    "address-line-2": "STE 404 UPDATED",
    "address-city": "San Diego",
    "address-state-province-abbreviation": "CA",
    "address-postal-code": "92122-1025",
    "address-country-abbreviation": "US",
    "address-location-description": "front left desk",
    "address-provisioned-carrier-name": "bandwidth",
    "address-formatted-pidflo": {
        "HouseNumber": 8910,
        "StreetName": "UNIVERSITY CENTER",
        "StreetSuffix": "LN",
        "City": "SAN DIEGO",
        "StateCode": "CA",
        "Zip": 92122,
        "PlusFour": 1012,
        "County": [],
        "Country": "US",
        "AddressType": "E911",
        "LocationId": "LOCATION ID",
        "ValidationStatus": "VALID",
        "Adjusted": "true"
    },
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/sampleDomain/addresses/endpoints/8585551234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "address-name": "WeWork Office",
    "caller-id-number": "WeWork Secretary UPDATED",
    "address-line-1": "8910 UNIVERSITY CENTER LN",
    "address-line-2": "STE 404 UPDATED",
    "address-city": "San Diego",
    "address-state-province-abbreviation": "CA",
    "address-postal-code": "92122-1025",
    "address-country-abbreviation": "US",
    "address-location-description": "front left desk",
    "address-provisioned-carrier-name": "bandwidth",
    "address-formatted-pidflo": {
        "HouseNumber": 8910,
        "StreetName": "UNIVERSITY CENTER",
        "StreetSuffix": "LN",
        "City": "SAN DIEGO",
        "StateCode": "CA",
        "Zip": 92122,
        "PlusFour": 1012,
        "County": [],
        "Country": "US",
        "AddressType": "E911",
        "LocationId": "LOCATION ID",
        "ValidationStatus": "VALID",
        "Adjusted": "true"
    },
}'

Responses

🟢202Accepted

application/json

Body

code

integer

required

message

string

required

Example

{
  "code": 202,
  "message": "Accepted"
}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Modified at 2023-12-21 20:52:14

Update Address for User

Create Address for User