Skip to main content
PATCH

Autenticação

string
required
Bearer vg_live_<sua_chave> — API Key com escopo deals:write
Um único endpoint concentra todas as mutações do negócio. Envie ao menos um campo. As ações abaixo são combinações de campos deste mesmo PATCH:
  • Mover de etapa → envie stageId.
  • Marcar como ganho → envie status: "won".
  • Marcar como perdido → envie status: "lost" + lostReason.
  • Restaurar (reabrir) → envie status: "open" (limpa closedAt).

Body

string
Renomeia o negócio.
number
Novo valor (>= 0 ou null).
string
Move o negócio para outra etapa. Registra histórico e dispara o webhook card.moved + automação stage_changed.
string
ID do responsável, ou null para remover. Precisa ser membro do workspace.
string
open, won ou lost. won/lost marcam closedAt; open restaura (limpa closedAt). Dispara card.won/card.lost + automação deal_won/deal_lost.
string
Obrigatório quando status = lost.
object
Atualiza campos personalizados (mesma validação do create).
Transições de status e movimentação de etapa são atômicas: dois PATCH concorrentes idênticos não disparam o webhook/automação duas vezes.
Erros: 400 VALIDATION, 404 STAGE_NOT_FOUND, 404 NOT_FOUND, 400 ASSIGNEE_NOT_FOUND.