Corbee Vendas

Adiciona um novo cliente

POST

https://api.crm.corbee.com.br/customer

Cliente

Cria um novo cliente no sistema CRM.

Requisição

Parâmetros Header

corbee-token-integration

string

requerido

Token

Exemplo:

2f68dbbf-519d-4f01-9636-e2421b68f379

Parâmetros Bodyapplication/json

name

string

requerido

Nome completo do cliente.

Exemplo:

Thor

document

string

requerido

CPF do cliente com pontuação.

Exemplo:

172.876.676-52

birth_date

string <date>

opcional

Data de nascimento do cliente no formato AAAA-MM-DD.

Exemplo:

1986-06-20

foundation_date

string <date>

opcional

Data de fundação da empresa.

Exemplo:

thor@asgard.com

phone

number

opcional

Número de telefone do cliente, incluindo código do país e dígitos sem espaços ou pontuações.

Exemplo

{
    "name": "Thor",
    "document": "17287667652",
    "birth_date": "08/10/1994",
    "foundation_date": "08/10/1994",
    "phone": "11987984340"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.crm.corbee.com.br/customer' \
--header 'corbee-token-integration: 2f68dbbf-519d-4f01-9636-e2421b68f379' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Thor",
    "document": "17287667652",
    "birth_date": "08/10/1994",
    "foundation_date": "08/10/1994",
    "phone": "11987984340"
}'

Respostas

🟢201Criado

application/json

Cliente cadastrado com sucesso.

Body

message

string

opcional

Exemplo:

Cliente cadastrado com sucesso!

customer_id

integer

opcional

Exemplo:

132

Exemplo

{
    "message": "Cliente cadastrado com sucesso!",
    "customer_id": 132
}

🟠422Erro de parâmetro

Modificado em 2025-04-07 21:30:05

Página anterior

Lista as tags existentes

Próxima página

Atualiza os dados do cliente