{ "info": { "_postman_id": "00118203-3eb1-52c1-8ea6-d93abb7466d6", "name": "DialerBee API v1 (1.0.0-rc6)", "description": "Every operation of the DialerBee API v1, generated from the API contract 1.0.0-rc6. Select the DialerBee live or test environment and set DIALERBEE_API_KEY (current value only). Documentation: https://docs.dialerbee.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{DIALERBEE_API_KEY}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// DialerBee: never send a request without a key, and keep one Idempotency-Key per logical write.", "const key = pm.variables.get('DIALERBEE_API_KEY');", "if (!key) {", " throw new Error('Set DIALERBEE_API_KEY (current value only) in the selected environment.');", "}", "if (pm.request.headers.has('Idempotency-Key') && !pm.collectionVariables.get('idempotency_key')) {", " pm.collectionVariables.set('idempotency_key', pm.variables.replaceIn('{{$guid}}'));", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Keep the Idempotency-Key until the outcome is known: a retry must reuse it (never a new key", "// after outcome_unknown, conflict, 429 or 5xx). Clear it after a success or a definite refusal.", "const status = pm.response.code;", "let body = null;", "try { body = pm.response.json(); } catch (e) { body = null; }", "const code = body && typeof body === 'object' ? body.code : undefined;", "if (pm.request.headers.has('Idempotency-Key')) {", " const keep = status === 429 || status >= 500 ||", " (status === 409 && (code === 'outcome_unknown' || code === 'conflict'));", " if (!keep) { pm.collectionVariables.unset('idempotency_key'); }", "}", "// Remember the next page's cursor for list requests.", "if (body && body.page && Object.prototype.hasOwnProperty.call(body.page, 'next_cursor')) {", " if (body.page.next_cursor) { pm.collectionVariables.set('cursor', body.page.next_cursor); }", " else { pm.collectionVariables.unset('cursor'); }", "}" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://app.dialerbee.com/api", "type": "string" }, { "key": "idempotency_key", "value": "", "type": "string" }, { "key": "cursor", "value": "", "type": "string" }, { "key": "etag", "value": "", "type": "string" }, { "key": "appointment_id", "value": "appt_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" }, { "key": "call_id", "value": "call_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" }, { "key": "callback_id", "value": "cb_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" }, { "key": "event_id", "value": "evt_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" }, { "key": "lead_id", "value": "lead_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" }, { "key": "webhook_id", "value": "wh_0f8fad5b-d9cb-469f-a165-70867728950e", "type": "string" } ], "item": [ { "id": "0ff7ec1e-4afd-54f1-a703-496db98f9773", "name": "Account", "description": "The calling API client.", "item": [ { "id": "3a4bca9f-74fc-5486-953d-99e04fea69ee", "name": "Who am I: the API client, the account and the granted scopes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] }, "x-operation-id": "getMe", "description": "Answers from the authentication step only; it calls no platform service. Every active key can call it, even one with no scopes, so use it to check a new key. It never returns an internal account id.\n\nScope: none (any active key) · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-me" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"client\": {\n \"id\": \"cli_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"name\": \"CRM sync (production)\",\n \"environment\": \"live\"\n },\n \"account\": {\n \"name\": \"Example Clinic\"\n },\n \"scopes\": [\n \"leads:read\",\n \"leads:write\",\n \"calls:read\",\n \"recordings:read\",\n \"webhooks:read\"\n ],\n \"tier2\": {\n \"campaign_resume\": false,\n \"callback_write\": false,\n \"appointment_write\": false,\n \"consent_write\": false,\n \"sms_send\": false,\n \"calls_originate\": false\n }\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "401 invalid_api_key", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] } }, "status": "Invalid API key", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/invalid-api-key\",\n \"title\": \"Invalid API key\",\n \"status\": 401,\n \"detail\": \"The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"invalid_api_key\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] } ] }, { "id": "bb5af615-790d-531e-b2db-2c5653f9fda0", "name": "Leads", "description": "Import, read and update leads. Imports run the platform's own validation and DNC screen.", "item": [ { "id": "9b142911-3e83-5e92-94ea-e12edcdee787", "name": "Import leads into a campaign through the platform's own list-upload validation", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/import?campaign_id=cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", "import" ], "query": [ { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": false, "description": "required" } ] }, "x-operation-id": "importLeads", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"gold\"\n }\n },\n {\n \"external_id\": \"CRM-1002\",\n \"phone\": \"+12125550102\",\n \"full_name\": \"Omar Haddad\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Runs the real campaign list-upload path: sanctioned destinations, phone validation, duplicates in the request and in the campaign, the account's field rules and the Do-Not-Call screen.\n\nRefused with 409 `campaign_not_importable` unless the campaign is `paused`, `draft` or `ready`: an import into a running campaign would place real calls.\n\nIf the Do-Not-Call screen cannot run, the WHOLE import is refused with 503 `dnc_screen_unavailable`; nothing was written and a retry with the same `Idempotency-Key` is safe. If the platform cannot confirm the write, the answer is 409 `outcome_unknown` on every retry of that key until DialerBee has reconciled it.\n\nExactly one result per input lead, by `index` (0-based). `external_id` is stored per API client (two integrations may both use `12345`). At most 200 leads per request.\n\nScope: leads:write · Tier 1 · Idempotency-Key: required · Docs: https://docs.dialerbee.com/reference/import-leads" }, "response": [ { "name": "200 example", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/import?campaign_id=cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", "import" ], "query": [ { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": false, "description": "required" } ] }, "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"gold\"\n }\n },\n {\n \"external_id\": \"CRM-1002\",\n \"phone\": \"+12125550102\",\n \"full_name\": \"Omar Haddad\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"data\": [\n {\n \"index\": 0,\n \"external_id\": \"CRM-1001\",\n \"status\": \"accepted\",\n \"reason\": null,\n \"field\": null,\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\"\n },\n {\n \"index\": 1,\n \"external_id\": \"CRM-1002\",\n \"status\": \"duplicate\",\n \"reason\": \"duplicate_in_campaign\",\n \"field\": null,\n \"lead_id\": null\n }\n ],\n \"summary\": {\n \"received\": 2,\n \"accepted\": 1,\n \"rejected\": 1\n }\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/import?campaign_id=cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", "import" ], "query": [ { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": false, "description": "required" } ] }, "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"gold\"\n }\n },\n {\n \"external_id\": \"CRM-1002\",\n \"phone\": \"+12125550102\",\n \"full_name\": \"Omar Haddad\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "409 outcome_unknown", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/import?campaign_id=cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", "import" ], "query": [ { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": false, "description": "required" } ] }, "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"gold\"\n }\n },\n {\n \"external_id\": \"CRM-1002\",\n \"phone\": \"+12125550102\",\n \"full_name\": \"Omar Haddad\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Outcome unknown", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/outcome-unknown\",\n \"title\": \"Outcome unknown\",\n \"status\": 409,\n \"detail\": \"An earlier request with this Idempotency-Key may or may not have taken effect: the platform did not confirm it.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"outcome_unknown\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "29af30c7-91c8-5c2a-a972-6e76dd337e74", "name": "List leads across the account's campaigns", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "status", "value": "new", "disabled": true, "description": "Lead status bucket." }, { "key": "external_id", "value": "CRM-1001", "disabled": true, "description": "Your own id for the lead, as sent at import by this API client." } ] }, "x-operation-id": "listLeads", "description": "Newest first. Filter by campaign, status or your own `external_id` (the id you sent at import, scoped to your API client).\n\nScope: leads:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/list-leads" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "status", "value": "new", "disabled": true, "description": "Lead status bucket." }, { "key": "external_id", "value": "CRM-1001", "disabled": true, "description": "Your own id for the lead, as sent at import by this API client." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"status\": \"contacted\",\n \"attempts\": 1,\n \"custom_fields\": {\n \"tier\": \"gold\"\n },\n \"last_attempt_at\": \"2026-09-29T11:58:00Z\",\n \"next_attempt_at\": \"2026-09-30T10:00:00Z\",\n \"disposition_code\": \"interested\",\n \"hangup_cause\": \"NORMAL_CLEARING\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\"\n }\n ],\n \"page\": {\n \"next_cursor\": \"c1.example-opaque-cursor\",\n \"has_more\": true\n }\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "status", "value": "new", "disabled": true, "description": "Lead status bucket." }, { "key": "external_id", "value": "CRM-1001", "disabled": true, "description": "Your own id for the lead, as sent at import by this API client." } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "status", "value": "new", "disabled": true, "description": "Lead status bucket." }, { "key": "external_id", "value": "CRM-1001", "disabled": true, "description": "Your own id for the lead, as sent at import by this API client." } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "4b7b9ab8-799b-521e-ad0d-2163d74ab3d2", "name": "Add one lead, optionally to be dialled first (speed-to-lead)", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ] }, "x-operation-id": "createLead", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1003\",\n \"phone\": \"+12125550103\",\n \"full_name\": \"Rana Saleh\",\n \"email\": \"rana.saleh@example.com\",\n \"source\": \"website\",\n \"dial_now\": true,\n \"dial_within_seconds\": 300\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds one lead to a campaign that is draft, ready, paused or running, through the same validation as an import (phone checks, field rules, duplicates, Do-Not-Call, blocked countries). The answer has the import's per-lead `status`. With `dial_now: true` and a running campaign, the lead is put at the front of the campaign's dialling order for `dial_within_seconds` (default 300): the next free agent's next call is to this lead, with every compliance check (calling hours, Do-Not-Call, caller ID) still applied at dial time. After the window the lead stays in the campaign in its normal place. `source` names one of the account's lead sources (its code); it is stored on the lead as the custom field `lead_source`.\n\nA lead added to a running campaign, or with `dial_now: true`, is called by the dialler within seconds, so that request also needs the scope `calls:originate` (403 `insufficient_scope` otherwise) and the account switch `tier2_calls_originate_enabled` with the account's sending setup (403 `tier_not_enabled` otherwise), checked before anything is written; nothing is written on a refusal. Adding a lead to a draft, ready or paused campaign without `dial_now` needs only `leads:write`. AI assistants ask the user to confirm every call of this operation.\n\nScope: leads:write · Tier 1 · Idempotency-Key: required · Docs: https://docs.dialerbee.com/reference/create-lead" }, "response": [ { "name": "200 example", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ] }, "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1003\",\n \"phone\": \"+12125550103\",\n \"full_name\": \"Rana Saleh\",\n \"email\": \"rana.saleh@example.com\",\n \"source\": \"website\",\n \"dial_now\": true,\n \"dial_within_seconds\": 300\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"accepted\",\n \"reason\": null,\n \"field\": null,\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1003\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"dial_now\": {\n \"status\": \"queued\",\n \"expires_at\": \"2026-09-29T12:05:00Z\"\n }\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ] }, "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1003\",\n \"phone\": \"+12125550103\",\n \"full_name\": \"Rana Saleh\",\n \"email\": \"rana.saleh@example.com\",\n \"source\": \"website\",\n \"dial_now\": true,\n \"dial_within_seconds\": 300\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "409 outcome_unknown", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads" ] }, "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1003\",\n \"phone\": \"+12125550103\",\n \"full_name\": \"Rana Saleh\",\n \"email\": \"rana.saleh@example.com\",\n \"source\": \"website\",\n \"dial_now\": true,\n \"dial_within_seconds\": 300\n}", "options": { "raw": { "language": "json" } } } }, "status": "Outcome unknown", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/outcome-unknown\",\n \"title\": \"Outcome unknown\",\n \"status\": 409,\n \"detail\": \"An earlier request with this Idempotency-Key may or may not have taken effect: the platform did not confirm it.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"outcome_unknown\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "f9057d75-8085-5b2b-9e6e-08533b9e048e", "name": "One lead", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] }, "x-operation-id": "getLead", "description": "One lead\n\nScope: leads:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-lead" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"status\": \"contacted\",\n \"attempts\": 1,\n \"custom_fields\": {\n \"tier\": \"gold\"\n },\n \"last_attempt_at\": \"2026-09-29T11:58:00Z\",\n \"next_attempt_at\": \"2026-09-30T10:00:00Z\",\n \"disposition_code\": \"interested\",\n \"hangup_cause\": \"NORMAL_CLEARING\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\"\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "63f75823-73f8-5c52-9f79-90222740ced8", "name": "Update a lead's name, email or custom fields", "request": { "method": "PATCH", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known.", "disabled": true }, { "key": "If-Match", "value": "{{etag}}", "type": "text", "description": "The ETag from your last read of this object.", "disabled": true }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] }, "x-operation-id": "updateLead", "body": { "mode": "raw", "raw": "{\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"platinum\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Only `full_name`, `email` and `custom_fields` can change. The phone number can never change: import the new number as a new lead. In `custom_fields`, a key set to `null` is removed and keys you do not send are kept. Send `If-Match` with the lead's `ETag` to refuse the update (412) when someone changed the lead since you read it.\n\nScope: leads:write · Tier 1 · Idempotency-Key: optional · Docs: https://docs.dialerbee.com/reference/update-lead" }, "response": [ { "name": "200 example", "originalRequest": { "method": "PATCH", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known.", "disabled": true }, { "key": "If-Match", "value": "{{etag}}", "type": "text", "description": "The ETag from your last read of this object.", "disabled": true }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"platinum\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"external_id\": \"CRM-1001\",\n \"phone\": \"+12125550101\",\n \"full_name\": \"Ann Lee\",\n \"email\": \"ann.lee@example.com\",\n \"status\": \"contacted\",\n \"attempts\": 1,\n \"custom_fields\": {\n \"tier\": \"platinum\"\n },\n \"last_attempt_at\": \"2026-09-29T11:58:00Z\",\n \"next_attempt_at\": \"2026-09-30T10:00:00Z\",\n \"disposition_code\": \"interested\",\n \"hangup_cause\": \"NORMAL_CLEARING\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\"\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "PATCH", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known.", "disabled": true }, { "key": "If-Match", "value": "{{etag}}", "type": "text", "description": "The ETag from your last read of this object.", "disabled": true }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"platinum\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "PATCH", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known.", "disabled": true }, { "key": "If-Match", "value": "{{etag}}", "type": "text", "description": "The ETag from your last read of this object.", "disabled": true }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"ann.lee@example.com\",\n \"custom_fields\": {\n \"tier\": \"platinum\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "64f59113-387a-5554-a48a-ad381232020e", "name": "A lead's contact history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id", "history" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] }, "x-operation-id": "getLeadHistory", "description": "A lead's contact history\n\nScope: leads:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-lead-history" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id", "history" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"data\": [\n {\n \"type\": \"attempt\",\n \"occurred_at\": \"2026-09-29T11:58:00Z\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"status\": \"contacted\",\n \"attempts\": 1,\n \"last_attempt_at\": \"2026-09-29T11:58:00Z\"\n }\n ]\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id", "history" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/leads/:lead_id/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "leads", ":lead_id", "history" ], "variable": [ { "key": "lead_id", "value": "{{lead_id}}" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] } ] }, { "id": "a5c971e5-16a5-5125-b502-5c204895e1d9", "name": "Campaigns", "description": "Read campaigns and their progress; pause (Tier 1) and resume (Tier 2).", "item": [ { "id": "0e81654a-2404-5a26-975c-ad70ff2d93a3", "name": "List campaigns", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "status", "value": "draft", "disabled": true, "description": "optional filter" } ] }, "x-operation-id": "listCampaigns", "description": "Archived campaigns are not listed.\n\nScope: campaigns:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/list-campaigns" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "status", "value": "draft", "disabled": true, "description": "optional filter" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"name\": \"Autumn renewals\",\n \"status\": \"paused\",\n \"dialer_mode\": \"progressive\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\",\n \"started_at\": \"2026-09-29T11:58:00Z\",\n \"completed_at\": null\n }\n ],\n \"page\": {\n \"next_cursor\": \"c1.example-opaque-cursor\",\n \"has_more\": true\n }\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "status", "value": "draft", "disabled": true, "description": "optional filter" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "status", "value": "draft", "disabled": true, "description": "optional filter" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "95328c48-1a5f-5366-b79f-be67391d7e84", "name": "One campaign", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "x-operation-id": "getCampaign", "description": "One campaign\n\nScope: campaigns:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-campaign" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"name\": \"Autumn renewals\",\n \"status\": \"paused\",\n \"dialer_mode\": \"progressive\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\",\n \"started_at\": \"2026-09-29T11:58:00Z\",\n \"completed_at\": null\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "135dcf90-3d9d-59e1-a413-7d1bfd33c530", "name": "A campaign's progress counts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "progress" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "x-operation-id": "getCampaignProgress", "description": "Four counts, deliberately not one percentage: `attempted_leads` is not `reached_leads`. Reached means positive evidence that a person was on the call.\n\nScope: campaigns:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-campaign-progress" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "progress" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"status\": \"paused\",\n \"total_leads\": 1200,\n \"attempted_leads\": 640,\n \"reached_leads\": 310,\n \"pending_leads\": 560\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "progress" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "progress" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "445125c2-929a-50bf-8785-4cd0b18f5c3c", "name": "Pause a running campaign", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "x-operation-id": "pauseCampaign", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Idempotent: pausing a campaign that is already paused answers 200 with its state and changes nothing. Any state other than running or paused answers 409 `campaign_not_running`. The body must be empty or `{}`.\n\nScope: campaigns:pause · Tier 1 · Idempotency-Key: required · Docs: https://docs.dialerbee.com/reference/pause-campaign" }, "response": [ { "name": "200 example", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"name\": \"Autumn renewals\",\n \"status\": \"paused\",\n \"dialer_mode\": \"progressive\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\",\n \"started_at\": \"2026-09-29T11:58:00Z\",\n \"completed_at\": null\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "409 outcome_unknown", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Outcome unknown", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/outcome-unknown\",\n \"title\": \"Outcome unknown\",\n \"status\": 409,\n \"detail\": \"An earlier request with this Idempotency-Key may or may not have taken effect: the platform did not confirm it.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"outcome_unknown\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "0f8f7cdf-75f3-5edc-a9e7-64908601803e", "name": "[Tier 2] Resume a paused campaign (Tier 2: starts real calls)", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "x-operation-id": "resumeCampaign", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "TIER 2. Starts real calls to real people. Needs the `campaigns:resume` scope AND the account switch `tier2_campaign_resume_enabled` (off unless DialerBee turned it on). Resuming a running campaign answers 200 and changes nothing. The body must be empty or `{}`.\n\nScope: campaigns:resume · Tier 2 · Idempotency-Key: required · TIER 2: needs the scope AND the account switch tier2_campaign_resume_enabled, which is off unless DialerBee turns it on; otherwise 403 tier_not_enabled. · Docs: https://docs.dialerbee.com/reference/resume-campaign" }, "response": [ { "name": "200 example", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"name\": \"Autumn renewals\",\n \"status\": \"running\",\n \"dialer_mode\": \"progressive\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"updated_at\": \"2026-09-29T09:20:00Z\",\n \"started_at\": \"2026-09-29T11:58:00Z\",\n \"completed_at\": null\n}" }, { "name": "403 tier_not_enabled", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Capability not enabled", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/tier-not-enabled\",\n \"title\": \"Capability not enabled\",\n \"status\": 403,\n \"detail\": \"This operation can reach or unlock real people.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"tier_not_enabled\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "409 outcome_unknown", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "variable": [ { "key": "campaign_id", "value": "{{campaign_id}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Outcome unknown", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/outcome-unknown\",\n \"title\": \"Outcome unknown\",\n \"status\": 409,\n \"detail\": \"An earlier request with this Idempotency-Key may or may not have taken effect: the platform did not confirm it.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"outcome_unknown\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] } ] }, { "id": "fd1490d7-fd46-545b-a7df-a1dedf0de38f", "name": "Calls", "description": "Call records, recordings, transcripts and AI summaries (all calls of the account), and click-to-call.", "item": [ { "id": "070cab9f-dc34-5748-914f-8104e5f38f8e", "name": "List the account's calls, newest first", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "direction", "value": "inbound", "disabled": true, "description": "optional filter" } ] }, "x-operation-id": "listCalls", "description": "Tenant-wide: a key sees every call of its account (there is no team scope). Order is `created_at` descending, then `id` descending. The cursor is bound to the account, the API client and the filters. Known limit: a call moved into the account after a page was read may appear behind a cursor that was already returned.\n\nScope: calls:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/list-calls" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "direction", "value": "inbound", "disabled": true, "description": "optional filter" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"call_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"direction\": \"outbound\",\n \"from_number\": \"+12125550100\",\n \"to_number\": \"+12125550123\",\n \"status\": \"completed\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"answered_at\": \"2026-09-29T11:58:07Z\",\n \"ended_at\": \"2026-09-29T11:59:40Z\",\n \"duration_seconds\": 93,\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"disposition\": \"interested\",\n \"hangup_cause\": \"NORMAL_CLEARING\"\n }\n ],\n \"page\": {\n \"next_cursor\": \"c1.example-opaque-cursor\",\n \"has_more\": true\n }\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "direction", "value": "inbound", "disabled": true, "description": "optional filter" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ], "query": [ { "key": "limit", "value": "50", "disabled": false, "description": "1-100, default 50" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "page.next_cursor from the previous page" }, { "key": "campaign_id", "value": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e", "disabled": true, "description": "optional filter" }, { "key": "direction", "value": "inbound", "disabled": true, "description": "optional filter" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "706e1006-a58e-5b1c-9c67-8b278177c984", "name": "[Tier 2] Start a click-to-call", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/calls", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ] }, "x-operation-id": "createCall", "body": { "mode": "raw", "raw": "{\n \"to\": \"+12125550101\",\n \"agent_extension\": \"3901\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Connects one of your agents with a customer. DialerBee first checks that the agent (named by extension or by sign-in email) belongs to the account and is signed in and ready (409 `agent_unavailable` otherwise, and nothing is dialled), then dials the customer from one of the account's own verified caller IDs (or the `caller_id` you name, which must be one of the account's verified numbers: any other number is 422 `dial_refused` with `caller_id_not_registered` and nothing is dialled) and joins the agent the moment the customer answers. Every compliance check runs before the dial, exactly as for a call started in the console: a refusal is 422 `dial_refused` (or `on_dnc` / `blocked_country`, or 402 `insufficient_balance`) and nothing is dialled. `call_id` names the call record when it can be matched at once; otherwise it is null and the call still appears in `GET /v1/calls` and in the call webhooks. Retry only with the same `Idempotency-Key`: a new key places a new call.\n\nThe agent is held for this call before the customer is dialled (shown as ringing, so the dialler, the queues and a second click-to-call do not give the agent another call meanwhile) and released at once when the call is refused. A request for an agent who is already held answers 409 `agent_unavailable`.\n\nTIER 2: needs the scope `calls:originate`, the account switch `tier2_calls_originate_enabled` and a key made by the account's guided sending setup (IP allow-list, daily cap, per-minute cap). The account's own caps, estimated-spend limit, minimum balance and \"stop all sending\" switch apply, and the call is ended after 30 minutes by default (set by the platform) (429 `daily_cap_reached` / `rate_limit_exceeded` / `spend_cap_reached`, 402 `insufficient_balance`, 403 `sending_suspended`); a new self-service account answers 403 `outbound_not_approved` until DialerBee approves its outbound calling.\n\nScope: calls:originate · Tier 2 · Idempotency-Key: required · TIER 2: needs the scope AND the account switch tier2_calls_originate_enabled, which is off unless DialerBee turns it on; otherwise 403 tier_not_enabled. · Docs: https://docs.dialerbee.com/reference/create-call" }, "response": [ { "name": "201 example", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/calls", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+12125550101\",\n \"agent_extension\": \"3901\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"call_id\": \"call_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"status\": \"dialing\",\n \"to\": \"+12125550101\",\n \"agent_extension\": \"3901\",\n \"caller_id\": null,\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"recording\": true,\n \"created_at\": \"2026-09-29T12:00:00Z\"\n}" }, { "name": "403 tier_not_enabled", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/calls", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+12125550101\",\n \"agent_extension\": \"3901\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Capability not enabled", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/tier-not-enabled\",\n \"title\": \"Capability not enabled\",\n \"status\": 403,\n \"detail\": \"This operation can reach or unlock real people.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"tier_not_enabled\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "409 outcome_unknown", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Kept by the collection until the outcome is known." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/calls", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+12125550101\",\n \"agent_extension\": \"3901\",\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"lead_id\": \"lead_0f8fad5b-d9cb-469f-a165-70867728950e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Outcome unknown", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/outcome-unknown\",\n \"title\": \"Outcome unknown\",\n \"status\": 409,\n \"detail\": \"An earlier request with this Idempotency-Key may or may not have taken effect: the platform did not confirm it.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"outcome_unknown\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "14608f00-dc5a-5206-8e51-65d3e91aebd8", "name": "One call", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls/:call_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls", ":call_id" ], "variable": [ { "key": "call_id", "value": "{{call_id}}" } ] }, "x-operation-id": "getCall", "description": "One call\n\nScope: calls:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-call" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls/:call_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls", ":call_id" ], "variable": [ { "key": "call_id", "value": "{{call_id}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"call_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"direction\": \"outbound\",\n \"from_number\": \"+12125550100\",\n \"to_number\": \"+12125550123\",\n \"status\": \"completed\",\n \"created_at\": \"2026-09-29T09:15:00Z\",\n \"answered_at\": \"2026-09-29T11:58:07Z\",\n \"ended_at\": \"2026-09-29T11:59:40Z\",\n \"duration_seconds\": 93,\n \"campaign_id\": \"cmp_0f8fad5b-d9cb-469f-a165-70867728950e\",\n \"disposition\": \"interested\",\n \"hangup_cause\": \"NORMAL_CLEARING\"\n}" }, { "name": "403 insufficient_scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls/:call_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls", ":call_id" ], "variable": [ { "key": "call_id", "value": "{{call_id}}" } ] } }, "status": "Not permitted", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/insufficient-scope\",\n \"title\": \"Not permitted\",\n \"status\": 403,\n \"detail\": \"The API client does not hold the scope this operation requires.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"insufficient_scope\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" }, { "name": "429 rate_limit_exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls/:call_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls", ":call_id" ], "variable": [ { "key": "call_id", "value": "{{call_id}}" } ] } }, "status": "Too many requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "application/problem+json" }, { "key": "Retry-After", "value": "30" } ], "body": "{\n \"type\": \"https://docs.dialerbee.com/errors/rate-limit-exceeded\",\n \"title\": \"Too many requests\",\n \"status\": 429,\n \"detail\": \"Too many requests.\",\n \"instance\": \"urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\",\n \"code\": \"rate_limit_exceeded\",\n \"request_id\": \"req_01K6BZ3M9X4T7Q2V8N5R6P1W0C\"\n}" } ] }, { "id": "21ee43f4-40ad-5bdf-8f80-46a9147b41af", "name": "The call's newest playable recording, streamed", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls/:call_id/recording", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls", ":call_id", "recording" ], "variable": [ { "key": "call_id", "value": "{{call_id}}" } ] }, "x-operation-id": "getCallRecording", "description": "The audio is streamed through the API; no storage URL is ever issued. One `bytes=` range is supported and answered 206. 410 `recording_deleted` when retention removed the audio; 403 `recording_on_legal_hold`; 404 `not_found` when the call has no playable recording.\n\nScope: recordings:read · Tier 1 · Idempotency-Key: not used · Docs: https://docs.dialerbee.com/reference/get-call-recording" }, "response": [ { "name": "200 example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calls/:call_id/recording", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calls", ":call_id", "recording" ], "variable": [ { "key": "call_id", "value": "{{call_id}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "X-Request-ID", "value": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C" }, { "key": "Cache-Control", "value": "no-store" }, { "key": "Content-Type", "value": "audio/mpeg" } ], "body": "