Skip to main content

​
Endpoint

POST /v1/deals
Escopo necessário: write:deals

​
Corpo da requisição

CampoTipoObrigatórioDescrição
titlestringSimTítulo do negócio
pipeline_idstringSimID do pipeline
stage_idstringNãoID da etapa. Se omitido, usa a primeira etapa do funil de venda
valuenumberNãoValor em reais. Padrão: 0
contact_idsstring[]NãoIDs dos contatos vinculados
company_idstringNãoID da empresa
assigned_tostringNãoID do membro responsável
expected_close_datestringNãoData prevista de fechamento (ISO 8601)
tagsstring[]NãoTags
custom_fieldsobjectNãoCampos personalizados

​
Obtendo o pipeline_id

Use GET /v1/pipelines para listar os pipelines disponíveis e seus IDs de etapas.

​
Exemplo de requisição

curl -X POST https://api.socialsell.ai/v1/deals \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Contrato Anual - TechCorp",
    "pipeline_id": "664a1b2c3d4e5f6789012345",
    "value": 36000,
    "contact_ids": ["664f1a2b3c4d5e6f78901234"],
    "company_id": "664b1c2d3e4f5a6789012346",
    "expected_close_date": "2026-08-31T00:00:00.000Z",
    "tags": ["contrato-anual"]
  }'

​
Resposta

Retorna HTTP 201 com o objeto negócio criado. A criação dispara o evento deal.created em webhooks configurados.

​
Erros

CódigoStatusDescrição
MISSING_REQUIRED_FIELD400title ou pipeline_id ausente
PIPELINE_NOT_FOUND404Funil de venda não encontrado
STAGE_NOT_FOUND404Etapa não encontrada no funil de venda
NO_STAGES422Funil de venda não tem etapas