Skip to navigation
API Referencecustomers

Create a customer unit alias by the unit's key

Creates an alias that lands signals on this unit, without naming its customer: a signal whose externalCustomerId is the alias resolves to the unit’s customer and is attributed to this unit. The alias must be unique within the organization ignoring letter case (409 EXTERNAL_ID_IN_USE). The key is looked up across the organization ignoring letter case. When more than one unit carries it in another letter case (legacy duplicates across customers, or case variants on one customer), the exact spelling decides; when that does not single one out either, the answer is 409 CUSTOMER_UNIT_AMBIGUOUS: use the customer’s unit routes, where the key is exact.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

externalCustomerUnitIdstringRequired>=1 character

Your id of the unit (its externalId), unique within the organization ignoring letter case.

Request

Body
aliasstringRequired1-255 characters
Alternate external identifier that should resolve to this customer.
namestringOptional<=120 characters
Optional display name for this alias.
descriptionstringOptional<=500 characters
Optional note describing where this alias comes from.

Response

201
aliasstring
Alternate external identifier that resolves to the customer.
customerIdstring
Paid customer display ID this alias resolves to.
customerUnitExternalIdstring or null

Your id of the customer unit signals carrying this alias land on: the unit the alias was created under, or the customer's root unit for a customer-level alias. null only while the customer has no root unit.

namestring or null
descriptionstring or null
createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error