customers

Update customer by external ID

Update a customer by external ID. Changing externalId follows the organization-wide id rule: a new id that another customer already holds as its external id, a unit id or an alias, ignoring letter case, is refused with 409 EXTERNAL_ID_IN_USE; the same id in the same case stays 400 DUPLICATE_EXTERNAL_ID. When the id changes, the previous id is kept as an alias of the customer, so signals that still use it keep resolving to it.

put/customers/external/{externalId}

Request

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

Path parameters

externalIdstring required

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

Request body

namestring
legalNamestring nullable
emailstring email
phonestring
websitestring
externalIdstring nullable
creationState'draft' | 'active'
churnDatestring date-time nullable
vatNumberstring nullable
metadataobject nullable

Response

200

idstring required

Stable Paid customer display ID. Use this value as the {id} path parameter for customer routes, for example GET /api/v2/customers/cus_abc123/state.

namestring required
legalNamestring nullable required
emailstring required
phonestring required
websitestring required
externalIdstring nullable required
creationState'draft' | 'active' required
status'active' | 'churned' required

Customer status: churned when the customer is marked as churned, active otherwise.

churnDatestring date-time nullable required
vatNumberstring nullable required
metadataobject nullable required
defaultCurrencystring required

ISO 4217 currency code, for example USD, EUR, or GBP.

createdAtstring date-time required
updatedAtstring date-time required

Changes

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