POST
/
api-commerceIdentity
/
user
/
{userId}
/
address
/
{addressId}
/
set
curl --request POST \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}/address/{addressId}/set \
  --header 'x-api-key: <api-key>' \
  --header 'x-site-context: <x-site-context>'
[
  {
    "attention": "Account Manager",
    "address1": "1234 Main St.",
    "address2": "Suite 710",
    "address3": "Floor 7",
    "city": "Houston",
    "state": "TX",
    "country": "USA",
    "zipCode": 77035,
    "company": "Acme Inc.",
    "kind": "Business",
    "phone": {
      "number": "555-123-4567",
      "kind": "Mobile"
    },
    "name": {
      "first": "Pat",
      "last": "Kake"
    },
    "email": "test@mail.com",
    "isValidated": true,
    "isDefault": true
  }
]

Authorizations

​
x-api-key
string
header
required

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
userId
string
required

User ID

Example:

"6169b2d892a5f30009d76480"

​
addressId
string
required

Address ID

Example:

"2468qt3414159"

Response

200
application/json
OK
​
address1
string
required

Primary address

Example:

"1234 Main St."

​
city
string
required

Address city

Example:

"Houston"

​
state
string
required

Address state

Example:

"TX"

​
country
string
required

Address country

Example:

"USA"

​
zipCode
string
required

Address zip code

Example:

77035

​
email
string
required

Email address

Example:

"test@mail.com"

​
isValidated
boolean
required

true: Address has been validated<br />false: Address has not been validated

Example:

true

​
isDefault
boolean
required

true: This is the default address<br />false: This is an additional address

Example:

true

​
attention
string

Address recipient

Example:

"Account Manager"

​
address2
string

Second address line

Example:

"Suite 710"

​
address3
string

Third address line

Example:

"Floor 7"

​
company
string

Company name

Example:

"Acme Inc."

​
kind
string

Address type

Example:

"Business"

​
phone
object

Telephone number and type associated with address

​
name
object

Was this page helpful?

Delete specific addressUnset default address