Skip to main content
POST
/
public
/
people
/
{ContactId}
/
location
curl -i -X POST \
  'https://api.portal.io/public/people/1042/location' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE' \
  -d 'Street=456+Oak+Ave' \
  -d 'City=Austin' \
  -d 'State=Texas' \
  -d 'PostalCode=78702' \
  -d 'Country=United+States' \
  -d 'IsPrimary=true'
{
  "contactFirstName": "",
  "contactLastName": "",
  "contactPhoneNumber": "",
  "contactEmail": "",
  "isPrimary": true,
  "isBilling": false,
  "id": 305,
  "street": "456 Oak Ave",
  "suite": "",
  "city": "Austin",
  "postalCode": "78702",
  "state": "Texas",
  "stateAbbrev": "TX",
  "country": "United States",
  "phone": ""
}
Adds a new address to an existing contact. Street is the only required field. When Country is supplied, State must also be provided. Use IsPrimary=true to replace the contact’s current primary address, and IsBilling=true to set this as the billing address. A contact can have only one primary and one billing location at a time; setting either flag moves it from the previous location.
The request body must be submitted as application/x-www-form-urlencoded.
curl -i -X POST \
  'https://api.portal.io/public/people/1042/location' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE' \
  -d 'Street=456+Oak+Ave' \
  -d 'City=Austin' \
  -d 'State=Texas' \
  -d 'PostalCode=78702' \
  -d 'Country=United+States' \
  -d 'IsPrimary=true'
{
  "contactFirstName": "",
  "contactLastName": "",
  "contactPhoneNumber": "",
  "contactEmail": "",
  "isPrimary": true,
  "isBilling": false,
  "id": 305,
  "street": "456 Oak Ave",
  "suite": "",
  "city": "Austin",
  "postalCode": "78702",
  "state": "Texas",
  "stateAbbrev": "TX",
  "country": "United States",
  "phone": ""
}

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json
X-MSS-API-APPID
string
required

Application Id

X-MSS-CUSTOM-DATE
string
required

A date timestamp of the request

X-MSS-SIGNATURE
string
required

A signature for the request

X-MSS-API-USERKEY
string
required

User API Key

Path Parameters

ContactId
integer<int32>
required

Body

application/x-www-form-urlencoded
Street
string
required

Street (Maximum character length is 100)

ContactFirstName
string

Contact First Name (Maximum character length is 50)

ContactLastName
string

Contact Last Name (Maximum character length is 50)

ContactPhoneNumber
string

Contact Phone Number (Maximum character length is 50)

ContactEmail
string

Contact Email (Maximum character length is 100)

Suite
string

Suite (Maximum character length is 100)

City
string

City (Maximum character length is 50)

PostalCode
string

Postal Code (Maximum character length is 20)

State
string

State (Maximum character length is 256)

Country
string

Country (Maximum character length is 256)

IsPrimary
boolean
IsBilling
boolean

Response

Success

Contact-location detail model

isPrimary
boolean
required

Whether this location is the primary location for the contact

isBilling
boolean
required

Whether this location is the billing location for the contact

contactFirstName
string

Location contact first name

contactLastName
string

Location contact last name

contactPhoneNumber
string

Location contact phone number

contactEmail
string

Location contact email address

id
integer<int32>

Unique numeric identifier of the location, when available.

street
string

Primary street address line.

suite
string

Secondary address line, apartment, or suite.

city
string

City or locality.

postalCode
string

Postal or ZIP code.

state
string

State, province, or region name.

stateAbbrev
string

State or province abbreviation when available.

country
string

Country name.

phone
string

Location phone number when one is associated with this address.