YUyuvexpay
Customers

Update a customer

Changed on

Update one or more fields of an existing customer.

patch/v1/customers/{customerId}

Request

Path parameters

customerIdstring required

The customer's prefixed identifier (e.g., cus_ab12cd34ef). This is the merchant-facing slug, not the internal UUID.

Request body

namestring
emailstring email
documentstring
documentType'CPF' | 'CNPJ'
phonestring
isActiveboolean
metadataobject

Response

Customer updated.

messagestring

Changes

  • a382df24e843Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      for the path request parameter customerId, the format was generalized from uuid to no format

    • info

      added the optional property / to the response with the status

  • c75657100757Revision changes
    • info

      endpoint added