Criar novo negócio
POST
https://api.cubosuite.com.br/deals
Descrição
Valida estágios e pipelines, trata duplicados, calcula preço total e cria anotações iniciais.
Campos
| Campo | Tipo | Descrição |
|---|---|---|
| title | string | Título da negociação. Obrigatório. |
| status | enum ['open', 'won', 'lost'] | Status da negociação. Opcional, padrão é 'open'. |
| price | number | Preço total da negociação. Opcional, pode ser calculado a partir dos produtos. |
| userId | number | ID do usuário responsável. Opcional, deve existir na empresa. |
| duplicatedId | number | ID de negociação duplicada. Opcional. |
| peopleName | string | Nome da pessoa relacionada. Obrigatório se peopleId não for fornecido. |
| peopleId | number | ID da pessoa relacionada. Obrigatório se peopleName não for fornecido. |
| peoplePhone | string | Telefone da pessoa. Opcional. |
| organizationName | string | Nome da organização. Opcional. |
| organizationId | number | ID da organização. Opcional. |
| stageId | number | ID do estágio da negociação. Opcional, validado conforme pipeline. |
| pipeId | number | ID do pipeline da negociação. Opcional, validado conforme empresa. |
| rating | number (0 a 5) | Avaliação da negociação. Opcional. |
| products | array de objetos | Lista de produtos associados com productId, quantity e preço opcional. |
| customfields | array de objetos | Campos personalizados associados, com customfieldId e value. |
| expectClosingDate | date (dd/MM/yyyy) | Data esperada para fechamento da negociação. Opcional. |
| lostDate | datetime (yyyy-MM-dd HH:mm:ss) | Data em que a negociação foi perdida. Opcional. |
| lostReasonId | number | Motivo da perda, obrigatório se status for lost. |
| winDate | datetime (yyyy-MM-dd HH:mm:ss) | Data em que a negociação foi ganha. Opcional. |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cubosuite.com.br/deals' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Negociação com Empresa X",
"status": "open",
"price": 15000,
"userId": 5,
"peopleName": "João Silva",
"peoplePhone": "(11) 99999-9999",
"organizationName": "Empresa X LTDA",
"pipeId": 2,
"stageId": 7,
"rating": 4,
"products": [
{
"productId": 10,
"quantity": 2,
"price": 5000
},
{
"productId": 15,
"quantity": 1
}
],
"customfields": [
{
"customfieldId": 3,
"value": "Urgente"
}
],
"expectClosingDate": "31/12/2025"
}'Response Response Example
200 - Success
{
"id": 0,
"title": "string",
"price": "string",
"userId": 0,
"peopleName": "string",
"peoplePhone": "string",
"organizationName": "string",
"stageId": 0,
"pipeId": 0,
"rating": 0,
"products": [
{
"productId": 0,
"quantity": 0,
"price": "string"
}
],
"customfields": [
{
"customfieldId": 0,
"value": "string"
}
],
"createdAt": "string",
"updatedAt": "string"
}
Requisição
Parâmetros Header
Content-Type
string
opcional
Exemplo:
application/json
Parâmetros Bodyapplication/json
Respostas
Modificado em 2025-06-16 14:44:59