Skip to main content
POST
Create a new Customer Alias

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

sequence-version
enum<string>

Use this header to select an API version

Available options:
2024-07-30
Idempotency-Key
string

A unique key that makes this request safe to retry (maximum 255 characters). Retrying with the same key returns the original response, and the operation runs at most once. Keys are retained for 24 hours; after that, a request with the same key is treated as new.

Body

application/json
customerId
string
required

Customer ID

Example:

"01849e70-703e-705a-b59a-d3fd575587e0"

value
string
required

Alias value

Example:

"external-customer-alias-123"

label
string

Alias label

Example:

"CRM ID"

Response

Created

id
string
required

Unique ID

Example:

"01849e70-0a0f-72ca-ba07-5557dd734d43"

sequenceAccountId
string
required

Sequence Account ID

Example:

"ec1479a2-6ba1-421f-a7de-0853a20d17a1"

customerId
string
required

Customer ID

Example:

"01849e70-703e-705a-b59a-d3fd575587e0"

value
string
required

Alias value

Example:

"external-customer-alias-123"

createdAt
string
required

Created At

Example:

"2022-10-01T00:00:00Z"

deletedAt
string

Deleted At

Example:

"2022-10-01T00:00:00Z"

label
string

Alias label

Example:

"CRM ID"

archivedAt
string

Archived At

Example:

"2022-10-01T00:00:00Z"