Add a Location to a Contact

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'

import requests
from portal_auth import sign_request

url = "https://api.portal.io/public/people/1042/location"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
content_type = "application/x-www-form-urlencoded"
signature = sign_request("POST", url, content_type, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.post(url, headers={
    "Accept": "application/json",
    "Content-Type": content_type,
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
}, data={
    "Street": "456 Oak Ave",
    "City": "Austin",
    "State": "Texas",
    "PostalCode": "78702",
    "Country": "United States",
    "IsPrimary": "true"
})
print(response.json())

const { signRequest } = require('./portalAuth');

const url = "https://api.portal.io/public/people/1042/location";
const timestamp = new Date().toUTCString();
const contentType = "application/x-www-form-urlencoded";
const signature = signRequest("POST", url, contentType, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    method: "POST",
    headers: {
        "Accept": "application/json",
        "Content-Type": contentType,
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    },
    body: new URLSearchParams({
        Street: "456 Oak Ave",
        City: "Austin",
        State: "Texas",
        PostalCode: "78702",
        Country: "United States",
        IsPrimary: "true"
    })
});
const data = await response.json();
console.log(data);

{
  "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": ""
}

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'

import requests
from portal_auth import sign_request

url = "https://api.portal.io/public/people/1042/location"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
content_type = "application/x-www-form-urlencoded"
signature = sign_request("POST", url, content_type, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.post(url, headers={
    "Accept": "application/json",
    "Content-Type": content_type,
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
}, data={
    "Street": "456 Oak Ave",
    "City": "Austin",
    "State": "Texas",
    "PostalCode": "78702",
    "Country": "United States",
    "IsPrimary": "true"
})
print(response.json())

const { signRequest } = require('./portalAuth');

const url = "https://api.portal.io/public/people/1042/location";
const timestamp = new Date().toUTCString();
const contentType = "application/x-www-form-urlencoded";
const signature = signRequest("POST", url, contentType, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    method: "POST",
    headers: {
        "Accept": "application/json",
        "Content-Type": contentType,
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    },
    body: new URLSearchParams({
        Street: "456 Oak Ave",
        City: "Austin",
        State: "Texas",
        PostalCode: "78702",
        Country: "United States",
        IsPrimary: "true"
    })
});
const data = await response.json();
console.log(data);

{
  "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'

import requests
from portal_auth import sign_request

url = "https://api.portal.io/public/people/1042/location"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
content_type = "application/x-www-form-urlencoded"
signature = sign_request("POST", url, content_type, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.post(url, headers={
    "Accept": "application/json",
    "Content-Type": content_type,
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
}, data={
    "Street": "456 Oak Ave",
    "City": "Austin",
    "State": "Texas",
    "PostalCode": "78702",
    "Country": "United States",
    "IsPrimary": "true"
})
print(response.json())

const { signRequest } = require('./portalAuth');

const url = "https://api.portal.io/public/people/1042/location";
const timestamp = new Date().toUTCString();
const contentType = "application/x-www-form-urlencoded";
const signature = signRequest("POST", url, contentType, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    method: "POST",
    headers: {
        "Accept": "application/json",
        "Content-Type": contentType,
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    },
    body: new URLSearchParams({
        Street: "456 Oak Ave",
        City: "Austin",
        State: "Texas",
        PostalCode: "78702",
        Country: "United States",
        IsPrimary: "true"
    })
});
const data = await response.json();
console.log(data);

{
  "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": ""
}

Authorizations

X-MSS-API-APPID

string

header

required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY

string

header

required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE

string

header

required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE

string

header

required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

enum<string>

required

Accept Header

Available options:

application/json

Path Parameters

ContactId

integer<int32>

required

Body

application/json

People Services

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

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.

contactFirstName

string

Location contact first name

contactLastName

string

Location contact last name

contactPhoneNumber

string

Location contact phone number

contactEmail

string

Location contact email address

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Add a Location to a Contact

Authorizations

Headers

Path Parameters

Body

Response