customers

Create a customer unit alias

Creates an alias that lands signals on this unit: a signal whose externalCustomerId is the alias resolves to this customer and, when it names no customerUnit, to this unit. The alias shares one set of ids with customer external ids and unit ids, unique within the organization and ignoring letter case: an alias another customer holds is refused with 409 EXTERNAL_ID_IN_USE. Use the value returned as customer.id, for example cus_abc123; if you have your own customer ID, use the /api/v2/customers/external/{externalId}/… twin.

post/customers/{id}/customer-units/{externalCustomerUnitId}/aliases

Request

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

Path parameters

idstring required

Paid customer display id

externalCustomerUnitIdstring required

Your own id for the unit (its externalId), unique within this customer.

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.