Cadastro ou Atualização de Cliente (Customer Upsert)

Este endpoint recebe e coloca em fila até 50 clientes por vez. Não há rate limit.

Nenhum dado do cliente será retornado nesta requisição. O endpoint apenas recebe os dados, valida alguns parâmetros e informa o sucesso do enfileiramento. Todos os clientes podem ser consultados posteriormente pelo endpoint GET Customer.

Você pode testar este endpoint acessando: Upsert de clientes

Parâmetros

Este endpoint recebe os seguintes parâmetros:

address_city [String - Obrigatório - Not Empty]

Cidade do endereço do cliente.

Exemplo: "São Paulo"

address_complement [String - Obrigatório - Not Empty]

Complemento do endereço do cliente.

Exemplo: "Second Floor"

address_neighborhood [String - Obrigatório - Not Empty]

Bairro do endereço do cliente.

Exemplo: "Brooklyn"

address_number [String - Obrigatório - Not Empty]

Número do endereço do cliente.

Exemplo: "356"

address_state [String - Obrigatório - Not Empty]

Sigla do Estado onde o cliente está localizado

Exemplo: "SP"

Possíveis valores:

Acre (AC)

Alagoas (AL)

Amapá (AP)

Amazonas (AM)

Bahia (BA)

Ceará (CE)

Distrito Federal (DF)

Espírito Santo (ES)

Goiás (GO)

Maranhão (MA)

Mato Grosso (MT)

Mato Grosso do Sul (MS)

Minas Gerais (MG)

Pará (PA)

Paraíba (PB)

Paraná (PR)

Pernambuco (PE)

Piauí (PI)

Rio de Janeiro (RJ)

Rio Grande do Norte (RN)

Rio Grande do Sul (RS)

Rondônia (RO)

Roraima (RR)

Santa Catarina (SC)

São Paulo (SP)

Sergipe (SE)

Tocantins (TO)

address_street [String - Obrigatório - Not Empty]

Nome da rua do endereço do cliente.

Exemplo: "Avenida Paulista"

address_zip_code [String - Obrigatório - Not Empty]

CEP do endereço do cliente.

Exemplo: "01405-001"

document [String - Obrigatório - Not Empty]

CPF (11 dígitos) ou CNPJ (14 dígitos) do cliente.

Exemplo: "75730786000100"

mail [String - Obrigatório - Not Empty]

Email principal do cliente, onde ele receberá comunicações de cobrança.

Exemplo: "customer@gmail.com"

name [String - Obrigatório - Not Empty]

Nome do cliente.

Exemplo: "Maria Quinteros" or "Company XPTO Inc"

phone [String - Obrigatório - Not Empty]

Número de telefone do cliente com DDI + DDD, utilizado também para envio de mensagens via WhatsApp.

+ DDI + Número de telefone.

Exemplo: "+5511987654321"

secondary_phone [String - Opcional - Empty]

Segundo número de telefone do cliente com DDI + DDD. Também pode ser usado para mensagens via WhatsApp.

+ DDI + Número de telefone.

Exemplo: "+5511987654321"

Como realizar o upsert de um cliente

Cadastro ou Atualização de Cliente (Customer Upsert)#

Parâmetros#

address_city [String - Obrigatório - Not Empty]#

address_complement [String - Obrigatório - Not Empty]#

address_neighborhood [String - Obrigatório - Not Empty]#

address_number [String - Obrigatório - Not Empty]#

address_state [String - Obrigatório - Not Empty]#

address_street [String - Obrigatório - Not Empty]#

address_zip_code [String - Obrigatório - Not Empty]#

document [String - Obrigatório - Not Empty]#

mail [String - Obrigatório - Not Empty]#

name [String - Obrigatório - Not Empty]#

phone [String - Obrigatório - Not Empty]#

secondary_phone [String - Opcional - Empty]#

Segundo número de telefone do cliente com DDI + DDD. Também pode ser usado para mensagens via WhatsApp.#