DM Champ Docs

Fırsatlar API’si

Bir fırsat, Satış Hunisi panonuzdaki bir satış fırsatıdır; bir başlık, bir değer, bulunduğu aşama ve isteğe bağlı olarak ait olduğu kişi ve atandığı ekip üyesinden oluşur. Bu kılavuz, API üzerinden fırsatların okunmasını ve yönetilmesini kapsar.

Aşağıdaki tüm örnekler cURL’de ?apiKey= sorgu biçimini ve JavaScript ile Python’da X-API-Key başlığını göstermektedir; her ikisi de her uç noktada çalışır.

Fırsat nesnesi 

{
  "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, satış hunisi aşamalarınızdan birinin kimliğidir (id) — bunları satış hunisi ayarlarınızdan (GET /users/me/pipeline-settings) okuyabilirsiniz. Zaman damgaları ISO 8601 formatındadır.

Fırsatları listele

GET /deals — hesabınızdaki fırsatları, en yeniden başlayarak döndürür.

Sorgu parametreleri (hepsi isteğe bağlıdır): stage (bir aşama kimliği), contact_id, limit (varsayılan 50, maksimum 200), cursor (önceki sayfanın next_cursor değerinden).

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

Yanıt (200)

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

Bir fırsatı getir

GET /deals/{dealId}

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

Yanıt (200)

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

Var olmayan veya başka bir hesaba ait olan bir fırsat, 404 döndürür.

Bir fırsat oluştur

POST /deals — title ve stage zorunludur; stage, satış huninizin aşama kimliklerinden biri olmalıdır.

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

Yanıt (201)

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

Bir fırsatı güncelle

PUT /deals/{dealId} — yalnızca değiştirmek istediğiniz alanları gönderin (title, description, value, stage, status, priority, contact_id, …). value bir sayı olmalıdır.

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

Yanıt (200): { "success": true, "deal_id": "deal_abc123" }

Bir anlaşmayı başka bir aşamaya taşıma

POST /deals/{dealId}/move — gövde { "new_stage_id": "stage-3", "new_position": 0 }. 0 konumu, kartı sütunun en üstüne yerleştirir.

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

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

Bir anlaşmayı silme

DELETE /deals/{dealId} — anlaşmayı kaldırır. Bu işlem geri alınamaz.

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

Yanıt (200): { "success": true }

Sonraki adımlar

  • Satış Hunisi — aşamaların, aşama etiketlerinin ve panonun nasıl çalıştığı.
  • Görevler API’si — görevler deal_id ile bir anlaşmaya bağlanabilir.
  • Otomasyonlar — Anlaşmaları bul ve Anlaşma bul adımları, bir iş akışı içindeki aynı verileri okur.