PUT
/
customers
/
{customerId}
/
customer-address
/
{addressId}
{
  "id": "61604a30fdfacd0009816e44",
  "address": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Doe",
    "city": "Seattle",
    "region": "WA",
    "postalCode": 98121,
    "county": "King County",
    "country": "US",
    "type": "BILLING",
    "latitude": 47.6205,
    "longitude": -122.3493
  },
  "additionalAttributes": {
    "landmark": "Beach"
  },
  "isDeleted": false,
  "isDefault": false,
  "deletedAt": "2023-08-30T23:20:42.822Z",
  "createdAt": "2023-08-30T23:20:42.822Z",
  "updatedAt": "2023-08-30T23:20:42.822Z"
}

Authorizations

Authorization
string
headerrequired

The access token.

Headers

x-fabric-tenant-id
string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id
string

A UUID of the request.

Path Parameters

customerId
string
required

A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.

addressId
string
required

A 24-character system-generated ID of the customer's address.

Body

application/json
address
object

The address details.

isDefault
boolean

A flag indicating whether the address is the default one. true indicates the address is the default address and false indicates otherwise.

additionalAttributes
object

A placeholder for additional info, in key-value pairs.

Response

200 - application/json
id
string
required

A 24-character system-generated ID of the address.

address
object
required

The address details.

isDeleted
boolean
required

A flag indicating whether the address is deleted. true indicates the address is deleted and false indicates otherwise.

createdAt
string
required

The time when the address was created, in UTC format.

updatedAt
string | null
required

The time when the address was the last updated, in UTC format.

additionalAttributes
object

A placeholder for additional info, in key-value pairs.

isDefault
boolean

A flag indicating whether the address is the default one.true indicates the given address is the default address and false indicates otherwise.

deletedAt
string | null

The time when the address was deleted, in UTC format.

Was this page helpful?

OverviewGet customer's addresses