Leads API
Baca lead dan perbarui statusnya dari sistem Anda sendiri dengan kunci API bercakupan.
Halaman ini diterjemahkan dari bahasa Inggris. Jika ada perbedaan, versi bahasa Inggris yang berlaku. Baca dalam bahasa Inggris
Leads API memungkinkan CRM, data warehouse, atau otomasi Anda membaca lead dan memperbarui statusnya.
Buat kunci di Studio pada Integrations → Leads API → New key. Setiap kunci memiliki:
- sebuah nama;
- grant:
leads:read(Read leads) dan, secara opsional,leads:write-status(Change lead status); - masa berlaku 30, 90, 180 hari atau 1 tahun.
Kunci berbentuk atl_lead_ diikuti 43 karakter. Kunci ditampilkan sekali, disimpan hanya sebagai sidik jari, diperiksa pada setiap permintaan, dan dapat dicabut kapan saja (Revoke key). Satu lingkungan situs dapat memiliki hingga 20 kunci aktif. Pembuatan kunci dapat memerlukan konfirmasi kedua di ponsel Anda.
URL dasar dan autentikasi
Section titled “URL dasar dan autentikasi”https://<delivery host>/v1/leads-api/environments/{environmentId}Authorization: Bearer atl_lead_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXRespons berupa Cache-Control: private, no-store. Galat memakai format RFC 9457 application/problem+json.
Daftar lead
Section titled “Daftar lead”GET /leads?since=2026-10-01T00:00:00Z&limit=50&cursor=…
| Parameter | Catatan |
|---|---|
since |
Hanya lead yang diperbarui pada atau setelah waktu ini. ISO 8601 dengan zona waktu |
limit |
1 sampai 200, bawaan 50 |
cursor |
nextCursor dari respons sebelumnya |
Lead datang dengan perubahan terlama lebih dulu. Responsnya adalah { "leads": [ … ], "nextCursor": "…" | null }. Terus paginasi sampai nextCursor bernilai null, dan simpan updatedAt terakhir untuk mengambil hanya perubahan pada kesempatan berikutnya.
Daftar ini menyertakan lead yang digabungkan, dianonimkan, dan lead uji. Periksa mergedInto, anonymisedAt, dan isTest.
Ambil satu lead
Section titled “Ambil satu lead”GET /leads/{leadId}
| Bidang | Catatan |
|---|---|
id, source |
Source adalah formulir atau chatbot asal lead |
form |
{ key, name }, atau null untuk lead chatbot |
name, email, phone, company, message |
Kosong setelah retensi menghapus data pribadi |
details |
Jawaban lainnya |
status |
new, contacted, qualified, won, lost, atau spam |
isTest |
Kiriman uji dari Studio |
version |
Kirim kembali ketika Anda mengubah status |
mergedInto, anonymisedAt |
Terisi ketika lead digabungkan atau dianonimkan |
createdAt, updatedAt |
Stempel waktu ISO 8601 |
Ubah status lead
Section titled “Ubah status lead”PATCH /leads/{leadId}/status dengan { "status": "qualified", "expectedVersion": 4 }. Memerlukan grant Change lead status. Perubahan muncul di riwayat lead sebagai dilakukan oleh kunci tersebut.
Galat dan batas
Section titled “Galat dan batas”| Status | Kode | Arti |
|---|---|---|
| 401 | CP_UNAUTHENTICATED |
Kunci hilang, salah, kedaluwarsa, atau dicabut |
| 403 | CP_FORBIDDEN |
Kunci tidak memiliki grant untuk permintaan ini |
| 404 | CP_NOT_FOUND |
Tidak ada lead tersebut di lingkungan ini |
| 409 | CP_VERSION_CONFLICT |
Lead berubah sejak Anda membacanya. Baca lagi |
| 422 | REQUEST_SCHEMA_INVALID |
Body permintaan atau sebuah parameter tidak valid |
| 422 | CURSOR_INVALID |
Cursor tidak dapat dibaca |
| 429 | RATE_LIMITED |
Lebih dari 300 permintaan per menit. Tunggu dan coba lagi |
Batas laju diterapkan per server API Atlas, jadi perlakukan 300 permintaan per menit sebagai batas atas, bukan jaminan.