Atualizar cliente existente
Atualize o cadastro e os dados de integração de um cliente pelo identificador público.
Atualiza o cadastro e os dados de integração de um cliente existente pelo identificador público. O cadastro precisa pertencer à empresa e ao ambiente da sua chave de API.
Envie apenas os campos que deseja alterar. Campos omitidos mantêm o valor
atual. Nos campos de texto opcionais, enviar null ou um valor vazio limpa o campo. O identificador
e o CPF ou CNPJ permanecem os mesmos; esta requisição não cria um cliente.
O mapa metadata é atualizado por chave. Veja como acrescentar ou remover
valores em Dados adicionais da integração.
O endereço também é atualizado por campo. Alterar zip_code não preenche
nem substitui automaticamente rua, bairro, cidade ou UF; envie os campos do
endereço que deseja mudar. Veja as regras de atualização em
Atualizar cliente existente.
Parâmetros de caminho
Identificador público do cliente na Raims, recebido na criação ou na listagem de clientes.
Até 100 caracteres
Parâmetros do corpo
Nome completo do pagador. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 120 caracteres
E-mail do pagador. Atualizar o e-mail não envia uma mensagem. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 254 caracteres
Código de discagem internacional. Pode ser informado sem phone_local. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 5 caracteres
Número de telefone sem o código de discagem, com ou sem pontuação. Pode ser informado sem dial_code. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 20 caracteres
CEP do endereço, com ou sem hífen. Atualizar o CEP não preenche os outros campos de endereço. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 15 caracteres
Logradouro do endereço. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 120 caracteres
Número do endereço. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 10 caracteres
Complemento do endereço. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 40 caracteres
Bairro do endereço. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 80 caracteres
Cidade do endereço. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 80 caracteres
Sigla do estado, como SP. Omita para manter o valor atual; envie null ou texto vazio para removê-lo.
Até 5 caracteres
Identificador do cliente no seu sistema. Omita para manter a referência atual; envie null ou texto vazio para removê-la. Use external_reference na listagem de clientes para buscar esse valor.
Até 120 caracteres
Dados de integração associados ao recurso. Informe pares de chave e texto. Chaves diferenciam maiúsculas de minúsculas. Omitir ou enviar {} preserva os dados; null remove todos os pares, e null em uma chave remove somente essa chave. Texto vazio é um valor válido.
Até 32 entradas, Chaves: até 40 caracteres, Valores: até 500 caracteres, JSON: até 8192 bytes UTF-8
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.