API
Checking Raims account

Update an existing customer

Update a customer and their integration data by public identifier.

PATCHhttps://api.raims.com/v1/customers/{id}

Updates an existing customer and their integration data by public identifier. The customer must belong to the company and environment of your API key.

Send only the fields you want to change. Omitted fields keep their current value. For optional text fields, sending null or an empty value clears the field. The identifier and CPF or CNPJ stay the same; this request does not create a customer.

The metadata map is updated by key. See how to add or remove values in Additional integration data.

The address is also updated by field. Changing zip_code does not automatically fill in or replace the street, neighborhood, city or state; send the address fields you want to change. See the update rules in Update an existing customer.

Path Params

The customer's public ID in Raims, returned when the customer is created or listed.

Up to 100 characters

Body Params

Payer's full name. Omit it to keep the current value; send null or empty text to remove it.

Up to 120 characters

Payer's email. Updating the email does not send a message. Omit it to keep the current value; send null or empty text to remove it.

Up to 254 characters

International dialing code. Can be provided without phone_local. Omit it to keep the current value; send null or empty text to remove it.

Up to 5 characters

Phone number without the dialing code, with or without punctuation. Can be provided without dial_code. Omit it to keep the current value; send null or empty text to remove it.

Up to 20 characters

Address postal code, with or without a hyphen. Updating the postal code does not fill in other address fields. Omit it to keep the current value; send null or empty text to remove it.

Up to 15 characters

Address street. Omit it to keep the current value; send null or empty text to remove it.

Up to 120 characters

Address number. Omit it to keep the current value; send null or empty text to remove it.

Up to 10 characters

Address complement. Omit it to keep the current value; send null or empty text to remove it.

Up to 40 characters

Address neighborhood. Omit it to keep the current value; send null or empty text to remove it.

Up to 80 characters

Address city. Omit it to keep the current value; send null or empty text to remove it.

Up to 80 characters

State abbreviation, such as SP. Omit it to keep the current value; send null or empty text to remove it.

Up to 5 characters

Customer identifier in your system. Omit it to keep the current reference; send null or empty text to remove it. Use external_reference in the customer list to search for this value.

Up to 120 characters

Integration data associated with the resource. Provide key and text pairs. Keys are case-sensitive. Omitting it or sending {} keeps the data; null removes all pairs, and null for a key removes only that key. Empty text is a valid value.

Up to 32 entries, Keys: up to 40 characters, Values: up to 500 characters, JSON: up to 8192 UTF-8 bytes

Responses

For common errors, see HTTP response codes.