DM Champ Docs

Deals API

En handel er en salgsmulighed på din Salgspipeline-tavle — en titel, en værdi, det stadie den befinder sig i, og valgfrit den kontaktperson den tilhører, og det teammedlem den er tildelt. Denne guide dækker læsning og håndtering af handler via API’et.

Alle eksempler herunder viser ?apiKey= forespørgselsformen i cURL og X-API-Key headeren i JavaScript og Python — begge virker på alle slutpunkter.

Handelsobjektet 

{
  "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 er id’et på et af dine pipelinestadier — læs dem fra dine pipeline-indstillinger (GET /users/me/pipeline-settings). Tidsstempler er ISO 8601.

List handler

GET /deals — returnerer handlerne på din konto, nyeste først.

Forespørgselsparametre (alle valgfrie): stage (et stadie-id), contact_id, limit (standard 50, maks 200), cursor (fra den forrige sides next_cursor).

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"]

Svar (200)

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

Hent en handel

GET /deals/{dealId}

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

Svar (200)

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

En handel, der ikke eksisterer, eller som tilhører en anden konto, returnerer 404.

Opret en handel

POST /deals — title og stage er påkrævet; stage skal være et af din pipelines stadie-id’er.

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" }'

Svar (201)

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

Opdater en handel

PUT /deals/{dealId} — send kun de felter, du ønsker at ændre (title, description, value, stage, status, priority, contact_id, …). value skal være et tal.

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" }'

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

Flyt en handel til et andet stadie

POST /deals/{dealId}/move — body { "new_stage_id": "stage-3", "new_position": 0 }. Position 0 placerer kortet øverst i kolonnen.

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 }'

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

Slet en handel

DELETE /deals/{dealId} — fjerner handlen. Dette kan ikke fortrydes.

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

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

Næste skridt

  • Salgspipeline — hvordan stadier, stadie-tags og tavlen fungerer.
  • Tasks API — opgaver kan linkes til en handel med deal_id.
  • Automatiseringer — Find handler og Find handel-trinene læser de samme data i en arbejdsgang.