Atualizar dados de um cliente

patch

https://pay-public-api.raims.work/v1/client/{identifier}

Este endpoint é responsável por alterar dados cadastrais de um cliente específico.

Para alterar um registro, forneça um objeto JSON no corpo da solicitação com os dados que desejar alterar. Poderá fornecer somente o campo que desejar alterar. Campos não enviados serão ignorados mantendo o valor já existente.

Exemplo 1: Remover o número do celular e o endereço de e-mail gravado

{
  "cell_phone":null,
  "email":null
}

Exemplo 2: Mudar somente CEP e o endereço de e-mail gravado

{
  "zip_code":"12345678",
  "email":"[email protected]"
}

Observação 1: É obrigatório adicionar pelo menos um dos campos disponíveis na requisição.
Observação 2: Não é permitida a atualização de dados em registros removidos.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

identifier

string

required

length between 32 and 32

^[a-zA-Z0-9]+$

Identificador único do cliente digitado no patch da url.
Ex: 0e01234567890b01ed0123456fghi1cf0

Body Params

full_name

string

Nome completo
Ex: John Doe

cpfCnpj

string | null

^(\d{3}\.\d{3}\.\d{3}-\d{2}|\d{11})|(\d{2}\.\d{3}\.\d{3}/\d{4}-\d{2}|\d{14})$

CPF ou CNPJ do cliente.
Ex: CPF: 12345678901 | CNPJ: 12345678000190

string | null

^[^\s@]+@[^\s@]+\.[^\s@]{2,}$

Endereço de e-mail
Ex: [email protected]

cell_phone

string

^(?:\+(\d{1,4})\s?)?(?:(?:(?:$\d{1,4}$|\d{1,4})[\s.-]?)?\d{1,20})$

Número do celular
Ex: 5583981234567

zip_code

string | null

^(?:\d{5}-\d{3}|\d{8})$

CEP do cliente
Ex: 12345678

neigh

string | null

Nome do bairro
Ex: Centro

street

string | null

Nome da rua
Ex: Faria Lima

street_number

string | null

Número do endereço
Ex: 10
Alguns endereços podem conter letras no número, e nosso sistema permite a inclusão de letras neste campo. Para indicar que o endereço não possui número, coloque o valor como null ou deixe o campo fora do JSON.

complement

string | null

Complemento de endereço
Ex: Apto 101

city

string | null

Nome da cidade
Ex: São Paulo

string | null

^[A-Z]{2}$

Sigla do estado
Ex: SP

company_name

string | null

Nome da empresa caso seja pessoa jurídica
Ex: Micro Service S.A

Responses

204O registro foi atualizado com sucesso.

404Registro não encontrado. O identificador único digitado está cadastrado ou foi removido.