customers

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.

post/customer-units/external/{externalCustomerUnitId}/aliases

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customer-units/external/{externalCustomerUnitId}/aliases
  • Auth: HTTP bearer

Path parameters

externalCustomerUnitIdstring required

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

Request body

aliasstring required

Alternate external identifier that should resolve to this customer.

namestring

Optional display name for this alias.

descriptionstring

Optional note describing where this alias comes from.

Response

201

aliasstring required

Alternate external identifier that resolves to the customer.

customerIdstring required

Paid customer display ID this alias resolves to.

customerUnitExternalIdstring nullable required

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 nullable required
descriptionstring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.