customers

Create customer alias by external ID

Create an alternate external identifier for a customer by external ID. The alias shares one set of ids with customer external ids and unit ids, unique within the organization and ignoring letter case: an alias that another customer already holds as its external id, a unit id or an alias is refused with 409 EXTERNAL_ID_IN_USE (an exact match keeps its older code, ALIAS_CONFLICTS_WITH_CUSTOMER_EXTERNAL_ID or CUSTOMER_ALIAS_ALREADY_EXISTS).

post/customers/external/{externalId}/aliases

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customers/external/{externalId}/aliases
  • Auth: HTTP bearer

Path parameters

externalIdstring required

Customer ID from the integrator's system, stored on Paid as externalId.

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.