Update existing customer

Updates the registration data of an existing customer by ID.

Use this operation to keep the customer record up to date without creating a new record. The response represents the customer after the update and keeps the same ID.

The update changes the customer record, but does not automatically modify existing payments, subscriptions or other resources. The new information can be used in operations performed after the record change.

📘

Fields sent

Send only the fields that need to be changed. To preserve the current value of a field, do not send it in the request.

Avoid sending empty, null or default values when the intention is to keep the existing value.

Changing notificationDisabled modifies the customer's payment notification settings. To configure specific events or channels, use the notification endpoints.

Related content

Guides

Path Params
string
required

Unique identifier of the customer to be updated.

Body Params
string

Client name

string

Customer CPF or CNPJ

string

Customer email

string

Landline

string

Cell phone

string

Public place

string

Address number

string

Address complement

string

Neighborhood

string

Address zip code

string

Customer identifier in your system

boolean

true to disable sending billing notifications

string

Additional emails for sending billing notifications separated by ","

string

Customer municipal registration

string

Customer state registration

string

Additional observations

string

Name of the group the customer belongs to. To associate the customer with more than one group, use the "groupNames" attribute

groupNames
array of strings

List of names of the groups the customer belongs to (maximum of 20 per call). Can be used together with "groupName"

groupNames
string

Company

boolean

inform true if it's a non-brazilian customer

Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json