Sign in
Customers

Update a customer

Update one or more fields of an existing customer.

patch/v1/customers/{customerId}

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

Changed in 2 of the 12 revisions of this API.13

  • a382df24e84312See the full diff
    • ●

      removed the optional property customer/id from the response with the 200 status

      response-optional-property-removed

    • ○

      for the path request parameter customerId, the type/format was generalized from string/uuid to string/

      request-parameter-type-generalized

    • ○

      added the optional property customer/customerId to the response with the 200 status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c756571007571See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog