Update Address for User

put https://{server}/ns-api/v2/domains/{domain}/users/{user}/addresses/{emergency-address-id}

Path Params

domain

string

required

length ≤ 64

Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

user

string

required

length between 0 and 16

Defaults to ~

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

emergency-address-id

string

required

Body Params

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

required

This is the address line 1 for the address

address-line-2

string | null

This is the address line 2 for the address

address-city

string

required

This is the city for the address

address-state-province-abbreviation

string

required

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

address-postal-code

string

required

This is the postal code for the address

address-country-abbreviation

string

required

This is the country appreviation for the address

address-location-description

string | null

This is an optional location description for the address

ip-address-public

string | null

This is the public IP of the client window creating the address.

address-formatted-pidflo

string

required

This is a return value of the formatted PIDFLO standardized value for the address

carrier

string | null

This is the carrier name for the address

Responses

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url 'https://ns-api.com/ns-api/v2/domains/~/users/~/addresses/emergency-address-id' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted

400Bad Request

401Authentication Required

404Record not found