Skip to main content
Use this endpoint to partially update an existing customer record. Because this is a PATCH request, you only need to include the fields you want to modify — all omitted fields will remain unchanged. This is ideal for correcting a phone number, updating an email address, or fixing a name without having to resend the full customer payload. Pass the customer UUID in the URL path where {id} appears.

Request

X-Api-Key
string
required
Your CertoPay secret API key. Include it in every request as X-Api-Key: sk_live_sua_chave_aqui.
id
string
required
The UUID of the customer to update. This is the id returned when the customer was created.
name
string
Updated full name of the customer. Omit this field to leave the name unchanged.
email
string
Updated email address. Omit this field to leave the email unchanged.
phone
string
Updated phone number in Brazilian format (e.g. "(11) 88888-8888"). Omit this field to leave the phone unchanged.

Response

A successful request returns HTTP 200 OK with the complete updated customer object, reflecting all current field values.
id
string
Unique UUID identifying the customer (unchanged).
name
string
Full name — updated if provided in the request, otherwise the previous value.
email
string
Email address — updated if provided in the request, otherwise the previous value.
document
string
CPF number (11 digits). This field cannot be changed via PATCH.
phone
string
Phone number — updated if provided in the request, otherwise the previous value.
createdAt
string
ISO 8601 timestamp of the original creation date (unchanged).

Example

curl -X PATCH https://v2.certopaybrasil.com/api/customers/uuid-do-customer \
  -H "X-Api-Key: sk_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{"phone": "(11) 88888-8888"}'
200 OK
{
  "id": "uuid-do-customer",
  "name": "João da Silva",
  "email": "joao@email.com",
  "document": "12345678900",
  "phone": "(11) 88888-8888",
  "createdAt": "2026-06-26T10:00:00Z"
}