{ "item": [ { "id": "bf38db37-b58a-4ca9-8c31-d440da9fc8c3", "name": "meta", "description": { "content": "Service metadata and the API root.", "type": "text/plain" }, "item": [ { "id": "9b157c54-daa3-4954-8c45-1e8d68675c6d", "name": "API root — service metadata", "request": { "name": "API root — service metadata", "description": { "content": "A cheap, unauthenticated way to confirm you are pointed at the right host and to read back the API version. Not a health check — use `/health` for that.", "type": "text/plain" }, "url": { "path": [ "v1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9117f42f-2cf9-47a1-9f53-f557eaf1088e", "originalRequest": { "url": { "path": [ "v1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eab8e6f-82d6-4a37-9b1c-19899854dddd", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d88e48a-b5d8-4f07-8ac8-34e4b1c68479", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "71518281-c0ee-4948-adf8-edaefe3a9b88", "name": "health", "description": { "content": "Liveness and readiness probes. No credential required.", "type": "text/plain" }, "item": [ { "id": "1efef9a6-ecab-4750-8571-bbb04181c7c0", "name": "Liveness — is the process up?", "request": { "name": "Liveness — is the process up?", "description": { "content": "Touches no dependencies and never fails while the process can answer. Unversioned and un-enveloped on purpose, so a load balancer gets a stable, standard contract. Use it for restart decisions, not for traffic decisions.", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "41d638b9-3125-498e-be06-4fa16168acb0", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfdd64bd-7a12-4de9-bba5-7b7a9d7b669a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3b23df-a4bd-46ef-921e-bdff57c0dc63", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2c17a84-d3a6-4d61-95d3-a2f773be19d6", "name": "Readiness — are dependencies reachable?", "request": { "name": "Readiness — are dependencies reachable?", "description": { "content": "Checks Postgres. Answers `503` when a dependency is down, which is the signal to stop sending this instance traffic without restarting it. Cache status rides along in the payload but never fails the probe — it is an optimisation, not a dependency. Queue depths ride along the same way: the API only ever produces, so a broker outage defers work rather than breaking a request. The process that cannot run without a broker is `tone-worker`, which refuses to boot instead of reporting here.", "type": "text/plain" }, "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9bc1cebb-eba3-47a8-8cc7-056eeb1d27e9", "name": "The Health Check is successful", "originalRequest": { "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"details\": {\n \"database\": {\n \"status\": \"up\"\n }\n },\n \"error\": {},\n \"info\": {\n \"database\": {\n \"status\": \"up\"\n }\n },\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "305ddd5d-27bb-4467-b4e5-91c4a5f51a84", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a886760b-173d-4c3f-806b-3bfdce6e10f2", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b87c0c47-e3ca-42ad-b6ef-7c9ca04645bb", "name": "The Health Check is not successful", "originalRequest": { "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"details\": {\n \"database\": {\n \"status\": \"up\"\n },\n \"redis\": {\n \"message\": \"Could not connect\",\n \"status\": \"down\"\n }\n },\n \"error\": {\n \"redis\": {\n \"message\": \"Could not connect\",\n \"status\": \"down\"\n }\n },\n \"info\": {\n \"database\": {\n \"status\": \"up\"\n }\n },\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "691508db-92f6-4355-b9bd-25f9538d7f25", "name": "limits", "description": { "content": "Your request budget and concurrent-call quotas, per environment.", "type": "text/plain" }, "item": [ { "id": "df09417c-7615-4c6b-aa30-b33224f3a058", "name": "This organization's rate limits and concurrent-call quotas", "request": { "name": "This organization's rate limits and concurrent-call quotas", "description": { "content": "Two budgets that fail in different ways for different reasons. Exceeding the request budget is a `429 rate_limited` with a `Retry-After` — slow down. Exceeding a concurrency pool is a `429 concurrent_call_limit_reached`, which slowing down does not fix: you have to wait for calls to end. Live and test have separate budgets, and this answers for whichever key you asked with.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "19df2ca4-9124-4dcf-be4d-279777f7c1f5", "originalRequest": { "url": { "path": [ "v1", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"concurrency\": {\n \"agentCalls\": {\n \"inUse\": 0,\n \"limit\": 0\n },\n \"byoCalls\": {\n \"inUse\": 0,\n \"limit\": 0\n }\n },\n \"environment\": \"live\",\n \"requests\": {\n \"limitPerMinute\": 0,\n \"remaining\": 0\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26a4e4ee-a41a-4d9e-95fb-4fd3ccdc0a8d", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e908d588-6956-4a12-a1cc-963ee333655b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47337074-c137-4f33-9d5c-44585a1feda6", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74dc204f-366d-4956-bfde-a6b192e1629c", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9ecbb27c-c934-4deb-9b95-99d43ec265e3", "name": "agents", "description": { "content": "The thing that talks: prompt, voice, languages, variables and tools. Published versions are immutable and a call pins the one that ran it.", "type": "text/plain" }, "item": [ { "id": "bd09d216-d4e2-42ea-b3cd-b751eb0d6e9a", "name": "List the organization’s agents", "request": { "name": "List the organization’s agents", "description": { "content": "Every agent, live and draft. Small enough that it is not paginated.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8809fca5-bd39-4cd6-a5af-7d5c47bfdb53", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"llmProvider\": \"google\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"status\": \"draft\",\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"sttProvider\": \"sarvam\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsProvider\": \"sarvam\",\n \"ttsVoice\": \"simran\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2903c004-c6a6-4782-b6eb-fbd275372f75", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28db579a-e1bc-4ab0-922b-2015fc88d66c", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b51f0719-ad5f-46ac-abd2-62d4e3bffea7", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db7078e0-a856-479b-87f6-55d1360206d8", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03206d6e-6880-4e78-bcc1-9c4f499eaf08", "name": "Create an agent (always as a draft)", "request": { "name": "Create an agent (always as a draft)", "description": { "content": "A new agent is always a draft, whatever you send: a draft can be dialled outbound but will NOT answer inbound calls, so publishing is the deliberate step that puts it on a phone line. The `(ttsModel, ttsVoice)` pair is validated here — a voice belonging to a different model version is rejected now rather than failing mid-call.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"systemPrompt\": \"\",\n \"callSettings\": {\n \"background\": {},\n \"hangupLine\": {},\n \"maxCallSeconds\": \"\",\n \"nudges\": {},\n \"openingLine\": {},\n \"voicemail\": {}\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"prompt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"prompt\": \"\"\n }\n ],\n \"inputVariables\": [\n {\n \"name\": \"\",\n \"default\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"default\": \"\",\n \"description\": \"\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"\",\n \"\"\n ],\n \"llmModel\": \"\",\n \"outputVariables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enumValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enumValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"purpose\": \"\",\n \"tools\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"http\": {\n \"url\": \"\",\n \"method\": \"\",\n \"auth\": {\n \"type\": \"\",\n \"secretId\": \"\",\n \"header\": \"\",\n \"in\": \"\",\n \"name\": \"\",\n \"secondary\": {\n \"secretId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"in\": {\n \"value\": \"\"\n }\n }\n },\n \"bodyFormat\": \"\",\n \"bodyRoot\": \"\",\n \"headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timeoutMs\": \"\"\n },\n \"connectionId\": \"\",\n \"mock\": {\n \"enabled\": \"\",\n \"response\": \"\"\n },\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n }\n ],\n \"preset\": \"\",\n \"speech\": {\n \"key_0\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"http\": {\n \"url\": \"\",\n \"method\": \"\",\n \"auth\": {\n \"type\": \"\",\n \"secretId\": \"\",\n \"header\": \"\",\n \"in\": \"\",\n \"name\": \"\",\n \"secondary\": {\n \"secretId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"in\": {\n \"value\": \"\"\n }\n }\n },\n \"bodyFormat\": \"\",\n \"bodyRoot\": \"\",\n \"headers\": {\n \"key_0\": \"\"\n },\n \"timeoutMs\": \"\"\n },\n \"connectionId\": \"\",\n \"mock\": {\n \"enabled\": \"\",\n \"response\": \"\"\n },\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n }\n ],\n \"preset\": \"\",\n \"speech\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"\",\n \"\"\n ],\n \"sttLanguage\": \"\",\n \"sttMode\": \"\",\n \"sttModel\": \"\",\n \"ttsModel\": \"\",\n \"ttsOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"ttsVoice\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f421745-2338-474e-a463-20507ef170cc", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"llmProvider\": \"google\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"status\": \"draft\",\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"sttProvider\": \"sarvam\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsProvider\": \"sarvam\",\n \"ttsVoice\": \"simran\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1efed0ae-5fec-4ce0-a844-a8bc3ea1239b", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5126a5-dd14-4b9c-97c2-3e1db77e9e45", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86007d96-ca62-44ea-a814-6d69beda765c", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68fc35ec-5a53-4aea-866e-2ff49b6ae398", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cf7df38-c252-4888-915a-57410efcba6a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f20d4ed7-6ac5-4695-b727-7d90f054fc68", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c469c44d-b389-4326-8b2e-94d0857b24d7", "name": "Delete an agent (its numbers unassign; its call log survives)", "request": { "name": "Delete an agent (its numbers unassign; its call log survives)", "description": { "content": "Any number bound to this agent is unassigned rather than released, so you keep the number and can rebind it. Calls the agent already made are kept: deleting the agent must not erase the record of what it said.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "69ffd402-ff2b-4c5b-8879-9581698608bf", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ad388f-d65d-46e9-afc3-991cbf50fa91", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e178bd8-21e1-4e5e-a66e-dd85d75af5bd", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9cb7844-1011-46b9-b6c3-5a7fd6c143e4", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f7d57c-8237-4b38-910d-2bf97056efb8", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae53fd5a-e118-46b7-a55b-c207b85a14a4", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc293f47-6b7e-40a1-9a4b-b9f320153b39", "name": "Fetch a single agent", "request": { "name": "Fetch a single agent", "description": { "content": "Returns the WORKING COPY — what an edit would change and what the next publish would freeze. To read what actually ran on a call, fetch that version by number instead.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "119d4021-d27d-4280-8926-36a8c69303b4", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"llmProvider\": \"google\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"status\": \"draft\",\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"sttProvider\": \"sarvam\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsProvider\": \"sarvam\",\n \"ttsVoice\": \"simran\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e40031-d88e-4b47-b3a5-26c09b4d2455", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "452fc369-d066-472e-85f3-51a70f318a33", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ac6fc80-9fcb-44b7-8263-3172ea58ffd2", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c1fe5da-cdd1-4d3e-855a-0d9f60de5ec7", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe4d7326-b84a-4a79-93bd-2f198c54ecf5", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "826f522c-d873-4543-994b-8aa928d170b3", "name": "Update an agent (voice changes re-validate the whole stack)", "request": { "name": "Update an agent (voice changes re-validate the whole stack)", "description": { "content": "Edits the working copy; live calls and the published version are untouched until you publish. Sending `voice` re-validates the whole speech stack, because a model change can invalidate a voice that was legal before. List-shaped fields (`knowledgeBaseIds`, `inputVariables`, `outputVariables`, `evaluationCriteria`, `tools`) are REPLACEMENTS, not merges — omit a key to leave it alone, send an empty array to clear it.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {},\n \"hangupLine\": {},\n \"maxCallSeconds\": \"\",\n \"nudges\": {},\n \"openingLine\": {},\n \"voicemail\": {}\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"prompt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"prompt\": \"\"\n }\n ],\n \"inputVariables\": [\n {\n \"name\": \"\",\n \"default\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"default\": \"\",\n \"description\": \"\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"\",\n \"\"\n ],\n \"llmModel\": \"\",\n \"name\": \"\",\n \"outputVariables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enumValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enumValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"purpose\": \"\",\n \"status\": \"\",\n \"systemPrompt\": \"\",\n \"tools\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"http\": {\n \"url\": \"\",\n \"method\": \"\",\n \"auth\": {\n \"type\": \"\",\n \"secretId\": \"\",\n \"header\": \"\",\n \"in\": \"\",\n \"name\": \"\",\n \"secondary\": {\n \"secretId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"in\": {\n \"value\": \"\"\n }\n }\n },\n \"bodyFormat\": \"\",\n \"bodyRoot\": \"\",\n \"headers\": {\n \"key_0\": \"\"\n },\n \"timeoutMs\": \"\"\n },\n \"connectionId\": \"\",\n \"mock\": {\n \"enabled\": \"\",\n \"response\": \"\"\n },\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n }\n ],\n \"preset\": \"\",\n \"speech\": {\n \"key_0\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"http\": {\n \"url\": \"\",\n \"method\": \"\",\n \"auth\": {\n \"type\": \"\",\n \"secretId\": \"\",\n \"header\": \"\",\n \"in\": \"\",\n \"name\": \"\",\n \"secondary\": {\n \"secretId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"in\": {\n \"value\": \"\"\n }\n }\n },\n \"bodyFormat\": \"\",\n \"bodyRoot\": \"\",\n \"headers\": {\n \"key_0\": \"\"\n },\n \"timeoutMs\": \"\"\n },\n \"connectionId\": \"\",\n \"mock\": {\n \"enabled\": \"\",\n \"response\": \"\"\n },\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"enum\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"in\": \"\",\n \"path\": \"\",\n \"required\": \"\",\n \"value\": \"\"\n }\n ],\n \"preset\": \"\",\n \"speech\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"\",\n \"\"\n ],\n \"sttLanguage\": \"\",\n \"sttMode\": \"\",\n \"sttModel\": \"\",\n \"ttsModel\": \"\",\n \"ttsOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"ttsVoice\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c39bf701-4444-4be1-9b08-e8839e47afda", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"llmProvider\": \"google\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"status\": \"draft\",\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"sttProvider\": \"sarvam\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsProvider\": \"sarvam\",\n \"ttsVoice\": \"simran\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df9b2975-5c9e-47c7-9066-a3f0b5959125", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc48d03-f553-4703-8b17-3e13fddf9335", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7888e650-5e67-4175-94ce-5f16a553cbf8", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa8585fe-7c48-4ae6-bd9f-994f6d335a7b", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e54c4e5b-6249-42fa-92ca-352b65b2b92b", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "177f4d36-5b5b-4bff-99bd-a9636cc82e48", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f0da53f-fb34-4b3b-bb70-c38228151071", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"name\": \"Order confirmation\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"transactional\",\n \"status\": \"live\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order. Confirm the order, ask which day suits them for delivery, then thank them and end the call. Be brief and polite.\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"ttsVoice\": \"simran\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0787e76b-12e3-4f99-bb40-4dfec069ea96", "name": "Publish the working copy as a new live version", "request": { "name": "Publish the working copy as a new live version", "description": { "content": "Freezes the current working copy into an immutable numbered version and points the agent at it. Publishing is what changes behaviour — editing does not. A running campaign finishes on the version it launched with; inbound calls always answer with the live version.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d172f7bc-0e9e-41ec-8308-e2d3d4a2f798", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"version\": 0,\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsVoice\": \"simran\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3202fad0-dd41-4982-8e0a-1a3b9b3a34dd", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54460dce-70c0-4962-b6d1-808db0975804", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad8295da-392a-4943-be2b-b29f6a2cc1a9", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a7497be-56f4-41d7-ad36-8b0941455b4f", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4f077aa-90cd-4b61-9d65-ca070d48e2d5", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "306bff66-87a5-42d3-be0f-c426f5588a97", "name": "Restore an older version (mints a new one)", "request": { "name": "Restore an older version (mints a new one)", "description": { "content": "Rolling back MINTS A NEW VERSION carrying the old content rather than moving a pointer backwards, so the history stays append-only and the rollback itself is visible in it.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5a80e40f-872b-4c84-8251-6acbb01e5bc5", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"version\": 0,\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsVoice\": \"simran\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8700196f-f220-4094-bd93-6a75defd7526", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79aad316-8ef4-40e9-8913-683413e0bbd1", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ae16aec-1ded-48b6-a3bf-a2a2334db944", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79184dff-8b54-43f1-9878-9cc279f42674", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a82f0a25-ff03-4aa5-a638-f6d263357a18", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69c7dc7a-b332-431f-9fb8-8c8532be0a05", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3113d91-1706-4b2f-9284-f00eeb91f487", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "703bacd6-23f7-46f5-9de6-fadfc8f901a8", "name": "Version history, newest first", "request": { "name": "Version history, newest first", "description": { "content": "Versions are kept forever. Each entry is exactly what ran on the calls pinned to it.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50", "description": "How many results to return. 1-100, defaulting to 50." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a6df7763-5142-4a70-a5ac-11bc66ab245f", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"version\": 0,\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsVoice\": \"simran\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70289859-4f07-4df3-ba9d-648c75ba9f1a", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84a30489-ccbb-4843-b18c-9dfd4d149dfd", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c6abdd1-b566-4cef-ab32-55523d3fe497", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58ead7c7-10aa-4362-b9d2-59646d2d8a38", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbb4dfe-9179-492d-80b1-24e866e6f670", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab31d825-d80f-4706-9def-1a33bd5491ee", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b7c9a7f-9970-4f92-9e03-be6fb9baf8ee", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a3d2ecc-9e58-4e56-8502-edeedd7488e8", "name": "One version by its number", "request": { "name": "One version by its number", "description": { "content": "The immutable content of a single published version — prompt, voice, tools and the knowledge bases it was published with. This is how a finished call stays explainable after the agent has moved on.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1dc24b0e-5639-49f6-8574-60a79215ea7f", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"callSettings\": {\n \"background\": {\n \"sound\": \"none\",\n \"volume\": 0.3\n },\n \"hangupLine\": {\n \"text\": \"Thanks for your time. Goodbye.\"\n },\n \"maxCallSeconds\": 600,\n \"nudges\": {\n \"enabled\": true,\n \"hangupAfter\": true,\n \"steps\": [\n {\n \"afterSeconds\": 15,\n \"line\": {\n \"text\": null\n }\n }\n ]\n },\n \"openingLine\": {\n \"text\": \"Hi {{customer_name}}, I’m calling from Acme about your order.\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"windowSeconds\": 30\n }\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"evaluationCriteria\": [\n {\n \"id\": \"confirmed_order\",\n \"name\": \"Confirmed the order\",\n \"prompt\": \"Did the customer explicitly confirm they still want the order?\"\n }\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"inputVariables\": [\n {\n \"default\": \"there\",\n \"description\": \"The customer’s first name, as it appears on the order.\",\n \"name\": \"customer_name\"\n }\n ],\n \"knowledgeBaseIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"llmModel\": \"gemini-2.5-flash\",\n \"outputVariables\": [\n {\n \"description\": \"Which day the customer agreed to take delivery. Leave empty if they did not commit to one.\",\n \"enumValues\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"name\": \"delivery_day\",\n \"type\": \"enum\"\n }\n ],\n \"purpose\": \"promotional\",\n \"systemPrompt\": \"You call customers to confirm a cash-on-delivery order…\",\n \"tools\": [\n {\n \"connectionId\": \"b4e6d8a1-9c3f-4b2e-8d7a-1f0e9c8b7a6d\",\n \"description\": \"Call this once the customer has agreed to a specific delivery date and time window.\",\n \"http\": {\n \"auth\": {\n \"header\": \"x-api-key\",\n \"in\": \"header\",\n \"name\": \"api_key\",\n \"secondary\": {\n \"in\": \"header\",\n \"name\": \"x-acme-secret\",\n \"secretId\": \"7c2b8e5d-1a3f-4e6b-8c9d-0e1f2a3b4c5d\"\n },\n \"secretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"type\": \"bearer\"\n },\n \"bodyFormat\": \"json\",\n \"bodyRoot\": \"object\",\n \"headers\": {\n \"x-acme-source\": \"tone\"\n },\n \"method\": \"POST\",\n \"timeoutMs\": 5000,\n \"url\": \"https://api.acme.example/v1/deliveries\"\n },\n \"mock\": {\n \"enabled\": true,\n \"response\": \"{\\\"status\\\":\\\"booked\\\",\\\"slot\\\":\\\"2026-09-02T10:00:00+05:30\\\"}\"\n },\n \"name\": \"book_delivery_slot\",\n \"parameters\": [\n {\n \"description\": \"The agreed date as YYYY-MM-DD.\",\n \"name\": \"delivery_date\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"preset\": \"cal.com/book\",\n \"speech\": {\n \"en-IN\": \"Let me check that for you.\",\n \"hi-IN\": \"मैं अभी देखता हूँ।\"\n }\n }\n ],\n \"ttsOptions\": {\n \"pace\": 1\n },\n \"version\": 0,\n \"voice\": {\n \"languages\": [\n \"hi-IN\",\n \"en-IN\"\n ],\n \"sttLanguage\": \"auto\",\n \"sttMode\": \"transcribe\",\n \"sttModel\": \"saaras:v3\",\n \"ttsModel\": \"bulbul:v3\",\n \"ttsVoice\": \"simran\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d6183ce-6694-4cef-9249-e32aeb837c8b", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c8c01e0-9e12-4bc3-9536-ab0363015b3c", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "611a98ac-7a3f-4301-a170-a5c36052fdb5", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2078f182-d15a-42b6-9cb5-db54c4471f73", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e4b2ba0-da93-4e1d-b805-2759201cc9d3", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "agents", ":id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The agent's id." }, { "disabled": false, "type": "any", "value": "", "key": "version", "description": "(Required) Which version to read, counting from 1." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9bdbbcba-94bd-455d-ab4f-6b00a6d95558", "name": "catalog", "description": { "content": "Which speech models, voices and languages an agent may be set to. Fetched from the provider, so treat every value as an open set.", "type": "text/plain" }, "item": [ { "id": "44a3c970-dd94-4650-9856-d692ab8e27f0", "name": "Sarvam models, languages and voices available to an agent", "request": { "name": "Sarvam models, languages and voices available to an agent", "description": { "content": "The legal values for an agent speech stack, fetched from the provider rather than hardcoded — so this changes without a deploy and every list here is an OPEN set. 🔴 A voice belongs to a specific model version: the `(ttsModel, ttsVoice)` pair is the constraint, not the voice name, and each speaker names the model it belongs to. A retired voice is marked deprecated rather than removed, so an agent already using one keeps working.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "catalog", "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5ed96695-7ffe-4f96-a4a5-f1d93fae1d98", "originalRequest": { "url": { "path": [ "v1", "catalog", "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"defaultAgentLanguages\": [\n \"en-IN\",\n \"hi-IN\"\n ],\n \"fetchedAt\": \"2026-08-25T04:00:00Z\",\n \"languageNames\": {},\n \"llm\": {\n \"defaults\": {\n \"model\": \"gemini-2.5-flash\"\n },\n \"models\": [\n {\n \"deprecated\": true,\n \"description\": \"Latest speech model. Adds `temperature`; drops `pitch` and `loudness`.\",\n \"id\": \"gemini-2.5-flash\",\n \"label\": \"Bulbul v3\",\n \"provider\": \"gemini\"\n }\n ]\n },\n \"previewSamples\": {},\n \"source\": \"spec\",\n \"stt\": {\n \"autoDetect\": \"auto\",\n \"defaults\": {\n \"language\": \"auto\",\n \"mode\": \"transcribe\",\n \"model\": \"saaras:v3\"\n },\n \"languages\": [\n \"en-IN\",\n \"hi-IN\",\n \"gu-IN\",\n \"ta-IN\"\n ],\n \"models\": [\n {\n \"deprecated\": true,\n \"description\": \"Latest speech model. Adds `temperature`; drops `pitch` and `loudness`.\",\n \"id\": \"saaras:v3\",\n \"label\": \"Bulbul v3\",\n \"supportsModes\": true\n }\n ],\n \"modes\": [\n {\n \"description\": \"Transcribes faithfully in the language spoken, without translating.\",\n \"id\": \"transcribe\",\n \"label\": \"Bulbul v3\"\n }\n ]\n },\n \"tts\": {\n \"defaults\": {\n \"model\": \"bulbul:v3\",\n \"speaker\": \"anushka\"\n },\n \"languages\": [\n \"en-IN\",\n \"hi-IN\",\n \"gu-IN\"\n ],\n \"models\": [\n {\n \"deprecated\": true,\n \"description\": \"Latest speech model. Adds `temperature`; drops `pitch` and `loudness`.\",\n \"id\": \"bulbul:v3\",\n \"label\": \"Bulbul v3\",\n \"options\": [\n {\n \"default\": 1,\n \"description\": \"Latest speech model. Adds `temperature`; drops `pitch` and `loudness`.\",\n \"key\": \"pace\",\n \"label\": \"Bulbul v3\",\n \"max\": 2,\n \"min\": 0.5,\n \"step\": 0.1\n }\n ]\n }\n ],\n \"sampleRates\": [\n 8000,\n 16000,\n 22050\n ],\n \"speakers\": [\n {\n \"deprecated\": true,\n \"gender\": \"female\",\n \"id\": \"simran\",\n \"label\": \"Bulbul v3\",\n \"models\": [\n \"bulbul:v3\"\n ]\n }\n ]\n },\n \"version\": \"c7f2a9e1b4d6\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27ca0a3-de49-4f55-93d6-bfaba61e3e4a", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "catalog", "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422ae4d2-f4ac-4b6e-80c9-5129918a27f6", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "catalog", "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf8a747d-2dd8-415e-b63f-d1924db68f9d", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "catalog", "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3ea61b8-2a78-460e-b347-0f095416251c", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "catalog", "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cdf3ec05-69e1-4354-a77a-73e7b76662c7", "name": "knowledge", "description": { "content": "Knowledge bases an agent answers from. Builds are asynchronous — wait for the webhook rather than polling.", "type": "text/plain" }, "item": [ { "id": "7f3e553b-772e-4e6f-b277-9ad9a60abec0", "name": "List the organization’s knowledge bases", "request": { "name": "List the organization’s knowledge bases", "description": { "content": "Each with its derived status, document count and size. Status is computed, not stored: a base is `empty`, `indexing`, `ready` or `error` based on what its last build did.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8771fbdb-e98b-47ad-a10e-6fc2cd96ccc7", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"agentCount\": 2,\n \"chunkCount\": 187,\n \"compiledTokens\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"deliveryMode\": \"inline\",\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"docCount\": 4,\n \"error\": null,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Shipping and returns policy\",\n \"status\": \"empty\",\n \"totalBytes\": 248311,\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42fcaeb3-983f-4f82-964f-4c920f11ab35", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11fd6484-f08d-4552-9a4e-b1d6a8bbf0b1", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b480ffe6-5277-45c6-ae44-fed9b6cf7977", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ce8ddb2-4f95-45d3-88fe-506fc8686d12", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d15b41b-3591-4147-8f9f-13b912eda22d", "name": "Create a knowledge base", "request": { "name": "Create a knowledge base", "description": { "content": "Creates it empty. Add documents, wait for the build, then attach it to an agent.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31b541ba-07df-4eb3-80c7-f93e29ccb179", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentCount\": 2,\n \"chunkCount\": 187,\n \"compiledTokens\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"deliveryMode\": \"inline\",\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"docCount\": 4,\n \"error\": null,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Shipping and returns policy\",\n \"status\": \"empty\",\n \"totalBytes\": 248311,\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43fe6dae-30b5-4cc3-827c-8b9d6f1016e1", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e11e73b-8ce2-49cd-acde-9a6b2085d2fc", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c182cfc-8a6c-44c8-9bed-8e903df99219", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1fbadd5-5d5a-4664-bbe4-ddbcb4d9f937", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3a84d6a-250e-4074-bf15-554ec1589ba7", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a23f3b-b30a-416a-939f-ffa8487c2353", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dac0457-504b-4a34-90c7-7a9670360f9b", "name": "Delete a knowledge base and everything in it", "request": { "name": "Delete a knowledge base and everything in it", "description": { "content": "Documents and the built index go with it. Agents attached to it simply stop having it — they keep working.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5c8efd99-9eb5-4ba1-8fc4-70785ef4ded6", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b870dd09-7b5f-4be7-bb27-cd8c248ea0bd", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a5ee27d-bc3a-4bc5-91f5-bb818569bc14", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7044f70-7ba3-43d6-8f37-2a66546a4b36", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a330df2-865e-43ab-a5ca-48102748db0a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5605af4c-557e-4f88-9779-9d649a1536cd", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4642fc09-2e28-4d11-bbfd-2d85df8f0c19", "name": "Get a knowledge base", "request": { "name": "Get a knowledge base", "description": { "content": "Includes the chunk count from the last successful build — the number of retrievable passages an agent can actually draw on.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c5e476d8-c4ed-49cc-9710-5ecf3a3cd9f5", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentCount\": 2,\n \"chunkCount\": 187,\n \"compiledTokens\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"deliveryMode\": \"inline\",\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"docCount\": 4,\n \"error\": null,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Shipping and returns policy\",\n \"status\": \"empty\",\n \"totalBytes\": 248311,\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a33f7191-3054-49f9-8612-1253b7a97a17", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a4a462-942d-4729-ae0f-21900f9f6997", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9597b7ab-4ad9-4327-80c9-5df90ce83d5a", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7446e362-38d3-4f27-a536-f035811ec22a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aabba01a-69fa-48e5-b019-d81c98af6754", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d15ffd64-ec4d-440a-a3e1-27b0fa854396", "name": "Update a knowledge base or its attached agents", "request": { "name": "Update a knowledge base or its attached agents", "description": { "content": "`agentIds` is the COMPLETE attachment set, not a delta: send the full list every time, omit the key to leave attachments untouched, send an empty array to detach it from everything.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "252d38f7-6055-47ec-a415-abd4d21ef032", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentCount\": 2,\n \"chunkCount\": 187,\n \"compiledTokens\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"deliveryMode\": \"inline\",\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"docCount\": 4,\n \"error\": null,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Shipping and returns policy\",\n \"status\": \"empty\",\n \"totalBytes\": 248311,\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf18e36c-f374-4c27-a78f-11447ba797d3", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "530de337-56c7-46f4-970b-6a1f704687f6", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4b8d944-557e-49ee-9d6d-4d48e9464866", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1902bc-e84f-4f42-afc5-ded15ae2c2b9", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f22c9c65-8363-444a-b1b4-227b563881af", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7903962c-9e15-4e68-b0e7-8e290591ef1a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7737100d-568b-4feb-ad80-023f5e56642d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ],\n \"description\": \"Delivery timelines, COD rules and the returns window.\",\n \"name\": \"Shipping and returns policy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f3458f7-7443-423c-8345-56a936b6e5f8", "name": "Agent ids attached to this knowledge base", "request": { "name": "Agent ids attached to this knowledge base", "description": { "content": "The other end of the same join `PATCH /v1/agents/{id}` edits with `knowledgeBaseIds`.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "42acb29c-08c2-4290-a8b5-47bdc5671a46", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentIds\": [\n \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af749b5c-eea5-468a-beed-bc2477d1811c", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf1c2fc9-04b9-4bca-b20e-b27e9e1a34ca", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47aac29f-8acf-4e8e-af7c-41119af9438e", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac30a923-d264-4d18-aa7c-ae32cc9abb9b", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc249c4d-89a1-45ea-add8-2868aaa45dba", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54cb4e2e-d859-4c81-94e0-ef208258b56a", "name": "List documents in a knowledge base", "request": { "name": "List documents in a knowledge base", "description": { "content": "Each with its own indexing state, so you can tell one failing document from a failing base.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "53ef01b6-2275-406d-a2ea-d61ebc3cddf5", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"byteSize\": 0,\n \"charCount\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"error\": null,\n \"filename\": \"returns-policy.pdf\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"kind\": \"pdf\",\n \"mimeType\": \"application/pdf\",\n \"status\": \"awaiting_upload\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba2e9ff6-8ca4-4427-a7bd-1e3970aea569", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c12dc5-f5f7-4427-b7bf-ee23f1103e93", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d6779d6-5bac-45e1-95ae-b71e8e0d67d6", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d16d307a-4564-4040-8140-dc6ac0a32d4c", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c82131-5ceb-4445-af01-5ffb55ba4a0e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5341ed84-2f17-4d23-b818-504520d41025", "name": "Get a presigned URL to upload a document", "request": { "name": "Get a presigned URL to upload a document", "description": { "content": "Phase one of a two-phase upload: declare the file, PUT the bytes to the URL you get back, then confirm. `contentLength` is signed into the URL and must match exactly — a presigned PUT that does not pin the length is an unbounded write.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"contentType\": \"\",\n \"contentLength\": \"\",\n \"kind\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ec15be41-7249-47d6-a901-602d1b10c1b4", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"documentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"expiresInSeconds\": 0,\n \"headers\": {},\n \"url\": \"https://uploads.usetone.ai/kb/9f1c2d84…?signature=…\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8df95324-2da2-4006-b093-6ea2d033fd15", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ad29c2e-c6e1-4e46-9a4a-15cdda49d71c", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385a2baa-cdff-46a2-9b60-4f941a9f5f48", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aa41fa7-203c-4cdc-a498-96e73763261c", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "816370f3-bee2-4b67-910d-6adfe3e54466", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e217c4c-f0a2-4bde-95f4-520cb58e82f1", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f4f1d2-ac52-4fe5-909b-21e29b94e455", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentLength\": 248311,\n \"contentType\": \"application/pdf\",\n \"filename\": \"returns-policy.pdf\",\n \"kind\": \"file\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef62949f-563b-4388-afdf-29a99483b4d4", "name": "Import a public web page into a knowledge base", "request": { "name": "Import a public web page into a knowledge base", "description": { "content": "Fetches and indexes a URL rather than a file. Must be reachable from the open internet; private and link-local addresses are refused, and refused again after DNS resolution.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ad92edd1-4742-4656-9fb7-fc4fbba7abf8", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"byteSize\": 0,\n \"charCount\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"error\": null,\n \"filename\": \"returns-policy.pdf\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"kind\": \"pdf\",\n \"mimeType\": \"application/pdf\",\n \"status\": \"awaiting_upload\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "193cd549-7308-46d9-b1c9-bc0d9587116a", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d39f48-d54f-4f10-8497-96d22ee487cd", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2de9cd45-ce67-429d-9874-0165d3b97f22", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228ed35e-15ea-4026-88f7-75c63a3ff790", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d8e776d-12e3-44ac-b9e6-647c97bc5447", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80d011f5-b485-48e8-a4da-6c9a3d319897", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db05bd80-d205-4a4d-99c0-ca3da8696f81", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/help/returns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df91edab-d149-426b-a394-4d63fcfbeace", "name": "Remove a document from a knowledge base", "request": { "name": "Remove a document from a knowledge base", "description": { "content": "The index is rebuilt without it. Until that build succeeds, the old index keeps serving.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "07e40a6c-7362-4e95-8348-87e47d9d2fdb", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "677cfe87-86d4-453a-993a-281ebb5580ec", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f23e185-f440-4f10-9262-1dd44da109f7", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd2e1de-0850-4abe-9dd9-40766fdacf0a", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b179d3d8-6ca1-4072-82e1-43972a5cb3e6", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "677f1480-b4b3-4645-ad4d-0c65b985342f", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e701a3a-3da2-47b0-b8cc-d01d6e495818", "name": "Confirm an upload finished and queue it for indexing", "request": { "name": "Confirm an upload finished and queue it for indexing", "description": { "content": "Phase two. Nothing is trusted until here: the object is re-read and its real size and type checked against what you declared. Indexing is asynchronous — wait for `knowledge.build.completed` rather than polling.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a4125c64-1047-4d8d-b498-9a650ee63f01", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"byteSize\": 0,\n \"charCount\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"error\": null,\n \"filename\": \"returns-policy.pdf\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"kind\": \"pdf\",\n \"mimeType\": \"application/pdf\",\n \"status\": \"awaiting_upload\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21303389-c83e-4db6-abb1-d0df3787b2a4", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c871e2-5d09-4b24-abf5-5d16260bb93b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c949597-256a-499b-9d16-680fad30081e", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1362011c-a810-44b9-bcf8-dd7a02944747", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cecc9a3d-851b-436c-8626-872976314ae8", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "documents", ":documentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." }, { "disabled": false, "type": "any", "value": "", "key": "documentId", "description": "(Required) The document's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b13fbdc1-3a44-4451-89f1-56e12d6ffdf6", "name": "Preview what an agent would retrieve, and answer, for a question", "request": { "name": "Preview what an agent would retrieve, and answer, for a question", "description": { "content": "Runs the SAME retrieval a live turn runs, so what you see here is what the agent would get. Optionally generates the answer a caller would hear. `degraded: true` means embeddings were unavailable and this fell back to keyword search alone — the results are real, just weaker.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"answer\": true,\n \"limit\": 3\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3c892b5c-044a-4e6a-88ae-4d5eb71f817e", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"answer\": \"You can return unopened items within 30 days for a full refund.\",\n \"answerScope\": \"inline\",\n \"answerStatus\": \"ok\",\n \"degraded\": true,\n \"results\": [\n {\n \"documentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"headingPath\": \"Returns > Timeframe\",\n \"matchedText\": true,\n \"matchedVector\": true,\n \"score\": 0,\n \"text\": \"Unopened items may be returned within 30 days of delivery for a full refund.\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7d854b9-4b4a-484b-9ba0-ee7758c21c15", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79854617-67ce-4fc8-a911-c34c6f6bd303", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab2f12b3-22df-4992-ae79-67b27220470d", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1960c203-2a39-4035-b5d7-9ec6339a651e", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a713e3c7-0367-487f-a285-faa4939da7cb", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37009dd1-54f7-4679-90fc-44ca9bd3365b", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b3e23f6-5312-490c-b08a-75e8ce51582e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "knowledge-bases", ":id", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The knowledge base's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": true,\n \"limit\": 3,\n \"query\": \"How long do I have to return an item?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5bb83bff-b594-4bc0-96e8-c9faa203abf7", "name": "numbers", "description": { "content": "Search, buy, route and release +91 numbers. Routing mode decides whether a Tone agent answers or your own stack does.", "type": "text/plain" }, "item": [ { "id": "d88bc308-7f2a-485c-8c40-08c2ef81008a", "name": "List the organization’s numbers", "request": { "name": "List the organization’s numbers", "description": { "content": "Every number you hold, in any state. A `suspended` number still counts: suspension is unpaid rent, not a release, and it keeps your claim on the line.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7e810b7-7f69-4dd2-8406-9d4aca629d4a", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "291ed193-b9f4-45ac-af01-a41344d0c060", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "480361fa-4394-4014-ad4d-6bfec1e7443a", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8101be07-ff12-404d-966d-6ffd07ef3088", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebeed275-3c92-473b-a7b6-86b66d3a834f", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e0762f9-0bce-44da-8580-a3d7c45afb55", "name": "Assign a sandbox number — 140/160 require an approved DLT PE ID", "request": { "name": "Assign a sandbox number — 140/160 require an approved DLT PE ID", "description": { "content": "Allocates a free number from the sandbox pool. No carrier is contacted and nothing is charged — this is the number you build against before any paperwork exists.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"agentId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "80d3438d-322b-474b-a386-8dfccca9e966", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7b78a17-9940-4816-9fad-491b17ad0f79", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e05932f-0958-4ddd-9abc-50a4e17d3e57", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a96a42-a57f-4a4f-866f-d44455d4979b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "081e0564-ae49-4bb0-9b57-b1e34a3631ab", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "632cead4-34f7-406a-8643-f760ad08d607", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9704df33-39b2-4293-871d-214f5e6393a0", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"series\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7b1414a-50a9-4e23-8a73-1af3233d9694", "name": "Search the carrier for numbers available to buy", "request": { "name": "Search the carrier for numbers available to buy", "description": { "content": "Live carrier inventory, so results go stale — a number can be taken between this call and your purchase, which is a `409 number_unavailable`. Only regular numbers are offered: the 140 and 160 series are not purchasable through any carrier API.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "number_type", "value": "landline", "description": "Which kind of number to search for. Open set — handle an unrecognised value rather than throwing. Today: `landline`, `mobile`, `tollfree`." }, { "disabled": false, "key": "region", "value": "", "description": "Telecom circle code, uppercase — list them with GET /v1/numbers/regions. Omit to search the carrier default pool." }, { "disabled": false, "key": "contains", "value": "", "description": "Digits the number must contain. Digits only — carriers treat other characters inconsistently." }, { "disabled": false, "key": "sms", "value": "", "description": "Only numbers that can also send SMS. Note that SMS itself additionally requires DLT registration." }, { "disabled": false, "key": "limit", "value": "20", "description": "How many results to return. 1-50, defaulting to 20." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b9e7273a-61ab-493d-a05d-d05fc000d3ca", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"e164\": \"+918045678901\",\n \"numberType\": \"landline\",\n \"region\": \"KA\",\n \"rentalPaise\": 0,\n \"setupPaise\": 0,\n \"totalPaise\": 0\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50f9873f-f6a7-46bd-8b85-e7cadfad12b2", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d98bbfa7-793e-46f3-bda5-85656d5d8e00", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "233252a1-b16a-4279-a774-5115a16e781b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "188436e8-1896-47c7-bc95-bd5ce57d9c01", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402963f7-cd0d-46fa-9cdc-51159f2347f7", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f4fcba5-a3d7-4222-9f36-c5596b8a5b72", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "number_type", "value": "landline" }, { "key": "region", "value": "KA" }, { "key": "contains", "value": "4567" }, { "key": "sms", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50a8c471-f4dc-43f3-98fb-3868977788f8", "name": "Whether this organization can buy a number right now", "request": { "name": "Whether this organization can buy a number right now", "description": { "content": "Answers before you try: whether business verification is complete and whether the wallet covers a purchase. Cheaper than a `403` and easier to show in a UI.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e42f360-d552-4b76-971f-051066654020", "originalRequest": { "url": { "path": [ "v1", "numbers", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"balancePaise\": 0,\n \"verified\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff558f8f-cf38-49b5-932e-164b31f675c6", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c59ffa45-b7a4-428d-bf8d-7e1c758c89cb", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46cb6154-0642-48e1-8714-057a22c16c32", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1f93048-2b16-4d4a-8738-fd05f1896b57", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9dd88b8d-01b9-4d5e-957e-035ece12898d", "name": "Buy a number — requires completed business verification and an Idempotency-Key", "request": { "name": "Buy a number — requires completed business verification and an Idempotency-Key", "description": { "content": "🔴 `Idempotency-Key` is REQUIRED — without it this returns `400`. A duplicate purchase buys a second number and starts a second monthly rental, and a timeout is indistinguishable from a purchase that never happened, so retry with the SAME key. The number arrives unrouted; bind it to an agent with a PATCH. Setup and the first month are debited immediately.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164\": \"\",\n \"agentId\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1cc551be-f6a6-437e-85cd-dd6bbd76311f", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "`true` when this response is a replay of an earlier request with the same `Idempotency-Key`, rather than fresh work.", "key": "Idempotent-Replayed", "value": "string" }, { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb77811e-1de9-4b72-a82a-168c78d96bdb", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c86b1fd-1528-4ea5-8b3a-10afaf02a37d", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2395c14d-4134-4eaf-8008-3a49928f2d75", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd624d68-f413-486a-bbba-f3f8d7a39111", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84fc31d2-05a3-4145-96e2-9943e29421fb", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93da65dc-8ea4-4ad8-a331-5564550ccec5", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"e164\": \"+918045678901\",\n \"label\": \"Support line — Bengaluru\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76e69dc9-9b9e-443d-bc61-d6dffc27ffdc", "name": "Telecom circles that can be searched", "request": { "name": "Telecom circles that can be searched", "description": { "content": "The circle codes to pass as the `region` filter when searching.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cb3f1b50-9108-4fa2-b1f3-28ddb895676e", "originalRequest": { "url": { "path": [ "v1", "numbers", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"code\": \"KA\",\n \"label\": \"Karnataka\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bfd10f6-d674-4d8e-97ad-6c429298b771", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "650bded3-7b8d-4c50-a97b-793c47502334", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11cf6556-1514-45e6-a8e3-4ce7f28f5cb2", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f799c4e9-7d11-4955-a4d3-014fc9d4ca8e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d6b2d78-366f-45a4-96e9-9e4401d2425b", "name": "Release a number back to the carrier — permanent", "request": { "name": "Release a number back to the carrier — permanent", "description": { "content": "🔴 There is no undo. The number returns to general inventory and can be bought by anyone. Rental stops. If you are only trying to stop paying, note that an unpaid number suspends rather than releases, and reactivates on its own once the wallet can cover it.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "32cfbfba-aa12-441e-9bf1-62c7036ed634", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b88204f3-f4b2-4b76-8436-800e0de0942f", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e4f1877-d1e6-459a-9d51-0cd5a6b10bfc", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c61fd4e-60a1-4f52-afcb-d91d3255531f", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cec9710e-e8d2-4221-9c49-29a11d150d6e", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2826c84-e9b9-4651-b93c-7b1341a7fdd2", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9911929a-b5f8-4f2f-a1be-0c40f4abb9ca", "name": "Rename a number or bind it to an agent", "request": { "name": "Rename a number or bind it to an agent", "description": { "content": "Also where you switch who answers it. Send `null` to clear a field; omit the key to leave it alone. Switching to a BYO routing mode KEEPS the bound agent — it is ignored while BYO and restored when you switch back.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"agentId\": \"\",\n \"label\": \"\",\n \"mediaEndpoint\": {\n \"type\": \"\",\n \"url\": \"\",\n \"authSecretId\": \"\",\n \"customParameters\": {\n \"key_0\": \"\"\n },\n \"format\": \"\",\n \"sampleRate\": \"\"\n },\n \"recordCalls\": \"\",\n \"routingMode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7b07ff39-56d7-4f17-9bb2-2097a621effa", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "886dd62d-8d68-4080-ad47-9bfa75452b69", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65bd35df-02cc-4935-8514-26aa02d96bbf", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27eef084-a3e2-44c6-abe2-1411623fddfa", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eeeeccd-2eb2-4663-99d9-21606ba535ef", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5df0d4c-8afb-40cc-a101-d48bc10df007", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0c8182b-23fb-4c18-bd45-62c258441662", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3c347e2-2e64-4b2e-a19b-c1d02140920a", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.example.com/tone\"\n },\n \"recordCalls\": true,\n \"routingMode\": \"tone_agent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f787b1a-3ae6-4299-8aed-0d2cac680611", "name": "Point a number at the inbound flow, or unroute it", "request": { "name": "Point a number at the inbound flow, or unroute it", "description": { "content": "Repairs routing for numbers bought before inbound existed, or after a dev tunnel changed hostname. Talks to the carrier, so it is a POST rather than part of PATCH — rebinding an agent must not fail during a carrier outage.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a3568c83-e42b-4f79-97c2-6a2cfb67fc41", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "197ab958-1051-46e8-bf75-594d9b385e69", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24540bcc-1481-4a91-a8ef-0e97f9562a00", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb8e5dde-9b1d-47bb-9ccd-aa2b11712e50", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56dff197-064a-452e-9bb3-8f488b1471d6", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b18bdc25-0bfd-4e22-8f6d-3ef5040bac6f", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9566bb42-22ec-41e3-ab00-2cd0d20d18a2", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63761d1c-26d3-429d-aacb-56da3784b82d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c961009f-8c59-43c9-9675-79241512faf8", "name": "Remove the SIP trunk pair and return the number to tone_agent mode", "request": { "name": "Remove the SIP trunk pair and return the number to tone_agent mode", "description": { "content": "Tears down the trunk. The number itself is kept — this is not a release.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9d23a21-20b0-4d1d-973a-58f632ccd67b", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afa995c4-574f-4256-a7e1-253b1c5c732f", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c9e3da-fd41-4b04-95e9-62c2a92bdb08", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bd609c3-744b-423c-b52d-2cf73d146aee", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f64e06d1-38f7-4f8c-a57a-9ac60512e13c", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac506e89-7f00-4c1d-8f6e-0d12cdd3c3f0", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f44a0713-7b46-4d16-a95e-745d09a42c98", "name": "Provision a SIP trunk pair for the customer's voice platform", "request": { "name": "Provision a SIP trunk pair for the customer's voice platform", "description": { "content": "Vobiz numbers only. Inbound calls are sent to `sipUri`; outbound termination credentials are returned ONCE in this response and never stored. The number switches to byo_sip.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e0cf9a3-7ac4-4ece-86f8-c3e84a7ffe7c", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"number\": {\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"capabilities\": {\n \"sms\": false,\n \"voice\": true\n },\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"currency\": \"INR\",\n \"e164\": \"+918045678901\",\n \"environment\": \"live\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\",\n \"inbound\": \"ready\",\n \"label\": \"Support line — Bengaluru\",\n \"mediaEndpoint\": {\n \"authSecretId\": \"3f1a7f6e-2b4c-4d1e-9a8b-5c6d7e8f9a0b\",\n \"customParameters\": {\n \"tenant\": \"acme\"\n },\n \"format\": \"linear16\",\n \"sampleRate\": 16000,\n \"type\": \"static\",\n \"url\": \"wss://media.acme.example/tone\"\n },\n \"nextRentalAt\": \"2026-09-01T06:30:00Z\",\n \"numberType\": \"landline\",\n \"provider\": \"exotel\",\n \"purchasedAt\": \"2026-08-01T06:30:00Z\",\n \"recordCalls\": true,\n \"region\": \"KA\",\n \"releasedAt\": null,\n \"rentalPaise\": 50000,\n \"routed\": true,\n \"routingMode\": \"tone_agent\",\n \"series\": \"regular\",\n \"setupPaise\": 50000,\n \"sipTrunk\": {\n \"credentialId\": \"cred_5a1b\",\n \"inboundTrunkId\": \"tin_2c7d\",\n \"originationSipUri\": \"sip:acme@sip.livekit.cloud\",\n \"originationUriId\": \"ouri_9f2c\",\n \"outboundTrunkId\": \"tout_8e3f\",\n \"provider\": \"vobiz\",\n \"terminationDomain\": \"acme.sip.vobiz.example\",\n \"terminationRealm\": \"vobiz.example\",\n \"terminationUsername\": \"acme-out\",\n \"transport\": \"tls\"\n },\n \"status\": \"pending\"\n },\n \"termination\": {\n \"domain\": \"acme.sip.vobiz.example\",\n \"password\": \"K7x2QpL9vR4nT1cW\",\n \"realm\": \"vobiz.example\",\n \"username\": \"acme-out\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0421c8c8-b2b3-437a-9126-e37f9622d0e2", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0809fd4-7fb1-4250-bf79-1453e45b2dcb", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e058ef6-da72-4c24-99a7-2e8bcededbe7", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "475de53b-8d16-46eb-89b1-c2f193560fe4", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8818afea-c16e-4bca-a4a6-4fc033f2d25c", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7421f9f6-d748-4012-8f2e-23af3730c9f3", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "127d738e-629e-4e17-8d9a-4df9fa9c3d6e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "numbers", ":id", "sip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The number's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sipUri\": \"sip:agent@sip.example.com;transport=tls\",\n \"transport\": \"tls\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "47ba7c1f-3abc-4740-80bd-89ba7b177e31", "name": "calls", "description": { "content": "Place a call, then read its outcome, transcript and recording.", "type": "text/plain" }, "item": [ { "id": "bbde6f5b-26a2-41fd-abdb-8492dd39e0ff", "name": "List calls, newest first (cursor-paginated)", "request": { "name": "List calls, newest first (cursor-paginated)", "description": { "content": "Every call, inbound and outbound, including campaign calls. Filter by agent, number, campaign, direction, disposition or date range. A campaign filter here returns every ATTEMPT including retries, which the recipient list cannot give you.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many calls to return. 1-100." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor — pass `meta.pagination.cursor` from the previous response. Its contents are an implementation detail; do not parse or construct one." }, { "disabled": false, "key": "agent_id", "value": "", "description": "Only calls run by this agent, across every one of its versions." }, { "disabled": false, "key": "number_id", "value": "", "description": "Only calls placed from, or received on, this number." }, { "disabled": false, "key": "campaign_id", "value": "", "description": "Every call this campaign placed, retries included — which is what the recipient list cannot give you, since a recipient row names only its LAST attempt." }, { "disabled": false, "key": "direction", "value": "", "description": "Which way the call went. Open set — handle an unrecognised value rather than throwing. Today: `inbound`, `outbound`." }, { "disabled": false, "key": "channel", "value": "", "description": "How the call was carried. `browser` is the in-dashboard microphone test only; every dial the API places is `pstn`. Open set — handle an unrecognised value rather than throwing. Today: `browser`, `pstn`." }, { "disabled": false, "key": "status", "value": "", "description": "Where the call is in its lifecycle. Open set — handle an unrecognised value rather than throwing. Today: `queued`, `in_progress`, `ended`." }, { "disabled": false, "key": "disposition", "value": "", "description": "How the call finished. Only set once `status` is `ended`. Open set — handle an unrecognised value rather than throwing. Today: `answered`, `no_answer`, `busy`, `failed`, `voicemail`, `unknown`." }, { "disabled": false, "key": "environment", "value": "", "description": "Ignored when you authenticate with an API key: the key's own prefix pins the environment, so a `tone_test_` key structurally cannot read live calls." }, { "disabled": false, "key": "from", "value": "", "description": "Inclusive lower bound on `createdAt`. A bare date (`2026-08-01`) is accepted and read as midnight UTC." }, { "disabled": false, "key": "to", "value": "", "description": "Exclusive upper bound on `createdAt`. Must be later than `from`." }, { "disabled": false, "key": "include_unstarted", "value": "", "description": "Include rows for calls that never started — an abandoned browser test dialog mints one, so they are hidden by default." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9927e09-753d-4ae3-b0e4-75cd0b883bcb", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"agentVersion\": 3,\n \"billedPaise\": 600,\n \"campaignId\": null,\n \"channel\": \"pstn\",\n \"compliance\": \"passed\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"direction\": \"outbound\",\n \"disposition\": \"answered\",\n \"durationSeconds\": 45,\n \"endReason\": \"agent_ended\",\n \"endedAt\": \"2026-08-25T09:15:11Z\",\n \"environment\": \"live\",\n \"evaluations\": {},\n \"hasRecording\": true,\n \"hasTranscript\": true,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"initiator\": {\n \"id\": \"key_8f14a2c9\",\n \"type\": \"api_key\"\n },\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\"\n },\n \"outputs\": {\n \"confirmed\": true,\n \"delivery_day\": \"Thursday\"\n },\n \"peer\": \"+919876543210\",\n \"quality\": {\n \"answerP50Ms\": 480,\n \"perceivedP50Ms\": 0,\n \"turns\": 6\n },\n \"ratePaisePerMinute\": 600,\n \"startedAt\": \"2026-08-25T09:14:26Z\",\n \"status\": \"ended\",\n \"summary\": \"Customer confirmed the order and asked for Thursday delivery.\",\n \"variables\": {\n \"customer_name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n },\n \"verdict\": \"success\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d640921-e475-4d3b-b3b1-d0935ce3cc28", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaac5b49-9242-44ca-909f-d1267d24d0ea", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3cdc3f0-a076-4a47-920a-dff0dd07a319", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60b3ab9a-93be-495c-b0cd-35581797b104", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5747eea-2cef-46fc-8ee5-760db40f33f4", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bda50db-21b4-4c4a-8be8-b8ba1d08737a", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc00c8e4-7cc6-440f-89dc-aab03add7a49", "name": "Place an outbound call (runs the compliance gate)", "request": { "name": "Place an outbound call (runs the compliance gate)", "description": { "content": "Runs the full pre-dial compliance gate inside the same transaction, so a refusal is a `403` with the audit rows already written and no carrier contacted. Requires `agentId` on a number that routes to a Tone agent and forbids it on a BYO number. Over your concurrent-call quota this returns `429` BEFORE the gate runs, so no verdict is recorded. Send an `Idempotency-Key` — a timeout is otherwise indistinguishable from a call you did not place.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"numberId\": \"\",\n \"toE164\": \"\",\n \"agentId\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08d4649d-11cc-42ba-861a-e42af98fbac3", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "`true` when this response is a replay of an earlier request with the same `Idempotency-Key`, rather than fresh work.", "key": "Idempotent-Replayed", "value": "string" }, { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"agentVersion\": 3,\n \"billedPaise\": 600,\n \"campaignId\": null,\n \"channel\": \"pstn\",\n \"compliance\": \"passed\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"direction\": \"outbound\",\n \"disposition\": \"answered\",\n \"durationSeconds\": 45,\n \"endReason\": \"agent_ended\",\n \"endedAt\": \"2026-08-25T09:15:11Z\",\n \"environment\": \"live\",\n \"evaluations\": {},\n \"hasRecording\": true,\n \"hasTranscript\": true,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"initiator\": {\n \"id\": \"key_8f14a2c9\",\n \"type\": \"api_key\"\n },\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\"\n },\n \"outputs\": {\n \"confirmed\": true,\n \"delivery_day\": \"Thursday\"\n },\n \"peer\": \"+919876543210\",\n \"quality\": {\n \"answerP50Ms\": 480,\n \"perceivedP50Ms\": 0,\n \"turns\": 6\n },\n \"ratePaisePerMinute\": 600,\n \"startedAt\": \"2026-08-25T09:14:26Z\",\n \"status\": \"ended\",\n \"summary\": \"Customer confirmed the order and asked for Thursday delivery.\",\n \"variables\": {\n \"customer_name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n },\n \"verdict\": \"success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e4a43c-ac57-4589-9ed3-835d3e00ac47", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c65ab5b2-281a-444b-9ff1-c45f23891261", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "738c70aa-6736-47a5-90fb-11eadb74a7c3", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83490b92-f14f-4842-ad06-a0bfcf8de7d3", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aaddcf1-be5f-4acb-bb09-28a4291273f4", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031f3630-1328-410a-af6a-0fbb0f19f269", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional but recommended. Retrying with the same key replays the first response instead of placing a second call. Reusing a key with a different body is `422`; a concurrent duplicate is `409`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"toE164\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55fc59e5-4402-4a2b-a461-f58582ef9c87", "name": "Export the filtered call log as CSV (newest first, max 10,000 rows)", "request": { "name": "Export the filtered call log as CSV (newest first, max 10,000 rows)", "description": { "content": "Takes the same filters as the list endpoint and streams a CSV rather than JSON. The column order is deliberately frozen — new fields are appended, never inserted — so a positional parser keeps working.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "agent_id", "value": "", "description": "Only calls run by this agent, across every one of its versions." }, { "disabled": false, "key": "number_id", "value": "", "description": "Only calls placed from, or received on, this number." }, { "disabled": false, "key": "campaign_id", "value": "", "description": "Every call this campaign placed, retries included — which is what the recipient list cannot give you, since a recipient row names only its LAST attempt." }, { "disabled": false, "key": "direction", "value": "", "description": "Which way the call went. Open set — handle an unrecognised value rather than throwing. Today: `inbound`, `outbound`." }, { "disabled": false, "key": "channel", "value": "", "description": "How the call was carried. `browser` is the in-dashboard microphone test only; every dial the API places is `pstn`. Open set — handle an unrecognised value rather than throwing. Today: `browser`, `pstn`." }, { "disabled": false, "key": "status", "value": "", "description": "Where the call is in its lifecycle. Open set — handle an unrecognised value rather than throwing. Today: `queued`, `in_progress`, `ended`." }, { "disabled": false, "key": "disposition", "value": "", "description": "How the call finished. Only set once `status` is `ended`. Open set — handle an unrecognised value rather than throwing. Today: `answered`, `no_answer`, `busy`, `failed`, `voicemail`, `unknown`." }, { "disabled": false, "key": "environment", "value": "", "description": "Ignored when you authenticate with an API key: the key's own prefix pins the environment, so a `tone_test_` key structurally cannot read live calls." }, { "disabled": false, "key": "from", "value": "", "description": "Inclusive lower bound on `createdAt`. A bare date (`2026-08-01`) is accepted and read as midnight UTC." }, { "disabled": false, "key": "to", "value": "", "description": "Exclusive upper bound on `createdAt`. Must be later than `from`." }, { "disabled": false, "key": "include_unstarted", "value": "", "description": "Include rows for calls that never started — an abandoned browser test dialog mints one, so they are hidden by default." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bdb00e59-6316-4621-acc2-e6277c1cf54f", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5b1345e-5399-46b5-bdbb-4cabca450ec1", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f1987f-3cd8-4cd1-89eb-bdf49c7e97aa", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e39f33-9753-4ace-b5ea-53bb30237b52", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fbd487e-8ffb-4d82-bbf4-925159e891d8", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da369a00-ea7c-4198-adf5-30324e8e5cc5", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bc088e6-d155-4072-99e0-3005767d8882", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "number_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "direction", "value": "outbound" }, { "key": "channel", "value": "pstn" }, { "key": "status", "value": "ended" }, { "key": "disposition", "value": "answered" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-08-25T00:00:00Z" }, { "key": "include_unstarted", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a33e813-f870-47fc-99ea-26e776b08eca", "name": "Fetch a single call", "request": { "name": "Fetch a single call", "description": { "content": "The full call detail record: outcome, duration, what was billed, the agent version that ran it, your declared output variables, the evaluation verdicts and the per-call variables it was given.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ec06b570-b1e5-4ed3-996f-dff56a8fa831", "originalRequest": { "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"agentVersion\": 3,\n \"billedPaise\": 600,\n \"campaignId\": null,\n \"channel\": \"pstn\",\n \"compliance\": \"passed\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"direction\": \"outbound\",\n \"disposition\": \"answered\",\n \"durationSeconds\": 45,\n \"endReason\": \"agent_ended\",\n \"endedAt\": \"2026-08-25T09:15:11Z\",\n \"environment\": \"live\",\n \"evaluations\": {},\n \"hasRecording\": true,\n \"hasTranscript\": true,\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"initiator\": {\n \"id\": \"key_8f14a2c9\",\n \"type\": \"api_key\"\n },\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4b7c1a02-9de5-4f31-bb07-2c1a5e9f0d43\"\n },\n \"outputs\": {\n \"confirmed\": true,\n \"delivery_day\": \"Thursday\"\n },\n \"peer\": \"+919876543210\",\n \"quality\": {\n \"answerP50Ms\": 480,\n \"perceivedP50Ms\": 0,\n \"turns\": 6\n },\n \"ratePaisePerMinute\": 600,\n \"startedAt\": \"2026-08-25T09:14:26Z\",\n \"status\": \"ended\",\n \"summary\": \"Customer confirmed the order and asked for Thursday delivery.\",\n \"variables\": {\n \"customer_name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n },\n \"verdict\": \"success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "864faf4d-5e26-43a2-ac00-c8d28d4b8bb1", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e44aafa-ea40-4d0c-acf0-ad54680bf445", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cacd5bb8-2eec-451b-b53a-46920e99ac81", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0a5396-8249-4e8c-8597-cf08c3eaae23", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6903338-18ea-4111-b61d-aa14cfe3cdeb", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b8abd5a-2920-47ff-929f-a496fa913e94", "name": "Fetch a call's sealed evidence record", "request": { "name": "Fetch a call's sealed evidence record", "description": { "content": "The tamper-evident evidence document for this call: the legal basis it was placed on (DNC, consent, carrier signal), how it was placed (DLT registration, A2P declaration, calling window, AI disclosure), the outcome, and the hash-chain seal. Available shortly after the call ends.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fd7a3736-b325-4458-bb17-69155384f57d", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"campaignId\": null,\n \"chainSeq\": \"4211\",\n \"content\": {},\n \"contentHash\": \"a3f1…\",\n \"e164\": \"+919876543210\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"kind\": \"completed_call\",\n \"prevHash\": \"0000…\",\n \"recordHash\": \"b7e2…\",\n \"sealedAt\": \"2026-08-31T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52ac18a5-ba4e-4faa-afb4-4797a1bcd6c7", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b85f94-85ff-48c2-99f5-131dc7ca2540", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a6c84a2-cbda-410a-9296-977c25b50f29", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32bfe33a-722c-492e-b6b8-b9a6009adc23", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b2d8dc9-15f2-466c-b5b7-6c8c4cf64d33", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1db5bd87-b2bb-45b2-bc27-a6678caf2ba2", "name": "Download a call's evidence record as a PDF", "request": { "name": "Download a call's evidence record as a PDF", "description": { "content": "The same sealed record `GET /v1/calls/{id}/evidence` returns, rendered as a human-readable document with the hash-chain seal on page one.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e86a68f9-69a4-4153-9237-7684602b8fb0", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c8821dd-d8bf-457a-8bf0-fd9d5d96ed80", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09642638-5b26-4e73-af41-bf052f2f7114", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faac28ab-cf39-42a0-a569-12d06ee9947f", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d40e1b55-fd9f-446d-86ac-46a61d400899", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd183ca7-8403-4f09-9f5e-bfb88a79acfe", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "evidence.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdbe6888-1e2a-477e-8202-dad681a3e0e1", "name": "Fetch a call's audio recording (WAV)", "request": { "name": "Fetch a call's audio recording (WAV)", "description": { "content": "Streams the recording as `audio/wav`, in stereo: the caller on the left channel, the agent on the right. Not enveloped, and often several megabytes. Absent when recording is off for the number, or when the call never connected.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a832e508-dd81-4854-b6c1-3dbd4c02d6a9", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33f6a93c-1ba2-45b4-bd2c-336458dd3a61", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c95d18a2-3394-4e08-b4c4-53deadd95025", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c0ab4c-ae6e-4390-8436-7802367e518c", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e070dc4-706b-4ba9-8496-95a3397aedfd", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "603560d1-1c83-45e1-972c-e4653a1f818d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b202c5cf-b52e-46db-9192-7ff8ce113a90", "name": "Fetch a call's transcript", "request": { "name": "Fetch a call's transcript", "description": { "content": "The turn-by-turn transcript, once the call has ended. A call with no audio — a sandbox call, an unanswered one — has no transcript.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "06de39dd-1b4d-4eaa-b6a7-d3284b4a6445", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba381f1f-ac14-4710-8dd7-da933ef09d13", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eeb908a-de90-47be-9b05-85ea68edb5ce", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c227a8a-68ef-4f35-b353-8693e68e3b80", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18e43d07-555d-4310-9028-af60323f85f4", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de2e89fe-4e30-4080-9691-163bdc5d23c5", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "calls", ":id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The call's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "74d73195-4199-41a6-a3b6-cac18218c345", "name": "campaigns", "description": { "content": "Dial a list at a controlled rate, inside the legal calling window, with retries and a wallet floor.", "type": "text/plain" }, "item": [ { "id": "3bda6e25-b99e-4a82-a564-b3832f0eda96", "name": "List campaigns, newest first (cursor-paginated)", "request": { "name": "List campaigns, newest first (cursor-paginated)", "description": { "content": "Archived campaigns are hidden by default; pass `archived=true` to see only those. There is deliberately no way to ask for both at once.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor — pass `meta.pagination.cursor` from the previous response to fetch the next page. Its contents are an implementation detail; do not parse or construct one." }, { "disabled": false, "key": "status", "value": "", "description": "Only campaigns in this state. Open set — handle an unrecognised value rather than throwing. Today: `draft`, `scheduled`, `running`, `paused`, `completed`, `stopped`, `failed`." }, { "disabled": false, "key": "agent_id", "value": "", "description": "Only campaigns running this agent." }, { "disabled": false, "key": "environment", "value": "", "description": "Ignored when you authenticate with an API key: the key prefix pins the environment." }, { "disabled": false, "key": "from", "value": "", "description": "Inclusive lower bound on when the campaign was created." }, { "disabled": false, "key": "to", "value": "", "description": "Exclusive upper bound on when the campaign was created." }, { "disabled": false, "key": "archived", "value": "", "description": "true returns ONLY archived campaigns; the default returns only unarchived ones. There is deliberately no way to ask for both." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a5876aa0-cb5a-43b2-ab3a-6cf023b4dc64", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "565d1a11-2d3d-48ab-8887-0db1a168714c", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7445bc9e-11ad-4520-80ca-2c2a7b08e630", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84810e29-1cd9-4746-9417-7bd6b585a457", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5611e9c8-1fc9-4b05-93d8-7182e86790ed", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a0424de-566e-4d60-9f2c-0a8e0bbcec97", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d65aa726-eb05-42f1-8b67-56bb3c9929c6", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "running" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "environment", "value": "live" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" }, { "key": "archived", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a24d19c-9f67-4576-b97f-bd7e3f9168cb", "name": "Create a campaign (as a draft)", "request": { "name": "Create a campaign (as a draft)", "description": { "content": "A campaign is a recipient list plus a pacing, retry and calling-window policy. It is created as a draft and dials nothing until you launch it. 🔴 `agentId` can never be changed afterwards — duplicate the campaign to use a different agent.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"agentId\": \"\",\n \"numberId\": \"\",\n \"autoPauseBelowPaise\": \"\",\n \"callsPerMinute\": \"\",\n \"endsAt\": \"\",\n \"maxConcurrent\": \"\",\n \"retryAttempts\": \"\",\n \"retryBackoff\": \"\",\n \"retryIntervalMinutes\": \"\",\n \"retryOn\": [\n \"\",\n \"\"\n ],\n \"startsAt\": \"\",\n \"weekdays\": \"\",\n \"windowEndMinute\": \"\",\n \"windowStartMinute\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3e36de13-6cfd-4888-9c27-ac1e159e294c", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac76480f-89b7-4328-9844-8419de698136", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e76e8f0-83c7-4a74-9812-2700fa1bb8df", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a60a96-4d65-4acf-a376-1579c71f76e3", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34324c20-32b2-4453-9faf-35ee88df83a2", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "034e63fb-1461-4f17-9b53-80d03967f2c1", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aab7ab5-73dd-4246-a827-ef0175f54709", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea67b30c-852d-4773-8f67-76fe8671613d", "name": "Delete a campaign and its recipients", "request": { "name": "Delete a campaign and its recipients", "description": { "content": "The calls it already placed survive in the call log — deleting the campaign must not erase the record of what was dialled.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f032cd52-0ac3-413b-bff0-9d5bc371de32", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b3ea011-338c-4933-b1f4-9dee011457f0", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59d60f35-63ef-4631-974f-17d49e72f353", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "025a7772-5080-4458-9be9-35f6cd76782a", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae5b802d-07bf-409f-918e-f460078bd8ef", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357ec385-396d-4501-b903-ea12b9e75199", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71fbfaff-95a6-4a0b-8f77-2e7859412d43", "name": "Fetch a single campaign", "request": { "name": "Fetch a single campaign", "description": { "content": "Includes the snapshot taken at launch — the agent, the number and the sender classification the run actually used — which is evidence, not a live read of what those objects say today.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "03d8d7de-2c18-458f-b67f-12dbad39dcc5", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f6896d-2cdc-460d-8c29-a34223bc2046", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dbf4590-ea5c-410e-872e-592ddd67255a", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97232f1e-0fa7-4fd1-b1de-8f8d66bf8616", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "779da713-469f-468e-8b1e-1575bdb773e0", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d064e81-7cf9-49c0-b76d-aeb158a69c6a", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9eb499e-52fd-4fe2-b772-878e637cad84", "name": "Update a campaign. Only while it is a draft or scheduled.", "request": { "name": "Update a campaign. Only while it is a draft or scheduled.", "description": { "content": "Everything freezes once the campaign leaves draft: a running campaign is paused, edited and relaunched, not edited in place. `agentId` cannot be changed at any point.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": \"\",\n \"callsPerMinute\": \"\",\n \"endsAt\": \"\",\n \"maxConcurrent\": \"\",\n \"name\": \"\",\n \"numberId\": \"\",\n \"retryAttempts\": \"\",\n \"retryBackoff\": \"\",\n \"retryIntervalMinutes\": \"\",\n \"retryOn\": [\n \"\",\n \"\"\n ],\n \"startsAt\": \"\",\n \"weekdays\": \"\",\n \"windowEndMinute\": \"\",\n \"windowStartMinute\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bfdc1612-5590-4613-abec-b13b66a70e36", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac0e714-e0c2-4e18-9291-6f863b79e045", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9648321-b9c2-4f90-af52-eb24f8ea1671", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c125a4-8b1b-4d76-ae59-f4e6b947a10c", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c5d7456-9c66-4883-8149-c1f2cfde9352", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7671d1ac-534c-4712-807e-865e0cf8b1fa", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff7f155d-fc1a-404a-aec6-4f9f68789456", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a01fdf8-0622-4312-a291-a04352630b2a", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoPauseBelowPaise\": 50000,\n \"callsPerMinute\": 10,\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"maxConcurrent\": 4,\n \"name\": \"COD confirmations — September\",\n \"numberId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"retryAttempts\": 1,\n \"retryBackoff\": \"fixed\",\n \"retryIntervalMinutes\": 60,\n \"retryOn\": [\n \"no_answer\",\n \"busy\"\n ],\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a04a1e2c-8148-4dbf-a0f9-404f843bf2d0", "name": "Hide the campaign from the list. Nothing is deleted, and this route still serves it.", "request": { "name": "Hide the campaign from the list. Nothing is deleted, and this route still serves it.", "description": { "content": "Housekeeping for a finished run. Its calls, recipients and compliance record are all still there.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "af397218-ce0b-4e04-ad64-9de53e97f54e", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd64a11-3aa1-40e3-a22f-6964ccda45f4", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed9f370d-e4ec-4c24-aaac-1c371f862b43", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f72561b4-eb65-4c73-bf69-e2b00977cdcd", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bc938db-3da4-4237-8ca2-dd9923ecbec9", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d8d38ba-4ff9-4a2e-b528-48f699286cba", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ade14a3d-b260-42dd-ba4d-00efa2e90220", "name": "Every compliance check recorded for this campaign's calls", "request": { "name": "Every compliance check recorded for this campaign's calls", "description": { "content": "The audit trail for the whole run: every check that passed, warned or blocked, in the order it ran. This is what a complaint is answered with.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "afbc1d67-0002-4e49-851e-09d5bd962c49", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"checkType\": \"dnc\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"detail\": {},\n \"e164\": \"+919876543210\",\n \"enforced\": true,\n \"id\": \"8814\",\n \"outcome\": \"pass\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"internal\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37031ac7-9fca-46da-9cfe-a507f2307519", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9fcb93e-bc17-436e-bae2-0b71369472d5", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3ff9444-5953-4b14-9221-96ed7df69455", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717d3060-321b-47ad-8f7a-aefdff5a7b70", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "663f3d13-cae1-42dc-b45c-940cb43fd12c", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c109c0ff-1a2f-4442-8211-2733c7705214", "name": "Copy this campaign and its recipients to a draft", "request": { "name": "Copy this campaign and its recipients to a draft", "description": { "content": "The way to re-run a list, or to change the agent — which the original campaign will not let you do.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e8eb556f-c470-4c7e-b2e6-5c39019ed54d", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc25efa7-f4cd-4f49-b07c-3226b7b41e46", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5b2bb8-128e-4d66-9820-0faae5fd9a32", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94a081e4-0128-4e63-ba64-7eea60e15e13", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "367882e3-5470-4779-8758-84ba65da09ea", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a441ba6-1070-46e7-8d82-b6542633c8ee", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa345b59-fa21-447a-a2bd-46c95d837359", "name": "Export the recipient list, outcomes included", "request": { "name": "Export the recipient list, outcomes included", "description": { "content": "Streams CSV rather than JSON, for the whole list rather than a page.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "04ad28a7-4898-42ff-8bf8-d9545c5907bc", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6cbbcaf-d60f-4880-b7fc-cdb3e0fdbb6b", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9772d2d1-3912-4deb-ad57-a8b3f3b3fdce", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "140d0c75-01fc-43da-b1e6-e8b38c6a5796", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f743f6b-a494-40e5-9c95-879bc35cf1b9", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "972bafe0-5422-4990-86a1-7dbe46e69f83", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88c4e44c-2faf-4310-87fe-ba84998c500e", "name": "Apply the pre-flight exclusions and start dialling (requires Idempotency-Key)", "request": { "name": "Apply the pre-flight exclusions and start dialling (requires Idempotency-Key)", "description": { "content": "🔴 `Idempotency-Key` is REQUIRED — without it this returns `400`. Launching twice would dial the whole list twice, which is exactly the complaint pattern TCCCPR punishes. Refused if the agent is still a draft, if the number routes to your own stack, or if any pre-flight check blocks. Scrubbing runs here and MUST succeed: a scrubber outage fails the launch rather than passing an unscrubbed list.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8804f01c-58ee-47d5-9b7f-553561bf5106", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "`true` when this response is a replay of an earlier request with the same `Idempotency-Key`, rather than fresh work.", "key": "Idempotent-Replayed", "value": "string" }, { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde13187-eb74-4a15-9122-5fe10e19d3e4", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f5ec63-08b7-442d-909d-ca9e3594785b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83038000-7ffc-4f47-94ad-204f1e66e89e", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c778867-c9c8-4b80-93d5-cd3405d3eecd", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "709e9519-6871-44c8-869f-f093e0125b24", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) REQUIRED. A unique key of your choosing — a UUID is fine. Retrying with the same key replays the first response instead of acting twice, which is what makes a timeout safe to retry here. Reusing a key with a DIFFERENT body is `422 idempotency_key_reused_with_different_params`; retrying while the first is still running is `409 idempotency_key_in_use`. Keys are remembered for 24 hours.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e22ccb8-69e2-4b42-8094-e1d0bfe265c0", "name": "Outcome tallies for the campaign funnel", "request": { "name": "Outcome tallies for the campaign funnel", "description": { "content": "Counts by disposition, plus the tallies of your declared output variables — how many said yes, how many rescheduled — which is usually the number the campaign existed to produce.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d3956b04-519d-4234-9c1b-8181da05976a", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agentOutcome\": {},\n \"disposition\": \"answered\",\n \"excludedReason\": \"invalid_number\",\n \"status\": \"running\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03d2bd93-31ea-404d-b549-c93ac18a2ab5", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2657dbc-8335-4bef-a586-e8b3aa4cbe77", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "510a4d0d-55de-49d2-bdd5-bae95f9a1c3c", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a9e6c7c-2a04-489b-827c-f02433c457f3", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b5b636a-356e-46de-987a-d38150a4561e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3023569d-0b98-43b4-a534-60e8855c2a06", "name": "Stop dialling; resumable", "request": { "name": "Stop dialling; resumable", "description": { "content": "Calls already in flight finish. The campaign also pauses itself if the wallet falls below `autoPauseBelowPaise`, with `pausedReason` saying so.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "26e1854d-da70-4dae-83c3-27dc07296b61", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00d46447-ec45-4ffd-9eff-ae9bab5dd213", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4bd787-c61e-4727-9e3e-cab553dad881", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57b768bf-3228-4e24-8103-1c93abcabe1b", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e58882-9a6d-48e4-b39b-6013ccb8c449", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4db9575-976a-4f1e-b4d6-5d2ff3d25959", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15c353a7-42de-44da-8681-1f18f903a174", "name": "Compute the pre-flight funnel, compliance checks and cost band", "request": { "name": "Compute the pre-flight funnel, compliance checks and cost band", "description": { "content": "What launching would actually do, without doing it. Returns how many recipients would be excluded and why, each counted against exactly one reason; the compliance checks that would run; an estimated cost band; and your balance. A `block` verdict here makes launch a `422`; a `warn` does not. Changes nothing.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2d7baa7d-e0e8-4859-b680-071689c4a6c0", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13b049f1-1693-4cdb-a1f7-b66c02010eeb", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d76dfcb2-0197-4aea-8cdf-235dc1b800d7", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba5fbe8d-beba-4800-9734-dd5ad5d72b6b", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b35a53b-166c-49bd-afff-39a6c50a4b3d", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a243cad-cf52-4514-a1c8-4ce326e6ecb9", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b263c16-ea8a-4070-aa28-fce7beffd1db", "name": "Remove every recipient — replacing the list", "request": { "name": "Remove every recipient — replacing the list", "description": { "content": "Clears the list so you can upload a different one. Only meaningful while the campaign is still a draft.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4a2b2335-3b17-4003-a76c-5429ada3c5a0", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"removed\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c1f2f41-6c80-4fbf-83f7-19555772ba46", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "653ec606-6ed5-43dd-af7e-25f87f2639dc", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcdf9027-dbe7-452c-be6d-4d12fb4ca977", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb54cf53-5ced-439e-89b5-8963e9a46725", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d057fc8-a9cd-4226-9363-f4b9c3e2d568", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "679e32ca-b731-4bbd-9b26-fec146f25183", "name": "List a campaign's recipients and their outcomes", "request": { "name": "List a campaign's recipients and their outcomes", "description": { "content": "A recipient row names its LAST attempt. For every call the campaign placed, retries included, filter `GET /v1/calls` by `campaign_id` instead.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor — pass `meta.pagination.cursor` from the previous response to fetch the next page. Its contents are an implementation detail; do not parse or construct one." }, { "disabled": false, "key": "status", "value": "", "description": "Only recipients in this state. Open set — handle an unrecognised value rather than throwing. Today: `pending`, `dialing`, `done`, `excluded`, `failed`." }, { "disabled": false, "key": "disposition", "value": "", "description": "Only recipients whose LAST attempt ended this way. A recipient row names one attempt — for every call a campaign placed, retries included, filter GET /v1/calls by campaign_id instead. Open set — handle an unrecognised value rather than throwing. Today: `answered`, `no_answer`, `busy`, `failed`, `voicemail`, `unknown`." }, { "disabled": false, "key": "excluded_reason", "value": "", "description": "Only recipients excluded at launch for this reason. Each excluded recipient is counted against exactly one reason. Open set — handle an unrecognised value rather than throwing. Today: `invalid_number`, `duplicate`, `dnc`, `frequency_cap`, `dnd_scrub`, `blocked_by_gate`." }, { "disabled": false, "key": "search", "value": "", "description": "Substring match on the recipient number." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "daa9f455-0f33-4d5f-87d6-20eae5092dfb", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"attemptCount\": 0,\n \"costPaise\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"disposition\": \"answered\",\n \"e164\": \"+919876543210\",\n \"excludedReason\": \"invalid_number\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"lastCallId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"nextAttemptAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": {},\n \"status\": \"running\",\n \"talkSeconds\": 0,\n \"variables\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3df41ad2-dc47-4a73-b070-d41f6e323695", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "358a03fc-e25d-475b-8e01-a8bff9b0eadb", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20b11328-ce6b-47d7-8351-321e56f189dd", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1833f24b-1016-46c0-8839-9e66d3c0ee18", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9317e805-7797-442c-b693-19832647096e", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e7ca9a9-7363-4c22-98f3-7a0914b67851", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0937be-1ecf-44e7-9700-d9ca908e1e8d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "status", "value": "" }, { "key": "disposition", "value": "answered" }, { "key": "excluded_reason", "value": "dnc" }, { "key": "search", "value": "9876" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0e3b80e-af27-4ba1-a91b-2796eb0a99ae", "name": "Add up to 500 recipients. Retrying a batch is safe.", "request": { "name": "Add up to 500 recipients. Retrying a batch is safe.", "description": { "content": "Duplicates are counted rather than rejected, so a request that timed out can simply be resent without double-dialling anyone. A campaign holds at most 20,000 recipients. Add them before launching; the list is fixed once dialling starts.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3fca731-8425-4c71-a001-2fbeb434dc38", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"added\": 0,\n \"duplicates\": 0,\n \"total\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bbc1f3f-d2d4-490b-ab63-60e140035066", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69264e1-0a32-4123-a4ea-86e6090d45d4", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f10a438d-63be-44ea-b01a-faeab98d9bb1", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01e508c5-efe4-4def-a63f-6634823ac2a2", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f3eda01-e72a-4552-bc66-f6c1351737f4", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86d5f8ff-8366-48b2-b0d5-605d5db13bf3", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92fc0d15-f08f-455e-9e4d-e249e5951290", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"e164\": \"+919876543210\",\n \"variables\": {\n \"name\": \"Priya\",\n \"order_id\": \"AC-4417\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be94eef3-fea3-4490-9ca9-c9f31e6bf8b8", "name": "Manually queue one settled recipient for another call. A completed campaign wakes up for it.", "request": { "name": "Manually queue one settled recipient for another call. A completed campaign wakes up for it.", "description": { "content": "For the one number you want to try again after the run finished — a wrong time of day, a handset that was off. It respects the campaign calling window and the compliance gate like any other dial.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fdeb6838-758f-4b17-b8e4-25d07e33fbb0", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3abe1a97-0f59-4e69-a2b3-a6c046b85759", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0a3bcca-3f22-4f61-936b-6d8c1936723f", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fa3bcb1-4b3d-4975-9262-1e0cfd1a4591", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23022b5b-8ac3-47fa-a5d3-be3865eece26", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac5eb303-302f-4780-aecb-470f2b90ff4f", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "recipients", ":recipientId", "redial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." }, { "disabled": false, "type": "any", "value": "", "key": "recipientId", "description": "(Required) The recipient's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0afbbd46-7445-49f7-b600-ed9804d7825a", "name": "Resume a paused campaign", "request": { "name": "Resume a paused campaign", "description": { "content": "Picks up where it stopped, on the version of the agent it launched with. Top the wallet up first if it paused for low balance, or it will pause again.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "56dfb57b-e842-4934-a03f-363584d4eb68", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bf692bf-d5f9-4724-82bb-5ebe0c2eccd3", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73d3620a-fee3-4f45-a4d1-cdfe627d12e4", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210c7157-7700-4029-af86-3b53c72ff1aa", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca04f989-1e58-4093-8ec5-e4f12aa31711", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e6b3f36-a8d8-4251-b3ad-5a73b0c06c1d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d611942a-f56a-4cd2-9ae8-504e21f60033", "name": "End the campaign. Terminal — the remaining recipients are abandoned.", "request": { "name": "End the campaign. Terminal — the remaining recipients are abandoned.", "description": { "content": "There is no resuming from here. Pause instead if you might want to continue.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4cda7474-dc98-469b-a4bb-28f33bf1dbbc", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b535cb33-b6a5-4a8b-a88d-108a2912249e", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b27493c-f118-4203-84f0-3b5d7cea533c", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0176fd08-f3b6-48be-8a63-510db7f96caa", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa00b46-d657-4fbf-b36e-ad5a04922cf5", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed228fe-44e1-4766-8cae-12358bafcbd4", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37b1d095-b831-4be2-8b4d-ac90d65efa69", "name": "Return an archived campaign to the list", "request": { "name": "Return an archived campaign to the list", "description": { "content": "The inverse of archiving. Nothing else changes.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d0d0ea07-1d25-44dd-bb33-d2c26478d554", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"agent\": {\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"name\": \"Order confirmation\"\n },\n \"archivedAt\": null,\n \"autoPauseBelowPaise\": 50000,\n \"completedAt\": null,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"environment\": \"live\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"launchedAt\": \"2026-09-01T04:00:00Z\",\n \"name\": \"COD confirmations — September\",\n \"number\": {\n \"e164\": \"+918045678901\",\n \"id\": \"4c8b1e77-3d2a-4f5b-9e6c-8a7b6c5d4e3f\"\n },\n \"pacing\": {\n \"callsPerMinute\": 10,\n \"maxConcurrent\": 4\n },\n \"pausedReason\": \"operator\",\n \"preflight\": {\n \"callable\": 0,\n \"checks\": [\n {\n \"outcome\": \"pass\",\n \"reason\": \"Outside the 09:00-21:00 IST window for promotional calls.\",\n \"type\": \"time_window\"\n }\n ],\n \"computedAt\": \"2026-09-01T03:58:12Z\",\n \"estimatedCostPaise\": {\n \"high\": 480000,\n \"low\": 120000\n },\n \"excluded\": \"invalid_number\",\n \"excludedE164s\": {},\n \"total\": 0,\n \"walletBalancePaise\": 500000\n },\n \"progress\": {\n \"connected\": 244,\n \"dialed\": 320,\n \"excluded\": 31,\n \"spentPaise\": 146400,\n \"total\": 500\n },\n \"purpose\": \"transactional\",\n \"retries\": {\n \"attempts\": 1,\n \"backoff\": \"linear\",\n \"intervalMinutes\": 60,\n \"on\": [\n \"no_answer\",\n \"busy\"\n ]\n },\n \"schedule\": {\n \"endsAt\": \"2026-09-07T14:00:00Z\",\n \"startsAt\": \"2026-09-01T04:00:00Z\",\n \"weekdays\": 31,\n \"windowEndMinute\": 1260,\n \"windowStartMinute\": 540\n },\n \"status\": \"running\",\n \"updatedAt\": \"2026-08-25T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb3db10f-f20a-48e6-8cd0-0db36e90d833", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e16275-df8c-4f64-bc80-89d617429074", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6cd1370-b6f6-4ee6-a23a-ff248dc8beef", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a62bd411-c5ef-45ec-8868-aa28ef93e869", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9d53f43-c970-4212-ad93-fcfdb1b5ede8", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The campaign's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b99c17a2-55b2-4972-9402-91927b58e451", "name": "compliance", "description": { "content": "The pre-dial gate, standalone verdicts, consent records, suppression lists and the evidence pack behind any of them.", "type": "text/plain" }, "item": [ { "id": "8de2ae96-809f-4e01-8bdc-d76e6fe78b04", "name": "Report what happened to a call you placed yourself", "request": { "name": "Report what happened to a call you placed yourself", "description": { "content": "Closes the audit loop on a verdict. `opt_out` revokes consents and suppresses the number for 90 days; `complaint` suppresses it permanently.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164\": \"\",\n \"outcome\": \"\",\n \"callReference\": \"\",\n \"checkId\": \"\",\n \"durationSeconds\": \"\",\n \"notes\": \"\",\n \"occurredAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a07863a0-27e3-45ba-ba33-bb20dac89f00", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"consentsRevoked\": 0,\n \"e164\": \"+919876543210\",\n \"id\": \"8814\",\n \"outcome\": \"connected\",\n \"suppressed\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b0a423b-2c0e-4c48-a3a3-c4052df7b838", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33fbeadb-4ca4-40f8-8ee1-4027662cfb77", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6384023b-d247-4b33-8b48-8ebb201bd3ff", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "219b3e96-c831-46a2-b9e0-d9d89a58d18e", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11f72307-dfd5-4370-bbf8-78a56285319c", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b18e2582-7849-4b89-b2b2-9de9fb344082", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "call-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callReference\": \"acme-crm-4417\",\n \"checkId\": \"8814\",\n \"durationSeconds\": 45,\n \"e164\": \"+919876543210\",\n \"notes\": \"Customer asked to be called after 6pm.\",\n \"occurredAt\": \"2026-08-25T09:14:22Z\",\n \"outcome\": \"connected\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83449dad-31f3-4a73-9823-56dfb72c29c9", "name": "Run the pre-dial compliance gate for one number, without dialling", "request": { "name": "Run the pre-dial compliance gate for one number, without dialling", "description": { "content": "Runs the exact checks an outbound call runs (DLT, A2P declaration, calling window, DNC, carrier DND, consent) and records the same audit rows. Returns the verdict instead of enforcing it — use it to pre-flight a number you dial on your own infrastructure.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6595a64e-b14e-4ffa-8446-a277723dc2ae", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"allowed\": true,\n \"blockedBy\": null,\n \"checks\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"checkType\": \"dnc\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"detail\": {},\n \"e164\": \"+919876543210\",\n \"enforced\": true,\n \"id\": \"8814\",\n \"outcome\": \"pass\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"internal\"\n }\n ],\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a61ad14-894c-4744-946b-b77694a301b8", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ad0a5f-cb1a-4803-8cea-6d83b2ff0073", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41877f6c-b8c4-4b57-824d-10bc61a8db6b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "040a1bc0-f78c-4e07-9d6c-be2d4df58445", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "600d89ef-b75d-47fe-9648-030def730172", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031ac1bd-a909-4321-b6a1-5a4f3e185ae7", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "615b223d-14e3-47c4-8f55-ca56458b8b37", "name": "Pre-flight up to 100 numbers in one call", "request": { "name": "Pre-flight up to 100 numbers in one call", "description": { "content": "Each number runs the full gate and is metered as its own verdict, so a batch of 100 costs 100 verdicts. A campaign-sized list belongs in a campaign, which has a pre-flight built for that scale.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"\"\n ],\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e425648-74eb-4257-917b-8259ad8eeb5d", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"allowed\": true,\n \"blockedBy\": null,\n \"checks\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"checkType\": \"dnc\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"detail\": {},\n \"e164\": \"+919876543210\",\n \"enforced\": true,\n \"id\": \"8814\",\n \"outcome\": \"pass\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"internal\"\n }\n ],\n \"e164\": \"+919876543210\",\n \"purpose\": \"promotional\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9163cfc0-d2fc-4a36-a1bf-6872029407a9", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3f4ba38-10df-4efa-a9b6-453af7da79e0", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f0068d-465d-4e44-95a4-5db571fd6ecd", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b92a9b6-7208-4589-aacc-915f3dd74301", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "484e2cf7-1e1d-42fd-802b-5e901d7c410e", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a48795c8-4bf0-4e1d-ae9b-7f1b72fe48d2", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "check", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164s\": [\n \"+919876543210\",\n \"+919812345678\"\n ],\n \"purpose\": \"promotional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0acd7792-20eb-4701-9f27-5136d0364da8", "name": "Pre-dial compliance checks, newest first", "request": { "name": "Pre-dial compliance checks, newest first", "description": { "content": "Every check ever recorded, from dials and from standalone verdicts alike. Append-only at the database level — this is the audit trail, so nothing here can be edited or deleted after the fact.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor from the previous response." }, { "disabled": false, "key": "check_type", "value": "", "description": "Only checks of this kind. The six that run before a dial are dlt, a2p, time_window, dnc, carrier_dnd and consent; the rest record changes you made. Open set — handle an unrecognised value rather than throwing. Today: `dlt`, `a2p`, `time_window`, `dnc`, `scrub`, `carrier_dnd`, `consent`, `enforcement_change`, `profile_change`, `call_outcome`, `suppression_change`." }, { "disabled": false, "key": "outcome", "value": "", "description": "Only checks that ended this way. Note that carrier_dnd can only ever warn — the authoritative register is not exposed to senders, so it is advisory by design. Open set — handle an unrecognised value rather than throwing. Today: `pass`, `warn`, `block`, `error`." }, { "disabled": false, "key": "e164", "value": "", "description": "Only checks about this number." }, { "disabled": false, "key": "call_id", "value": "", "description": "Only checks recorded for this call. A standalone verdict has no call id." }, { "disabled": false, "key": "from", "value": "", "description": "Inclusive lower bound on when the check ran." }, { "disabled": false, "key": "to", "value": "", "description": "Exclusive upper bound on when the check ran." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b8622770-57e8-453e-9b49-a11cde93504c", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"checkType\": \"dnc\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"detail\": {},\n \"e164\": \"+919876543210\",\n \"enforced\": true,\n \"id\": \"8814\",\n \"outcome\": \"pass\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"internal\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8124caa-4f6e-4431-b55c-82972c258d59", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56cea90a-005f-412b-ba6a-d1ea6d8d6da7", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fd56370-d42b-42a8-b452-0408db73d309", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0adf582c-9982-4d6e-8570-0178276a9c18", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffeb5db2-c532-4756-9a08-9e5ecdbd61c3", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06fd7398-0266-456f-a844-339602c569e8", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "8814" }, { "key": "check_type", "value": "dnc" }, { "key": "outcome", "value": "block" }, { "key": "e164", "value": "+919876543210" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67d30b96-46eb-4799-b35b-127b04d042bc", "name": "The evidence pack for one number", "request": { "name": "The evidence pack for one number", "description": { "content": "Every check, consent record, outcome and suppression we hold for a number — the document to hand an access provider when a complaint lands.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "e164", "value": "", "description": "(Required) The number to assemble evidence for. Returns every check, consent record, suppression entry and reported outcome Tone holds about it." }, { "disabled": false, "key": "from", "value": "", "description": "Inclusive lower bound. Omit for everything on record." }, { "disabled": false, "key": "to", "value": "", "description": "Exclusive upper bound." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7270fdfe-735a-4216-ab18-6d51ad94dc9d", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"checks\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"checkType\": \"dnc\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"detail\": {},\n \"e164\": \"+919876543210\",\n \"enforced\": true,\n \"id\": \"8814\",\n \"outcome\": \"pass\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"internal\"\n }\n ],\n \"consents\": [\n {\n \"active\": true,\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"revokedAt\": null,\n \"revokedReason\": null,\n \"scope\": \"Order updates and delivery reminders.\",\n \"source\": \"api\"\n }\n ],\n \"e164\": \"+919876543210\",\n \"generatedAt\": \"2026-08-25T09:14:22Z\",\n \"outcomes\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"checkType\": \"dnc\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"detail\": {},\n \"e164\": \"+919876543210\",\n \"enforced\": true,\n \"id\": \"8814\",\n \"outcome\": \"pass\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"internal\"\n }\n ],\n \"suppression\": {\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"removedAt\": null,\n \"removedReason\": null,\n \"source\": \"manual\",\n \"sourceCallId\": null\n },\n \"truncated\": true,\n \"window\": {\n \"from\": \"2026-08-01T00:00:00Z\",\n \"to\": \"2026-08-25T00:00:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249da8ab-3c79-4879-ac0a-085552f6b6d8", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b432ee57-2070-4851-89d2-ac389ee470a4", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "563837d0-815e-4c92-926d-96b48032061e", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd101a70-bf41-4016-9c2b-d8b1821a3871", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b504f8c-5356-4308-a6ce-2aef1f8f699b", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d9b4284-a836-448f-bb3d-955ef0290129", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "e164", "value": "+919876543210" }, { "key": "from", "value": "2026-08-01" }, { "key": "to", "value": "2026-09-01" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44265430-2e40-4485-97a7-aeecfbc92e37", "name": "Sealed evidence records, newest first", "request": { "name": "Sealed evidence records, newest first", "description": { "content": "One tamper-evident record per call attempt — completed calls AND refused dials. Each carries the full basis on which the attempt was allowed or refused, hashed and chained to its predecessor so any alteration, deletion or reordering is detectable.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor from the previous response." }, { "disabled": false, "key": "e164", "value": "", "description": "Only records about this number." }, { "disabled": false, "key": "kind", "value": "", "description": "Only records of this kind. Refusals are evidence too — a ledger of only successes proves nothing about whether the rules were honoured when they bit. Open set — handle an unrecognised value rather than throwing. Today: `completed_call`, `blocked_dial`." }, { "disabled": false, "key": "call_id", "value": "", "description": "The record sealing this call." }, { "disabled": false, "key": "campaign_id", "value": "", "description": "Only records from this campaign, refusals included." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d2bd6141-ecfc-47b5-be13-499b2931ab08", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"campaignId\": null,\n \"chainSeq\": \"4211\",\n \"content\": {},\n \"contentHash\": \"a3f1…\",\n \"e164\": \"+919876543210\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"kind\": \"completed_call\",\n \"prevHash\": \"0000…\",\n \"recordHash\": \"b7e2…\",\n \"sealedAt\": \"2026-08-31T09:14:22Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2541a394-bc58-4036-aa9f-a55cb6daff40", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2cfab6d-ce97-46d1-9312-6bca52d31445", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97261b15-555c-4017-beaa-829c49497c42", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7a0ef7a-d81a-450e-bd6e-8596f9b7a832", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a6d695b-34e1-4fd0-af97-794cb76f793c", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "253706a5-4b6a-4a99-a401-537f0ba12f6f", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "4210" }, { "key": "e164", "value": "+919876543210" }, { "key": "kind", "value": "completed_call" }, { "key": "call_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" }, { "key": "campaign_id", "value": "2b7c9e10-88d1-4f22-9c33-5a6b7c8d9e0f" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a86f2b88-e1c5-4d62-8701-b88018f3f2e9", "name": "Verify the evidence chain's integrity", "request": { "name": "Verify the evidence chain's integrity", "description": { "content": "Re-hashes every record in the requested slice and re-checks every link. An edited record fails its content hash; a deleted or reordered one breaks the chain. Long chains verify in slices — when `complete` is false, continue from `throughSeq + 1`.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from_seq", "value": "", "description": "Start of the slice to verify, inclusive. Defaults to 1 — the beginning of the chain." }, { "disabled": false, "key": "to_seq", "value": "", "description": "End of the slice, inclusive. Defaults to the head of the chain." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3f7c0102-85ab-471d-8f0a-acfb81fc42e8", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"brokenReason\": null,\n \"checked\": 0,\n \"complete\": true,\n \"firstBrokenSeq\": null,\n \"fromSeq\": \"1\",\n \"throughSeq\": \"5000\",\n \"valid\": true,\n \"verifiedAt\": \"2026-08-31T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0540bbda-0b84-4773-97d9-07f0f30f7adc", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f132c37-7e10-4a8e-8c91-068dadcb900d", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d4b76f-f077-4380-b8b6-e81cddd3e3aa", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3275c20c-c83d-42e5-8f45-87ecf025c7e5", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b4b7c53-c2a7-420c-a79c-637c399f4415", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf0ff6db-f18b-466f-82aa-13b1f21b993e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_seq", "value": "1" }, { "key": "to_seq", "value": "5000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b1acece-025b-48af-928c-5f76ad7650a4", "name": "One sealed evidence record", "request": { "name": "One sealed evidence record", "description": { "content": "The full evidence document plus its seal: the content hash, the previous record’s hash, and the chain position. Recompute sha256 over the canonical content to prove the document was not altered; walk the verify endpoint to prove the whole chain.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4fe60cee-6ea9-4483-849f-e69b4c437e52", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"campaignId\": null,\n \"chainSeq\": \"4211\",\n \"content\": {},\n \"contentHash\": \"a3f1…\",\n \"e164\": \"+919876543210\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"kind\": \"completed_call\",\n \"prevHash\": \"0000…\",\n \"recordHash\": \"b7e2…\",\n \"sealedAt\": \"2026-08-31T09:14:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "711e4649-c297-469a-b2f1-024c5b0b5638", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86085685-670b-4ac9-887b-b2b2a62ce6a8", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c54847af-9683-4c75-98fd-d5138cc8d116", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62e387f-ddbe-42ed-ac8f-077d984f4d1b", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77238485-17fc-4e4b-8baa-2ea1bb3530a6", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "compliance", "evidence-records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The evidence record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cde96f8e-b0d0-4565-9ac5-349bf5570f48", "name": "Consent records, newest first", "request": { "name": "Consent records, newest first", "description": { "content": "Consent is purpose-scoped, so a number can appear several times — once per purpose. `active=true` filters to the records that would satisfy the gate right now.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many records to return. 1-100." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor from the previous response." }, { "disabled": false, "key": "e164", "value": "", "description": "Only records for this number." }, { "disabled": false, "key": "purpose", "value": "", "description": "Only records covering this purpose. Open set — handle an unrecognised value rather than throwing. Today: `promotional`, `service`, `transactional`, `collections`." }, { "disabled": false, "key": "active", "value": "", "description": "Only records that would satisfy the gate right now — neither revoked nor expired." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a8e3c2a3-4784-47c3-a35d-3eeb6003fea9", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"active\": true,\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"revokedAt\": null,\n \"revokedReason\": null,\n \"scope\": \"Order updates and delivery reminders.\",\n \"source\": \"api\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b129b4f0-5205-478c-ba54-a47ec1ea3aa1", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60217d2c-16af-4cb3-9716-9b32e079ff85", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5cb10df-3b57-497c-b698-c6dd6f0b6785", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbc0827b-73df-4edc-9e96-9187adaec45c", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "056e8d74-d7fc-42e3-ad2c-542446ef6865", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd75986-a4af-4b66-8291-2966a51a915e", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "" }, { "key": "e164", "value": "+919876543210" }, { "key": "purpose", "value": "promotional" }, { "key": "active", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d65b7d31-9c47-45a5-84f3-750c7b8acf1c", "name": "Record a consent", "request": { "name": "Record a consent", "description": { "content": "Explicit transactional consent expires after 7 days by policy; inferred consent must carry its own expiry. Verified explicit consent is what lets a promotional call pass the gate.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164\": \"\",\n \"purpose\": \"\",\n \"kind\": \"\",\n \"source\": \"\",\n \"capturedAt\": \"\",\n \"evidenceRef\": \"\",\n \"expiresAt\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2a011d4a-67a4-4fc5-a940-bcc7d22f2b29", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"active\": true,\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"revokedAt\": null,\n \"revokedReason\": null,\n \"scope\": \"Order updates and delivery reminders.\",\n \"source\": \"api\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59332e83-59ac-40c4-a7df-30ce7c451704", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7f38164-968d-42af-861d-da3ca614e747", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49eaa57f-e9b4-4e16-a954-b46fa0ad46b8", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37d48d2e-ac82-424a-ba25-bed9ae67478c", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b566fa72-ab0c-41b3-b62c-f27e5ab6efee", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a04c8cd-ef2e-4274-a8e5-75fb61820f68", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ad03f42-9251-4d47-9fc3-147e4389b7c8", "name": "Import many consents at once (CSV upload, CRM export)", "request": { "name": "Import many consents at once (CSV upload, CRM export)", "description": { "content": "Up to 1,000 per request. Rows are accepted INDIVIDUALLY: a record that violates policy (an inferred consent missing `expiresAt`, a number inside its 90-day opt-out lockout) is refused with its index and reason while the rest import — fix and resubmit only the rejected rows. 🔴 Set `capturedAt` on every imported record: it defaults to now, which dates your whole back catalogue to the day of the import.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"e164\": \"\",\n \"purpose\": \"\",\n \"kind\": \"\",\n \"source\": \"\",\n \"capturedAt\": \"\",\n \"evidenceRef\": \"\",\n \"expiresAt\": \"\",\n \"scope\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "50b4bf23-6ab7-45ec-b807-2e496f2169ce", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"imported\": 0,\n \"rejected\": [\n {\n \"code\": \"conflict\",\n \"e164\": \"+919876543210\",\n \"index\": 0,\n \"message\": \"This number opted out and is inside the 90-day re-consent lockout.\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcafa8d4-fc8e-496a-9b23-fc6c8d930243", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e59b24b2-ddd1-4aa7-9b5f-bea70ae68056", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a217df-ef55-48fe-b49f-3abaf593fc3b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e327d1fb-33c5-42e0-92a1-f5d9c97fd15f", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3b088ee-d0e0-4a60-9353-b4a334ad5536", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7247eacf-b9f2-48c9-8134-574b719df81f", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "consent", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-08-27T11:02:00Z\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"scope\": \"Order updates and delivery reminders for orders placed on acme.example.\",\n \"source\": \"web_form\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dca1c7ef-5799-45e2-af81-71d3ffa73b38", "name": "A recipient opted out", "request": { "name": "A recipient opted out", "description": { "content": "Revokes every active consent for the number and suppresses it for the 90-day re-consent lockout, in one transaction.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5036874e-0f60-4004-bf07-dfc4418a797e", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"revoked\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfc857e0-64b1-4b68-991d-8299b4d60b85", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28720eb7-3f4e-44ae-9c0b-b56c2baae054", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0abde13e-6256-406d-af36-f9765d10471b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13bba8eb-115b-41c5-a615-2e3db97b2d65", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc7cae3-62e4-4253-807b-6ff479d7f5a2", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b39fef38-7c45-4483-aef5-0a89cf642d15", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "consent", "opt-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"reason\": \"Said \\\"do not call me again\\\" during the call.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "156a3472-b307-455b-8ff7-2370c042d9e2", "name": "Revoke one consent record", "request": { "name": "Revoke one consent record", "description": { "content": "⚠️ Revoking consent does NOT stop calls on its own: the ledger passes or warns, it never blocks. Only the suppression list blocks. If the recipient asked not to be called, use the opt-out endpoint, which revokes and suppresses in one transaction.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "949ed78c-c88e-400f-bace-4aff5ac475ac", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"active\": true,\n \"capturedAt\": \"2026-08-20T11:02:00Z\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"evidenceRef\": \"form-sub-88213\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"kind\": \"explicit\",\n \"purpose\": \"promotional\",\n \"revokedAt\": null,\n \"revokedReason\": null,\n \"scope\": \"Order updates and delivery reminders.\",\n \"source\": \"api\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "401e281d-45d2-4d90-a9d7-c12a46483bf3", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dac6ee3e-b78c-4a71-a952-3797861f27ca", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b52f56b-f268-46b2-8321-8d13a5bd4df3", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12f7bc27-22dd-43ae-a236-10c719c5bbf5", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "960ca7db-286c-40c3-be74-caf292f86566", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae720272-9eef-4ead-9cd4-b134c81925ba", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77cde976-f189-4b1b-82d5-e74f11fbb8c8", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "consent", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The consent record's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Recipient asked to be removed by email.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc3041ed-579a-4278-b575-633130185f25", "name": "Numbers on the Do-Not-Call list", "request": { "name": "Numbers on the Do-Not-Call list", "description": { "content": "Your own suppression list — the only list the gate hard-blocks on. Search accepts whatever someone types: `+91 98765 43210`, `09876543210` and `4321` all work.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor — pass `meta.pagination.cursor` from the previous response to fetch the next page. Its contents are an implementation detail; do not parse or construct one." }, { "disabled": false, "key": "source", "value": "", "description": "Only entries added this way. Open set — handle an unrecognised value rather than throwing. Today: `manual`, `csv`, `api`, `caller_request`, `complaint`, `carrier_rejection`." }, { "disabled": false, "key": "status", "value": "all", "description": "Whether to include entries whose 90-day lockout has already elapsed. Open set — handle an unrecognised value rather than throwing. Today: `all`, `active`, `permanent`, `lockout`, `lapsed`, `removed`." }, { "disabled": false, "key": "search", "value": "", "description": "Digits to find. A full number matches exactly, a fragment matches anywhere in the number. Deliberately forgiving about formatting — +91 98765 43210, 09876543210 and 4321 all work." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b4403b71-3d1a-4971-8d5f-7a72aea43873", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"removedAt\": null,\n \"removedReason\": null,\n \"source\": \"manual\",\n \"sourceCallId\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6d6f97e-5e03-4f59-aa2f-492c5ed72a5e", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4ebee1-1a94-4066-b408-224630619dfa", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb469c4-3e6d-407b-984a-326ad1a32ea6", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca33ff5d-eb81-4d38-b3c2-02b69908798e", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ae6e4fd-52dd-4ccc-9988-3d69593ff974", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaa1f58d-51b6-4444-bf3b-4a1edbd4c511", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "eyJjIjoiMjAyNi0wOC0yNVQwOToxNDoyMi4xMTFaIiwiaSI6IjlmMWMyZDg0LTRlM2EtNGY2Yy1iOTAyLTdkMWU4YTMzYzQ1MSJ9" }, { "key": "source", "value": "manual" }, { "key": "status", "value": "all" }, { "key": "search", "value": "9876" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a1235fe-7d55-4357-87fa-71fd2374dad1", "name": "Suppress a number (idempotent)", "request": { "name": "Suppress a number (idempotent)", "description": { "content": "Adding a number already on the list is a no-op rather than an error, so a replayed webhook or a retried job cannot fail here. Use `lockout90d` for an opt-out, which becomes contactable again on a date, rather than a permanent suppression.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"e164\": \"\",\n \"lockout90d\": false,\n \"reason\": \"\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c8c5973c-d6b1-42ab-8602-cc9a0e1af94b", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"removedAt\": null,\n \"removedReason\": null,\n \"source\": \"manual\",\n \"sourceCallId\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "567d6974-971b-4b25-97d8-c766526131cc", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ded63c-3267-4206-aa15-1c03d44a97e3", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b852dc0-bfef-46a7-be0d-6c95094b9ba5", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b190454-d9ec-4ebd-9758-f863b5ee984b", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af276c62-e77c-40e5-8cb6-56ac214bf2cc", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84e5dda9-de37-41a2-bfb2-e1c98b37d5c9", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "dnc" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d137671e-aa31-4a86-8b97-b5428d102610", "name": "Suppress many numbers at once (CSV upload)", "request": { "name": "Suppress many numbers at once (CSV upload)", "description": { "content": "Up to 1,000 per request, as one transaction — it either all lands or none of it does. This is how you bring an existing suppression list with you.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"\",\n \"lockout90d\": false,\n \"reason\": \"\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c4b9374f-933d-43dd-a32f-d06d6654e834", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"e164\": \"+919876543210\",\n \"expiresAt\": \"2026-11-23T09:14:22Z\",\n \"id\": \"8814\",\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"removedAt\": null,\n \"removedReason\": null,\n \"source\": \"manual\",\n \"sourceCallId\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1a56b45-8529-4026-84c2-dbf960a68aa8", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be25694d-d501-4088-bb96-201a83ce1340", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b762f41b-d6e1-4b09-a91f-228d5566feb0", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeb0a6b7-e5bb-46e2-aa2d-9a02f99d1fa3", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccdd1617-d894-4dce-b0d8-a572a3beb248", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81ca45cb-ef9e-4aea-8f0b-f85086e59748", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "dnc", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"e164\": \"+919876543210\",\n \"lockout90d\": false,\n \"reason\": \"Asked to be removed during a call on 2026-08-20.\",\n \"source\": \"manual\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0116850f-c0b4-4ac3-9af7-30c25d418c0f", "name": "Deprecated — lifting a suppression now requires the dashboard", "request": { "name": "Deprecated — lifting a suppression now requires the dashboard", "description": { "content": "⚠️ Always refuses. Lifting a suppression is a deliberate, reasoned act: it now requires a dashboard session and a written justification (`POST /v1/dnc/{id}/remove`, session-only), and is recorded in the audit trail. API keys can ADD suppressions — an opt-out must land within seconds — but can no longer silently make an opted-out number callable again.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "099c2039-edcb-4b75-9ae8-ab0b64c60ba4", "originalRequest": { "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "231e4b41-0de6-48ce-8c78-aec4c7257b45", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec663f06-162c-4024-b4ee-d051f857d53e", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32f6a80e-9166-4597-9f93-2480700c6081", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fefac50d-e281-42e0-81ce-260afd892384", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e68c8b2-b8b4-4f74-a3c8-190fe070883a", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "dnc", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The suppression entry's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "84e06ac3-a2e5-411b-9982-fcc6f049e207", "name": "events", "description": { "content": "Recent events, re-readable for 30 days. The replay path when a webhook delivery was missed.", "type": "text/plain" }, "item": [ { "id": "703308e8-d357-448c-a34e-3a06f1d6b33f", "name": "Recent events (newest first, 30-day retention)", "request": { "name": "Recent events (newest first, 30-day retention)", "description": { "content": "The reconciliation path when a webhook delivery was missed, and the debugging path for \"what exactly did Tone send\". Deliveries are at-least-once and unordered, so dedupe on the event id.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "type", "value": "", "description": "Only events of this type, for example call.completed. Treat the set as open — new types are added without notice." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ba01f31-2ec4-47f0-aec8-2511cf9b3213", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"delivery\": {\n \"attempts\": 0,\n \"deliveredAt\": \"2026-08-25T09:14:03Z\",\n \"endpointId\": \"2b7c1d90-4e5f-4a6b-8c9d-0e1f2a3b4c5d\",\n \"lastStatus\": 0,\n \"status\": \"pending\"\n },\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"subjectId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"subjectType\": \"call\",\n \"type\": \"call.initiated\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36395e8a-f2c5-40a6-a505-96365c3f124a", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9397074-d362-44d2-95ca-edda1096453e", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e21b77-55cf-4650-98bd-a78736b179ac", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7b80670-faf9-41d4-99df-537301428a2a", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27f7eddb-55cb-460a-93cd-a1a01fe428fd", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6069702-f6b7-4090-a0de-7fb4ccdea034", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "type", "value": "call.completed" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a244fa6e-3c03-4fab-ad2f-a885cff8bda1", "name": "One event, with its payload re-rendered from current state", "request": { "name": "One event, with its payload re-rendered from current state", "description": { "content": "⚠️ The payload is RE-RENDERED from the resource as it stands now, not replayed from the signed bytes that were delivered. A transcript that landed after delivery will be present here and absent from what your endpoint received. Use it to understand an event, not to re-verify a signature.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c0d4ee21-83e6-4d1b-8c6b-c16e95887966", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"delivery\": {\n \"attempts\": 0,\n \"deliveredAt\": \"2026-08-25T09:14:03Z\",\n \"endpointId\": \"2b7c1d90-4e5f-4a6b-8c9d-0e1f2a3b4c5d\",\n \"lastStatus\": 0,\n \"status\": \"pending\"\n },\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"payload\": {\n \"created_at\": \"2026-08-25T09:14:22Z\",\n \"data\": {},\n \"id\": \"evt_01J9Z2K3M4N5P6Q7R8S9T0\",\n \"links\": {\n \"recording\": \"/v1/calls/9f1c2d84-5b6a-4c3d-8e2f-1a0b9c8d7e6f/recording\",\n \"self\": \"/v1/calls/9f1c2d84-5b6a-4c3d-8e2f-1a0b9c8d7e6f\",\n \"transcript\": \"/v1/calls/9f1c2d84-5b6a-4c3d-8e2f-1a0b9c8d7e6f/transcript\"\n },\n \"type\": \"call.completed\"\n },\n \"subjectId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"subjectType\": \"call\",\n \"type\": \"call.initiated\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee7e29f3-ddab-4724-a182-d97d6a5d1617", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be936c24-d7bf-479e-914b-7dfd00148a5f", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11dfe64-ae12-4195-beef-c241489be11d", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2894fe5-3c99-4a7b-bd4c-f54048f5864a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16e2d2ed-6c94-434b-b4ee-b2b67fa68507", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The event's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "829ab974-a1e9-49d8-b780-e15478c0ab1d", "name": "integrations", "description": { "content": "Webhook endpoints, their signing secrets and delivery history.", "type": "text/plain" }, "item": [ { "id": "60167ad4-78eb-49b7-89e5-65c6eff2a24b", "name": "Webhook endpoints", "request": { "name": "Webhook endpoints", "description": { "content": "Every endpoint you have registered, with what it subscribes to and whether it is still enabled.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "920a9e16-17c9-426c-b590-a88982e04b97", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"consecutiveFailures\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"description\": \"Production — order service\",\n \"disabledReason\": null,\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"campaign.finished\"\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"url\": \"https://hooks.acme.example/tone\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53d04f02-c975-4f59-8da3-d559c1545537", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "394e8846-760a-4d0b-992c-36eb2d0336fe", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68bfc07f-d2cc-4d65-b6a5-48ef5f523c48", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2d160c2-00d0-4ce1-ac03-76b7003d8298", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "151165ec-ec46-4668-828c-d556d26ef703", "name": "Add a webhook endpoint", "request": { "name": "Add a webhook endpoint", "description": { "content": "Must be a public `https://` URL — private and link-local addresses are refused at save time rather than discovered at delivery time. The signing secret is returned once, here. Subscribe only to what you consume: every delivery is retried up to 14 times over roughly a day.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"events\": [\n \"call.completed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a7107306-b264-48b6-8f3b-41dc9a64dbca", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"consecutiveFailures\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"description\": \"Production — order service\",\n \"disabledReason\": null,\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"campaign.finished\"\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"secret\": \"whsec_3f1a7f6e2b4c4d1e9a8b5c6d7e8f9a0b\",\n \"url\": \"https://hooks.acme.example/tone\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad05fe62-0e25-42a7-9a09-22dd53b1e839", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d0ea483-4255-4c6b-8a5f-203a44bd5bf5", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4f92d50-5950-490b-b5ce-ee4a5ae1df32", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d31fcab-1350-4f13-bef4-2d83da118b3c", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24170588-c990-4748-bbe1-3c295b17ee9a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a94706af-96f9-4452-ab3b-4df1a8bc26e4", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ef6a1b2-1878-4d9b-99dc-dac092dcde2e", "name": "Recent webhook deliveries", "request": { "name": "Recent webhook deliveries", "description": { "content": "What was sent, what your endpoint answered and how many attempts it took. The place to look when an integration \"missed\" an event.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "661e508b-0cbb-4d90-9bbf-e731287d6b68", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"attempts\": 0,\n \"callId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"deliveredAt\": \"2026-08-25T09:14:22Z\",\n \"endpointId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"eventType\": \"call.initiated\",\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"lastError\": \"connection_timeout\",\n \"lastStatus\": 0,\n \"status\": \"pending\",\n \"subjectId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"subjectType\": \"call\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "400d773e-40be-40a7-8030-3fba83f4488d", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98c2b0b5-df2f-43b5-8908-b3e4b48c11e2", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1580cf9-c83c-4f02-bbe4-2cc6daa53e63", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaf9f93a-c086-46ca-bc37-4ca5e45f10be", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed657b7c-3c19-4ba1-aa71-5bf5346f5c0b", "name": "Send a delivery again now", "request": { "name": "Send a delivery again now", "description": { "content": "Re-sends immediately instead of waiting for the next backoff step. The event id is unchanged, so a correctly written consumer deduplicates it.\n\n**Requires the `write` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b79bc28f-9c68-4ff9-ab9f-ddc67813fd9d", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e2a1633-4936-4915-b57b-80c703df14e0", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3f940d4-0992-492f-a464-b2527e0f9493", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c200c805-e198-4726-a0bf-7073ebc38ab6", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49492099-708d-4c48-82b2-c85abf41ff6a", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da87ba5f-d514-4fac-ab67-268a3ee50e64", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook delivery's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2455835d-a8b6-4776-80dd-8c9e36640930", "name": "The secret webhook signatures are made with", "request": { "name": "The secret webhook signatures are made with", "description": { "content": "Shown so you can configure a verifier. Compare `x-tone-signature` against an HMAC-SHA256 of `{timestamp}.{raw body}` — the RAW body, before any JSON parsing.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "99908a25-37af-4dcf-87b1-1883bf74484e", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"note\": \"Signs every delivery to this endpoint as x-tone-signature.\",\n \"secret\": \"whsec_3f1a7f6e2b4c4d1e9a8b5c6d7e8f9a0b\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e704ded-c97c-4fb3-84c7-e484f1511c8c", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8520959c-c235-4867-9405-95acde1d5bbc", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19819ee4-8239-49a8-bbd8-31a18db20f5e", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19c01030-3779-4f87-a85b-66cc98c5dce6", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adc7c09a-f992-4d95-91f4-72b01df214f0", "name": "Remove a webhook endpoint", "request": { "name": "Remove a webhook endpoint", "description": { "content": "Deliveries stop immediately. The delivery history goes with it — disable it instead if you still need the record.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "88f5b619-0b8a-4a02-aa91-06aaea5e6dd0", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "817f6a13-68d9-4d66-8f61-fb90407a94bf", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce34406-aa7a-4780-978c-f73281592d2b", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b2d0783-b428-49fa-8d6b-470f837238e3", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff84c0d2-7f17-4773-bac4-27100fe6bafd", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91e58e09-7557-4c8b-809c-f2646cc95220", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17c382b0-46ac-47f8-8a1c-1136d2cb89e3", "name": "Update a webhook endpoint", "request": { "name": "Update a webhook endpoint", "description": { "content": "Change the URL, the subscribed events, or disable it. Disabling stops delivery without losing the endpoint, its secret or its history.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"enabled\": \"\",\n \"events\": [\n \"call.completed\"\n ],\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6dfb0890-0915-4c1a-8ae1-178de81ffc07", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"consecutiveFailures\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"description\": \"Production — order service\",\n \"disabledReason\": null,\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"campaign.finished\"\n ],\n \"id\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"url\": \"https://hooks.acme.example/tone\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c8208ea-1b2b-4add-a7bc-2b99820f3c92", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6dec604-8c2b-4243-84c2-34d91ef54959", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d55e26a-f006-44dd-97d1-1dc87521846a", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b867c6-a814-4c42-ae74-bb074901d916", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5137fe1-6837-42a7-aab4-f61ba46b67a4", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7db4745e-fea2-4d75-9ba5-53d1e7573e6e", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1551cd1e-1981-4204-afef-a739b84ddf3a", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Production CRM sync\",\n \"enabled\": true,\n \"events\": [\n \"call.completed\",\n \"call.failed\"\n ],\n \"url\": \"https://hooks.example.com/tone\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46b9f5a8-369c-4f7e-8416-cbe3ceadb886", "name": "Rotate the signing secret (old one keeps verifying for 24h)", "request": { "name": "Rotate the signing secret (old one keeps verifying for 24h)", "description": { "content": "🔴 During the overlap `x-tone-signature` carries SEVERAL space-delimited signatures, and a verifier that treats the header as one string starts rejecting everything. Accept the delivery if ANY of them matches. Deploy the new secret within the 24 hours.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fc098f12-f6bd-4644-8691-d8c7d19b8ea3", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"previousValidUntil\": \"2026-08-25T09:14:22Z\",\n \"secret\": \"whsec_8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3f84730-8728-46b9-a9ed-29941f0ae9a1", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ba1720-1078-4fda-b13d-5886e81cd022", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4115d89-59f4-4193-b99c-79ec05c04a85", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ee67d7-03a4-44fd-a24e-1fa678117de6", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b9c4774-fb1d-49c0-9fe0-096e379fa9ad", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "roll-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "209dae55-6a9a-4563-b1ea-5eb897d41da5", "name": "This endpoint's signing secret", "request": { "name": "This endpoint's signing secret", "description": { "content": "Each endpoint has its own, so rotating one does not disturb the others.\n\n**Requires the `admin` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dfe38362-2988-4cdc-b85a-51e1b492fba0", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"note\": \"Signs every delivery to this endpoint as x-tone-signature.\",\n \"secret\": \"whsec_3f1a7f6e2b4c4d1e9a8b5c6d7e8f9a0b\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2b04091-ebf8-423d-b0eb-39f387123a14", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8623f9df-96ec-4ad7-b699-4028a987c204", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a6f626d-9edb-4e83-ab90-1a9dca7a2ef3", "name": "No such resource, or it belongs to another organization.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907ac43d-2023-45b3-b5cc-8dd327c49791", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a54817-bdb2-48dc-a90b-da2ed0e1578d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "integrations", "webhooks", ":id", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The webhook endpoint's id." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d52e71e3-75bc-4ccd-b2fe-aee38970c892", "name": "wallet", "description": { "content": "Prepaid balance, the ledger behind it, and spend by category.", "type": "text/plain" }, "item": [ { "id": "cf03de1c-ce00-4ac1-abbd-0807596c4da5", "name": "Prepaid balance and estimated talk time remaining", "request": { "name": "Prepaid balance and estimated talk time remaining", "description": { "content": "Everything is prepaid and in paise. The estimate divides the balance by your per-minute rate, so it is a guide, not a quota. Subscribe to `wallet.balance.low` rather than polling this.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ec99eb9a-43b5-40b5-8a69-83f445f5868e", "originalRequest": { "url": { "path": [ "v1", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"balancePaise\": 0,\n \"currency\": \"INR\",\n \"estimatedMinutesRemaining\": 0,\n \"lowBalanceThresholdPaise\": 0,\n \"ratePaisePerMinute\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b9eb656-6516-4ad4-a3a6-75dc8a8d97ba", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5023998-f7a2-461f-b41d-87e287aa2422", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d94082e2-d862-4b84-b1af-67dce9b01e82", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc060b9-0019-42d9-bd3c-9001ce87d912", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b9ed805-ff00-436a-b258-edab44dcc982", "name": "Wallet transactions, newest first", "request": { "name": "Wallet transactions, newest first", "description": { "content": "The ledger behind the balance, and the source of truth for it: every top-up, call, number purchase, monthly rental and compliance verdict. Append-only — a correction is a new compensating row, never an edit.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25", "description": "How many results to return. 1-100, defaulting to 25." }, { "disabled": false, "key": "cursor", "value": "", "description": "Opaque page cursor from the previous response." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7f965492-8d7f-4a78-bc71-350b0ffd1a27", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"amountPaise\": 0,\n \"balanceAfterPaise\": 0,\n \"createdAt\": \"2026-08-25T09:14:22Z\",\n \"description\": \"Call to +919876543210 (45s)\",\n \"entryType\": \"topup\",\n \"id\": \"1043827\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ce9de79-50c9-46f6-89bc-3ea2c83a2073", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a4b135f-ae10-446f-8869-dfab099b3ea5", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cfd9920-16ad-467d-983b-2fd2b9de0445", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799f7bb2-6dcb-4db9-88bd-633a47b42e36", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2e6be95-94c8-44e4-9678-e744fc5fe483", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ea726cd-71d8-4581-8dbd-0b8308168178", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "wallet", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "48213" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "909741f3-7328-4253-ab49-dac8f70da504", "name": "Spend by category over the selected period", "request": { "name": "Spend by category over the selected period", "description": { "content": "Calls, numbers and adjustments, each as a single figure. A purchase and its reversal fall in the same bucket, so the numbers show what something actually cost rather than a gross figure beside a credit that cancels it.\n\n**Requires the `read` scope.** A key with less gets `403 insufficient_scope`.", "type": "text/plain" }, "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "period", "value": "30d", "description": "How far back to look. A closed set rather than an arbitrary window — this is a billing summary, not a reporting API. Open set — handle an unrecognised value rather than throwing. Today: `7d`, `30d`, `all`." }, { "disabled": false, "key": "agent_id", "value": "", "description": "Narrow the breakdown to one agent calls." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "04486ee8-0089-4ca4-9cb4-4c7c98c6d814", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"addedPaise\": 0,\n \"agentId\": \"9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451\",\n \"categories\": [\n {\n \"category\": \"calls\",\n \"entries\": 0,\n \"spentPaise\": 0\n }\n ],\n \"from\": \"2026-08-25T09:14:22Z\",\n \"period\": \"7d\",\n \"to\": \"2026-08-25T09:14:22Z\",\n \"totalSpentPaise\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c0be495-65ae-4d6e-813e-b6608db2c80b", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4cd840a-08ee-4ed8-bb25-bd6bb5bb0aa4", "name": "Missing, malformed, revoked or expired credential.", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8993a73-5098-4558-94f7-cce1a5c32473", "name": "Authenticated but not permitted — `insufficient_scope`, a session-only route reached with a key, or a compliance `blocked_*` refusal.", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c56f1be8-f248-45e9-810b-36b6645130f6", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046b5b6c-02ad-498c-b2de-d2abee11b2d5", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "What is left of it, as `\"org\";r=;t=`.", "key": "RateLimit", "value": "string" }, { "disabled": false, "description": "The budget in force, as `\"org\";q=;w=`.", "key": "RateLimit-Policy", "value": "string" }, { "disabled": false, "description": "Seconds to wait before retrying.", "key": "Retry-After", "value": "string" }, { "disabled": false, "description": "Requests allowed per minute for this organization and environment.", "key": "X-RateLimit-Limit", "value": "string" }, { "disabled": false, "description": "Requests left in the current window.", "key": "X-RateLimit-Remaining", "value": "string" }, { "disabled": false, "description": "Unix seconds at which the window resets.", "key": "X-RateLimit-Reset", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1361759b-69ec-4371-8c82-044fcb67dc5d", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "wallet", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "30d" }, { "key": "agent_id", "value": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "898ca7b6-a8d5-47e7-ae3d-97a0db6b1c7d", "name": "auth", "description": { "content": "Sign-up pre-checks. The rest of the identity surface is mounted separately.", "type": "text/plain" }, "item": [ { "id": "0bee9ac6-0516-481e-a17c-b0cdbc292f70", "name": "Check whether an email is available for signup", "request": { "name": "Check whether an email is available for signup", "description": { "content": "Sign-up itself answers GENERICALLY when an address is already registered, because telling callers which addresses exist is an account-enumeration oracle. This endpoint exists so the sign-up form can show an honest \"already registered\" message instead; it is deliberately the only place that distinction is made.", "type": "text/plain" }, "url": { "path": [ "v1", "signup", "email-available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a11260f2-bb1d-46c0-9845-1200fa983269", "originalRequest": { "url": { "path": [ "v1", "signup", "email-available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"priya@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1124ad02-257c-40c8-acce-c9940a53247e", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "signup", "email-available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"priya@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e97b911a-19be-447c-8dca-76213da0a463", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "signup", "email-available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"priya@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e68b3ea-e4c4-45f0-9126-bec45d1bc09b", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "signup", "email-available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"priya@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d152187d-004d-4f32-b806-b54285a4928c", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "signup", "email-available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"priya@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "49932ea2-1107-4772-b253-fdb6c066e246", "name": "contact-sales", "description": { "content": "Public enquiry form.", "type": "text/plain" }, "item": [ { "id": "15dc6326-d9d4-4096-ac0e-5a7bffa6e0ea", "name": "Submit a contact-sales enquiry", "request": { "name": "Submit a contact-sales enquiry", "description": { "content": "The public enquiry form behind usetone.ai. No credential required.", "type": "text/plain" }, "url": { "path": [ "v1", "contact-sales" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"companySize\": \"\",\n \"companyWebsite\": \"\",\n \"details\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67446282-3f8b-4d87-983b-bf869ae9995e", "originalRequest": { "url": { "path": [ "v1", "contact-sales" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"building\": [\n \"Order confirmations\"\n ],\n \"companyName\": \"Acme Retail\",\n \"companySize\": \"11-50\",\n \"companyWebsite\": \"https://acme.example\",\n \"details\": \"We place about 5,000 COD confirmation calls a week.\",\n \"email\": \"priya@example.com\",\n \"firstName\": \"Priya\",\n \"lastName\": \"Sharma\",\n \"lookingFor\": [\n \"Outbound calling\",\n \"TRAI compliance\"\n ],\n \"phone\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8369c52c-a09d-4d28-8416-eb7e9809ad25", "name": "Malformed request — `validation_error` names the offending fields.", "originalRequest": { "url": { "path": [ "v1", "contact-sales" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"building\": [\n \"Order confirmations\"\n ],\n \"companyName\": \"Acme Retail\",\n \"companySize\": \"11-50\",\n \"companyWebsite\": \"https://acme.example\",\n \"details\": \"We place about 5,000 COD confirmation calls a week.\",\n \"email\": \"priya@example.com\",\n \"firstName\": \"Priya\",\n \"lastName\": \"Sharma\",\n \"lookingFor\": [\n \"Outbound calling\",\n \"TRAI compliance\"\n ],\n \"phone\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "747a9e2e-2195-4786-9de7-f7ec93a57256", "name": "Well-formed but not valid against current state.", "originalRequest": { "url": { "path": [ "v1", "contact-sales" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"building\": [\n \"Order confirmations\"\n ],\n \"companyName\": \"Acme Retail\",\n \"companySize\": \"11-50\",\n \"companyWebsite\": \"https://acme.example\",\n \"details\": \"We place about 5,000 COD confirmation calls a week.\",\n \"email\": \"priya@example.com\",\n \"firstName\": \"Priya\",\n \"lastName\": \"Sharma\",\n \"lookingFor\": [\n \"Outbound calling\",\n \"TRAI compliance\"\n ],\n \"phone\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43599d97-df05-4da1-ba88-3a0e30b8b030", "name": "Rate limited — see `Retry-After`. `rate_limited`, or `concurrent_call_limit_reached` on a dial.", "originalRequest": { "url": { "path": [ "v1", "contact-sales" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"building\": [\n \"Order confirmations\"\n ],\n \"companyName\": \"Acme Retail\",\n \"companySize\": \"11-50\",\n \"companyWebsite\": \"https://acme.example\",\n \"details\": \"We place about 5,000 COD confirmation calls a week.\",\n \"email\": \"priya@example.com\",\n \"firstName\": \"Priya\",\n \"lastName\": \"Sharma\",\n \"lookingFor\": [\n \"Outbound calling\",\n \"TRAI compliance\"\n ],\n \"phone\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e08e0d3a-622c-462f-9b2a-cc00ff571161", "name": "Something failed on our side. Retry with backoff.", "originalRequest": { "url": { "path": [ "v1", "contact-sales" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"building\": [\n \"Order confirmations\"\n ],\n \"companyName\": \"Acme Retail\",\n \"companySize\": \"11-50\",\n \"companyWebsite\": \"https://acme.example\",\n \"details\": \"We place about 5,000 COD confirmation calls a week.\",\n \"email\": \"priya@example.com\",\n \"firstName\": \"Priya\",\n \"lastName\": \"Sharma\",\n \"lookingFor\": [\n \"Outbound calling\",\n \"TRAI compliance\"\n ],\n \"phone\": \"+919876543210\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"doc_url\": \"http://EbPffCjhwSpqMUIzWg.pqfP1mKUElmk\",\n \"request_id\": \"string\",\n \"details\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://apibeta.usetone.ai", "key": "baseUrl" } ], "info": { "_postman_id": "e703c1c6-5045-461d-80be-80b4ac955175", "name": "Tone API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The +91 phone-number API for AI agents.\n\n`/v1` is a promise, not a version number: changes are additive only. New endpoints,\nnew optional request fields, new response fields and new enum members can appear at any\ntime and are NOT breaking. Nothing you receive today is removed, renamed or retyped.\n\n**Treat every enum as open.** Fields documented with `x-known-values` list what exists\ntoday, not what can ever arrive — handle an unrecognised value instead of throwing.\n\nSuccessful responses are wrapped in `{ data, meta? }`. Failures replace it with\n`{ error }` — branch on `error.code`, never on `error.message`.\n\nContact Support:\n Name: Tone support\n Email: hello@usetone.ai", "type": "text/plain" } } }