Create Address for User - NetSapiens API v2

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

user

string

required

Example:

sampleUser

Body Params application/json

emergency-address-id

string

required

This is an autogenerated ID for the Address.

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

optional

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

optional

This is an optional location description for the address

ip-address-public

string | null

optional

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

optional

This is the carrier name for the address

Example

{
  "emergency-address-id": "a-UNIQE_ID",
  "address-name": "WeWork Office",
  "caller-id-number": "WeWork Secretary",
  "address-line-1": "8910 UNIVERSITY CENTER LN",
  "address-line-2": "STE 400",
  "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": "a-UNIQE_ID",
    "ValidationStatus": "VALID",
    "Adjusted": "true"
  },
  "ip-address-public": "XXX.XX.XX.XXX"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

address-formatted-pidflo

object

required

object

string

required

domain

string

required

user

string

required

address_id

string

required

address_name

string

required

callid_nmbr

string

required

address_line_1

string

required

address_line_2

string

required

city

string

required

state_code

string

required

zip

string

required

country_code

string

required

location

string

required

carrier

string

required

public_ip

string

required

action

string

required

singular

integer

required

controller

string

required

format

string

required

apiVer

string

required

Example

{
  "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": "a-652487faeb24d_9",
    "ValidationStatus": "VALID",
    "Adjusted": "true"
  },
  "object": "address",
  "domain": "portal",
  "user": "2500",
  "singular": 0,
  "address_id": "a-652487faeb24d_12",
  "address_name": "WeWork Office",
  "callid_nmbr": "WeWork Secretary",
  "address_line_1": "8910 UNIVERSITY CENTER LN",
  "address_line_2": "STE 400",
  "city": "San Diego",
  "state_code": "CA",
  "zip": "92122-1025",
  "country_code": "US",
  "location": "front left desk",
  "carrier": "bandwidth",
  "public_ip": "207.45.79.249",
  "action": "create",
  "controller": "addresses",
  "format": "json",
  "apiVer": "v2",
  "uid": "2500@portal"
}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required