Skip to main content
POST

Autenticação

string
required
Bearer vg_live_<sua_chave> — API Key com escopo deals:write
Cria um negócio para um contato já existente no workspace. Para criar contato + negócio de uma vez a partir de uma integração, use Criar lead.

Body

string
required
ID de um contato existente no workspace. Obrigatório. Contato inexistente, excluído ou de outro tenant → 404 CONTACT_NOT_FOUND.
string
required
ID ou nome do pipeline (case-insensitive) onde o negócio será criado.
string
ID ou nome da etapa. Se omitido, o negócio vai para a primeira etapa do pipeline.
string
Nome do negócio (até 200 caracteres). Se omitido, usa o nome ou telefone do contato.
number
Valor em BRL. Número >= 0 ou null.
string
Origem do negócio (até 64 caracteres). Padrão: "api".
string
ID ou nome do produto. Se o nome não existir no workspace, o produto é criado automaticamente.
string
ID do usuário ou nome de um membro do workspace (case-insensitive). Não sendo membro → 400 ASSIGNEE_NOT_FOUND.
object
Valores de campos personalizados. Só chaves definidas como campo personalizado do pipeline (ou global) são gravadas — chaves desconhecidas são descartadas silenciosamente. Valores aceitos: string, número, boolean ou array de primitivos. Objeto aninhado → 400 VALIDATION.
Erros: 400 VALIDATION, 404 CONTACT_NOT_FOUND, 404 PIPELINE_NOT_FOUND, 404 STAGE_NOT_FOUND, 422 PIPELINE_EMPTY (pipeline sem etapas), 400 ASSIGNEE_NOT_FOUND, 402 DEAL_LIMIT_REACHED (cota de negócios do plano atingida).