ResgataInstall

Summary

Update an existing customer's information in Resgata by specifying their CPF and the fields to modify.

Inputs

• CPF (required) — The CPF (Brazilian individual taxpayer registry identification) of the customer to update; accepts CPF with or without punctuation.
• Update Fields — A collection of optional fields to update on the customer record, such as name, email, phone, WhatsApp, birth date, gender, marital status (both descriptive and coded), education level (coded), mother's name, identity document details (RG, issuer, UF), address components (ZIP code, street, number, complement, neighborhood, city, state), banking details (bank code, agency and digit, account and digit, account type), notes, and employer contact information.

Output shape

A single JSON object representing the updated customer data returned from the Resgata API.

The operation returns the updated customer data as JSON. The CPF parameter is mandatory and identifies which customer to update. The "Update Fields" collection allows selectively updating specific properties; you can provide any subset of these fields. Errors are thrown if parameters are invalid or the API request fails.

Examples

Example 1: Update the email and phone number of a customer identified by their CPF.

Set 'CPF' to the client's CPF, and in 'Update Fields' set 'Email' and 'Telefone' with the new values.