{ "item": [ { "name": "Quickstart", "description": "The guide's Quickstart (https://developers.callview.ai/quickstart/). Set key_id and key_secret to a TEST key and request_bin_url to your request bin, then run 1 to 5 in order.", "item": [ { "name": "1. Send events to your request bin", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "pm.test('created', () => pm.response.to.have.status(201));", "if (body.data) { pm.collectionVariables.set('webhook_endpoint_id', body.data.id); pm.collectionVariables.set('webhook_secret', body.data.secret); }" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/webhook_endpoints", "host": [ "{{baseUrl}}" ], "path": [ "webhook_endpoints" ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"url\": \"{{request_bin_url}}\",\n \"events\": [\n \"call.completed\"\n ]\n}" } } }, { "name": "2. Find your campaign", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "pm.test('ok', () => pm.response.to.have.status(200));", "if (body.data && body.data.length) pm.collectionVariables.set('campaign_id', body.data[0].id);" ] } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ] } } }, { "name": "3. Add a lead with the magic number +15550100001", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "pm.test('accepted', () => pm.expect([200, 201]).to.include(pm.response.code));", "if (body.data) pm.collectionVariables.set('lead_id', body.data.id);" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"campaign_id\": \"{{campaign_id}}\",\n \"external_id\": \"postman-{{$timestamp}}\",\n \"phone\": \"+15550100001\",\n \"name\": \"Test Lead\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}" } } }, { "name": "4. Where is the lead?", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/leads/{{lead_id}}", "host": [ "{{baseUrl}}" ], "path": [ "leads", "{{lead_id}}" ] } } }, { "name": "5. Catch up: call.completed events", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/events?type=call.completed", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "type", "value": "call.completed" } ] } } } ] }, { "id": "94f03d82-7565-4df5-b68b-b6f74fe07696", "name": "Leads", "description": { "content": "Add leads to a campaign (speed to lead), look them up, change them, opt them out.", "type": "text/plain" }, "item": [ { "id": "17216d24-d1bd-4ddf-9469-02e87e64f328", "name": "Add a lead (older address)", "request": { "name": "Add a lead (older address)", "description": { "content": "The same checks, queue and reply as POST /leads, with the campaign in the path. customFields is still accepted (it is merged into fields). Use POST /leads for new work.", "type": "text/plain" }, "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{campaign_id}}", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"fields\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customFields\": {\n \"key_0\": \"\"\n },\n \"consent\": {\n \"source\": \"\",\n \"agreed_at\": \"\",\n \"text\": \"\",\n \"url\": \"\",\n \"ip\": \"\"\n },\n \"call_now\": \"\",\n \"dry_run\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb0aad30-9166-4618-b36e-207278ccec22", "name": "A dry run, or a re-queued lead", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e11c8fd4-e210-4804-332f-ed4715881ac1\",\n \"external_id\": \"string\",\n \"status\": \"scheduled\",\n \"call_now\": true,\n \"place_in_line\": 1140,\n \"estimated_wait_seconds\": 1066,\n \"scheduled_for\": \"1950-11-29T15:49:27.750Z\",\n \"scheduled_reason\": \"null\",\n \"held_reason\": \"campaign_not_started\",\n \"dry_run\": true,\n \"livemode\": true,\n \"requeued\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a584e2-021e-4dbc-84cb-01758e7ce6ea", "name": "Accepted (see POST /leads)", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e11c8fd4-e210-4804-332f-ed4715881ac1\",\n \"external_id\": \"string\",\n \"status\": \"scheduled\",\n \"call_now\": true,\n \"place_in_line\": 1140,\n \"estimated_wait_seconds\": 1066,\n \"scheduled_for\": \"1950-11-29T15:49:27.750Z\",\n \"scheduled_reason\": \"null\",\n \"held_reason\": \"campaign_not_started\",\n \"dry_run\": true,\n \"livemode\": true,\n \"requeued\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e4fb8c-16ce-4d22-88e9-2501176bc402", "name": "invalid_request or invalid_phone", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0264c8c-b210-4959-8af4-c99993e8d17a", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91e244e8-c36b-4712-8666-0d3ff64df9f7", "name": "permission_denied", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "104b9568-b35b-4ed0-b1a0-9ec70a89ebd0", "name": "not_found (no such campaign)", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52b69072-f7de-4082-af6a-1dcd7c85c25a", "name": "duplicate_lead, campaign_closed, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"duplicate_lead\",\n \"message\": \"A lead with this phone number (or external_id) already exists in this campaign. `lead_id` names it.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6355aa0c-14ae-401e-a183-537184c40db1", "name": "on_dnc_list, number_retired, consent_required or number_not_allowed", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"on_dnc_list\",\n \"message\": \"The number is on the organization's Do Not Call list.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db285563-7ee5-4695-beb7-82c1a45b6bab", "name": "queue_full, lead_rate_limited, test_flows_busy, rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"queue_full\",\n \"message\": \"The campaign already has 5,000 API leads waiting to be called. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b27790a3-4bb2-4de3-904e-5a22e6b1439b", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8516649-b93f-4abf-a7d6-70c5219e0187", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"call_now\": true,\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e84dfc7-a926-4e50-bb78-7daea305dfc7", "name": "List a campaign's leads (older list)", "request": { "name": "List a campaign's leads (older list)", "description": { "content": "A campaign's leads, page by page (cursor = the next_cursor you were\ngiven). A live key gets the older lead shape here; GET /leads with\ncampaign_id gives the lead object and is the one to use for new work.\nNeeds leads:read.\n", "type": "text/plain" }, "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "search", "value": "", "description": "Part of a name, phone or email." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{campaign_id}}", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "7039ec8a-57a6-44b2-8788-65356000306e", "name": "A page of leads", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"9ca8a979-d150-32c9-adff-605fe5544973\",\n \"livemode\": true,\n \"key_0\": \"string\"\n },\n {\n \"id\": \"9869d10c-b9e3-d68e-512d-113ddf7513d1\",\n \"livemode\": true,\n \"key_0\": 3860,\n \"key_1\": 3382.4127759395474\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd73906-123c-4c2a-99bf-046982ee8087", "name": "invalid_request", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff08184-28b6-40be-86fd-84f45a268b76", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70857ea2-325d-41b7-9343-87ee921b70a9", "name": "permission_denied (leads:read, or the campaign is outside the key's)", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe2e76f-ffb6-4883-80a7-ff7f6b244154", "name": "not_found (no such campaign)", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f2eca23-82e7-4436-afcb-a117d7e1733a", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb75a6eb-ecdd-4968-b910-c65f68d4d21b", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fd40c01-0cd4-4505-9a4f-71f6d7a98664", "name": "Add up to 60 leads (older address)", "request": { "name": "Add up to 60 leads (older address)", "description": { "content": "The same as POST /leads/batch, with the campaign in the path.", "type": "text/plain" }, "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{campaign_id}}", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"phone\": \"\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"fields\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"customFields\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"consent\": {\n \"source\": \"\",\n \"agreed_at\": \"\",\n \"text\": \"\",\n \"url\": \"\",\n \"ip\": \"\"\n },\n \"call_now\": \"\"\n }\n ],\n \"dry_run\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5252ed68-bbec-40fc-8a56-0b646861b1f8", "name": "A result per lead (see POST /leads/batch)", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"succeeded\": 9888,\n \"failed\": 1453,\n \"dry_run\": false,\n \"results\": [\n {\n \"index\": {\n \"value\": \"\"\n },\n \"ok\": {\n \"value\": \"\"\n },\n \"lead\": {\n \"value\": \"\"\n }\n },\n {\n \"index\": {\n \"value\": \"\"\n },\n \"ok\": {\n \"value\": \"\"\n },\n \"lead\": {\n \"value\": \"\"\n }\n }\n ],\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c11df2-b1d0-43b2-b304-67ca5b74b471", "name": "invalid_request", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92ae9ec4-db09-4b1a-8ad6-155a21458e5b", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7713699-a011-4005-9ca8-883636f5baa9", "name": "permission_denied", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75678dd-0513-44fd-b881-cc01073e4bc6", "name": "not_found (no such campaign)", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c77f989-1ea4-4cbb-9703-715eedd3af31", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "278d9212-81d7-4834-adcc-ede7c7ceabca", "name": "lead_rate_limited, rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"lead_rate_limited\",\n \"message\": \"Too many new leads a minute on this key. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1572b5df-c5f9-4d8b-bb11-90607f6e8665", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2de8e463-5d18-48aa-9ee5-84e024236901", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "campaigns", ":campaignId", "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d0cb926-b1c9-43ba-93e5-4e61f54994b8", "name": "Add a lead (speed to lead)", "request": { "name": "Add a lead (speed to lead)", "description": { "content": "Checks the lead first: a valid +1 number, your Do Not Call list, the\ncampaign's retired numbers, duplicates (by external_id or phone),\nconsent if the campaign asks for it, number rules (no premium or\ninternational numbers) and the 5,000 waiting-lead limit. If it passes,\nthe lead goes straight into the campaign's dial queue.\n\nA call_now lead is dialed before the campaign's other leads, oldest\nfirst, as the campaign's lines free up. Outside the lead's calling\nhours it is scheduled for the next window. A paused or not-started\ncampaign holds the lead and dials it when the campaign runs, and so\ndoes a reached spend cap. A refused lead isn't saved. place_in_line\nand estimated_wait_seconds are estimates.\n\nWith dry_run true every check runs and the lead isn't saved. Needs\nleads:write.\n", "type": "text/plain" }, "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"\",\n \"phone\": \"\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"fields\": {\n \"key_0\": \"\"\n },\n \"consent\": {\n \"source\": \"\",\n \"agreed_at\": \"\",\n \"text\": \"\",\n \"url\": \"\",\n \"ip\": \"\"\n },\n \"call_now\": \"\",\n \"dry_run\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "785c19c4-35c7-49aa-87aa-dc08d08b7120", "name": "A dry run (not saved), or a lead that already existed and was put back in the queue (requeued true)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e11c8fd4-e210-4804-332f-ed4715881ac1\",\n \"external_id\": \"string\",\n \"status\": \"scheduled\",\n \"call_now\": true,\n \"place_in_line\": 1140,\n \"estimated_wait_seconds\": 1066,\n \"scheduled_for\": \"1950-11-29T15:49:27.750Z\",\n \"scheduled_reason\": \"null\",\n \"held_reason\": \"campaign_not_started\",\n \"dry_run\": true,\n \"livemode\": true,\n \"requeued\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3df985cc-a70a-4a75-968f-463ef9ca32f7", "name": "Accepted. status says what happens next.", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e11c8fd4-e210-4804-332f-ed4715881ac1\",\n \"external_id\": \"string\",\n \"status\": \"scheduled\",\n \"call_now\": true,\n \"place_in_line\": 1140,\n \"estimated_wait_seconds\": 1066,\n \"scheduled_for\": \"1950-11-29T15:49:27.750Z\",\n \"scheduled_reason\": \"null\",\n \"held_reason\": \"campaign_not_started\",\n \"dry_run\": true,\n \"livemode\": true,\n \"requeued\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86131058-672e-41ee-a263-ed349c8964a8", "name": "invalid_request or invalid_phone", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4198e5b1-7195-47a7-a336-e188b497a7fa", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd266cf-5398-436e-9f0e-f9cd765da878", "name": "permission_denied (leads:write, or the campaign is outside the key's)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43261472-1ca4-4e14-91f3-f8e049d2230b", "name": "not_found (no such campaign)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ce7e8a8-997f-4671-9439-b5fb38baa1f8", "name": "duplicate_lead, campaign_closed, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"duplicate_lead\",\n \"message\": \"A lead with this phone number (or external_id) already exists in this campaign. `lead_id` names it.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d5e4cf-62b8-4b7b-affe-53876b42f34b", "name": "on_dnc_list, number_retired, consent_required or number_not_allowed (premium or international; reason says which)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"on_dnc_list\",\n \"message\": \"The number is on the organization's Do Not Call list.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6893bc9d-9b1c-40c0-bc5b-dbeb6cca6274", "name": "queue_full, lead_rate_limited, call_limit_reached, test_flows_busy, rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"queue_full\",\n \"message\": \"The campaign already has 5,000 API leads waiting to be called. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8709b4-21d4-4b24-bd4f-d3e432edf751", "name": "internal_error", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d643137-09c7-4da7-b9e2-09d33ba2eea1", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"external_id\": \"crm-10442\",\n \"phone\": \"+15550100001\",\n \"name\": \"Dana Smith\",\n \"email\": \"dana@example.com\",\n \"fields\": {\n \"roof_age\": \"12\"\n },\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n },\n \"call_now\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e64ecb04-90f2-4299-9840-b5045fb4a59b", "name": "Find a lead by external_id, or list leads", "request": { "name": "Find a lead by external_id, or list leads", "description": { "content": "With external_id: the one lead carrying your ID, as `{ data: lead }`.\nexternal_id is unique per campaign, not per organization: a match in\ntwo of the key's campaigns is 409 ambiguous_external_id with\n`candidates` ([{ id, campaign_id }]); add campaign_id to pick one.\n\nWithout it: the key's leads, newest first, keyset-paged\n(`starting_after` = the last lead's id), as\n`{ data: [lead], meta: { next_cursor, has_more } }`. With a status\nfilter a page can hold fewer than `limit` leads while has_more is\ntrue; keep paging with next_cursor. place_in_line is only given on\na single-lead read.\n\nstatus is one of: new, queued, scheduled, held, dialing, on_call,\ncallback_scheduled, done, out_of_queue.\n", "type": "text/plain" }, "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "external_id", "value": "" }, { "disabled": true, "key": "campaign_id", "value": "" }, { "disabled": true, "key": "status", "value": "" }, { "disabled": true, "key": "created[gte]", "value": "", "description": "Created at or after (ISO 8601 or unix seconds)." }, { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "bf8b552b-3dd4-4986-bc5e-51e2e7a2fea9", "name": "With external_id, the one lead. Without it, a page of leads.", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"dfe15c7c-cec3-7ae8-158b-c52a017f962d\",\n \"external_id\": \"string\",\n \"campaign_id\": \"aff34a4d-79e6-da59-c12f-b9a3aabe2677\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"fields\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"consent\": {\n \"value\": \"\"\n },\n \"lead_source\": \"string\",\n \"owner\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"created\": \"2009-12-06T17:59:11.995Z\",\n \"updated\": \"2021-02-04T01:48:24.318Z\",\n \"status\": \"held\",\n \"call_now\": true,\n \"place_in_line\": 6828,\n \"estimated_wait_seconds\": 7605,\n \"scheduled_for\": \"1968-01-14T19:15:11.263Z\",\n \"scheduled_reason\": \"outside_calling_hours\",\n \"held_reason\": \"null\",\n \"callback_at\": \"1992-01-13T11:10:11.834Z\",\n \"late\": true,\n \"attempts\": 1220,\n \"last_outcome\": \"screened\",\n \"last_outcome_label\": \"string\",\n \"next_dial_at\": \"2015-01-26T07:56:26.038Z\",\n \"calls\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de2d301d-2a99-4052-a9c5-84d6d4427431", "name": "invalid_request (a bad filter, or a starting_after that isn't one of this key's leads)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9d6b2bd-a9aa-40c2-831d-b1fcccc5c439", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c08d462-0adb-415c-9b77-9707bcc2fa88", "name": "permission_denied (leads:read, or a campaign_id outside the key's)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3326745-20ca-4f0a-9f18-99d21ce16f64", "name": "not_found (no lead with this external_id in the key's campaigns)", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08f6a6d9-46e8-4861-9ab1-fdf3cf1d0304", "name": "ambiguous_external_id, with candidates", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"ambiguous_external_id\",\n \"message\": \"This external_id matches leads in more than one campaign. `candidates` lists them; add campaign_id (Story 34-7).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e8790c0-988a-4cd6-aae2-cc3e1075288b", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "722a3cda-cdc4-4974-8512-e22aa78382f6", "name": "internal_error", "originalRequest": { "url": { "path": [ "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "external_id", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "status", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "258bb475-d6b7-420c-ac0f-3023d7b391b4", "name": "Get a lead - where it is and its calls", "request": { "name": "Get a lead - where it is and its calls", "description": { "content": "The lead object: id, external_id, campaign_id, livemode, name, phone,\nemail, address, fields, consent, lead_source, owner ({ id, name } of\nthe SDR its latest call was dialed for, or null), created, updated,\nstatus, call_now, place_in_line and estimated_wait_seconds (while\nqueued; estimates), scheduled_for, scheduled_reason, held_reason,\ncallback_at, late, attempts, last_outcome (a stable word, the\nsame as the call object's outcome) and last_outcome_label (your\norganization's name for it), next_dial_at, and calls (the last 10,\nnewest first: { id, started, outcome, outcome_label, duration_seconds }).\n\nstatus: new (not yet queued), queued (due now), scheduled (waits\nfor scheduled_for: calling hours, a cooldown, a retry), held\n(held_reason: campaign_paused, campaign_not_started,\nspend_cap_reached), dialing, on_call, callback_scheduled\n(callback_at), done (finished, not coming back), out_of_queue\n(taken out, opted out or on the Do Not Call list).\n\nA lead in a campaign outside the key's, in another organization, or\nremoved is 404 not_found.\n", "type": "text/plain" }, "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{lead_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "5d9661e4-58b9-4893-8b61-b803ca3ab36e", "name": "The lead", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"9e4acd73-1854-45a9-666b-4e20e403aeed\",\n \"external_id\": \"string\",\n \"campaign_id\": \"c48567f2-70ae-2ae4-98dc-8d015d9ca908\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"consent\": {\n \"source\": {\n \"value\": \"\"\n },\n \"agreed_at\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"ip\": {\n \"value\": \"\"\n }\n },\n \"lead_source\": \"string\",\n \"owner\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"created\": \"1973-05-01T23:28:56.926Z\",\n \"updated\": \"1951-08-23T01:28:46.319Z\",\n \"status\": \"dialing\",\n \"call_now\": false,\n \"place_in_line\": 6136,\n \"estimated_wait_seconds\": 5249,\n \"scheduled_for\": \"1966-05-04T08:40:59.055Z\",\n \"scheduled_reason\": \"recent_contact_cooldown\",\n \"held_reason\": \"campaign_paused\",\n \"callback_at\": \"2026-08-23T18:40:58.762Z\",\n \"late\": false,\n \"attempts\": 8303,\n \"last_outcome\": \"failed\",\n \"last_outcome_label\": \"string\",\n \"next_dial_at\": \"1991-05-16T14:50:49.227Z\",\n \"calls\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"started\": {\n \"value\": \"\"\n },\n \"outcome\": {\n \"value\": \"\"\n },\n \"outcome_label\": {\n \"value\": \"\"\n },\n \"duration_seconds\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"started\": {\n \"value\": \"\"\n },\n \"outcome\": {\n \"value\": \"\"\n },\n \"outcome_label\": {\n \"value\": \"\"\n },\n \"duration_seconds\": {\n \"value\": \"\"\n }\n }\n ],\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a78823f-94ac-4677-9c5e-060be6cc7dc8", "name": "invalid_request", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c7cec31-830a-426e-bfd8-fe54c9d7b28b", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69155f00-aae5-4d52-93bf-578d465c127a", "name": "permission_denied (leads:read)", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f1dc6a0-4881-4f5c-9954-5c88e972ebae", "name": "not_found", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c08e70-cc59-4059-8e18-3324aab2aa2f", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cae9c4d1-b974-43f8-beb0-6938ddd6a7c0", "name": "internal_error", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "952e90d0-7188-4cb1-b9ac-e4b2d5bfcba8", "name": "Update a lead", "request": { "name": "Update a lead", "description": { "content": "name, email, address (null or \"\" clears one), fields (merged: a key\nsent as \"\" is removed; other keys are kept), consent (replaced),\nexternal_id (only while the lead has none), call_now: false (drops\nthe speed-to-lead priority). The phone can't be changed\n(phone_cannot_change): add a new lead instead. Answers the updated\nlead. Idempotency-Key is honoured.\n", "type": "text/plain" }, "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{lead_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"fields\": {\n \"key_0\": \"\"\n },\n \"consent\": {\n \"source\": \"\",\n \"agreed_at\": \"\",\n \"text\": \"\",\n \"url\": \"\",\n \"ip\": \"\"\n },\n \"external_id\": \"\",\n \"call_now\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8a8155f9-2985-4aa5-8016-037f24d8bd67", "name": "The updated lead", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"9e4acd73-1854-45a9-666b-4e20e403aeed\",\n \"external_id\": \"string\",\n \"campaign_id\": \"c48567f2-70ae-2ae4-98dc-8d015d9ca908\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"consent\": {\n \"source\": {\n \"value\": \"\"\n },\n \"agreed_at\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"ip\": {\n \"value\": \"\"\n }\n },\n \"lead_source\": \"string\",\n \"owner\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"created\": \"1973-05-01T23:28:56.926Z\",\n \"updated\": \"1951-08-23T01:28:46.319Z\",\n \"status\": \"dialing\",\n \"call_now\": false,\n \"place_in_line\": 6136,\n \"estimated_wait_seconds\": 5249,\n \"scheduled_for\": \"1966-05-04T08:40:59.055Z\",\n \"scheduled_reason\": \"recent_contact_cooldown\",\n \"held_reason\": \"campaign_paused\",\n \"callback_at\": \"2026-08-23T18:40:58.762Z\",\n \"late\": false,\n \"attempts\": 8303,\n \"last_outcome\": \"failed\",\n \"last_outcome_label\": \"string\",\n \"next_dial_at\": \"1991-05-16T14:50:49.227Z\",\n \"calls\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"started\": {\n \"value\": \"\"\n },\n \"outcome\": {\n \"value\": \"\"\n },\n \"outcome_label\": {\n \"value\": \"\"\n },\n \"duration_seconds\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"started\": {\n \"value\": \"\"\n },\n \"outcome\": {\n \"value\": \"\"\n },\n \"outcome_label\": {\n \"value\": \"\"\n },\n \"duration_seconds\": {\n \"value\": \"\"\n }\n }\n ],\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7dab81e-34e8-456e-a1e0-9fb6f0202c7b", "name": "invalid_request (nothing to update, call_now true, or external_id already set to another value - reason external_id_already_set)", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfad7971-4418-4618-b3da-e5255696e342", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bb0cb1f-91ce-45b8-aa26-a04b9c39dc88", "name": "permission_denied (leads:write)", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a22b96b-26d3-4d09-83aa-c6afc5ee4a1a", "name": "not_found", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69ef31ce-9ced-4b7c-8f05-578c5c73e213", "name": "duplicate_lead, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"duplicate_lead\",\n \"message\": \"A lead with this phone number (or external_id) already exists in this campaign. `lead_id` names it.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bca198cb-4d29-430b-bf52-a393184b1cdd", "name": "phone_cannot_change", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"phone_cannot_change\",\n \"message\": \"A lead's phone number can't be changed (Story 34-7). Add a new lead with the new number.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b280078-3c7e-48e5-a754-f742f4247024", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b2d7f2c-b020-4b20-bb83-bbde32bc9822", "name": "internal_error", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84b9dcf7-987c-468d-9d2b-aa626edccf03", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Dana Smith-Lee\",\n \"fields\": {\n \"roof_age\": \"13\",\n \"old_field\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4c32482-721b-4a63-acab-7b15d62cefe0", "name": "Opt a lead out - stop calling, add to Do Not Call", "request": { "name": "Opt a lead out - stop calling, add to Do Not Call", "description": { "content": "The number goes on the organization's Do Not Call list (source\n\"API\"), so no campaign of the organization dials it again; the lead\nleaves the queue with the DNC outcome and its open callbacks are\nclosed. A call in progress is NOT cut: the reply says\ncall_in_progress true, and nothing dials the number again.\nIdempotent: a second opt_out answers the same, with no second Do\nNot Call entry. Answers the updated lead plus call_in_progress.\n", "type": "text/plain" }, "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{lead_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "525e49f6-5e4e-47ab-8e37-54967f7c9e59", "name": "The lead, plus call_in_progress", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"address\": \"string\",\n \"attempts\": 9307,\n \"call_in_progress\": false,\n \"call_now\": false,\n \"callback_at\": \"2005-02-01T06:26:35.561Z\",\n \"calls\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaign_id\": \"01bee0ea-b19a-b09e-fbbf-1e461f236391\",\n \"consent\": {\n \"value\": \"\"\n },\n \"created\": \"1967-01-18T03:01:13.424Z\",\n \"email\": \"string\",\n \"estimated_wait_seconds\": 896,\n \"external_id\": \"string\",\n \"fields\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"held_reason\": \"campaign_not_started\",\n \"id\": \"8e304b07-bfe2-1278-f57a-30d6f4e5cd52\",\n \"last_outcome\": \"undetermined\",\n \"last_outcome_label\": \"string\",\n \"late\": false,\n \"lead_source\": \"string\",\n \"name\": \"string\",\n \"next_dial_at\": \"1956-08-23T05:12:36.172Z\",\n \"owner\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"phone\": \"string\",\n \"place_in_line\": 9427,\n \"scheduled_for\": \"1967-04-30T08:48:15.366Z\",\n \"scheduled_reason\": \"retry_after_outcome\",\n \"status\": \"queued\",\n \"updated\": \"2025-12-27T05:15:38.986Z\",\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f72ba73-4e0d-4181-8554-eaa734e95a40", "name": "invalid_request", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f301b96-87d0-4a80-9e9f-e3074bf64a3f", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "833933b4-235d-4053-8970-2f82d80617c5", "name": "permission_denied (leads:write)", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2290c594-f3cc-451b-a71a-80e20f618e5c", "name": "not_found", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2733ac6-9607-4443-a9d0-4fc1adb6cfac", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e36aa17c-10e3-4a35-9c71-0c6179af9a65", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ffc7415-d443-403d-bd66-1012d7a32bcb", "name": "internal_error", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d71f2d66-c44e-4f0e-a52f-6031ca4b5e98", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "leads", ":id", "opt_out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Asked to stop on our web chat\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "531e3fb8-b2a0-4f5e-a217-7cab13403cb0", "name": "Add up to 60 leads", "request": { "name": "Add up to 60 leads", "description": { "content": "Each lead gets the same checks as POST /leads and its own result, in\nthe order you sent them. A lead that fails doesn't stop the others.\ncampaign_id may be on each lead or once for the batch. Each lead\ncounts toward the key's new leads a minute. Needs leads:write.\n", "type": "text/plain" }, "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"phone\": \"\",\n \"campaign_id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"fields\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"consent\": {\n \"source\": \"\",\n \"agreed_at\": \"\",\n \"text\": \"\",\n \"url\": \"\",\n \"ip\": \"\"\n },\n \"call_now\": \"\"\n }\n ],\n \"campaign_id\": \"\",\n \"dry_run\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "79ea0605-53ec-4f24-83d8-ebeb86bd0f1f", "name": "A result per lead: { index, ok: true, lead } or { index, ok: false, error: { code, message, param, lead_id } }", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"succeeded\": 9888,\n \"failed\": 1453,\n \"dry_run\": false,\n \"results\": [\n {\n \"index\": {\n \"value\": \"\"\n },\n \"ok\": {\n \"value\": \"\"\n },\n \"lead\": {\n \"value\": \"\"\n }\n },\n {\n \"index\": {\n \"value\": \"\"\n },\n \"ok\": {\n \"value\": \"\"\n },\n \"lead\": {\n \"value\": \"\"\n }\n }\n ],\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d366a8e2-4b3d-4a87-a1ea-a6aae538e8c6", "name": "invalid_request (more than 60 leads, or a malformed lead)", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d791570-bbb8-442a-a7f9-67b76f556dc9", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c689c7c-31f9-4cc0-b020-b69862c622dc", "name": "permission_denied (leads:write, or the batch's campaign_id is outside the key's)", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eafca67e-9673-4ca6-821c-a873a3717964", "name": "not_found (the batch's campaign_id)", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe4c6295-9881-4014-9f11-e3ce0b9012c6", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b26ea4-0e7a-4654-8791-702b13e352dd", "name": "lead_rate_limited, rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"lead_rate_limited\",\n \"message\": \"Too many new leads a minute on this key. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501cce1a-c468-4a9e-a0e3-99bfea3b66cc", "name": "internal_error", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "655b1bd8-04b5-4665-aedd-de47feadbbd8", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "leads", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": \"7c1f2b9e-4a3d-4e8f-9b21-5d6a7e8f9a01\",\n \"leads\": [\n {\n \"external_id\": \"crm-10443\",\n \"phone\": \"+15550100002\",\n \"name\": \"Lee Park\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n },\n {\n \"external_id\": \"crm-10444\",\n \"phone\": \"+15550100003\",\n \"name\": \"Sam Ortiz\",\n \"consent\": {\n \"source\": \"web_form\",\n \"agreed_at\": \"2026-10-06T16:58:02Z\",\n \"url\": \"https://example.com/quote\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "21c35355-32ed-4bee-92fc-9348ad5600e7", "name": "Calls", "description": { "content": "Calls, their outcomes, recordings and transcripts. Call a lead now.", "type": "text/plain" }, "item": [ { "id": "b311f990-4be5-4b5d-9dc0-5e25e6af13e8", "name": "List calls", "request": { "name": "List calls", "description": { "content": "Newest first. Cursor-paged: pass the last call's id as starting_after\nfor the next page. Needs calls:read; a key limited to some campaigns\nsees only their calls.\n\nDeprecated for one release: offset and status (and a limit over\n100) still answer the old list shape, with a Deprecation header.\n", "type": "text/plain" }, "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "starting_after", "value": "" }, { "disabled": true, "key": "campaign_id", "value": "" }, { "disabled": true, "key": "lead_id", "value": "" }, { "disabled": true, "key": "external_id", "value": "", "description": "The lead's ID in your system." }, { "disabled": true, "key": "outcome", "value": "" }, { "disabled": true, "key": "created[gte]", "value": "" }, { "disabled": true, "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "61e4fd76-e268-41c5-8a99-16bcd7519013", "name": "A page of calls, newest first", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"b8fa8778-1db5-e671-1570-15578231d9e4\",\n \"object\": \"call\",\n \"livemode\": true,\n \"lead\": {\n \"id\": \"8f932968-d389-5698-010b-ea26b9e16445\",\n \"external_id\": \"string\",\n \"name\": \"string\",\n \"phone\": \"string\"\n },\n \"campaign_id\": \"ce72c658-46e0-9a7e-5fe7-bb8a37be645a\",\n \"direction\": \"inbound\",\n \"status\": \"ended\",\n \"outcome\": \"undetermined\",\n \"outcome_label\": \"string\",\n \"note\": \"string\",\n \"duration_seconds\": 4032,\n \"started\": \"2016-07-16T07:36:09.673Z\",\n \"answered\": \"2010-08-17T12:21:26.651Z\",\n \"ended\": \"1972-03-30T10:39:12.025Z\",\n \"updated\": \"1967-04-13T18:50:33.120Z\",\n \"handled_by\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"sdr\"\n },\n \"owner\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"tth_seconds\": 6819.058280654982,\n \"callback_at\": \"1981-04-22T18:58:10.171Z\",\n \"recording_available\": true,\n \"transcript_available\": true,\n \"started_by\": {\n \"type\": \"dialer\",\n \"api_key_id\": \"string\"\n }\n },\n {\n \"id\": \"48c61463-2543-a925-c411-9c3526fb2e20\",\n \"object\": \"call\",\n \"livemode\": false,\n \"lead\": {\n \"id\": \"9a91d152-bf02-a981-640a-cb88396b38db\",\n \"external_id\": \"string\",\n \"name\": \"string\",\n \"phone\": \"string\"\n },\n \"campaign_id\": \"1492aadb-eaa8-0e83-cf72-443f38a3489c\",\n \"direction\": \"outbound\",\n \"status\": \"ringing\",\n \"outcome\": \"wrong_number\",\n \"outcome_label\": \"string\",\n \"note\": \"string\",\n \"duration_seconds\": 8055,\n \"started\": \"1951-12-20T15:39:47.270Z\",\n \"answered\": \"1958-02-28T01:29:45.108Z\",\n \"ended\": \"1998-07-13T08:18:33.140Z\",\n \"updated\": \"2012-09-20T19:58:48.070Z\",\n \"handled_by\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"ai\"\n },\n \"owner\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"tth_seconds\": 2762.4317307240344,\n \"callback_at\": \"2022-06-16T14:13:47.794Z\",\n \"recording_available\": true,\n \"transcript_available\": true,\n \"started_by\": {\n \"type\": \"dialer\",\n \"api_key_id\": \"string\"\n }\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ac713fb-58ae-42f6-b1a7-a0df96e2314a", "name": "invalid_request (a bad filter, or a starting_after that isn't one of your calls)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38141a52-5579-407b-9357-ae43bdeb5098", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82baba54-b41e-45dd-9a96-66902b17602f", "name": "permission_denied (calls:read, or campaign_id outside the key's campaigns)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc2475a-7aa6-466b-8873-a81ccce8f25d", "name": "not_found (no such campaign_id)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91705d06-4c39-4a59-946d-9785c8dffabe", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3269492-6e70-4b65-88b9-08b4378af515", "name": "internal_error", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "lead_id", "value": "" }, { "key": "external_id", "value": "" }, { "key": "outcome", "value": "" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d06b8830-6bb6-4c4f-ad80-193e41d63385", "name": "Call this lead now", "request": { "name": "Call this lead now", "description": { "content": "Puts an existing lead at the front of its campaign's dial queue\n(the same queue as POST /leads with call_now): it is dialed next,\nnever above the campaign's lines. The same checks and the same reply\nas POST /leads: dialing, queued (with the place in line), scheduled\n(outside the lead's calling hours) or held (a paused campaign).\nDo Not Call, calling hours and the other dialing rules always apply.\nAt most 3 API-started calls per lead in 24 hours. Needs calls:write.\n", "type": "text/plain" }, "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"\",\n \"external_id\": \"\",\n \"campaign_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5a53fd40-b5cc-49ea-9f2b-7e8848380fc4", "name": "Accepted. status says what happens next.", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"lead_id\": \"1c1af043-d6d3-8585-91dc-d9b3e539a869\",\n \"external_id\": \"string\",\n \"campaign_id\": \"6e1d02c5-ea05-3df2-ff4f-d579ab9d0be4\",\n \"status\": \"scheduled\",\n \"place_in_line\": 7983,\n \"estimated_wait_seconds\": 8866,\n \"scheduled_for\": \"1971-12-05T13:24:15.399Z\",\n \"scheduled_reason\": \"outside_calling_hours\",\n \"held_reason\": \"spend_cap_reached\",\n \"calls_left_today\": 9801,\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a664c2d-8700-4807-b177-e9fa74689e2b", "name": "invalid_request (neither or both of lead_id and external_id; an external_id in more than one campaign without campaign_id)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "864c6e21-69b9-4d52-9c53-f2131b6130af", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb461ed4-8848-4f81-8c25-aecd9452e37b", "name": "permission_denied (calls:write, or campaign_id outside the key's campaigns)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a74c795-1825-4c8e-a7be-2f8dca04809d", "name": "not_found (no such lead for this key)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b902d4b-dc88-496f-a3a1-1bf7de76ba11", "name": "lead_busy, lead_taken_out_of_queue, campaign_closed, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"lead_busy\",\n \"message\": \"The lead is being dialed or is on a call now.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9362fc42-2d23-48ae-b1b7-7898c0f161e6", "name": "on_dnc_list, number_retired, or number_not_allowed (a premium or international number; reason premium / international)", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"on_dnc_list\",\n \"message\": \"The number is on the organization's Do Not Call list.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75e81e04-e104-47aa-98c9-893995cc1dee", "name": "call_limit_reached, test_flows_busy, rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"call_limit_reached\",\n \"message\": \"The lead has had 3 calls started by the API in the last 24 hours. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca9c53fa-57d2-48d0-a7e9-120cebc8b4e6", "name": "internal_error", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d782154-a43a-4484-a224-b6308a81234f", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"crm-10442\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df0b60bf-c39a-4306-a644-871da55644aa", "name": "Get a call", "request": { "name": "Get a call", "description": { "content": "Needs calls:read. A call in another organization, or in a campaign outside the key's, is 404.", "type": "text/plain" }, "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "9be54e50-99fe-44b2-9b74-51db4eeb8a90", "name": "The call", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"86079793-0eff-0abe-b720-b4fcb6d02294\",\n \"object\": \"call\",\n \"livemode\": false,\n \"lead\": {\n \"id\": \"edc8536b-eabc-2063-96c7-7f2e568b8545\",\n \"external_id\": \"string\",\n \"name\": \"string\",\n \"phone\": \"string\"\n },\n \"campaign_id\": \"3e770dd1-f508-b03a-7b08-36f7238564d1\",\n \"direction\": \"inbound\",\n \"status\": \"ringing\",\n \"outcome\": \"callback\",\n \"outcome_label\": \"string\",\n \"note\": \"string\",\n \"duration_seconds\": 848,\n \"started\": \"2007-04-09T01:21:52.540Z\",\n \"answered\": \"1974-09-07T12:33:17.282Z\",\n \"ended\": \"2024-04-07T09:04:41.610Z\",\n \"updated\": \"2010-02-05T07:36:30.655Z\",\n \"handled_by\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"sdr\"\n },\n \"owner\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"tth_seconds\": 5972.8479947309725,\n \"callback_at\": \"1947-06-17T23:23:08.064Z\",\n \"recording_available\": false,\n \"transcript_available\": true,\n \"started_by\": {\n \"type\": \"api\",\n \"api_key_id\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b93d1d-bc0a-4f92-bc9f-0c74c6d53219", "name": "invalid_request", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86066d51-6611-41ca-9d5a-8b4a684b9c52", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86fa8d25-d703-4db0-b898-6b9b7319ee99", "name": "permission_denied", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0d9d0a4-6199-45a4-af26-21fed61490d1", "name": "not_found", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd1d8d43-87a8-4ed2-8428-6cdaa4164167", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b13584a2-5527-43d3-834a-cbdf853af18f", "name": "internal_error", "originalRequest": { "url": { "path": [ "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ebe8dd4-f178-4d22-9abf-c21462930d0b", "name": "A link to the call's recording, valid for 5 minutes", "request": { "name": "A link to the call's recording, valid for 5 minutes", "description": { "content": "Made on request and never stored: fetch a fresh one each time. The\nlink is a signed storage URL that stops working at expires_at.\n404 recording_not_available when there is none (recording is off\nfor your organization, or it is past retention). Needs calls:read.\n", "type": "text/plain" }, "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "c507af1c-9623-4bd9-a751-d3c4382b98b0", "name": "A link that works for 5 minutes", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"url\": \"https://storage.example.com/recordings/e4d3c2b1.mp3?X-Signature=example\",\n \"expires_at\": \"2026-10-06T17:10:20.000Z\",\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9416503a-8812-4cd1-8531-884655e24a31", "name": "invalid_request", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2df614-9732-4649-8575-6a31a6c857b7", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd6e860f-2058-4d14-8b59-0fd5a90ed9a7", "name": "permission_denied", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b26e85b-6444-4734-b42f-79b288d9748d", "name": "not_found (no such call) or recording_not_available", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dd2d96e-86af-462b-9209-3b105d8b4507", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97237220-d2d0-45c8-ab94-b4f9fc0172b0", "name": "internal_error", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7d73efd-64e2-4185-8cf1-21e3e2c0e2b5", "name": "service_unavailable (recordings can't be reached right now)", "originalRequest": { "url": { "path": [ "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3101b46-519c-4e4d-97f4-d80ad09631c2", "name": "The call's transcript", "request": { "name": "The call's transcript", "description": { "content": "The lines in order: speaker ai, lead or agent (the person who took\nthe call), with a name and a time. ?format=text answers plain text,\none \"Name: text\" line per turn. Needs calls:read.\n", "type": "text/plain" }, "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "145d20e4-b092-4043-a428-5e32b6342596", "name": "The transcript, or plain text with ?format=text", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"call_id\": \"0f8c3213-81e2-a0ac-bccf-ec5ce56ab244\",\n \"lines\": [\n {\n \"speaker\": \"lead\",\n \"name\": \"string\",\n \"text\": \"string\",\n \"at\": \"string\"\n },\n {\n \"speaker\": \"ai\",\n \"name\": \"string\",\n \"text\": \"string\",\n \"at\": \"string\"\n }\n ],\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a67264a-cffb-4a2b-8c1a-b2064290c48f", "name": "invalid_request", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b42aaecc-f917-417a-b536-d4b1a9bf6c93", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c134294-e28e-4981-aa9d-57f663c79fb5", "name": "permission_denied", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8caf606f-8337-4a9a-826f-0394836e566f", "name": "not_found", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe99e257-6c7c-47c1-a463-ed3174060aae", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3342cf21-778a-4649-bbe9-cfeb18920522", "name": "internal_error", "originalRequest": { "url": { "path": [ "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "json" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e67ac089-204a-4f3a-b3f9-c413716f9b06", "name": "Campaigns", "description": { "content": "Your campaigns. Start and pause them.", "type": "text/plain" }, "item": [ { "id": "d8030ad0-18c0-416d-939a-fc61bb25836a", "name": "List campaigns", "request": { "name": "List campaigns", "description": { "content": "The campaigns this key can use, page by page (cursor = the next_cursor you were given). Needs campaigns:read.", "type": "text/plain" }, "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "24c70c83-5ab5-4610-9106-7afd0b2f7928", "name": "A page of campaigns", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"0ad36626-d6bc-5ad7-c861-a08873e61914\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"livemode\": false\n },\n {\n \"id\": \"f980091f-f73c-8b2c-964b-344dd81aab56\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"livemode\": false\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58db76d8-c81c-4663-9871-052e14e2d618", "name": "invalid_request", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0333b6c-4645-498b-94a7-700baab805e4", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "288d12d3-651c-48e4-b38e-29bc80c04877", "name": "permission_denied", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0df1815b-5181-4d09-8999-ba3283c1dcc9", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6b9f51f-2738-4545-bda8-2c1a128fefc6", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "021e45e2-9bde-49a6-a199-d75fbc23fc4e", "name": "Get a campaign", "request": { "name": "Get a campaign", "description": { "content": "Needs campaigns:read. A test key sees the id and name only.", "type": "text/plain" }, "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{campaign_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ccf873eb-641a-4986-a955-c22cb87bae4a", "name": "The campaign", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"117936e7-78ec-d0ba-7945-c4478b903abf\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d396a70-a364-4ed4-95b8-5a0cc0a64823", "name": "invalid_request", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c86d86-a889-4857-9bc2-514d2081cdc9", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4e733e0-7fc3-4bc5-a0df-72ebdfe87bc5", "name": "permission_denied (campaigns:read, or the campaign is outside the key's)", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bcb6df5-83a5-442c-818b-4c4e3509db9d", "name": "not_found", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e38e889d-c737-4594-aa2c-21c777afd375", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b5c520a-1402-4fe6-b53f-21abd04aa068", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37c555c4-fca7-4785-bc8c-b3f8670aa126", "name": "Start a campaign", "request": { "name": "Start a campaign", "description": { "content": "Starts (or restarts) dialing. The campaign needs an SDR and must be a\ndraft or paused. A test key changes nothing and answers what the status\nwould be. Needs campaigns:write.\n", "type": "text/plain" }, "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{campaign_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "685b95f9-04a0-4fe6-92fc-c48273267808", "name": "Started", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"8a4eb654-ea13-901b-cd93-65d1ab306935\",\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c93a448-f869-4c87-a909-ddebf8544a6c", "name": "invalid_request (the campaign can't start from its status, or has no SDR)", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d056b57a-769c-47ff-8ce6-8684112ffe71", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea0fd058-cee1-4133-b144-4f9bf8f1ee1e", "name": "permission_denied (campaigns:write, or the campaign is outside the key's)", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "877653fb-4054-4323-97be-7f9ea073c0f3", "name": "not_found", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b98feff6-4915-4490-8053-bc5442b2b933", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c49f71-5457-4f21-b2a5-e6e9515b158e", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d9d1c0b-6509-406b-be29-d6d0de2a5b31", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac3ab48f-8ce8-49e1-8a65-0dfaab217dc6", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "campaigns", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4760317d-6098-4564-a228-16535f5f7d1f", "name": "Pause a campaign", "request": { "name": "Pause a campaign", "description": { "content": "Stops new calls. Calls already up carry on. Leads you add while it is paused are kept (status held) and dialed when it starts again. A test key changes nothing. Needs campaigns:write.", "type": "text/plain" }, "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{campaign_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "da0098d8-3a3b-4fe6-a26b-d32436b9558e", "name": "Paused", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"8a4eb654-ea13-901b-cd93-65d1ab306935\",\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d835778-fa3f-438d-8f58-6c21a10f61d7", "name": "invalid_request (the campaign isn't running)", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a05394ac-d0f7-445c-8dc4-90956d770cee", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a207025-5069-491f-a9a9-2a8c8ccc7f01", "name": "permission_denied (campaigns:write, or the campaign is outside the key's)", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dea1c4a-cb34-4341-851d-b283688d5511", "name": "not_found", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0214c503-c2e0-4897-8da8-273dd21b51bc", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96964126-7363-47c0-b551-86d6bba4c0d1", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70d066c2-e3b2-4ebc-b684-62d6bde56968", "name": "internal_error", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e2ca17d-40c1-48ea-894c-8142d4fbbc45", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "997b24a9-973c-406d-a487-1d577c5b11d1", "name": "DNC", "description": { "content": "Your organization's Do Not Call list.", "type": "text/plain" }, "item": [ { "id": "301b3e9e-9166-4eb8-9116-c4bd18ddcfd1", "name": "List your Do Not Call list", "request": { "name": "List your Do Not Call list", "description": { "content": "Page by page (cursor = the next_cursor you were given). Needs dnc:read.", "type": "text/plain" }, "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "search", "value": "", "description": "Part of a phone number." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "3a4a998d-c7a0-47d1-a3ba-f272e1ac8fed", "name": "A page of entries", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"94d5c6f0-767e-05bf-02d6-e1a402d1c6c1\",\n \"phone\": \"string\",\n \"source\": \"string\",\n \"createdAt\": \"2000-05-21T00:54:11.434Z\",\n \"livemode\": false\n },\n {\n \"id\": \"16742139-b11f-bcb3-3aa9-d2f71cb5a2fd\",\n \"phone\": \"string\",\n \"source\": \"string\",\n \"createdAt\": \"1976-11-11T16:47:26.253Z\",\n \"livemode\": false\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c1ca32-57e6-4865-a221-f05041c6fd15", "name": "invalid_request", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d3e10e1-d665-4431-92bf-12984a681959", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c85f8145-bac1-4e32-8b62-f28dbc8db663", "name": "permission_denied", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef215497-6d1b-48f5-bdff-cb465395cd99", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd2e94f8-91ba-4a81-8d9b-37e6708a6abe", "name": "internal_error", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c87da2e3-9cd4-40fa-8a2a-07b338f149a2", "name": "Add a number to the list", "request": { "name": "Add a number to the list", "description": { "content": "No campaign of your organization dials it again. Your leads with this number get a lead.opted_out event. Needs dnc:write.", "type": "text/plain" }, "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "667c77c2-d04f-456b-af8e-542269c23042", "name": "Added", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"fb309385-f764-087c-79cb-fdf0da51c354\",\n \"phone\": \"string\",\n \"source\": \"string\",\n \"createdAt\": \"1997-02-20T08:52:18.819Z\",\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae926b87-76e4-4a03-bf93-8c8c0d88dbe2", "name": "invalid_request or invalid_phone", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ead7e6-46a6-4667-bd8f-0b5a20142ecb", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fcdae94-426a-4f8f-8fe5-18a9f1cf3945", "name": "permission_denied", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6312db0d-8f42-4e99-b2ae-24704a0b311c", "name": "duplicate_dnc_entry, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"duplicate_dnc_entry\",\n \"message\": \"This number is already on the Do Not Call list.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222f5b9f-4f06-4fc8-9106-9478a8fad7b5", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0850f1ee-2826-40ee-a46a-f50f9697ba87", "name": "internal_error", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5067f09-5778-4ed5-9c0f-884a48859e9f", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+12125557812\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1e17839-ef4a-4580-9495-37bc7911ce5c", "name": "Take a number off the list", "request": { "name": "Take a number off the list", "description": { "content": "Needs dnc:write. Be sure the person asked for it; we can call the number again after this.", "type": "text/plain" }, "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "47368b8c-8b8d-4f66-b920-fd96db4d9fe7", "name": "The entry that was removed", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"fb309385-f764-087c-79cb-fdf0da51c354\",\n \"phone\": \"string\",\n \"source\": \"string\",\n \"createdAt\": \"1997-02-20T08:52:18.819Z\",\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b39e6e3-ee29-47c8-bf35-41ed237200c1", "name": "invalid_request", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "612a46e5-96bd-499d-adae-a5904038d217", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "855a216f-53ef-4e4e-9933-b873d6538018", "name": "permission_denied", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8931a40b-56e8-4b2f-885c-fb2360a87616", "name": "not_found", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bf6eb1d-7682-4d36-9d35-2a8d38b8ee7f", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "014ab932-12bd-4569-a746-b99fd837bf51", "name": "internal_error", "originalRequest": { "url": { "path": [ "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a35354e-5ca2-47d8-8df4-8d97f8894c90", "name": "Add up to 100 numbers to the list", "request": { "name": "Add up to 100 numbers to the list", "description": { "content": "Each number is added on its own; errors lists the ones that weren't (bad or already there). Needs dnc:write.", "type": "text/plain" }, "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "55f72ce8-d065-48f9-9bae-428c403b4a31", "name": "How many were added", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"succeeded\": 370,\n \"failed\": 4666,\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c41cb512-7012-4ee9-b43b-a80b441bf4c1", "name": "invalid_request (no numbers, or more than 100)", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b84f87b-c78c-4227-a7bd-a9f4ba5b2a37", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a280c17-8116-445c-ad61-194d7399cd27", "name": "permission_denied", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f1ae2d5-0690-4254-b073-d84bdced8d07", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5e8261c-bc8c-4239-afea-b7fe72771480", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564dc906-1462-4897-b83b-92ec8abdba7f", "name": "internal_error", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a0a3424-9da8-4a06-bc26-19cc3eaed0f0", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "dnc", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phones\": [\n \"+12125557812\",\n \"+13105557845\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84d221b7-81bd-4428-9cc9-6167868e30a1", "name": "Is this number on the list?", "request": { "name": "Is this number on the list?", "description": { "content": "Needs dnc:read.", "type": "text/plain" }, "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "phone", "value": "", "description": "(Required) The number to check, in any common format. URL-encode a leading plus (%2B); an unencoded one arrives as a space and is read as a plus." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "1ba7385b-fa18-4ffa-b83a-fc6a7e551b04", "name": "The answer. normalizedPhone is the number in E.164 form, as the list stores it; null when the number couldn't be read (the value as sent was then matched exactly, so onDncList false does not mean it is safe to call).", "originalRequest": { "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phone", "value": "+12125557812" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"phone\": \"string\",\n \"normalizedPhone\": \"string\",\n \"onDncList\": false,\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d07d25c0-be2d-42e8-888b-44b7a33b3da1", "name": "invalid_request (phone missing or sent more than once) or invalid_phone", "originalRequest": { "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phone", "value": "+12125557812" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a44d9933-9bd7-4459-a91d-1833ac8c9bb5", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phone", "value": "+12125557812" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3e86dad-8356-4057-b537-f0ac0ad8c75a", "name": "permission_denied", "originalRequest": { "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phone", "value": "+12125557812" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f796040d-b077-445e-b359-26ea1594217f", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phone", "value": "+12125557812" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d39a9b21-cdc6-41d6-badf-49b958e512a1", "name": "internal_error", "originalRequest": { "url": { "path": [ "dnc", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phone", "value": "+12125557812" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "02f9a2e3-c2e9-4a7b-b0d4-cf9d4cd24e94", "name": "Events", "description": { "content": "Every event we sent, or would have sent, for the last 30 days.", "type": "text/plain" }, "item": [ { "id": "ebbc34db-508e-4a11-97de-df328e38b870", "name": "List events", "request": { "name": "List events", "description": { "content": "Every event we sent or would have sent, newest first, kept 30 days. Keyset-paged: pass the last event's id as `starting_after` for the next page. A test key sees only test events (`livemode: false`), a live key only live ones. Needs the `events:read` permission; a key limited to some campaigns sees only their events.\n", "type": "text/plain" }, "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "starting_after", "value": "", "description": "The id of the last event on the previous page." }, { "disabled": true, "key": "type", "value": "", "description": "One event type, a comma-separated list, or the parameter repeated." }, { "disabled": true, "key": "created[gte]", "value": "", "description": "Created at or after (ISO 8601 or unix seconds)." }, { "disabled": true, "key": "created[lte]", "value": "", "description": "Created at or before (ISO 8601 or unix seconds)." }, { "disabled": true, "key": "campaign_id", "value": "" }, { "disabled": true, "key": "object_id", "value": "", "description": "Only events about this call or lead." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f6cb06c2-fe10-4e85-822a-dc53074efb8e", "name": "A page of events, newest first", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"evt_\",\n \"type\": \"lead.opted_out\",\n \"created\": \"1999-07-02T15:09:47.115Z\",\n \"livemode\": true,\n \"api_version\": \"2026-10-01\",\n \"data\": {\n \"object\": {}\n },\n \"sample\": false\n },\n {\n \"id\": \"evt_\",\n \"type\": \"call.completed\",\n \"created\": \"2001-12-20T02:56:14.285Z\",\n \"livemode\": true,\n \"api_version\": \"2026-10-01\",\n \"data\": {\n \"object\": {}\n },\n \"sample\": false\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf08582f-ef50-4452-8969-aa7a803346d0", "name": "invalid_request (a bad filter, an unknown type, or a starting_after that isn't one of your events)", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ba035c7-df80-4352-9c34-fab93045ac07", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66f7090e-8868-4b56-9fe0-4840a13d2138", "name": "permission_denied (events:read, or a campaign outside the key's)", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01b4f678-7105-4e58-97af-35bffbfd6d7f", "name": "not_found (no such campaign_id)", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19387ab2-74e2-456e-95b8-738545c178ee", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd4c3d48-808c-44db-b72b-af8bf322e0a2", "name": "internal_error", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "starting_after", "value": "evt_3fQ9xK2mZpL8vN1cR7tY4wBa" }, { "key": "type", "value": "call.completed,lead.queued" }, { "key": "created[gte]", "value": "2026-10-06T00:00:00Z" }, { "key": "created[lte]", "value": "" }, { "key": "campaign_id", "value": "" }, { "key": "object_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf272015-6c1c-4f1d-b7a8-eac669ed858d", "name": "Get one event", "request": { "name": "Get one event", "description": { "content": "The same envelope a webhook carries. Needs `events:read`. Another organization's event, or one of the other mode (test/live), is 404.\n", "type": "text/plain" }, "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e3869c90-3024-41e1-aefc-21480d487204", "name": "The event, in the same envelope a webhook carries", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"evt_\",\n \"type\": \"handover.accepted\",\n \"created\": \"1968-04-28T05:47:49.628Z\",\n \"livemode\": false,\n \"api_version\": \"2026-10-01\",\n \"data\": {\n \"object\": {}\n },\n \"sample\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d832d548-badc-40e7-84e0-62c39183e6aa", "name": "invalid_request", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b256b940-65a7-4474-a8ef-bd61e952c510", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bda96fda-00b7-42a2-9c47-8ce7dd6890cf", "name": "permission_denied (events:read, or the event's campaign is outside the key's)", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1db3037f-4046-4213-a94d-5bc31b843568", "name": "not_found", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0bc7561-a2ff-4e1d-a5d7-8f13ccfdd751", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "167bef87-8776-4928-90f0-ca92606e0695", "name": "internal_error", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "22dd7d78-622b-43b0-b4a5-519600f1e424", "name": "Webhooks", "description": { "content": "Where we send events, and how each delivery went.", "type": "text/plain" }, "item": [ { "id": "da642178-062e-48cf-92e1-62acd0e2001a", "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": { "content": "The endpoints for the key's mode (test or live) within its campaigns. Needs webhooks:read.", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "0ee98541-558e-4083-bcf5-f915d1bd867a", "name": "Your endpoints", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"20f7f36c-f4f1-25fb-e288-1af3e0ca13c1\",\n \"object\": \"string\",\n \"url\": \"http://dvghdTxdXDuCsCPqnUr.xqwp5+3sk8UIx,RExGBng32a,Z7tCWeyG-LG71JZP\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"campaign_ids\": [\n \"42645a4c-b665-8400-7e94-5d62ed53aae1\",\n \"672b1e5e-5cb0-6a39-712c-ae27ba7aca17\"\n ],\n \"mode\": \"live\",\n \"livemode\": false,\n \"status\": \"paused\",\n \"failing_since\": \"1982-01-13T18:13:15.711Z\",\n \"paused_at\": \"2026-07-19T13:33:27.148Z\",\n \"last_success_at\": \"2025-08-01T15:42:08.354Z\",\n \"previous_secret_expires_at\": \"1965-10-19T02:56:54.193Z\",\n \"created\": \"1967-02-12T11:45:37.348Z\",\n \"updated\": \"2017-11-22T03:05:01.479Z\"\n },\n {\n \"id\": \"cdfd87e9-a74b-222c-2bc2-9aae7fce82d4\",\n \"object\": \"string\",\n \"url\": \"https://FbiovVqULNOwdijzU.rgc7\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"campaign_ids\": [\n \"38d1c830-5618-e92e-c281-027ab75e676c\",\n \"ebccca6b-0435-a5ac-6343-fb26b2057050\"\n ],\n \"mode\": \"test\",\n \"livemode\": false,\n \"status\": \"paused\",\n \"failing_since\": \"1974-02-25T19:59:44.146Z\",\n \"paused_at\": \"1974-04-11T01:03:05.535Z\",\n \"last_success_at\": \"2009-08-13T10:23:52.698Z\",\n \"previous_secret_expires_at\": \"1980-01-19T09:57:48.757Z\",\n \"created\": \"2001-05-31T00:09:31.443Z\",\n \"updated\": \"1990-07-02T02:22:59.201Z\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2071aa9-4b1e-4908-a01d-9c020854c48e", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c9ea21c-e828-4e56-839c-98c5f33318b5", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8ee173f-c432-44ac-84fc-e40b770c86ac", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "943421bc-b778-4be5-a313-96ecd1f8005c", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aad568d-ae69-4b8a-9bf1-5ffdffc732cf", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c126832e-9ed5-4885-8797-7afe2bc28932", "name": "Create a webhook endpoint", "request": { "name": "Create a webhook endpoint", "description": { "content": "Where we send events. HTTPS only, and the address must be on the public\ninternet. The endpoint's mode is the key's: a test key's endpoint gets\ntest events only. The secret (whsec_...) is in this reply only. Every\ndelivery is signed with it in the CallView-Signature header (see the\nWebhooks guide). At most 10 endpoints per organization. Needs\nwebhooks:write, plus the read permission of every event's data:\nleads:read for lead.created, lead.queued, lead.opted_out, lead.late\nand callback.booked; calls:read for call.*, lead.interested,\nhandover.accepted and voicemail.left (403 permission_denied names\nthe one missing).\n", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"campaign_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "17c9278e-5fc8-4d09-85a5-f6520ced1b67", "name": "Created. Keep the secret; it is not shown again.", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"campaign_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created\": \"1963-11-27T15:16:08.677Z\",\n \"events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"failing_since\": \"1994-10-01T02:18:43.613Z\",\n \"id\": \"3f192298-755c-dc5e-8bab-529ca9393f27\",\n \"last_success_at\": \"1983-08-12T01:45:23.728Z\",\n \"livemode\": true,\n \"mode\": \"live\",\n \"object\": \"string\",\n \"paused_at\": \"2002-11-07T03:31:53.930Z\",\n \"previous_secret_expires_at\": \"2007-10-30T15:47:24.113Z\",\n \"secret\": \"whsec_\",\n \"status\": \"active\",\n \"updated\": \"1964-01-05T09:09:07.979Z\",\n \"url\": \"https://GSuhmrmQeBNugq.qvglzB8\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "284cfa4d-a06a-4f99-b108-f7e156e0ce1f", "name": "invalid_request (an http:// or private address, or an unknown event type)", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83b0a730-a8b4-4b02-a219-135a305cb603", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23ed597e-4323-4089-816c-c6b00f4ee690", "name": "permission_denied, or limit_reached (10 endpoints)", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ed0ef30-ac18-4901-bea8-88e82b3e20c1", "name": "not_found (a campaign in campaign_ids)", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67450f47-7ce3-49ac-9a0c-5c6a31fda18c", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7794a452-a151-4c04-8a0b-4aa85260b010", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff27b214-1759-459b-9743-29016c4f75a7", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "821cf0be-0b66-44f0-bd17-106a9cae43a1", "name": "service_unavailable (the secret can't be stored right now)", "originalRequest": { "url": { "path": [ "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.example.com/callview\",\n \"events\": [\n \"call.completed\",\n \"lead.interested\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c5446e8-570a-47bf-bf66-8493a043eb28", "name": "Get a webhook endpoint", "request": { "name": "Get a webhook endpoint", "description": { "content": "Needs webhooks:read. Another organization's endpoint, or one of the other mode, is 404.", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "dcc2417f-b7ec-422a-aa47-5426b36bd285", "name": "The endpoint (never its secret)", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"c08c326b-5894-952e-9202-98bff982bb6d\",\n \"object\": \"string\",\n \"url\": \"http://aogvmzwz.vccfYNlL4Sv\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"campaign_ids\": [\n \"6991bad8-b364-49e3-1847-fd8dc220a841\",\n \"faf0c57f-20cf-5592-d155-d40d6670ee59\"\n ],\n \"mode\": \"live\",\n \"livemode\": false,\n \"status\": \"paused\",\n \"failing_since\": \"2005-11-18T09:32:09.857Z\",\n \"paused_at\": \"2013-02-20T19:31:31.293Z\",\n \"last_success_at\": \"1955-11-10T21:06:43.182Z\",\n \"previous_secret_expires_at\": \"1992-07-20T06:11:22.250Z\",\n \"created\": \"2002-01-23T21:13:31.402Z\",\n \"updated\": \"1991-12-17T11:56:13.063Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "105803f0-8faf-4b34-a669-8da786a73186", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eda4508-e8d0-40ef-af04-bbf55a3467ff", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "721da1bc-59a2-4d00-8c76-48cd6e3e6142", "name": "permission_denied (webhooks:read, or the endpoint covers campaigns outside the key's)", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee686d95-1f23-4ddf-afc1-682b7992abe7", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2216445b-65cd-4c5c-8ef6-753ba6baa6f9", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "749a7650-7a07-4b12-b801-ee19092cb9f2", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff9a6d26-31c5-4248-8a5b-b74cb6d2fb7a", "name": "Change a webhook endpoint", "request": { "name": "Change a webhook endpoint", "description": { "content": "url, events, campaign_ids (null = every campaign) or status (active or paused). A new address is checked like a new endpoint's. Needs webhooks:write; changing url, events or campaign_ids also needs the read permission of every event the endpoint takes (as at creation).", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"campaign_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1496dd9e-2af0-459c-9c24-82540fe19d1c", "name": "The changed endpoint", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"c08c326b-5894-952e-9202-98bff982bb6d\",\n \"object\": \"string\",\n \"url\": \"http://aogvmzwz.vccfYNlL4Sv\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"campaign_ids\": [\n \"6991bad8-b364-49e3-1847-fd8dc220a841\",\n \"faf0c57f-20cf-5592-d155-d40d6670ee59\"\n ],\n \"mode\": \"live\",\n \"livemode\": false,\n \"status\": \"paused\",\n \"failing_since\": \"2005-11-18T09:32:09.857Z\",\n \"paused_at\": \"2013-02-20T19:31:31.293Z\",\n \"last_success_at\": \"1955-11-10T21:06:43.182Z\",\n \"previous_secret_expires_at\": \"1992-07-20T06:11:22.250Z\",\n \"created\": \"2002-01-23T21:13:31.402Z\",\n \"updated\": \"1991-12-17T11:56:13.063Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ce6330c-d33d-4a37-b001-4410f686c1ad", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f6c035b-edbc-4172-a561-f82fd41df2b3", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b05870af-2efe-471e-9467-c56e9d2cd819", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06f8cd0f-9f00-4295-a4d4-9e1f9204438e", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fcf025e-97cf-41e6-8ef6-c39cf46016a4", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f947e3a1-2d07-4370-9536-d0059038ea5b", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a81d189-e632-4343-ad80-b34d9c011fb4", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9845ea34-3cb7-4a38-b6af-86794349905b", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"call.completed\",\n \"lead.interested\",\n \"lead.opted_out\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1732b7c-3f9c-4337-a235-799060b6a332", "name": "Delete a webhook endpoint", "request": { "name": "Delete a webhook endpoint", "description": { "content": "The endpoint and its delivery history go. Events stay in GET /events. Needs webhooks:write.", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "bc44c2f2-3aa7-402f-8bd3-75cf4e533b2b", "name": "Deleted", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"deleted\": false,\n \"id\": \"string\",\n \"object\": \"string\",\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "405073d4-c49f-4d72-9606-c42e3cb9a0fe", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa7442d9-f803-4205-a926-602b4dbfc96c", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6acdef-d4f0-486b-9c1d-d8d72d587731", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8427bd-1780-4183-8d0b-b3c75f5e81e7", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55068c39-66d3-430f-a843-b050f1a7c62b", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6052f9ef-d4d9-4285-b26d-2fbf826a8209", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c0d9aa2-8f63-49c8-b1c3-79f3d7dcc163", "name": "An endpoint's deliveries", "request": { "name": "An endpoint's deliveries", "description": { "content": "Each delivery is one event sent (or waiting to be sent) to this\nendpoint: its status, how many tries (7 at most, over 24 hours), your\nlast answer (the first 4 KB) and the times. Newest first, page by page\n(starting_after = the next_cursor you were given). Needs webhooks:read.\n", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "25" }, { "disabled": true, "key": "starting_after", "value": "" }, { "disabled": true, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "fe1d92f7-04c5-427d-924c-2dca84d37001", "name": "A page of deliveries", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"object\": \"string\",\n \"endpoint_id\": \"2aef3aee-6ec4-ee5a-90e3-437dd722f73c\",\n \"event_id\": \"string\",\n \"event_type\": \"string\",\n \"status\": \"failed\",\n \"attempts\": 4364,\n \"next_attempt_at\": \"1990-07-05T00:55:45.475Z\",\n \"last_attempt_at\": \"1974-09-05T15:39:11.890Z\",\n \"response_status\": 7655,\n \"response_body\": \"string\",\n \"duration_ms\": 1163,\n \"resent_from\": \"string\",\n \"created\": \"2011-03-17T15:14:09.190Z\",\n \"livemode\": false\n },\n {\n \"id\": \"string\",\n \"object\": \"string\",\n \"endpoint_id\": \"3cd6e892-2304-6e31-9734-3126100ddfe0\",\n \"event_id\": \"string\",\n \"event_type\": \"string\",\n \"status\": \"sent\",\n \"attempts\": 351,\n \"next_attempt_at\": \"1996-01-31T09:56:32.976Z\",\n \"last_attempt_at\": \"1995-03-07T21:22:54.645Z\",\n \"response_status\": 483,\n \"response_body\": \"string\",\n \"duration_ms\": 1912,\n \"resent_from\": \"string\",\n \"created\": \"1976-03-17T13:32:47.879Z\",\n \"livemode\": false\n }\n ],\n \"meta\": {\n \"next_cursor\": \"string\",\n \"has_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9b7c753-4658-4075-93c3-4cc2752e9425", "name": "invalid_request (a bad filter, or a starting_after that isn't one of this endpoint's)", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69376ff1-0080-4ef6-87dc-43984275bd99", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62471de0-6e23-42c7-9ca9-a8ab9ad1e444", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "590966b6-3d5a-40e6-964d-2fcf7ca54e5d", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "541a1616-1e13-475c-964d-92cd52f521d7", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee131f53-5973-44a0-a426-06e4e7b26490", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "" }, { "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "405b22d8-f4d3-43ad-8ede-26c3c333e026", "name": "Send a delivery again", "request": { "name": "Send a delivery again", "description": { "content": "A new delivery with the same event id (so your side can skip it if it already has it) and a fresh signature. A paused endpoint has to be resumed first. Needs webhooks:write.", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "e323114d-800e-4416-946b-651b4a091581", "name": "Queued. It goes out within a second or two.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"object\": \"string\",\n \"endpoint_id\": \"14dbb225-4326-5d79-c807-3da9b9e850f0\",\n \"event_id\": \"string\",\n \"event_type\": \"string\",\n \"status\": \"skipped_paused\",\n \"attempts\": 9034,\n \"next_attempt_at\": \"1947-04-07T15:18:48.422Z\",\n \"last_attempt_at\": \"2025-08-18T20:10:47.961Z\",\n \"response_status\": 2775,\n \"response_body\": \"string\",\n \"duration_ms\": 5365,\n \"resent_from\": \"string\",\n \"created\": \"2001-02-10T19:29:59.365Z\",\n \"livemode\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6ede266-2e3f-4b7e-a4d2-0e21c6dffe59", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2050130-6d91-4443-9a7e-642bce3c7b38", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "250e8751-65fc-4a1e-b571-e24e8eb60945", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f5d6f19-f1c3-446f-b226-d5ce37d927c6", "name": "not_found (the endpoint or the delivery)", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc0cbc0-0c37-45a5-aa8e-5d516bc8815e", "name": "endpoint_paused, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"endpoint_paused\",\n \"message\": \"The webhook endpoint is paused. Resume it (POST /webhook_endpoints/{id}/resume), then re-send or send the test event.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3799c3f6-08bc-4076-b8ce-58b7149a2aa3", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "312671b2-b736-4059-b8ee-0011712afb1e", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0441cb55-6aaf-40aa-9b23-85e84d7d7e94", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "deliveries", ":delivery_id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "delivery_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea1f90cb-2b5d-417e-97ec-c67268ade400", "name": "Resume a paused endpoint", "request": { "name": "Resume a paused endpoint", "description": { "content": "With resend_skipped true, the deliveries skipped while it was paused (up to 1,000, newest first) are sent again with their original event ids. Needs webhooks:write.", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f677cd76-71de-4fb2-9246-97b9dd79f9ba", "name": "The endpoint, and how many deliveries were queued again", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"campaign_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created\": \"1972-04-04T19:39:44.935Z\",\n \"events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"failing_since\": \"1964-07-09T17:59:39.564Z\",\n \"id\": \"f48901f9-bd15-07e8-4e6d-706f582cf641\",\n \"last_success_at\": \"1995-02-27T23:23:08.803Z\",\n \"livemode\": true,\n \"mode\": \"test\",\n \"object\": \"string\",\n \"paused_at\": \"1999-08-26T12:13:18.903Z\",\n \"previous_secret_expires_at\": \"1956-07-10T15:55:10.417Z\",\n \"resent\": 6279,\n \"status\": \"active\",\n \"updated\": \"1963-08-04T06:25:57.493Z\",\n \"url\": \"http://mBYjAAWLGfWVzFzubMcfOjeNJhs.xlVTu-i0y0H7EsYj9.w797vMGLBFvyhzmsotGAbNlXJmzg1kFjlPpoZeyZjh0x5.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c0aef3b-bb02-40ff-a855-391b90e48c25", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebf884b0-72b3-4cbb-b71e-8b748f148a0b", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c499fe-9cf0-4aa2-bf82-8bc7148ce304", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57d46512-3211-41bf-9f56-286c06500a68", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82d57b6f-c364-46aa-8e95-647bf6b78e36", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cfd32aa-1fa1-4561-b6ef-237649eee812", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd97ff9e-6eb8-4760-ab2c-3f7fc7e00894", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d495e4c-fc08-497d-a26d-78ab326fb7f7", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resend_skipped\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d96d6e44-849b-4778-ac3b-9567590d3e2d", "name": "Roll the signing secret", "request": { "name": "Roll the signing secret", "description": { "content": "A new secret, shown once. The old one keeps signing too (two v1 values\nin the header) for grace_hours, so you can switch over without missing\nanything. Needs webhooks:write.\n", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1d819915-6e65-448b-ac5a-83de7529e59a", "name": "The endpoint and its new secret", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"campaign_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created\": \"1963-11-27T15:16:08.677Z\",\n \"events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"failing_since\": \"1994-10-01T02:18:43.613Z\",\n \"id\": \"3f192298-755c-dc5e-8bab-529ca9393f27\",\n \"last_success_at\": \"1983-08-12T01:45:23.728Z\",\n \"livemode\": true,\n \"mode\": \"live\",\n \"object\": \"string\",\n \"paused_at\": \"2002-11-07T03:31:53.930Z\",\n \"previous_secret_expires_at\": \"2007-10-30T15:47:24.113Z\",\n \"secret\": \"whsec_\",\n \"status\": \"active\",\n \"updated\": \"1964-01-05T09:09:07.979Z\",\n \"url\": \"https://GSuhmrmQeBNugq.qvglzB8\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c5d119-8e11-416f-948f-38b844cebba4", "name": "invalid_request", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf82267a-aeac-4eed-84c5-87e772c16394", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac312fe4-39ba-4729-b151-a50659b25c44", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ecd06bc-9f37-4227-8807-b1a53c7b0afb", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ec807df-889b-46af-9112-1e367aa12164", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc9cce5-bf01-445f-b98e-25ee6407bde6", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14f9ddf5-9136-4c37-abe9-2c52f14bf131", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e6f303-99aa-43a4-b143-3058dd5bafff", "name": "service_unavailable (the secret can't be stored right now)", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "roll_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grace_hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e6f0227-527d-47c6-a951-9ba1e13194f9", "name": "Send a test event", "request": { "name": "Send a test event", "description": { "content": "Sends one sample of any event type to this endpoint, so you can check\nyour receiver. It is the event's example in a real envelope with a new\nevt_ id, livemode false and \"sample\": true, signed with this endpoint's\nsecret just like a real delivery, and retried like one. It shows in the\nendpoint's deliveries. It is not an event, so GET /events doesn't list\nit. A paused endpoint has to be resumed first. Needs webhooks:write.\n", "type": "text/plain" }, "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{webhook_endpoint_id}}", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "031716de-d110-4269-9a88-9418e2611449", "name": "Queued. It goes out within a second or two.", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"attempts\": 9665,\n \"created\": \"2018-09-28T13:13:30.383Z\",\n \"duration_ms\": 1929,\n \"endpoint_id\": \"409570b0-5cd8-985e-e9ab-5d6f4f7b5243\",\n \"event\": {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"livemode\": {\n \"value\": \"\"\n },\n \"api_version\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"sample\": {\n \"value\": \"\"\n }\n },\n \"event_id\": \"string\",\n \"event_type\": \"string\",\n \"id\": \"string\",\n \"last_attempt_at\": \"1994-04-30T04:01:41.186Z\",\n \"livemode\": true,\n \"next_attempt_at\": \"1980-01-08T03:00:03.129Z\",\n \"object\": \"string\",\n \"resent_from\": \"string\",\n \"response_body\": \"string\",\n \"response_status\": 4927,\n \"status\": \"gave_up\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f119bfd-e2b0-4f5c-9823-0153045d2ca5", "name": "invalid_request (an unknown type)", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e070b055-ae22-42f6-b742-1653ea8c8565", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ef40750-2678-4bba-bda1-4e4ee963b0da", "name": "permission_denied", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dd842b8-32d2-4f11-9af6-14abd9415064", "name": "not_found", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"not_found\",\n \"message\": \"No such object or endpoint (or it belongs to someone else).\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df991c81-e397-411c-871d-0caf55a938f7", "name": "endpoint_paused, idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"endpoint_paused\",\n \"message\": \"The webhook endpoint is paused. Resume it (POST /webhook_endpoints/{id}/resume), then re-send or send the test event.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c59605a4-9b6f-4e2f-a816-b722b1109a36", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ddf73f9-5147-4265-952d-ea6692e29976", "name": "internal_error", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "649cac1d-49b6-464e-88af-7a71c81429a3", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "webhook_endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"call.completed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1095be62-596c-48e9-8720-17c25adbe641", "name": "Usage", "description": { "content": "Requests, leads, calls, minutes and cost for a month.", "type": "text/plain" }, "item": [ { "id": "8be1bb48-21c8-4b0d-b76f-96705d3045fd", "name": "Usage for a month", "request": { "name": "Usage for a month", "description": { "content": "API requests, leads added, calls, billable minutes and their cost for the month so far (or a past month), in your organization's time zone. Minutes are the bill's own rule (rounded up per call) and `cost_usd` is those minutes at your rate, so the month's total matches your bill. Updated every 5 minutes (`updated`). A test key sees its test counts (`livemode: false`, never billed). A key limited to some campaigns sees only their leads, calls and minutes, plus its own requests. Needs the `usage:read` permission.\n", "type": "text/plain" }, "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "period", "value": "current", "description": "`current` (the month so far) or a month, YYYY-MM." }, { "disabled": true, "key": "group_by", "value": "", "description": "Split the totals by API key, campaign or day." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "0191cb59-93ea-4fb6-84e9-cafde0b890f5", "name": "The month's totals, and with group_by one group per key, campaign or day carrying the same counts plus its key_id / key_name, campaign_id / campaign_name, or day.\n", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-10" }, { "key": "group_by", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"object\": \"string\",\n \"period\": \"2026-10\",\n \"timezone\": \"string\",\n \"livemode\": false,\n \"totals\": {\n \"requests\": 5670,\n \"leads_added\": 8842,\n \"calls\": 6594,\n \"calls_connected\": 6860,\n \"minutes\": 2098.0857191595783,\n \"cost_usd\": 5565.183305636223\n },\n \"group_by\": \"null\",\n \"groups\": [\n {\n \"key_id\": {\n \"value\": \"\"\n },\n \"key_name\": {\n \"value\": \"\"\n },\n \"campaign_id\": {\n \"value\": \"\"\n },\n \"campaign_name\": {\n \"value\": \"\"\n },\n \"day\": {\n \"value\": \"\"\n }\n },\n {\n \"key_id\": {\n \"value\": \"\"\n },\n \"key_name\": {\n \"value\": \"\"\n },\n \"campaign_id\": {\n \"value\": \"\"\n },\n \"campaign_name\": {\n \"value\": \"\"\n },\n \"day\": {\n \"value\": \"\"\n }\n }\n ],\n \"updated\": \"1989-10-02T10:40:32.112Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfd02fbb-72b9-4641-bd5c-282047337427", "name": "invalid_request (a bad period or group_by)", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-10" }, { "key": "group_by", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e36870c9-9fe6-46c5-811e-d72ccc4260b6", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-10" }, { "key": "group_by", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc733801-51d4-45a7-abc0-ed6d0af5f396", "name": "permission_denied (usage:read)", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-10" }, { "key": "group_by", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d884ea1f-e1d2-4c28-86a0-ed26a1871ffa", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-10" }, { "key": "group_by", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c67ae2d-db4b-4dea-a79f-a40f1ee4a4f6", "name": "internal_error", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-10" }, { "key": "group_by", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e3a82a59-b8c4-453f-8473-89194926ff53", "name": "Exports", "description": { "content": "Download your leads and calls as a file.", "type": "text/plain" }, "item": [ { "id": "6b1e9fc4-e2df-464c-83b1-ed57a6320692", "name": "Make an export file", "request": { "name": "Make an export file", "description": { "content": "Leads, call history or analytics as a file, with a download link. Needs\nleads:read and calls:read, on a key for every campaign. A test key gets\na sample file.\n", "type": "text/plain" }, "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"\",\n \"filters\": {\n \"campaignId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d480437d-dcdb-4599-83ce-9dc66fb95f25", "name": "The export and its download link", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "disabled": true, "description": "true when this is the kept answer to an earlier request with the same Idempotency-Key.", "key": "Idempotent-Replayed", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"export\": {\n \"id\": \"ee2c1c56-30a3-ee83-3725-09f243691bf4\",\n \"exportType\": \"leads\",\n \"status\": \"string\",\n \"rowCount\": 6068,\n \"createdAt\": \"1983-09-11T03:49:15.148Z\",\n \"expiresAt\": \"1978-12-27T15:46:23.513Z\",\n \"livemode\": false\n },\n \"downloadUrl\": \"http://YOh.lxkfJU+PTs..E\",\n \"livemode\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bef86acd-ecf9-42e5-8032-70b89fd426d8", "name": "invalid_request", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5405640-4efc-4914-b86c-3c01c6ac4f82", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb8c9bef-f675-4b3a-a1f4-e08208916bce", "name": "permission_denied (leads:read and calls:read, on a key for every campaign)", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed9c701-7b0a-4399-bbd7-3cacc635bc96", "name": "idempotency_mismatch, idempotency_in_progress", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"idempotency_error\",\n \"code\": \"idempotency_mismatch\",\n \"message\": \"This Idempotency-Key was already used with a different request.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c902f2e-7581-4cf4-89a9-b76d0b5aa584", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c1b917-5399-4c41-9a3e-1813dbbc1e7d", "name": "internal_error", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd3f6d64-494e-48c3-8e48-41647628a507", "name": "service_unavailable", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": true, "description": "Any string you choose (1 to 255 visible characters), new for each new action. Send the same key again within 24 hours and you get the first answer back instead of a second lead or call.", "key": "Idempotency-Key", "value": "crm-10442-create" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"exportType\": \"call_history\",\n \"filters\": {\n \"startDate\": \"2026-10-01\",\n \"endDate\": \"2026-10-06\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"service_unavailable\",\n \"message\": \"A service we depend on is unavailable. Retry later.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e392bda-4509-4736-9c2a-e18a1ca9caa1", "name": "List your exports", "request": { "name": "List your exports", "description": { "content": "Needs leads:read and calls:read, on a key for every campaign. A test key has none.", "type": "text/plain" }, "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f9863c7e-2a07-4d0f-999c-1a710f3add69", "name": "Your exports", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Requests allowed a minute.", "key": "RateLimit-Limit", "value": "1681" }, { "disabled": true, "description": "Requests left this minute.", "key": "RateLimit-Remaining", "value": "1681" }, { "disabled": true, "description": "Seconds until the minute resets.", "key": "RateLimit-Reset", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"4bbb96d0-8240-badb-e65a-cdde673f62d3\",\n \"exportType\": \"call_history\",\n \"status\": \"string\",\n \"rowCount\": 4886,\n \"createdAt\": \"2018-10-25T06:18:29.108Z\",\n \"expiresAt\": \"1964-02-26T07:32:20.508Z\",\n \"livemode\": false\n },\n {\n \"id\": \"a48213aa-fcd0-bdbe-49e1-8c085ebf00dd\",\n \"exportType\": \"leads\",\n \"status\": \"string\",\n \"rowCount\": 9107,\n \"createdAt\": \"2005-03-27T12:24:30.814Z\",\n \"expiresAt\": \"2018-01-10T14:45:37.831Z\",\n \"livemode\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28c56b35-d13f-4acb-bcb6-ce0135a2cd88", "name": "invalid_request", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_request\",\n \"message\": \"The request is malformed: a missing or unknown field, a bad value, a body over 1 MB, a batch over 60 leads, or over 100 numbers for Do Not Call.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc824886-6ddd-4463-9530-80d2597f8c46", "name": "authentication_failed", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"authentication_error\",\n \"code\": \"authentication_failed\",\n \"message\": \"The key ID or secret is missing, wrong, revoked, expired or disabled.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2eb705b-68f3-4db9-9d92-8ac64f22a665", "name": "permission_denied", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"code\": \"permission_denied\",\n \"message\": \"The key is not allowed to do this.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5537fd23-1c02-426d-bba9-d6ad6752c675", "name": "rate_limited, too_many_concurrent_requests", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "disabled": true, "description": "Seconds to wait before trying again.", "key": "Retry-After", "value": "1681" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"rate_limit_error\",\n \"code\": \"rate_limited\",\n \"message\": \"Too many requests a minute for this key or the organization's plan. Retry after Retry-After seconds.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f4f19e6-bd1c-45d8-84db-81c8249ef5e6", "name": "internal_error", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "The ID of this request (req_...). Quote it when you contact us.", "key": "Request-Id", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"api_error\",\n \"code\": \"internal_error\",\n \"message\": \"Something went wrong on our side.\",\n \"param\": null,\n \"request_id\": \"req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://v2-api.callview.ai/api/v1/external", "type": "string" }, { "key": "key_id", "value": "ck_test_your_key_id", "type": "string" }, { "key": "key_secret", "value": "cs_test_your_secret", "type": "string" }, { "key": "request_bin_url", "value": "https://your-request-bin.example.com/callview", "type": "string" }, { "key": "campaign_id", "value": "", "type": "string" }, { "key": "lead_id", "value": "", "type": "string" }, { "key": "webhook_endpoint_id", "value": "", "type": "string" }, { "key": "webhook_secret", "value": "", "type": "string" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{key_id}}", "type": "string" }, { "key": "password", "value": "{{key_secret}}", "type": "string" } ] }, "info": { "_postman_id": "7e68c821-bdf1-4b05-8ee1-dd62c557a738", "name": "CallView API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "The CallView API (https://developers.callview.ai). Put your key ID in key_id and your secret in key_secret (a test key, ck_test_ / cs_test_, while you build)." } }