DM Champ Docs

API de Negócios

Um negócio é uma oportunidade de venda no seu quadro de Pipeline de Vendas — um título, um valor, a fase em que se encontra e, opcionalmente, o contacto a que pertence e o membro da equipa a quem está atribuído. Este guia aborda a leitura e gestão de negócios através da API.

Todos os exemplos abaixo mostram o formato de consulta ?apiKey= em cURL e o cabeçalho X-API-Key em JavaScript e Python — qualquer um funciona em todos os endpoints.

O objeto de negócio 

{
  "id": "deal_abc123",
  "title": "Annual plan – Jane's Clinic",
  "description": "Asked for pricing on the annual plan.",
  "company": "Jane's Clinic",
  "stage": "stage-2",
  "value": 4800,
  "probability": 60,
  "priority": "high",
  "status": "open",
  "source": "whatsapp",
  "position": 0,
  "contact_id": "ctc_9f8e7d",
  "assigned_to": "usr_4a2b",
  "tags": ["clinic"],
  "close_date": "2026-10-01T00:00:00.000Z",
  "created_at": "2026-09-05T09:12:00.000Z",
  "updated_at": "2026-09-05T09:40:00.000Z",
  "stage_entered_at": "2026-09-05T09:40:00.000Z"
}

stage é o id de uma das fases do seu pipeline — leia-os a partir das definições do seu pipeline (GET /users/me/pipeline-settings). Os carimbos de data/hora estão no formato ISO 8601.

Listar negócios

GET /deals — devolve os negócios na sua conta, começando pelos mais recentes.

Parâmetros de consulta (todos opcionais): stage (um id de fase), contact_id, limit (predefinição 50, máximo 200), cursor (da next_cursor da página anterior).

cURL

curl "https://api.dmchamp.com/v1/deals?apiKey=YOUR_API_KEY&stage=stage-2&limit=50"

JavaScript

const res = await fetch("https://api.dmchamp.com/v1/deals?stage=stage-2&limit=50", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const { deals, next_cursor } = await res.json();

Python

res = requests.get(
    "https://api.dmchamp.com/v1/deals",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"stage": "stage-2", "limit": 50},
)
deals = res.json()["deals"]

Resposta (200)

{ "success": true, "deals": [{ "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "...": "..." }], "next_cursor": null }

Obter um negócio

GET /deals/{dealId}

curl "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY"

Resposta (200)

{ "success": true, "deal": { "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "...": "..." } }

Um negócio que não existe, ou que pertence a outra conta, devolve 404.

Criar um negócio

POST /deals — title e stage são obrigatórios; stage tem de ser um dos ids de fase do seu pipeline.

curl -X POST "https://api.dmchamp.com/v1/deals?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Annual plan – Jane'"'"'s Clinic", "stage": "stage-1", "value": 4800, "contact_id": "ctc_9f8e7d" }'

Resposta (201)

{ "success": true, "deal_id": "deal_abc123" }

Atualizar um negócio

PUT /deals/{dealId} — envie apenas os campos que pretende alterar (title, description, value, stage, status, priority, contact_id, …). value tem de ser um número.

curl -X PUT "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "value": 5200, "priority": "high" }'

Resposta (200): { "success": true, "deal_id": "deal_abc123" }

Mover um negócio para outra fase

POST /deals/{dealId}/move — corpo { "new_stage_id": "stage-3", "new_position": 0 }. A posição 0 coloca o cartão no topo da coluna.

curl -X POST "https://api.dmchamp.com/v1/deals/deal_abc123/move?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "new_stage_id": "stage-3", "new_position": 0 }'

Resposta (200): { "success": true, "deal_id": "deal_abc123", "stage": "stage-3", "position": 0 }

Eliminar um negócio

DELETE /deals/{dealId} — remove o negócio. Esta ação não pode ser desfeita.

curl -X DELETE "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY"

Resposta (200): { "success": true }

Próximos passos

  • Pipeline de Vendas — como funcionam as fases, as etiquetas de fase e o quadro.
  • API de Tarefas — as tarefas podem ser associadas a um negócio com deal_id.
  • Automatizações — os passos Encontrar negócios e Encontrar negócio leem os mesmos dados dentro de um fluxo de trabalho.