v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

Addresses

Create Address Endpoint

post/domains/{domain}/addresses/endpoints

Path parameters

domainstring required

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.

Example:example.com

Request body

address-namestring required

This is the name label for the address

caller-namestring required

This is the caller's name for the address

address-line-1string

This is the address line 1 for the address

address-line-2string nullable

This is the address line 2 for the address

address-citystring

This is the city for the address

address-state-province-abbreviationstring

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

address-postal-codestring

This is the postal code for the address

address-country-abbreviationstring

This is the country appreviation for the address

address-location-descriptionstring nullable

This is an optional location description for the address

address-formatted-pidfloobject nullable

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

carrierstring nullable

This is the carrier name for the address

location-idstring nullable

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

Response

codeinteger required

messagestring required