Criar um Cliente

post https://{apiHost}/v1/customers

Body Params

Informações a serem salvas no cliente

external_code

string | null

Código Externo

cnpj_cpf

string

length ≤ 20

CPF/CNPJ

person_name

string

required

length ≤ 120

Nome ou Razão Social

contact_person

string | null

Pessoa de Contato (quando Empresa)

nickname

string | null

Apelido ou Nome Fantasia do Pagador

birthday

date | null

Data de Nascimento

string

length ≤ 80

E-mail principal

email_cc

string

length ≤ 80

E-mail alternativo

address

string

required

length ≤ 255

Endereço

address_complement

string | null

Complemento do Endereço

address_number

string

length ≤ 10

Número

neighborhood

string

required

length ≤ 80

Bairro

zipcode

string

required

length ≤ 8

CEP (formato 99999999)

state

string

length ≤ 2

Estado

city_name

string

required

length ≤ 60

Cidade (Nome deve estar correto e completo)

phone_number

string | null

Telefone (com DDD)

mobile_local_code

string | null

DDD do Celular

mobile_number

string | null

Celular

ignore_email

boolean | null

Defaults to false

Nunca enviar e-mail para este cliente

ignore_sms

boolean | null

Defaults to false

Nunca enviar SMS para este cliente

ignore_whatsapp

boolean | null

Defaults to false

Nunca enviar Whatsapp para este cliente

notes

string | null

Anotações

tags

custom_data

object | null

Hash com chave e valor no formato JSON.

Headers

User-Agent

string

Informar um e-mail válido para contatos.

X-Idempotency-Key

string

Chave de idempotência para evitar replay de processamento.

Responses

Language

Credentials

Bearer

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api-sandbox.kobana.com.br/v1/customers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "ignore_email": false,
8
  "ignore_sms": false,
9
  "ignore_whatsapp": false
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Cliente criado

401Falha de autenticação. Token inválido

403Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

422Cliente inválido