DM Champ Docs

API transakcji

Transakcja to jedna szansa sprzedaży na Twojej tablicy lejka sprzedaży — zawiera tytuł, wartość, etap, na którym się znajduje, oraz opcjonalnie przypisany kontakt i członka zespołu. Ten przewodnik opisuje odczytywanie i zarządzanie transakcjami za pośrednictwem API.

Wszystkie poniższe przykłady pokazują formularz zapytania ?apiKey= w cURL oraz nagłówek X-API-Key w JavaScript i Pythonie — oba działają w każdym punkcie końcowym.

Obiekt transakcji 

{
  "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 to identyfikator jednego z etapów Twojego lejka — odczytasz go z ustawień lejka (GET /users/me/pipeline-settings). Sygnatury czasowe są w formacie ISO 8601.

Lista transakcji

GET /deals — zwraca transakcje na Twoim koncie, od najnowszej.

Parametry zapytania (wszystkie opcjonalne): stage (identyfikator etapu), contact_id, limit (domyślnie 50, maks. 200), cursor (z next_cursor poprzedniej strony).

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

Odpowiedź (200)

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

Pobierz transakcję

GET /deals/{dealId}

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

Odpowiedź (200)

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

Transakcja, która nie istnieje lub należy do innego konta, zwraca 404.

Utwórz transakcję

POST /deals — title i stage są wymagane; stage musi być jednym z identyfikatorów etapów Twojego lejka.

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

Odpowiedź (201)

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

Zaktualizuj transakcję

PUT /deals/{dealId} — wyślij tylko te pola, które chcesz zmienić (title, description, value, stage, status, priority, contact_id, …). value musi być liczbą.

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

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

Przenieś szansę sprzedaży do innego etapu

POST /deals/{dealId}/move — treść { "new_stage_id": "stage-3", "new_position": 0 }. Pozycja 0 umieszcza kartę na górze kolumny.

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

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

Usuń szansę sprzedaży

DELETE /deals/{dealId} — usuwa szansę sprzedaży. Tej operacji nie można cofnąć.

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

Odpowiedź (200): { "success": true }

Następne kroki

  • Lejek sprzedaży — jak działają etapy, tagi etapów i tablica.
  • API zadań — zadania można powiązać z szansą sprzedaży za pomocą deal_id.
  • Automatyzacje — kroki Znajdź szanse sprzedaży i Znajdź szansę sprzedaży odczytują te same dane w ramach przepływu pracy.