v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Customer Aliases

Update a Customer Alias

put/customer-aliases/{id}

Path parameters

idstring required

Unique ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

labelstring

Alias label

Example request

{
  "label": "CRM ID"
}

Response

idstring required

Unique ID

sequenceAccountIdstring required

Sequence Account ID

customerIdstring required

Customer ID

valuestring required

Alias value

createdAtstring required

Created At

deletedAtstring

Deleted At

labelstring

Alias label

archivedAtstring

Archived At

Example response

{
  "id": "01849e70-0a0f-72ca-ba07-5557dd734d43",
  "sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
  "customerId": "01849e70-703e-705a-b59a-d3fd575587e0",
  "value": "external-customer-alias-123",
  "createdAt": "2022-10-01T00:00:00Z",
  "deletedAt": "2022-10-01T00:00:00Z",
  "label": "CRM ID",
  "archivedAt": "2022-10-01T00:00:00Z"
}