{ "item": [ { "id": "1be5ed6c-19e1-4915-90b1-6b5cdaf572dd", "name": "ops", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c0838368-e6b8-41d6-841c-421009a76157", "name": "Healthz", "request": { "name": "Healthz", "description": {}, "url": { "path": [ "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6fffcc3b-a33f-47f3-a011-3dadb159a0cf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "healthz" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da219c1d-e402-476f-9bf5-605d968aa938", "name": "Readyz", "request": { "name": "Readyz", "description": { "content": "Ready means the database answers *and* both isolation checks still hold.\n\nThe admin verification runs only when the admin plane is wired: an unwired\nplane is a stated condition, not unreadiness (ADR-0016 §8).", "type": "text/plain" }, "url": { "path": [ "readyz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7c3dffce-d055-4606-8c8f-564c40ccc43c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "readyz" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "05270ecb-dbeb-4198-a2e7-b2b0c8fb9d4f", "name": "account deletion", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b236d066-260e-469f-aef1-9f0d2a64d958", "name": "Read Account Deletion", "request": { "name": "Read Account Deletion", "description": { "content": "Show only this account's current impact and protected request status.", "type": "text/plain" }, "url": { "path": [ "v1", "account-deletion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e59ccbe4-f407-472b-84eb-69b4f908b2d2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "account-deletion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fresh_auth_method\": \"email_link\",\n \"impact\": {\n \"workspaces\": [\n {\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"tenant_name\": {\n \"value\": \"\"\n },\n \"tenant_status\": {\n \"value\": \"\"\n },\n \"mobile_membership_role\": {\n \"value\": \"\"\n },\n \"legacy_role\": {\n \"value\": \"\"\n },\n \"has_active_subscription\": {\n \"value\": \"\"\n },\n \"is_last_active_owner\": {\n \"value\": \"\"\n }\n },\n {\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"tenant_name\": {\n \"value\": \"\"\n },\n \"tenant_status\": {\n \"value\": \"\"\n },\n \"mobile_membership_role\": {\n \"value\": \"\"\n },\n \"legacy_role\": {\n \"value\": \"\"\n },\n \"has_active_subscription\": {\n \"value\": \"\"\n },\n \"is_last_active_owner\": {\n \"value\": \"\"\n }\n }\n ],\n \"active_membership_count\": 7937,\n \"legacy_user_count\": 6644,\n \"legacy_owner_workspace_count\": 9594,\n \"last_owner_workspace_count\": 4172,\n \"active_owner_subscription_workspace_count\": 4209,\n \"staff_identity_count\": 4501,\n \"onboarding_application_count\": 3474,\n \"invitation_reference_count\": 3715\n },\n \"blockers\": [\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"string\"\n },\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"string\"\n }\n ],\n \"request\": {\n \"id\": \"string\",\n \"status\": \"processing\",\n \"verification_method\": \"email_link\",\n \"requested_at\": \"1984-08-27T05:28:43.136Z\",\n \"confirmed_at\": \"1967-06-19T12:12:26.417Z\",\n \"response_due_at\": \"2014-11-30T11:18:31.107Z\",\n \"processing_started_at\": \"2020-12-17T05:52:35.114Z\",\n \"completed_at\": \"1999-01-18T16:57:53.661Z\",\n \"refused_at\": \"2025-05-06T06:17:25.094Z\"\n },\n \"can_confirm_or_reconfirm\": true,\n \"retention_notices\": [\n {\n \"category\": \"string\",\n \"handling\": \"string\"\n },\n {\n \"category\": \"string\",\n \"handling\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27ff73bd-3210-48dd-89fa-2c6787399b2e", "name": "Create Account Deletion Request", "request": { "name": "Create Account Deletion Request", "description": { "content": "Confirm a password-account request with a fresh password and explicit phrase.", "type": "text/plain" }, "url": { "path": [ "v1", "account-deletion", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"confirmation\": \"string\",\n \"password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "853a3adf-b7a8-415c-8b0a-efafc779e043", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "account-deletion", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"confirmation\": \"string\",\n \"password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fresh_auth_method\": \"email_link\",\n \"impact\": {\n \"workspaces\": [\n {\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"tenant_name\": {\n \"value\": \"\"\n },\n \"tenant_status\": {\n \"value\": \"\"\n },\n \"mobile_membership_role\": {\n \"value\": \"\"\n },\n \"legacy_role\": {\n \"value\": \"\"\n },\n \"has_active_subscription\": {\n \"value\": \"\"\n },\n \"is_last_active_owner\": {\n \"value\": \"\"\n }\n },\n {\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"tenant_name\": {\n \"value\": \"\"\n },\n \"tenant_status\": {\n \"value\": \"\"\n },\n \"mobile_membership_role\": {\n \"value\": \"\"\n },\n \"legacy_role\": {\n \"value\": \"\"\n },\n \"has_active_subscription\": {\n \"value\": \"\"\n },\n \"is_last_active_owner\": {\n \"value\": \"\"\n }\n }\n ],\n \"active_membership_count\": 7937,\n \"legacy_user_count\": 6644,\n \"legacy_owner_workspace_count\": 9594,\n \"last_owner_workspace_count\": 4172,\n \"active_owner_subscription_workspace_count\": 4209,\n \"staff_identity_count\": 4501,\n \"onboarding_application_count\": 3474,\n \"invitation_reference_count\": 3715\n },\n \"blockers\": [\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"string\"\n },\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"string\"\n }\n ],\n \"request\": {\n \"id\": \"string\",\n \"status\": \"processing\",\n \"verification_method\": \"email_link\",\n \"requested_at\": \"1984-08-27T05:28:43.136Z\",\n \"confirmed_at\": \"1967-06-19T12:12:26.417Z\",\n \"response_due_at\": \"2014-11-30T11:18:31.107Z\",\n \"processing_started_at\": \"2020-12-17T05:52:35.114Z\",\n \"completed_at\": \"1999-01-18T16:57:53.661Z\",\n \"refused_at\": \"2025-05-06T06:17:25.094Z\"\n },\n \"can_confirm_or_reconfirm\": true,\n \"retention_notices\": [\n {\n \"category\": \"string\",\n \"handling\": \"string\"\n },\n {\n \"category\": \"string\",\n \"handling\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d660f4dc-9f3a-4d14-bece-1940ca929916", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "account-deletion", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"confirmation\": \"string\",\n \"password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7928e610-7c71-414c-a57b-43c98afbcb9f", "name": "Start Account Deletion Email Confirmation", "request": { "name": "Start Account Deletion Email Confirmation", "description": { "content": "Send fresh proof to a passwordless account's already verified mailbox.", "type": "text/plain" }, "url": { "path": [ "v1", "account-deletion", "email-confirmations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "35f74292-fb67-45cd-9649-f66230dcfde7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "account-deletion", "email-confirmations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"action_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9b896f0-529c-42b1-ba4b-6193e10d0881", "name": "Confirm Account Deletion Email", "request": { "name": "Confirm Account Deletion Email", "description": { "content": "Spend a one-time email proof and create/reconfirm its account's request.\n\nThis route intentionally does not take a cookie: a person may open the link on a\ndifferent device. The high-entropy, one-use token is the credential; trusted-origin\nvalidation ensures only the Vocapable portal can submit it from the fragment ceremony.", "type": "text/plain" }, "url": { "path": [ "v1", "account-deletion", "email-confirmations", "confirm" ], "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 \"token\": \"stringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5a9c027-ca14-49aa-aece-e1255c841e8a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "account-deletion", "email-confirmations", "confirm" ], "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 \"token\": \"stringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fresh_auth_method\": \"email_link\",\n \"impact\": {\n \"workspaces\": [\n {\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"tenant_name\": {\n \"value\": \"\"\n },\n \"tenant_status\": {\n \"value\": \"\"\n },\n \"mobile_membership_role\": {\n \"value\": \"\"\n },\n \"legacy_role\": {\n \"value\": \"\"\n },\n \"has_active_subscription\": {\n \"value\": \"\"\n },\n \"is_last_active_owner\": {\n \"value\": \"\"\n }\n },\n {\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"tenant_name\": {\n \"value\": \"\"\n },\n \"tenant_status\": {\n \"value\": \"\"\n },\n \"mobile_membership_role\": {\n \"value\": \"\"\n },\n \"legacy_role\": {\n \"value\": \"\"\n },\n \"has_active_subscription\": {\n \"value\": \"\"\n },\n \"is_last_active_owner\": {\n \"value\": \"\"\n }\n }\n ],\n \"active_membership_count\": 7937,\n \"legacy_user_count\": 6644,\n \"legacy_owner_workspace_count\": 9594,\n \"last_owner_workspace_count\": 4172,\n \"active_owner_subscription_workspace_count\": 4209,\n \"staff_identity_count\": 4501,\n \"onboarding_application_count\": 3474,\n \"invitation_reference_count\": 3715\n },\n \"blockers\": [\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"string\"\n },\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"string\"\n }\n ],\n \"request\": {\n \"id\": \"string\",\n \"status\": \"processing\",\n \"verification_method\": \"email_link\",\n \"requested_at\": \"1984-08-27T05:28:43.136Z\",\n \"confirmed_at\": \"1967-06-19T12:12:26.417Z\",\n \"response_due_at\": \"2014-11-30T11:18:31.107Z\",\n \"processing_started_at\": \"2020-12-17T05:52:35.114Z\",\n \"completed_at\": \"1999-01-18T16:57:53.661Z\",\n \"refused_at\": \"2025-05-06T06:17:25.094Z\"\n },\n \"can_confirm_or_reconfirm\": true,\n \"retention_notices\": [\n {\n \"category\": \"string\",\n \"handling\": \"string\"\n },\n {\n \"category\": \"string\",\n \"handling\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef068e3d-b534-436d-bfa3-e07d7924eae0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "account-deletion", "email-confirmations", "confirm" ], "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 \"token\": \"stringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "45c7a9a7-44bc-492f-b8bb-18e0aa070e2f", "name": "identity", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c3fe8cd8-b12e-46d1-8418-b8de79191f9d", "name": "Describe the authenticated principal", "request": { "name": "Describe the authenticated principal", "description": {}, "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "daa746aa-dff7-4f33-9286-bc722b8ccd35", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "me" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"string\",\n \"api_key_id\": \"string\",\n \"mode\": \"live\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"user_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bddcad66-f8f4-4e64-90b0-9d4eeae65ff8", "name": "The tenant's user directory (read-only)", "request": { "name": "The tenant's user directory (read-only)", "description": { "content": "Who work can be attributed or assigned to - never a management surface.\n\nInvitations, role changes, and deactivation have no `/v1` route on purpose; this\nexists so the portal can render an assignee picker and resolve \"assign to me\"\n(ADR-0037) without holding anything wider than a read.", "type": "text/plain" }, "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c816e5f2-6e40-4924-b2cb-94360aee2094", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"status\": \"string\",\n \"created_at\": \"1995-04-20T02:42:37.735Z\"\n },\n {\n \"id\": \"string\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"status\": \"string\",\n \"created_at\": \"1989-08-25T10:36:01.961Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8a7dd0b-d939-4c9a-857b-519ebd554a4e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d33c9d6-ac6e-46a4-b559-9dca7bb84765", "name": "List this tenant's API keys", "request": { "name": "List this tenant's API keys", "description": { "content": "Cursor-paginated like every other list endpoint (docs/04-api.md §1).\n\nIt used to answer a bare JSON array - the one exception on the surface - which broke\na generated client's generic list walker on the first resource most developers touch.", "type": "text/plain" }, "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d19197ab-48da-41fb-983d-94178b936695", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"display_prefix\": \"string\",\n \"mode\": \"test\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2016-02-08T13:06:10.216Z\",\n \"name\": \"string\",\n \"expires_at\": \"2016-08-03T18:56:46.584Z\",\n \"revoked_at\": \"1983-03-19T11:48:16.425Z\"\n },\n {\n \"id\": \"string\",\n \"display_prefix\": \"string\",\n \"mode\": \"live\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2014-11-06T05:25:02.457Z\",\n \"name\": \"string\",\n \"expires_at\": \"1985-07-21T13:03:06.652Z\",\n \"revoked_at\": \"1987-02-24T23:22:18.798Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff1f1c1b-e61b-4b1b-9ae2-12f938b2f5a8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a10d27b9-7cf2-4736-a3fd-50e1cfdfd07d", "name": "Create an API key (the secret is returned exactly once)", "request": { "name": "Create an API key (the secret is returned exactly once)", "description": {}, "url": { "path": [ "v1", "api-keys" ], "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 \"scopes\": [\n \"string\"\n ],\n \"mode\": \"test\",\n \"name\": \"string\",\n \"expires_at\": \"2001-04-13T20:17:12.552Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f4c870b0-04b9-4b29-a7c2-ee24a72127d5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "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 \"scopes\": [\n \"string\"\n ],\n \"mode\": \"test\",\n \"name\": \"string\",\n \"expires_at\": \"2001-04-13T20:17:12.552Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"display_prefix\": \"string\",\n \"mode\": \"live\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2015-04-30T18:33:04.692Z\",\n \"secret\": \"string\",\n \"name\": \"string\",\n \"expires_at\": \"1980-02-04T06:35:49.031Z\",\n \"revoked_at\": \"1985-06-22T09:31:36.429Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1029aa9d-23d1-4277-accf-e3731050883d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "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 \"scopes\": [\n \"string\"\n ],\n \"mode\": \"test\",\n \"name\": \"string\",\n \"expires_at\": \"2001-04-13T20:17:12.552Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbe77ad2-d589-47b8-a4a5-120549f81375", "name": "Replace a key with a new secret carrying the same authority", "request": { "name": "Replace a key with a new secret carrying the same authority", "description": { "content": "Retire one key and mint its replacement, in one transaction.\n\nRotation exists because the two-call alternative - create, then delete - has no\nsafe order. Create-then-delete leaves both live if the second call is lost;\ndelete-then-create leaves the integration with no credential at all. Here the\nrevoke is the claim (`revoke_returning`), so a lost response leaves exactly one\nlive key and a replaying client gets `404 api_key_not_found` rather than a second\nreplacement.\n\n**The replacement carries the retired key's mode and scopes, not the caller's.**\nThat is what lets a narrow contractor key rotate itself without the caller having to\nhold what it holds - and it is why the request body has no `scopes` field: there is\nno widening path here to guard, only one that does not exist.", "type": "text/plain" }, "url": { "path": [ "v1", "api-keys", ":key_id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "key_id", "description": "(Required) " } ] }, "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\": \"string\",\n \"expires_at\": \"1962-12-10T00:37:24.903Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7fb1c2c4-f6c8-46e2-8623-7ae0b88ce735", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":key_id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "key_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"expires_at\": \"1962-12-10T00:37:24.903Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"display_prefix\": \"string\",\n \"mode\": \"live\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1994-10-06T12:55:57.688Z\",\n \"secret\": \"string\",\n \"replaced_api_key_id\": \"string\",\n \"name\": \"string\",\n \"expires_at\": \"2016-11-21T17:03:37.604Z\",\n \"revoked_at\": \"2014-10-13T04:32:30.156Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a774f279-af87-4b77-b6de-07379489114c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":key_id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "key_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"expires_at\": \"1962-12-10T00:37:24.903Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a828624d-14ba-48dd-a426-4eb557be0166", "name": "Revoke an API key", "request": { "name": "Revoke an API key", "description": {}, "url": { "path": [ "v1", "api-keys", ":key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5f9e77b4-062f-42a9-9273-e71baf18778d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "key_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab7fb05f-120b-4f00-ab73-cf4ca9693699", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "key_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d3ffe997-9480-4c95-a206-803c6379f699", "name": "mobile", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "acee4db8-4faf-4941-ad25-0dfa388ac0b3", "name": "Approve a mobile PKCE authorization request in the first-party browser", "request": { "name": "Approve a mobile PKCE authorization request in the first-party browser", "description": { "content": "Issue a one-use code or show a workspace chooser for the signed-in account.\n\nBrowser login navigation belongs to the first-party portal bridge. This code-issuing\nendpoint stays native-cookie-only: an absent, stale, or forged browser session receives\nthe normal opaque 401 from :class:`NativeVerifiedDashboard`, never a portal redirect or\na weaker bearer-token fallback.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "membership_id", "value": "string" }, { "disabled": true, "key": "client_id", "value": "vocapable-mobile" }, { "disabled": true, "key": "response_type", "value": "code" }, { "disabled": false, "key": "redirect_uri", "value": "string", "description": "(Required) " }, { "disabled": false, "key": "code_challenge", "value": "lw85flDOs3BTEiav6Ev0JLU2jnW5iuzpXBXPwsMyTJ8fO_dhNhO7c-8YTGx2CVbRM4TP1VduUa8", "description": "(Required) " }, { "disabled": true, "key": "code_challenge_method", "value": "S256" }, { "disabled": true, "key": "scope", "value": "string" }, { "disabled": false, "key": "installation_id", "value": "stringstringstringstringstringstringstringstring", "description": "(Required) " }, { "disabled": false, "key": "platform", "value": "ios", "description": "(Required) " }, { "disabled": true, "key": "device_label", "value": "string" }, { "disabled": false, "key": "state", "value": "stringstringstring", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "22283b74-702a-4aad-9bfc-61c91f891cee", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "membership_id", "value": "string" }, { "key": "client_id", "value": "vocapable-mobile" }, { "key": "response_type", "value": "code" }, { "key": "redirect_uri", "value": "string" }, { "key": "code_challenge", "value": "lw85flDOs3BTEiav6Ev0JLU2jnW5iuzpXBXPwsMyTJ8fO_dhNhO7c-8YTGx2CVbRM4TP1VduUa8" }, { "key": "code_challenge_method", "value": "S256" }, { "key": "scope", "value": "string" }, { "key": "installation_id", "value": "stringstringstringstringstringstringstringstring" }, { "key": "platform", "value": "ios" }, { "key": "device_label", "value": "string" }, { "key": "state", "value": "stringstringstring" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "551401d2-9c5b-40c2-a223-4a6f6de351ef", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "membership_id", "value": "string" }, { "key": "client_id", "value": "vocapable-mobile" }, { "key": "response_type", "value": "code" }, { "key": "redirect_uri", "value": "string" }, { "key": "code_challenge", "value": "lw85flDOs3BTEiav6Ev0JLU2jnW5iuzpXBXPwsMyTJ8fO_dhNhO7c-8YTGx2CVbRM4TP1VduUa8" }, { "key": "code_challenge_method", "value": "S256" }, { "key": "scope", "value": "string" }, { "key": "installation_id", "value": "stringstringstringstringstringstringstringstring" }, { "key": "platform", "value": "ios" }, { "key": "device_label", "value": "string" }, { "key": "state", "value": "stringstringstring" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "295891f4-7892-4650-976f-c1229de8cdda", "name": "Exchange a mobile PKCE code or rotate a refresh credential", "request": { "name": "Exchange a mobile PKCE code or rotate a refresh credential", "description": {}, "url": { "path": [ "v1", "mobile", "token" ], "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 \"grant_type\": \"authorization_code\",\n \"client_id\": \"vocapable-mobile\",\n \"authorization_code\": \"stringstringstringstringstringstringstringstring\",\n \"code_verifier\": \"stringstringstringstringstringstringstringstring\",\n \"redirect_uri\": \"string\",\n \"refresh_token\": \"stringstringstringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b2e513d4-1e6a-4e42-ba15-178b690bcc31", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "token" ], "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 \"grant_type\": \"authorization_code\",\n \"client_id\": \"vocapable-mobile\",\n \"authorization_code\": \"stringstringstringstringstringstringstringstring\",\n \"code_verifier\": \"stringstringstringstringstringstringstringstring\",\n \"redirect_uri\": \"string\",\n \"refresh_token\": \"stringstringstringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"string\",\n \"refresh_token\": \"string\",\n \"expires_at\": \"2017-08-30T22:36:22.024Z\",\n \"tenant_id\": \"string\",\n \"membership_id\": \"string\",\n \"device_id\": \"string\",\n \"role\": \"admin\",\n \"token_type\": \"Bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa34ba1e-06c4-40c2-a0fc-4bcf0e9fb0ba", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "token" ], "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 \"grant_type\": \"authorization_code\",\n \"client_id\": \"vocapable-mobile\",\n \"authorization_code\": \"stringstringstringstringstringstringstringstring\",\n \"code_verifier\": \"stringstringstringstringstringstringstringstring\",\n \"redirect_uri\": \"string\",\n \"refresh_token\": \"stringstringstringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e78af2d-cdb9-4f6c-af2d-813db1324d51", "name": "Bootstrap the authenticated mobile workspace", "request": { "name": "Bootstrap the authenticated mobile workspace", "description": {}, "url": { "path": [ "v1", "mobile", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a492997f-ff94-4f52-8c42-5b9b11ef2a5a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "me" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"string\",\n \"membership\": {\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"account_id\": \"string\",\n \"role\": \"rep\",\n \"status\": \"revoked\",\n \"sessions_valid_after\": \"1987-10-09T14:26:03.154Z\",\n \"display_name\": \"string\",\n \"human_rep_id\": \"string\"\n },\n \"capabilities\": [\n \"activity:read\",\n \"receptionist_studio:write\"\n ],\n \"device\": {\n \"id\": \"string\",\n \"platform\": \"ios\",\n \"status\": \"revoked\",\n \"last_seen_at\": \"2002-12-01T18:01:10.257Z\",\n \"device_label\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8edbd8fa-b860-43f0-b2b6-8ebb6512745d", "name": "List this membership's registered mobile devices", "request": { "name": "List this membership's registered mobile devices", "description": {}, "url": { "path": [ "v1", "mobile", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "549cdf6c-ac90-4312-8e44-b01e86ec3a08", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"platform\": \"ios\",\n \"status\": \"revoked\",\n \"last_seen_at\": \"1993-03-27T04:39:29.826Z\",\n \"device_label\": \"string\"\n },\n {\n \"id\": \"string\",\n \"platform\": \"ios\",\n \"status\": \"revoked\",\n \"last_seen_at\": \"2015-07-14T12:58:50.208Z\",\n \"device_label\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb683cec-615e-4e1f-b9ee-536e51883a8b", "name": "Register, rotate, or clear this device's Expo push endpoint", "request": { "name": "Register, rotate, or clear this device's Expo push endpoint", "description": {}, "url": { "path": [ "v1", "mobile", "devices", "current", "push" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"push_token\": \"string\",\n \"device_label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "af7707d6-6c7f-420c-9978-ffb86043b2df", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", "current", "push" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"push_token\": \"string\",\n \"device_label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"platform\": \"android\",\n \"status\": \"revoked\",\n \"last_seen_at\": \"1979-02-06T10:23:48.902Z\",\n \"device_label\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5e0008-4b36-4c1a-8972-7931f4607a58", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", "current", "push" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"push_token\": \"string\",\n \"device_label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd7cb233-ca2a-4cbc-b8b2-e80e9896e6ab", "name": "Read this device's routine notification and urgent-alert preferences", "request": { "name": "Read this device's routine notification and urgent-alert preferences", "description": {}, "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7073eb9e-2c67-4609-9fe8-d991df0445d8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"urgent_alerts_enabled\": false,\n \"categories\": {\n \"operations\": true,\n \"booking\": true,\n \"integration\": true,\n \"subscription\": true,\n \"coach\": true\n },\n \"quiet_hours\": {\n \"enabled\": true,\n \"start_time\": \"21:34\",\n \"end_time\": \"11:08\",\n \"timezone\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb3e8658-f76a-45e1-8057-a488fa901135", "name": "Set this device's routine notification and urgent-alert preferences", "request": { "name": "Set this device's routine notification and urgent-alert preferences", "description": {}, "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"urgent_alerts_enabled\": false,\n \"categories\": {\n \"operations\": true,\n \"booking\": true,\n \"integration\": true,\n \"subscription\": true,\n \"coach\": true\n },\n \"quiet_hours\": {\n \"enabled\": true,\n \"start_time\": \"17:08\",\n \"end_time\": \"21:52\",\n \"timezone\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6e126226-1cb1-4b58-8ef8-f883a861c592", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"urgent_alerts_enabled\": false,\n \"categories\": {\n \"operations\": true,\n \"booking\": true,\n \"integration\": true,\n \"subscription\": true,\n \"coach\": true\n },\n \"quiet_hours\": {\n \"enabled\": true,\n \"start_time\": \"17:08\",\n \"end_time\": \"21:52\",\n \"timezone\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"urgent_alerts_enabled\": false,\n \"categories\": {\n \"operations\": true,\n \"booking\": true,\n \"integration\": true,\n \"subscription\": true,\n \"coach\": true\n },\n \"quiet_hours\": {\n \"enabled\": true,\n \"start_time\": \"21:34\",\n \"end_time\": \"11:08\",\n \"timezone\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de73b16b-8ad3-4d18-980e-f654c1d2111f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"urgent_alerts_enabled\": false,\n \"categories\": {\n \"operations\": true,\n \"booking\": true,\n \"integration\": true,\n \"subscription\": true,\n \"coach\": true\n },\n \"quiet_hours\": {\n \"enabled\": true,\n \"start_time\": \"17:08\",\n \"end_time\": \"21:52\",\n \"timezone\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0554d92b-2dff-4ff4-8e19-97b805a0b6ab", "name": "Queue one generic notification test for this device only", "request": { "name": "Queue one generic notification test for this device only", "description": { "content": "Queue an ID-only generic test without copying a push route into the response.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c4fc4773-dc34-4458-81fd-9f974bedf932", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", "current", "notification-preferences", "test" ], "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accepted\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d788d1ed-0896-4fd3-ad6b-839a41fc7bb3", "name": "Revoke one of this membership's mobile devices and every session on it", "request": { "name": "Revoke one of this membership's mobile devices and every session on it", "description": {}, "url": { "path": [ "v1", "mobile", "devices", ":device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "72b601b9-f5f1-4cc8-95bc-b166f9c1a627", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", ":device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2cdd2fd-91ee-440c-8752-0d5c13dce6c6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "devices", ":device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7708f529-b0b1-4a2f-a0d4-422269c9ef0f", "name": "Revoke the current mobile refresh session", "request": { "name": "Revoke the current mobile refresh session", "description": {}, "url": { "path": [ "v1", "mobile", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "eaee8753-e865-4800-a00a-896ac8d8895b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70f2f474-4dc1-4683-b8c0-55578de4c869", "name": "List mobile customer-team memberships", "request": { "name": "List mobile customer-team memberships", "description": {}, "url": { "path": [ "v1", "mobile", "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "87b4902e-fa3e-4550-b84b-f1f7025aa6d3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"role\": \"rep\",\n \"status\": \"active\",\n \"display_name\": \"string\",\n \"human_rep_id\": \"string\",\n \"forward_eligible\": false\n },\n {\n \"id\": \"string\",\n \"role\": \"rep\",\n \"status\": \"revoked\",\n \"display_name\": \"string\",\n \"human_rep_id\": \"string\",\n \"forward_eligible\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00aba72a-1da6-4a8b-bdf9-b945e90b30f7", "name": "List team invitation metadata without invitation credentials", "request": { "name": "List team invitation metadata without invitation credentials", "description": {}, "url": { "path": [ "v1", "mobile", "team", "invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ce8121cb-9f63-4895-89f4-3aba2b982585", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", "invitations" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"email\": \"string\",\n \"role\": \"admin\",\n \"status\": \"accepted\",\n \"expires_at\": \"1998-11-29T07:17:07.547Z\",\n \"human_rep_id\": \"string\",\n \"accepted_at\": \"2024-02-06T10:54:16.926Z\",\n \"revoked_at\": \"2004-01-02T09:34:05.905Z\"\n },\n {\n \"id\": \"string\",\n \"email\": \"string\",\n \"role\": \"rep\",\n \"status\": \"revoked\",\n \"expires_at\": \"2013-10-15T12:28:06.559Z\",\n \"human_rep_id\": \"string\",\n \"accepted_at\": \"2008-02-15T03:52:01.394Z\",\n \"revoked_at\": \"1984-08-16T08:50:57.911Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b37af31f-ea3d-4e04-8423-624741d3a087", "name": "Invite an admin, manager, or representative to this workspace", "request": { "name": "Invite an admin, manager, or representative to this workspace", "description": {}, "url": { "path": [ "v1", "mobile", "team", "invitations" ], "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 \"email\": \"string\",\n \"role\": \"admin\",\n \"expires_at\": \"1967-05-21T17:31:16.653Z\",\n \"human_rep_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dc107c28-f4ea-489b-96e1-494fc3f79774", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", "invitations" ], "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 \"email\": \"string\",\n \"role\": \"admin\",\n \"expires_at\": \"1967-05-21T17:31:16.653Z\",\n \"human_rep_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"email\": \"string\",\n \"role\": \"manager\",\n \"status\": \"accepted\",\n \"expires_at\": \"1955-10-17T11:30:54.451Z\",\n \"human_rep_id\": \"string\",\n \"accepted_at\": \"1976-09-03T02:40:05.925Z\",\n \"revoked_at\": \"1992-03-04T07:28:16.688Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2496e60f-03df-4cc3-b850-cf26eac81516", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", "invitations" ], "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 \"email\": \"string\",\n \"role\": \"admin\",\n \"expires_at\": \"1967-05-21T17:31:16.653Z\",\n \"human_rep_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c11e478-3c45-4191-8a1a-7c3eaeff8ca0", "name": "Revoke a pending team invitation", "request": { "name": "Revoke a pending team invitation", "description": {}, "url": { "path": [ "v1", "mobile", "team", "invitations", ":invitation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "invitation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8f040819-d3e6-40bb-9764-fe08d8f6b195", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", "invitations", ":invitation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "invitation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ebcc0c1-2e7f-4588-8b01-ff21bcb1a21e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", "invitations", ":invitation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "invitation_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ceba3811-7172-4227-91ed-5a38aeb1f260", "name": "Read non-PII transfer-destination verification progress for a team member", "request": { "name": "Read non-PII transfer-destination verification progress for a team member", "description": {}, "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9d43f97e-0e0d-4455-a5c4-b708420d990e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"verified\",\n \"transfer_enabled\": true,\n \"verification_attempts\": 6409,\n \"created_at\": \"1970-03-12T17:13:21.528Z\",\n \"updated_at\": \"2018-09-19T21:45:33.010Z\",\n \"expires_at\": \"1980-12-05T18:02:41.662Z\",\n \"verified_at\": \"2000-05-14T13:49:01.549Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51c169c2-d0ff-4461-8202-ed6b17acdbf9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fb520d5-aeeb-4fc3-9b7b-2a15db1d0853", "name": "Deliver an OTP before changing a linked representative's transfer destination", "request": { "name": "Deliver an OTP before changing a linked representative's transfer destination", "description": {}, "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"destination_e164\": \"+52829667\",\n \"transfer_enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "93c3b111-f000-4494-97c3-06816c3f7587", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"destination_e164\": \"+52829667\",\n \"transfer_enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"verified\",\n \"transfer_enabled\": true,\n \"verification_attempts\": 6409,\n \"created_at\": \"1970-03-12T17:13:21.528Z\",\n \"updated_at\": \"2018-09-19T21:45:33.010Z\",\n \"expires_at\": \"1980-12-05T18:02:41.662Z\",\n \"verified_at\": \"2000-05-14T13:49:01.549Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b28892d-908f-4bf7-a113-0487a6491770", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"destination_e164\": \"+52829667\",\n \"transfer_enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1789a20c-2a11-45d6-a6bd-b25cf3b0f4ce", "name": "Confirm a delivered OTP and atomically change the linked transfer destination", "request": { "name": "Confirm a delivered OTP and atomically change the linked transfer destination", "description": {}, "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"verification_id\": \"string\",\n \"code\": \"806866\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bebac555-8052-468d-ba59-f588a60d7dcd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"verification_id\": \"string\",\n \"code\": \"806866\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"verified\",\n \"transfer_enabled\": true,\n \"verification_attempts\": 6409,\n \"created_at\": \"1970-03-12T17:13:21.528Z\",\n \"updated_at\": \"2018-09-19T21:45:33.010Z\",\n \"expires_at\": \"1980-12-05T18:02:41.662Z\",\n \"verified_at\": \"2000-05-14T13:49:01.549Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a949365c-6c11-422e-b4ca-11763c648ac7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id", "transfer-destination-verification", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"verification_id\": \"string\",\n \"code\": \"806866\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30775a26-2da4-4931-9d65-3baba3d969f2", "name": "Change a team member's role, status, or explicit human-rep link", "request": { "name": "Change a team member's role, status, or explicit human-rep link", "description": {}, "url": { "path": [ "v1", "mobile", "team", ":membership_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"role\": \"admin\",\n \"status\": \"active\",\n \"human_rep_id\": \"string\",\n \"replace_human_rep\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4b2ab7c7-7f8d-4735-9f1c-3c5c4d20d898", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"role\": \"admin\",\n \"status\": \"active\",\n \"human_rep_id\": \"string\",\n \"replace_human_rep\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"account_id\": \"string\",\n \"role\": \"admin\",\n \"status\": \"revoked\",\n \"sessions_valid_after\": \"1951-12-11T16:02:39.851Z\",\n \"display_name\": \"string\",\n \"human_rep_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7738a15d-2d65-4ff4-a808-94078b6a9d2c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "team", ":membership_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "membership_id", "description": "(Required) " } ] }, "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 \"role\": \"admin\",\n \"status\": \"active\",\n \"human_rep_id\": \"string\",\n \"replace_human_rep\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a7bd5a1-5c99-4544-9002-168c13345713", "name": "Accept a delivered team invitation in a signed-in first-party browser", "request": { "name": "Accept a delivered team invitation in a signed-in first-party browser", "description": { "content": "Spend a fragment-delivered invite only for the matching verified account email.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "invitations", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstringstringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "07ef8dc3-fa92-45a1-8ea8-cb03e8947f59", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "invitations", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstringstringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"account_id\": \"string\",\n \"role\": \"admin\",\n \"status\": \"revoked\",\n \"sessions_valid_after\": \"1951-12-11T16:02:39.851Z\",\n \"display_name\": \"string\",\n \"human_rep_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8812cc50-e54d-4df5-9e6c-adbd0b585c4b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "invitations", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstringstringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "067adbbb-8172-4172-9f6e-ecb8c5f9fb46", "name": "mobile-integrations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e3405845-8af3-4fcd-b53b-2d425209666b", "name": "Read mobile-safe integration readiness", "request": { "name": "Read mobile-safe integration readiness", "description": { "content": "Return tenant-scoped status to Admins and Managers only.\n\nA Rep has no integration-management responsibility and receives no integration state.\nThe response is deliberately no-store because a reconnection can change booking readiness\noutside the app while it is backgrounded.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "integrations", "readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b70a86ce-2beb-4bcf-a269-66b184fbb9ab", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "integrations", "readiness" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"calendar\": {\n \"status\": \"not_connected\",\n \"booking_enabled\": false,\n \"provider\": \"string\",\n \"manage_on_web\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "059062fc-4211-4c8e-9e3b-d81a7a9ed370", "name": "Read privacy-minimized mobile integration health", "request": { "name": "Read privacy-minimized mobile integration health", "description": { "content": "Return the finite, repair-oriented registry for Admins and Managers.\n\nCalendar connection/booking reflect only the deployed Google Calendar adapter. CRM is\nrepresented explicitly as not shipped rather than guessing from generic webhook rows.\nWebhook health observes a bounded recent aggregate and never exposes endpoint/delivery\nidentities, URLs, secrets, recipients, raw provider errors, or response data.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "integrations", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "18a00b24-6bab-4488-8aad-3a508b0664a8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "integrations", "health" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"generated_at\": \"1947-09-05T11:25:29.023Z\",\n \"items\": [\n {\n \"key\": \"google_calendar_connection\",\n \"status\": \"not_observed\",\n \"reason_code\": \"webhook_delivery_healthy\",\n \"action\": \"browser\",\n \"destination\": \"webhooks\"\n },\n {\n \"key\": \"booking_readiness\",\n \"status\": \"attention\",\n \"reason_code\": \"calendar_not_connected\",\n \"action\": \"none\",\n \"destination\": \"integrations\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e944268c-dd4c-4ace-a4ac-a17f9131a3ad", "name": "Read current privacy-minimized integration incidents", "request": { "name": "Read current privacy-minimized integration incidents", "description": { "content": "Return current evidence-backed repair work for Admins and Managers.\n\nThis is intentionally not an audit timeline or integration browser. It offers only a\nfinite affected capability, a durable last-known health timestamp, and a named fixed\nrepair surface. No row/resource identifiers, endpoint URLs, credentials, provider\ndiagnostics, delivery payloads, recipient data, or customer content crosses this API.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "integrations", "timeline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0852166f-0d0b-49a7-a48c-8a747dccadda", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "integrations", "timeline" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"generated_at\": \"1956-02-25T15:19:10.376Z\",\n \"incidents\": [\n {\n \"capability\": \"google_calendar_connection\",\n \"health_status\": \"unavailable\",\n \"last_known_health_at\": \"1960-09-22T17:06:25.951Z\",\n \"recheck_action\": \"browser\",\n \"destination\": \"webhooks\"\n },\n {\n \"capability\": \"webhook_delivery\",\n \"health_status\": \"unavailable\",\n \"last_known_health_at\": \"2019-06-17T04:19:15.786Z\",\n \"recheck_action\": \"support\",\n \"destination\": \"calendar\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4c3a65c2-8ae3-4e0d-9d91-43a8b02ed6c0", "name": "mobile-receptionist", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "966c2014-0baf-48ee-a399-e420dc949b19", "name": "Read bounded comparative receptionist insights", "request": { "name": "Read bounded comparative receptionist insights", "description": { "content": "Return leader-only aggregates for the current and immediately-prior equal window.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "days", "value": "7", "description": "Comparison window: 7, 30, or 90 days." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be03d098-ede9-440c-954f-abbcec110a95", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "days", "value": "7" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"generated_at\": \"1989-01-02T12:53:36.994Z\",\n \"days\": 7,\n \"current_window\": {\n \"start\": \"1989-01-24T23:46:10.385Z\",\n \"end\": \"2014-05-27T07:19:19.326Z\"\n },\n \"previous_window\": {\n \"start\": \"2006-04-06T13:51:36.059Z\",\n \"end\": \"1997-02-08T03:15:06.420Z\"\n },\n \"cards\": [\n {\n \"key\": \"emergency_override_duration\",\n \"state\": \"insufficient_data\",\n \"unit\": \"seconds\",\n \"current_sample_size\": 2291,\n \"previous_sample_size\": 8290,\n \"detail_target\": \"integration\",\n \"current_value\": 5443,\n \"previous_value\": 9491,\n \"delta\": 8724\n },\n {\n \"key\": \"coverage_health\",\n \"state\": \"unavailable\",\n \"unit\": \"basis_points\",\n \"current_sample_size\": 207,\n \"previous_sample_size\": 585,\n \"detail_target\": \"team\",\n \"current_value\": 4670,\n \"previous_value\": 5100,\n \"delta\": 4803\n },\n {\n \"key\": \"handoff_timing\",\n \"state\": \"unavailable\",\n \"unit\": \"basis_points\",\n \"current_sample_size\": 2399,\n \"previous_sample_size\": 5967,\n \"detail_target\": \"activity\",\n \"current_value\": 3966,\n \"previous_value\": 9313,\n \"delta\": 6984\n },\n {\n \"key\": \"voicemail_aging\",\n \"state\": \"unavailable\",\n \"unit\": \"basis_points\",\n \"current_sample_size\": 1786,\n \"previous_sample_size\": 9065,\n \"detail_target\": \"team\",\n \"current_value\": 6970,\n \"previous_value\": 8310,\n \"delta\": 6631\n },\n {\n \"key\": \"handoff_timing\",\n \"state\": \"unavailable\",\n \"unit\": \"seconds\",\n \"current_sample_size\": 8061,\n \"previous_sample_size\": 6142,\n \"detail_target\": \"integration\",\n \"current_value\": 2815,\n \"previous_value\": 4318,\n \"delta\": 8263\n },\n {\n \"key\": \"handoff_success\",\n \"state\": \"insufficient_data\",\n \"unit\": \"seconds\",\n \"current_sample_size\": 1039,\n \"previous_sample_size\": 8720,\n \"detail_target\": \"inbox\",\n \"current_value\": 1946,\n \"previous_value\": 3289,\n \"delta\": 6066\n },\n {\n \"key\": \"emergency_override_duration\",\n \"state\": \"insufficient_data\",\n \"unit\": \"basis_points\",\n \"current_sample_size\": 4318,\n \"previous_sample_size\": 4024,\n \"detail_target\": \"integration\",\n \"current_value\": 8706,\n \"previous_value\": 6520,\n \"delta\": 1528\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "584ab2bd-770c-48c2-8aaa-e30180b561dd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "days", "value": "7" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc101dc2-bfe0-4dcd-bbf2-54c353fa8b4f", "name": "List live receptionist calls", "request": { "name": "List live receptionist calls", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "live-calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9e1bb64d-c4b7-4785-a02d-c94b6bdc3e5d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "live-calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"call_id\": \"string\",\n \"state\": \"active\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"connected_at\": \"1990-11-20T08:51:49.062Z\",\n \"expires_at\": \"1972-07-13T10:03:19.420Z\"\n },\n {\n \"call_id\": \"string\",\n \"state\": \"handoff_pending\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"connected_at\": \"1977-12-08T06:02:30.657Z\",\n \"expires_at\": \"1958-08-22T11:31:00.096Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1dd109c-bf21-4c1e-8de7-610c8776832b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "live-calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca571130-2492-45c3-8811-7d52985de356", "name": "Recent receptionist activity", "request": { "name": "Recent receptionist activity", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "activity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dd353c66-042d-49e9-a6a8-9f5c8e876889", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"resource_id\": \"string\",\n \"kind\": \"call\",\n \"status\": \"string\",\n \"occurred_at\": \"2008-07-05T11:04:04.374Z\",\n \"call_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\"\n },\n {\n \"resource_id\": \"string\",\n \"kind\": \"appointment\",\n \"status\": \"string\",\n \"occurred_at\": \"1969-10-22T13:00:12.915Z\",\n \"call_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8145a41-febe-4d01-98f1-38599f285fdc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "620c12ab-c3fe-4b55-b32b-4ee703abbe46", "name": "Page receptionist activity with a stable cursor", "request": { "name": "Page receptionist activity with a stable cursor", "description": { "content": "Page the merged activity timeline without offset drift under live call updates.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "activity", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fb93a67b-9c9d-4c7f-b0b3-fedc068cb89a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"resource_id\": \"string\",\n \"kind\": \"live_call\",\n \"status\": \"string\",\n \"occurred_at\": \"1998-02-19T03:38:23.611Z\",\n \"call_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\"\n },\n {\n \"resource_id\": \"string\",\n \"kind\": \"call\",\n \"status\": \"string\",\n \"occurred_at\": \"1958-05-08T12:25:09.717Z\",\n \"call_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d6b0603-4726-4907-953d-0d212d48b3f9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3a4ccf0-74da-454f-b7fc-9d3199edecfd", "name": "Read bounded aggregate receptionist metrics", "request": { "name": "Read bounded aggregate receptionist metrics", "description": { "content": "Return compact operational counts without exposing the calls behind the totals.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The report requires a half-open [start, end) window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6f5c82aa-78bf-4f60-b99d-20a3851e865c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"start\": \"1976-09-03T05:00:47.051Z\",\n \"end\": \"1998-01-01T12:45:05.306Z\",\n \"inbound_calls_received\": 5161,\n \"handoffs_requested\": 6423,\n \"handoffs_accepted\": 9764,\n \"handoffs_redirected\": 8012,\n \"handoffs_completed\": 8511,\n \"handoffs_declined\": 4284,\n \"handoffs_timed_out\": 552,\n \"handoffs_failed\": 9927,\n \"appointments_created\": 1242\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f73ecbe-c283-4cdf-8f02-2b5ecd08e7ee", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40216784-1a67-4001-bbed-92c59ec671a7", "name": "Read an authorized receptionist call transcript", "request": { "name": "Read an authorized receptionist call transcript", "description": { "content": "Serve the durable transcript read model for Admin/Manager activity review.\n\nA mobile bearer has no access to the generic API-key calls router. This adapter keeps\nthat boundary while preserving the exact tenant and recording-consent behavior of the\nexisting transcript reader.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bfb161f5-b7e7-4ff8-b97b-6f10d1d2a0ce", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"full_text\": \"string\",\n \"redaction_status\": \"pii_redacted\",\n \"created_at\": \"2003-01-25T04:38:15.670Z\",\n \"updated_at\": \"1995-08-17T08:11:21.452Z\",\n \"summary\": \"string\",\n \"turns\": [\n {\n \"id\": \"string\",\n \"seq\": 3155,\n \"speaker\": \"contact\",\n \"text\": \"string\",\n \"started_at_ms\": 6255,\n \"created_at\": \"1997-11-09T13:23:33.180Z\",\n \"ended_at_ms\": 9312,\n \"interrupted\": false,\n \"revision\": 0\n },\n {\n \"id\": \"string\",\n \"seq\": 7456,\n \"speaker\": \"contact\",\n \"text\": \"string\",\n \"started_at_ms\": 4305,\n \"created_at\": \"1961-08-06T03:24:12.169Z\",\n \"ended_at_ms\": 141,\n \"interrupted\": false,\n \"revision\": 0\n }\n ],\n \"turns_truncated\": false,\n \"language\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92ee5724-b140-4b31-94d2-c77ce2d7d7ce", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "450a8637-a637-43ce-8922-c0c485d37412", "name": "Report AI-generated receptionist call output for review", "request": { "name": "Report AI-generated receptionist call output for review", "description": { "content": "Create one durable, enum-only content report for an authorized call.\n\nThis is a safety intake, not a live-call control or a transcript-copy endpoint. The\nreport is tied to a tenant-scoped call proven by the existing repository; its body has\nno free-text field, and the audit record contains only opaque IDs and the enum reason.\nA repeated tap returns the original receipt without a second queue or audit entry.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "ai-output-reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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\": \"inaccurate_or_misleading\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c6f348e-6062-4b66-b413-662f06af01b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "ai-output-reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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\": \"inaccurate_or_misleading\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"reason\": \"unsafe_or_harmful\",\n \"review_status\": \"string\",\n \"created\": true,\n \"reported_at\": \"2023-12-16T10:50:28.121Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71adaccd-99ca-420d-9bf7-4b8982da3a47", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "ai-output-reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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\": \"inaccurate_or_misleading\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af037c20-2b3d-4d9f-9185-a1a39898ba34", "name": "Redirect to an authorized short-lived receptionist recording link", "request": { "name": "Redirect to an authorized short-lived receptionist recording link", "description": { "content": "Issue the same short-lived playback link as the main call review surface.\n\nThe response is deliberately a redirect, never audio bytes or a storage locator. The\nregistered recording adapter rechecks retention and tenant ownership before it signs a\ntarget, so native activity cannot turn a durable recording id into a reusable URL.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "49368aca-9f3a-4ca5-86e3-c458a3fc63a7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e3191866-f708-44bf-ae19-d9cb34fe95ff", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "calls", ":call_id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5c99654-f389-49ce-83cd-31d686241f00", "name": "Read an authorized inbound voicemail receipt", "request": { "name": "Read an authorized inbound voicemail receipt", "description": { "content": "Return receipt state and timing; use the call recording route for any audio.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "activity", "voicemails", ":voicemail_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "voicemail_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8521a436-f009-466a-97b4-ab396f199ea3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "voicemails", ":voicemail_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "voicemail_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"absent\",\n \"received_at\": \"1989-05-01T05:38:35.855Z\",\n \"updated_at\": \"2017-09-19T02:52:18.430Z\",\n \"duration_seconds\": 8917,\n \"completed_at\": \"2021-08-01T11:37:10.890Z\",\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e16b2ed-20fd-4036-8c85-e21ab15bd759", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "voicemails", ":voicemail_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "voicemail_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da174ba6-1502-49ba-b246-18d6272fe284", "name": "Read an authorized appointment detail", "request": { "name": "Read an authorized appointment detail", "description": { "content": "Read by opaque activity id, with the repository's tenant predicate in every query.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "activity", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "93fa3bfd-1fea-459c-b909-b4bb5fd12931", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"starts_at\": \"1974-02-24T01:50:40.735Z\",\n \"ends_at\": \"1984-06-28T11:53:37.384Z\",\n \"status\": \"rescheduled\",\n \"created_at\": \"1969-07-26T07:06:00.847Z\",\n \"updated_at\": \"2017-03-12T03:24:52.422Z\",\n \"contact_timezone\": \"string\",\n \"invite_sent_at\": \"2013-11-02T21:57:58.068Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3949abf4-e6ef-4b89-9b17-774deb86ad4f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "activity", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eebee73f-e7b7-4dd0-bd03-fbe894b9ab8b", "name": "Recent transfer history", "request": { "name": "Recent transfer history", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "78b78251-9202-4fe1-a56b-3afa9c1492dd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"system\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1990-09-12T08:20:23.199Z\",\n \"expires_at\": \"2018-06-01T21:35:14.081Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"2010-09-11T04:42:26.232Z\"\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"agent\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"2018-07-12T19:01:23.632Z\",\n \"expires_at\": \"1996-01-09T20:52:25.447Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"2021-05-19T02:02:39.085Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "418aa81f-9bba-4a17-99ff-1473e3c2aa57", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f85cb02e-8eee-478a-ba68-5780b7e5d14b", "name": "Page tenant transfer history with a stable cursor", "request": { "name": "Page tenant transfer history with a stable cursor", "description": { "content": "Page all tenant handoffs; destination numbers remain absent from every page.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "transfers", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "23373631-c659-42d8-ae1a-72bfa7a044b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "transfers", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"system\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"2000-03-25T22:18:40.235Z\",\n \"expires_at\": \"2003-10-16T23:22:12.546Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"1954-10-13T15:27:22.662Z\"\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"user\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1977-12-23T21:07:13.332Z\",\n \"expires_at\": \"1946-11-06T13:04:55.583Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"1999-03-22T15:31:20.228Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bcf06d7-3072-45ca-b4ab-9dd453ae5f17", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "transfers", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cc97185-34cb-4a43-bf23-5fd13e752fef", "name": "Read one transfer history entry", "request": { "name": "Read one transfer history entry", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "transfers", ":handoff_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8dd75281-81bb-4632-b211-a1558447e5e7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "transfers", ":handoff_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"user\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1950-06-05T12:14:00.254Z\",\n \"expires_at\": \"1978-10-03T03:57:53.609Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"2019-06-05T07:20:12.037Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97332c3d-e191-45fd-b829-2f4632c722fe", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "transfers", ":handoff_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7053ab1-9b45-45b9-ae42-59d055280c06", "name": "List the authenticated rep's own transfer history", "request": { "name": "List the authenticated rep's own transfer history", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "868462f5-5b65-43ba-970a-0e3e1b15e9f4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"system\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1959-03-21T09:55:19.291Z\",\n \"expires_at\": \"1998-09-27T11:15:26.960Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"1969-10-10T12:50:07.157Z\"\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"user\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1998-12-27T18:38:44.708Z\",\n \"expires_at\": \"2016-11-10T08:12:20.928Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"2017-08-29T22:15:12.931Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027c894d-ad6a-4972-af68-34422125680a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a56b701-694a-43a2-9951-61f66166f001", "name": "Page the authenticated rep's transfer history", "request": { "name": "Page the authenticated rep's transfer history", "description": { "content": "Keep historical cursor traversal bound to the server-linked rep identity.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e2d5993f-e9d4-487a-8578-4eabaf573ad6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"system\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"2000-03-25T22:18:40.235Z\",\n \"expires_at\": \"2003-10-16T23:22:12.546Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"1954-10-13T15:27:22.662Z\"\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"user\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1977-12-23T21:07:13.332Z\",\n \"expires_at\": \"1946-11-06T13:04:55.583Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"1999-03-22T15:31:20.228Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37764d35-51c7-4bc4-99cb-ead6b33dfd4c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5404cb51-dd6d-4865-bc84-e31a76d6349b", "name": "Read one transfer only when it belongs to the authenticated rep", "request": { "name": "Read one transfer only when it belongs to the authenticated rep", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers", ":handoff_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0bd4b9c4-d8aa-4368-907d-199a1c9f70fc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers", ":handoff_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"requested_by\": \"user\",\n \"mode\": \"string\",\n \"status\": \"string\",\n \"requested_at\": \"1950-06-05T12:14:00.254Z\",\n \"expires_at\": \"1978-10-03T03:57:53.609Z\",\n \"requested_rep_id\": \"string\",\n \"requested_rep_name\": \"string\",\n \"requested_group_id\": \"string\",\n \"resolved_rep_id\": \"string\",\n \"resolved_rep_name\": \"string\",\n \"failure_code\": \"string\",\n \"completed_at\": \"2019-06-05T07:20:12.037Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "955e7362-815f-40ad-81da-fddd9a19ef26", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "my-transfers", ":handoff_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d120bea9-a773-4fe0-89eb-cc6c25bd8c3b", "name": "Read no-cache carrier-confirmed handoff lifecycle", "request": { "name": "Read no-cache carrier-confirmed handoff lifecycle", "description": { "content": "Poll a safe lifecycle projection; carrier callbacks and workers remain the only writers.\n\nAdmins and Managers may review any inbound receptionist handoff in their tenant. A Rep\nreceives the same shape only when their server-linked human-rep id is a durable target\nof the request. The 404 remains identical for absent and unauthorized rep rows.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b1941897-f561-4a29-a968-df4a79c352cf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"call_state\": \"ended\",\n \"status\": \"accepted\",\n \"requested_at\": \"1983-07-12T05:59:35.843Z\",\n \"expires_at\": \"1955-05-20T11:51:19.328Z\",\n \"failure_code\": \"string\",\n \"rep_joined_at\": \"1969-04-22T02:16:34.589Z\",\n \"caller_redirected_at\": \"2025-02-01T05:12:28.910Z\",\n \"completed_at\": \"2019-12-17T14:00:39.438Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b0f59c-cfe5-44f4-9da1-4f44bcb82e6a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ceb57392-746d-44a2-ac81-d5d9ecf94831", "name": "Read whether cellular handoff controls are currently available", "request": { "name": "Read whether cellular handoff controls are currently available", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "handoff-capability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bb5ce963-5d7e-463e-85ec-4f6988a5d013", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoff-capability" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"available\": true,\n \"handoff_feature_enabled\": true,\n \"verified_byo_twilio\": false,\n \"active_transfer_destinations\": 5435,\n \"blockers\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cab5a07b-084d-47ee-885c-b2c8198b2a8e", "name": "List existing contacts selectable for one mobile AI call", "request": { "name": "List existing contacts selectable for one mobile AI call", "description": { "content": "Return live contact labels only; launch-time compliance remains server-side.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "77abfeea-a2e2-4165-87bd-e81cc8b33835", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"company\": \"string\"\n },\n {\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"company\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29122ccc-b73a-433b-8f4c-10722c354ba5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10cbb7f9-158b-4c6f-9d2f-bc5ff8bc1365", "name": "Search existing safe-label contacts for one mobile AI call", "request": { "name": "Search existing safe-label contacts for one mobile AI call", "description": { "content": "Return one virtualized picker page without searching raw contact destinations.\n\nThe response is a narrow selection aid rather than a dialability assertion. The\nsubsequent Call AI command still proves contact ownership and executes all consent,\nDNC, jurisdiction, caller-ID, agreement, spend, and idempotency gates server-side.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "strin", "description": "(Required) At least two label characters." }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "limit", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cb18f95d-ae9a-4059-99d5-36aff85bafa0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "strin" }, { "key": "cursor", "value": "string" }, { "key": "limit", "value": "30" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"company\": \"string\"\n },\n {\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"company\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c5a35ac-5e13-458d-9433-21ccb599d4d5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "strin" }, { "key": "cursor", "value": "string" }, { "key": "limit", "value": "30" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "843de468-66d6-4005-badf-eaad3987b287", "name": "List active published agents selectable for one mobile AI call", "request": { "name": "List active published agents selectable for one mobile AI call", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f5cdb109-655c-4067-80d2-4dfa20010bc6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"published_version\": 5119,\n \"eligibility\": \"published_active\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"published_version\": 5108,\n \"eligibility\": \"published_active\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aa53c72-17dc-4eda-a77a-958a67311e77", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "716a31ac-2cb0-4bcf-add6-0493922b6dbd", "name": "Queue one compliant live/BYO mobile AI call", "request": { "name": "Queue one compliant live/BYO mobile AI call", "description": { "content": "Launch exactly one resource-bound call through the shared production pipeline.\n\nThe native admission dependency enforces rate limits, current production agreements,\nand a membership/device idempotency key before this handler runs. ``mock=False`` is\nintentional: mobile Call AI has no test or managed-carrier branch, and the shared core\nrefuses anything except the tenant's verified default BYO route.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "call-ai" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this mobile Call AI request, so a retry replays the original result instead of placing another call. Stored for 24 hours; a replay carries `Idempotent-Replay: true`. **Required on this endpoint.**", "key": "Idempotency-Key", "value": "string" }, { "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 \"agent_id\": \"string\",\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5cb34ac1-6c55-4afd-afc5-0aa9421360c5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai" ], "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) Unique key for this mobile Call AI request, so a retry replays the original result instead of placing another call. Stored for 24 hours; a replay carries `Idempotent-Replay: true`. **Required on this endpoint.**", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"string\",\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"contact_id\": \"string\",\n \"telephony\": \"string\",\n \"state\": \"string\",\n \"created_at\": \"1955-11-09T19:41:54.010Z\",\n \"disposition\": \"string\",\n \"call_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b22736b-0601-4252-b221-cd9b1fc13dc2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "call-ai" ], "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) Unique key for this mobile Call AI request, so a retry replays the original result instead of placing another call. Stored for 24 hours; a replay carries `Idempotent-Replay: true`. **Required on this endpoint.**", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"string\",\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60f45d1e-ef45-4da1-9cc2-9364048dcb3d", "name": "List tenant-owned receptionist numbers for mobile routing controls", "request": { "name": "List tenant-owned receptionist numbers for mobile routing controls", "description": { "content": "List only policy-routed business voice lines, never caller or contact numbers.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bc6f1999-84fd-465e-8341-4c32e015e4f3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"status\": \"string\"\n },\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"status\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5f7add-094d-4c66-8c31-308f4c8269b5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f117d0c7-0871-499f-a1fa-90464ddf42ce", "name": "Read the mobile-editable answering-policy schedule", "request": { "name": "Read the mobile-editable answering-policy schedule", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "28dbdd0e-cd8b-4655-9dbb-8f8cfa552931", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"timezone\": \"string\",\n \"version\": 3879,\n \"updated_at\": \"2024-08-22T16:59:55.927Z\",\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"07:43\",\n \"end\": \"21:18\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"10:22\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:53\",\n \"end\": \"12:29\"\n },\n {\n \"start\": \"11:03\",\n \"end\": \"11:14\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"20:27\",\n \"end\": \"23:54\"\n },\n {\n \"start\": \"22:39\",\n \"end\": \"22:32\"\n }\n ],\n \"key_3\": [\n {\n \"start\": \"00:32\",\n \"end\": \"23:12\"\n },\n {\n \"start\": \"08:23\",\n \"end\": \"01:32\"\n }\n ]\n },\n \"holiday_dates\": [\n \"2026-05-30\",\n \"1958-12-02\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5d23f2c-6bfd-413f-b6e2-4a928106fc6b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c18628b8-fe77-453d-b710-3e87d2829eca", "name": "Version-check and update answering-policy business hours or holidays", "request": { "name": "Version-check and update answering-policy business hours or holidays", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_version\": 6810,\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n },\n {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"holiday_dates\": [\n \"1996-06-01\",\n \"1991-04-10\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1c4fdde9-ea17-45b4-ad11-deda3d185e94", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_version\": 6810,\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n },\n {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"holiday_dates\": [\n \"1996-06-01\",\n \"1991-04-10\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"timezone\": \"string\",\n \"version\": 3879,\n \"updated_at\": \"2024-08-22T16:59:55.927Z\",\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"07:43\",\n \"end\": \"21:18\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"10:22\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:53\",\n \"end\": \"12:29\"\n },\n {\n \"start\": \"11:03\",\n \"end\": \"11:14\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"20:27\",\n \"end\": \"23:54\"\n },\n {\n \"start\": \"22:39\",\n \"end\": \"22:32\"\n }\n ],\n \"key_3\": [\n {\n \"start\": \"00:32\",\n \"end\": \"23:12\"\n },\n {\n \"start\": \"08:23\",\n \"end\": \"01:32\"\n }\n ]\n },\n \"holiday_dates\": [\n \"2026-05-30\",\n \"1958-12-02\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a6bcbf1-e678-4aa6-9414-54398e97f866", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_version\": 6810,\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n },\n {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"holiday_dates\": [\n \"1996-06-01\",\n \"1991-04-10\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44b8b637-3bcc-4b92-b9e9-19c7b89f437c", "name": "Read the current emergency route override", "request": { "name": "Read the current emergency route override", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "16b14ca5-35df-40f8-8c2b-3edb516ceb82", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_number_id\": \"string\",\n \"mode\": \"ai\",\n \"status\": \"invalid\",\n \"version\": 2473,\n \"expires_at\": \"1977-02-18T17:43:35.325Z\",\n \"created_at\": \"1987-01-01T07:44:33.379Z\",\n \"updated_at\": \"1980-05-02T16:16:29.724Z\",\n \"rep_id\": \"string\",\n \"cleared_at\": \"1952-05-17T14:05:49.512Z\",\n \"invalidated_at\": \"1949-12-29T17:49:20.048Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "935596c6-9204-4044-a6af-82f9301e9af1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de2ff4ee-0377-44c6-bd29-918bab606a61", "name": "Set a mandatory-expiry emergency route override", "request": { "name": "Set a mandatory-expiry emergency route override", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"mode\": \"forward\",\n \"expires_at\": \"2001-12-01T02:57:05.809Z\",\n \"rep_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d9c76ef-6657-4975-a7f1-fbccf6a4f042", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mode\": \"forward\",\n \"expires_at\": \"2001-12-01T02:57:05.809Z\",\n \"rep_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_number_id\": \"string\",\n \"mode\": \"ai\",\n \"status\": \"invalid\",\n \"version\": 2473,\n \"expires_at\": \"1977-02-18T17:43:35.325Z\",\n \"created_at\": \"1987-01-01T07:44:33.379Z\",\n \"updated_at\": \"1980-05-02T16:16:29.724Z\",\n \"rep_id\": \"string\",\n \"cleared_at\": \"1952-05-17T14:05:49.512Z\",\n \"invalidated_at\": \"1949-12-29T17:49:20.048Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aa6fb7c-435d-44e0-9c46-1e4f3b6b3907", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mode\": \"forward\",\n \"expires_at\": \"2001-12-01T02:57:05.809Z\",\n \"rep_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19216ca5-92b0-430f-8293-40269cf47a7a", "name": "Clear an emergency route override and restore the base policy", "request": { "name": "Clear an emergency route override and restore the base policy", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"override_id\": \"string\",\n \"expected_version\": 498\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b4703e62-1911-4255-be3b-bb2e951042ca", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"override_id\": \"string\",\n \"expected_version\": 498\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a2961a5-39c8-4afb-a50a-5ec24d3edd6f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "emergency-override" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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": { "mode": "raw", "raw": "{\n \"override_id\": \"string\",\n \"expected_version\": 498\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "031159d1-6df8-4639-9a27-f2372f8b6a8b", "name": "Read role-aware mobile field-operations readiness", "request": { "name": "Read role-aware mobile field-operations readiness", "description": { "content": "Return current checks and their owned repair surfaces, never hidden diagnostics.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "283d651b-7686-4550-9eec-40be34ba484d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "readiness" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"role\": \"admin\",\n \"generated_at\": \"1963-09-22T16:52:38.225Z\",\n \"items\": [\n {\n \"key\": \"staffing_eligibility\",\n \"state\": \"ready\",\n \"reason_code\": \"v18sgxx30gp994ex4x8rpp6fljuh35a6ne4a9zfl7cc1do\",\n \"next_action\": \"support\",\n \"destination\": \"schedule\"\n },\n {\n \"key\": \"transfer_destination\",\n \"state\": \"unavailable\",\n \"reason_code\": \"a07xqin95mrwfm3cj6c_14_5r613d8cig9_2iub0vxdlc3jcun_7gakr1m49b\",\n \"next_action\": \"support\",\n \"destination\": \"schedule\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "068055f2-8482-40c3-b92e-ddbcce1eb923", "name": "Read privacy-safe live receptionist operations by business number", "request": { "name": "Read privacy-safe live receptionist operations by business number", "description": { "content": "Return operational facts, not a second agent/policy/calling-control surface.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "hub" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ccd0353d-4c72-49ca-81fd-5f1852973459", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "hub" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"generated_at\": \"1961-01-18T19:16:06.038Z\",\n \"items\": [\n {\n \"phone_number_id\": \"string\",\n \"phone_e164\": \"+937383614679\",\n \"published_state\": \"not_published\",\n \"schedule\": {\n \"state\": {\n \"value\": \"\"\n }\n },\n \"emergency_override\": {\n \"state\": {\n \"value\": \"\"\n },\n \"expires_at\": {\n \"value\": \"\"\n }\n },\n \"coverage\": {\n \"state\": {\n \"value\": \"\"\n },\n \"active_rep_count\": {\n \"value\": \"\"\n }\n },\n \"open_follow_up_count\": 2493,\n \"last_authorized_mobile_test\": {\n \"value\": \"\"\n }\n },\n {\n \"phone_number_id\": \"string\",\n \"phone_e164\": \"+32825032704\",\n \"published_state\": \"not_published\",\n \"schedule\": {\n \"state\": {\n \"value\": \"\"\n }\n },\n \"emergency_override\": {\n \"state\": {\n \"value\": \"\"\n },\n \"expires_at\": {\n \"value\": \"\"\n }\n },\n \"coverage\": {\n \"state\": {\n \"value\": \"\"\n },\n \"active_rep_count\": {\n \"value\": \"\"\n }\n },\n \"open_follow_up_count\": 7848,\n \"last_authorized_mobile_test\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd856699-183d-4dd4-820f-677a4ac12576", "name": "List active receptionist lines and their bounded mobile Studio state", "request": { "name": "List active receptionist lines and their bounded mobile Studio state", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7cf15965-568b-4453-a19f-6d528ad9d12c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "studio" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"phone_number_id\": \"string\",\n \"has_published_receptionist\": true,\n \"version\": 3603,\n \"business_facts\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"expires_at\": {\n \"value\": \"\"\n }\n },\n \"updated_at\": \"1951-06-29T05:02:28.954Z\"\n },\n {\n \"phone_number_id\": \"string\",\n \"has_published_receptionist\": false,\n \"version\": 4930,\n \"business_facts\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"expires_at\": {\n \"value\": \"\"\n }\n },\n \"updated_at\": \"2014-09-04T15:33:31.513Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0ce2eda-9f42-4017-9032-0ab01320bcfd", "name": "Read one mobile receptionist Studio state", "request": { "name": "Read one mobile receptionist Studio state", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e6a5a8be-26bd-4f21-bc56-653399c44c05", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"phone_number_id\": \"string\",\n \"has_published_receptionist\": false,\n \"version\": 7718,\n \"business_facts\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": \"weather_delay\",\n \"message\": \"string\",\n \"expires_at\": \"2012-08-25T15:49:30.786Z\"\n },\n \"updated_at\": \"2021-06-27T03:06:32.393Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fea6b574-5956-4617-aef1-1cec7c53c264", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "302a824a-6801-46bf-827e-e684967cface", "name": "Version-check and update bounded receptionist business facts", "request": { "name": "Version-check and update bounded receptionist business facts", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_version\": 7482,\n \"business_facts\": {\n \"key_0\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": \"weather_delay\",\n \"message\": \"string\",\n \"expires_at\": \"1977-05-25T21:14:33.582Z\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "43804c5b-7f69-4fcd-aee9-af71eda197f6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_version\": 7482,\n \"business_facts\": {\n \"key_0\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": \"weather_delay\",\n \"message\": \"string\",\n \"expires_at\": \"1977-05-25T21:14:33.582Z\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"phone_number_id\": \"string\",\n \"has_published_receptionist\": false,\n \"version\": 7718,\n \"business_facts\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": \"weather_delay\",\n \"message\": \"string\",\n \"expires_at\": \"2012-08-25T15:49:30.786Z\"\n },\n \"updated_at\": \"2021-06-27T03:06:32.393Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51708efd-c3fa-4627-b7c7-48e4f3adb7a4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_version\": 7482,\n \"business_facts\": {\n \"key_0\": \"string\"\n },\n \"short_greeting\": \"string\",\n \"escalation_preference\": \"standard\",\n \"temporary_status\": {\n \"template\": \"weather_delay\",\n \"message\": \"string\",\n \"expires_at\": \"1977-05-25T21:14:33.582Z\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "954c8b43-9a4e-45d6-bda6-05b987423426", "name": "Copy a bounded Mobile Studio revision into canonical intelligence review", "request": { "name": "Copy a bounded Mobile Studio revision into canonical intelligence review", "description": { "content": "Write source evidence only; no policy, route, draft, or published version changes.\n\nThe endpoint gives a mobile operator a safe bridge into the same review queue the web\nportal uses. It intentionally cannot promote the selected facts, change the phone\nline's schedule/routing, or bypass source approval and release gates.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio", "intelligence-snapshots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_studio_version\": 4069,\n \"agent_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1c43e62f-1972-40fa-9213-d8e1d4820cee", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio", "intelligence-snapshots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_studio_version\": 4069,\n \"agent_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"studio_version\": 5517,\n \"intelligence_source_id\": \"string\",\n \"source_review_status\": \"approved\",\n \"captured_at\": \"1975-05-13T23:01:52.628Z\",\n \"requires_customer_review\": true,\n \"canonical_draft_changed\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "022b4861-3ee5-4b84-a252-b0fd1d271d54", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "studio", "intelligence-snapshots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"expected_studio_version\": 4069,\n \"agent_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c087e506-5067-466e-ba69-37fb842999b5", "name": "Authorize the system-dialer test target for a published receptionist", "request": { "name": "Authorize the system-dialer test target for a published receptionist", "description": { "content": "Return an owned business number for native ``tel:`` handoff, never place a call.\n\nThe client must display carrier-charge disclosure and invoke the operating system\ndialer. This API has no microphone, call-log, contact, or carrier-control capability.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "test-receptionist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "08a9efd1-cf54-44e7-9fe3-52d9c0eef410", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "test-receptionist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"phone_number_id\": \"string\",\n \"phone_e164\": \"string\",\n \"carrier_charge_notice\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "293f298f-321d-43b0-88fa-5968418f1d0f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "numbers", ":number_id", "test-receptionist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6a8ea84d-5f36-42e9-85d9-d5bfc5f39ece", "name": "mobile-operations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b663dac7-76d3-4161-90f7-e08e0afa2e40", "name": "List Operations Inbox tasks", "request": { "name": "List Operations Inbox tasks", "description": {}, "url": { "path": [ "v1", "mobile", "operations", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "25" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "state", "value": "resolved" }, { "disabled": true, "key": "severity", "value": "high" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3a99e7bd-177e-4aaa-8ee7-f5f352e80396", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" }, { "key": "state", "value": "resolved" }, { "key": "severity", "value": "high" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"open_count\": 9353,\n \"items\": [\n {\n \"id\": \"string\",\n \"category\": \"emergency_override\",\n \"severity\": \"critical\",\n \"state\": \"resolved\",\n \"title\": \"s\",\n \"source_target\": {\n \"kind\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n }\n },\n \"next_action\": \"open_integration_settings\",\n \"created_at\": \"1952-10-11T04:19:16.662Z\",\n \"updated_at\": \"2001-03-31T05:20:20.706Z\",\n \"version\": 1989,\n \"detail\": \"string\",\n \"assignee\": {\n \"value\": \"\"\n },\n \"due_at\": \"1984-10-07T23:53:55.591Z\",\n \"acknowledged_by\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-11-15T12:04:57.756Z\",\n \"resolved_by\": {\n \"value\": \"\"\n },\n \"resolved_at\": \"1954-12-02T06:45:24.722Z\"\n },\n {\n \"id\": \"string\",\n \"category\": \"receptionist_health\",\n \"severity\": \"low\",\n \"state\": \"acknowledged\",\n \"title\": \"string\",\n \"source_target\": {\n \"kind\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n }\n },\n \"next_action\": \"contact_support\",\n \"created_at\": \"2013-10-24T18:33:08.272Z\",\n \"updated_at\": \"1962-04-06T06:47:03.216Z\",\n \"version\": 7699,\n \"detail\": \"string\",\n \"assignee\": {\n \"value\": \"\"\n },\n \"due_at\": \"2002-04-25T21:40:19.132Z\",\n \"acknowledged_by\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2014-04-25T03:26:38.903Z\",\n \"resolved_by\": {\n \"value\": \"\"\n },\n \"resolved_at\": \"2017-09-01T05:46:14.094Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73fbc084-8855-4361-8546-f3c9b327e8a4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "cursor", "value": "string" }, { "key": "state", "value": "resolved" }, { "key": "severity", "value": "high" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6fd950a-4a06-4c2b-b474-a21f2b546455", "name": "Read one Operations Inbox task", "request": { "name": "Read one Operations Inbox task", "description": {}, "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aafb68b4-43c4-4dd4-b574-2fccca5b75e6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"receptionist_health\",\n \"severity\": \"critical\",\n \"state\": \"acknowledged\",\n \"title\": \"string\",\n \"source_target\": {\n \"kind\": \"emergency_override\",\n \"resource_id\": \"string\"\n },\n \"next_action\": \"contact_support\",\n \"created_at\": \"1967-01-28T04:32:46.857Z\",\n \"updated_at\": \"1985-01-23T23:29:23.363Z\",\n \"version\": 5776,\n \"detail\": \"string\",\n \"assignee\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"due_at\": \"1998-09-19T05:48:13.996Z\",\n \"acknowledged_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"acknowledged_at\": \"1989-03-02T00:12:22.443Z\",\n \"resolved_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"resolved_at\": \"1973-12-13T21:18:25.585Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ae18a13-069d-462e-a2cf-aaba3fae7f22", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b20dc88c-998d-43ce-9581-06d48ad335b7", "name": "Acknowledge an Operations Inbox task", "request": { "name": "Acknowledge an Operations Inbox task", "description": {}, "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "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 \"expected_version\": 2069\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6cf54999-ab9a-4aa0-8bbf-51615d845535", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 2069\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"receptionist_health\",\n \"severity\": \"critical\",\n \"state\": \"acknowledged\",\n \"title\": \"string\",\n \"source_target\": {\n \"kind\": \"emergency_override\",\n \"resource_id\": \"string\"\n },\n \"next_action\": \"contact_support\",\n \"created_at\": \"1967-01-28T04:32:46.857Z\",\n \"updated_at\": \"1985-01-23T23:29:23.363Z\",\n \"version\": 5776,\n \"detail\": \"string\",\n \"assignee\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"due_at\": \"1998-09-19T05:48:13.996Z\",\n \"acknowledged_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"acknowledged_at\": \"1989-03-02T00:12:22.443Z\",\n \"resolved_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"resolved_at\": \"1973-12-13T21:18:25.585Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9715ebc-6aa3-44cf-adf5-19261f7aa04b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 2069\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eac41bec-da19-4825-bac8-51182d2af665", "name": "Assign or clear an Operations Inbox task owner", "request": { "name": "Assign or clear an Operations Inbox task owner", "description": {}, "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"expected_version\": 784,\n \"assignee_membership_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b8ad9092-e7d5-4373-bcf9-43c921916b6b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 784,\n \"assignee_membership_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"receptionist_health\",\n \"severity\": \"critical\",\n \"state\": \"acknowledged\",\n \"title\": \"string\",\n \"source_target\": {\n \"kind\": \"emergency_override\",\n \"resource_id\": \"string\"\n },\n \"next_action\": \"contact_support\",\n \"created_at\": \"1967-01-28T04:32:46.857Z\",\n \"updated_at\": \"1985-01-23T23:29:23.363Z\",\n \"version\": 5776,\n \"detail\": \"string\",\n \"assignee\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"due_at\": \"1998-09-19T05:48:13.996Z\",\n \"acknowledged_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"acknowledged_at\": \"1989-03-02T00:12:22.443Z\",\n \"resolved_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"resolved_at\": \"1973-12-13T21:18:25.585Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4424b491-1e8d-49b3-8e9f-37a945dd9bc6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 784,\n \"assignee_membership_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3f5e481-8080-4b88-b173-d8f41541e474", "name": "Resolve an Operations Inbox task without changing its source system", "request": { "name": "Resolve an Operations Inbox task without changing its source system", "description": {}, "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "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 \"expected_version\": 2725\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d11d889b-0ea3-46e6-a823-284651f93dc5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 2725\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"receptionist_health\",\n \"severity\": \"critical\",\n \"state\": \"acknowledged\",\n \"title\": \"string\",\n \"source_target\": {\n \"kind\": \"emergency_override\",\n \"resource_id\": \"string\"\n },\n \"next_action\": \"contact_support\",\n \"created_at\": \"1967-01-28T04:32:46.857Z\",\n \"updated_at\": \"1985-01-23T23:29:23.363Z\",\n \"version\": 5776,\n \"detail\": \"string\",\n \"assignee\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"due_at\": \"1998-09-19T05:48:13.996Z\",\n \"acknowledged_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"acknowledged_at\": \"1989-03-02T00:12:22.443Z\",\n \"resolved_by\": {\n \"id\": \"string\",\n \"display_name\": \"string\"\n },\n \"resolved_at\": \"1973-12-13T21:18:25.585Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5914197-4e55-424a-9dea-fb807af3f215", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "tasks", ":task_id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "Idempotency-Key", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 2725\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3e4b732-bc92-4877-b65d-6a3cc3717327", "name": "Resolve a legacy ID-only notification into a safe mobile destination", "request": { "name": "Resolve a legacy ID-only notification into a safe mobile destination", "description": {}, "url": { "path": [ "v1", "mobile", "operations", "resolve-target", ":event_type", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "voicemail.created", "key": "event_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e31e85f-09fc-4acb-9233-58f5cb74b43b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "resolve-target", ":event_type", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "voicemail.created", "key": "event_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"kind\": \"handoff\",\n \"state\": \"expired\",\n \"resource_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60075067-afb4-4002-9272-663b6bd39970", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "operations", "resolve-target", ":event_type", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "voicemail.created", "key": "event_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6f59c33f-637c-4888-a80d-7a74751decd5", "name": "mobile-step-up", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a1320168-ea86-4f97-a1d3-db545c5765ec", "name": "Begin Mobile Step Up", "request": { "name": "Begin Mobile Step Up", "description": { "content": "Start one browser confirmation for one canonical mobile mutation payload.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "step-up", "requests" ], "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 \"action\": \"call_ai_start\",\n \"target\": \"string\",\n \"payload_hash\": \"stringstringstringstringstringstringstringstringstringstringstri\",\n \"callback_uri\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a73c048c-d63a-47f0-9ce4-38132726e2f2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests" ], "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 \"action\": \"call_ai_start\",\n \"target\": \"string\",\n \"payload_hash\": \"stringstringstringstringstringstringstringstringstringstringstri\",\n \"callback_uri\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"request_id\": \"string\",\n \"portal_url\": \"string\",\n \"expires_at\": \"1986-10-17T14:55:06.142Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "451a0b02-683a-4509-9cd2-48f65a619768", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests" ], "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 \"action\": \"call_ai_start\",\n \"target\": \"string\",\n \"payload_hash\": \"stringstringstringstringstringstringstringstringstringstringstri\",\n \"callback_uri\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29ec58a4-81ca-40a7-af2e-94026c4a0f42", "name": "Get Mobile Step Up Request", "request": { "name": "Get Mobile Step Up Request", "description": {}, "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9550b0b1-072a-459a-b528-36de63fe8bef", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"request_id\": \"string\",\n \"action\": \"team_invitation_revoke\",\n \"action_label\": \"string\",\n \"intent_summary\": {\n \"subject\": \"string\",\n \"effect\": \"string\",\n \"target_reference\": \"string\"\n },\n \"verification_method\": \"email_link\",\n \"status\": \"verified\",\n \"expires_at\": \"1985-12-03T08:25:21.432Z\",\n \"email_expires_at\": \"1961-05-17T06:00:45.947Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73bf206b-8a1e-4cbe-8a3e-811eb282efda", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04b604cc-489c-4d17-aec7-12f6723f25d2", "name": "Complete Mobile Step Up Password", "request": { "name": "Complete Mobile Step Up Password", "description": { "content": "Verify the current password now; a previous sign-in does not count as freshness.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "22cd7fdc-de6d-454a-9bc0-110347a9382a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"callback_url\": \"string\",\n \"expires_at\": \"1991-02-02T12:14:30.658Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43517e9b-a98d-4ad4-a02f-ee4f76e365f7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27c2ab4b-0bd5-459c-8165-7137ebc1284f", "name": "Start Mobile Step Up Email", "request": { "name": "Start Mobile Step Up Email", "description": { "content": "Send one fresh verified-email proof for a passwordless account's request.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "26989bca-dd47-47c8-8e21-fe7905486edc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"expires_at\": \"1981-11-23T20:25:37.525Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1820ebf6-952b-4c1d-8065-2b34c398c3bb", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca40a09d-4267-4912-ae46-230d083bd380", "name": "Complete Mobile Step Up Email", "request": { "name": "Complete Mobile Step Up Email", "description": { "content": "Spend the fragment-held email credential only for the same signed-in account.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "email", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "__Host-vcp-session" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f83d7d4b-5c2c-4315-ae95-9f6a35c72894", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "email", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"callback_url\": \"string\",\n \"expires_at\": \"1991-02-02T12:14:30.658Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63adfef0-b870-4ecd-b480-2d13eb0be6a1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "step-up", "requests", ":request_id", "email", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "__Host-vcp-session", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstringstringstringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "feba1b7f-3383-4166-bfe0-161e7962efb0", "name": "mobile-workspace", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "88710aed-2e2a-461c-9809-c4fca8458cd6", "name": "Read the native Owner Command Center workspace overview", "request": { "name": "Read the native Owner Command Center workspace overview", "description": {}, "url": { "path": [ "v1", "mobile", "workspace", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "251e5198-f1d8-48ee-8152-5ab63f883a04", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "workspace", "overview" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workspace\": {\n \"membership_id\": \"string\",\n \"tenant_id\": \"string\",\n \"label\": \"string\",\n \"role\": \"rep\"\n },\n \"receptionist\": {\n \"state\": \"healthy\",\n \"label\": \"string\",\n \"detail\": \"string\",\n \"open_task_count\": 8247,\n \"production_ready\": false\n },\n \"generated_at\": \"2025-10-10T19:06:34.777Z\",\n \"subscription\": {\n \"status\": \"paused\",\n \"plan_label\": \"string\",\n \"payment_attention\": \"none\",\n \"usage_label\": \"string\",\n \"capacity_label\": \"string\",\n \"spend_cap_progress_bps\": 7287,\n \"next_renewal_at\": \"2023-03-23T01:11:54.421Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f372e14d-248f-4fc9-9021-28bac504cb58", "name": "Read server-derived mobile Get Live work", "request": { "name": "Read server-derived mobile Get Live work", "description": {}, "url": { "path": [ "v1", "mobile", "workspace", "setup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2716d49e-1663-4270-9d5e-8ef481e7b1aa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "workspace", "setup" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"generated_at\": \"2007-09-07T08:33:07.465Z\",\n \"items\": [\n {\n \"key\": \"notifications\",\n \"state\": \"attention\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"none\",\n \"destination\": \"schedule\"\n },\n {\n \"key\": \"notifications\",\n \"state\": \"attention\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"next_action\": \"none\",\n \"destination\": \"subscription\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b4184a1-eaa0-4abd-8476-817c6609aa8b", "name": "List active workspaces eligible for native browser reauthorization", "request": { "name": "List active workspaces eligible for native browser reauthorization", "description": { "content": "Return safe labels only; a client must still run the browser PKCE exchange to switch.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "61af1acc-6619-48ca-b347-5daf5f054f3f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "workspaces" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active_membership_id\": \"string\",\n \"items\": [\n {\n \"membership_id\": \"string\",\n \"tenant_id\": \"string\",\n \"label\": \"string\",\n \"role\": \"admin\"\n },\n {\n \"membership_id\": \"string\",\n \"tenant_id\": \"string\",\n \"label\": \"string\",\n \"role\": \"rep\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09c52743-96a2-46f3-8a5f-29eb3a6601be", "name": "Read a safe subscription and billing-health summary", "request": { "name": "Read a safe subscription and billing-health summary", "description": {}, "url": { "path": [ "v1", "mobile", "billing", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9eab8b2b-bd51-4763-a7a5-ba9be928678e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "billing", "summary" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"plan_label\": \"string\",\n \"status\": \"trialing\",\n \"payment_attention\": \"unavailable\",\n \"generated_at\": \"1992-01-23T05:41:31.065Z\",\n \"usage_label\": \"string\",\n \"capacity_label\": \"string\",\n \"next_renewal_at\": \"2020-02-05T20:35:10.768Z\",\n \"budget\": {\n \"currency\": \"string\",\n \"version\": 195,\n \"updated_at\": \"2022-08-30T12:21:36.483Z\",\n \"amount_minor\": 7634,\n \"period\": \"daily\",\n \"low_balance_threshold_minor\": 8380\n },\n \"invoices\": [\n {\n \"id\": \"string\",\n \"status\": \"paid\",\n \"amount_minor\": 8441,\n \"currency\": \"string\",\n \"due_at\": \"2025-06-17T14:32:59.357Z\"\n },\n {\n \"id\": \"string\",\n \"status\": \"void\",\n \"amount_minor\": 9502,\n \"currency\": \"string\",\n \"due_at\": \"1984-03-15T01:01:49.916Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72cb1430-6363-4187-97d2-00d8be77fe5b", "name": "Set the mobile monthly/daily spend guardrail after fresh browser confirmation", "request": { "name": "Set the mobile monthly/daily spend guardrail after fresh browser confirmation", "description": { "content": "CAS one displayed cap, preserving the wallet's non-mobile threshold and period.\n\nA mobile retry with a lost response cannot replay the state change: the one-use grant\nis consumed and the revision has advanced. The client receives a conflict on retry,\nreloads the live value, and asks for a fresh browser proof rather than guessing.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "billing", "budget" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"expected_version\": 4551,\n \"amount_minor\": 9200\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4259ee05-876d-4540-9bbb-1be2d74cf685", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "billing", "budget" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 4551,\n \"amount_minor\": 9200\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"string\",\n \"version\": 6779,\n \"updated_at\": \"2012-09-06T08:28:52.917Z\",\n \"amount_minor\": 1563,\n \"period\": \"monthly\",\n \"low_balance_threshold_minor\": 8200\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52351de3-b8fc-4fe0-a803-db3f269647c7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "billing", "budget" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"expected_version\": 4551,\n \"amount_minor\": 9200\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d798895-0aeb-488d-a10d-00f3606943ea", "name": "Mint one Stripe-hosted billing-management link after fresh browser confirmation", "request": { "name": "Mint one Stripe-hosted billing-management link after fresh browser confirmation", "description": { "content": "Open only the generic hosted billing home; no native payment or plan mutation exists.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "billing", "portal" ], "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": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ab26b03-2dbb-4e31-9c2f-ebdd93d89a05", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "billing", "portal" ], "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": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"stringstring\",\n \"expires_at\": \"1986-10-08T23:24:01.633Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12a70a94-ddba-492f-b4bd-bcdc4aa55810", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "billing", "portal" ], "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": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "10e57d94-88b3-40b0-858d-e166924052f6", "name": "mobile-change-feed", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cd81aa09-842a-4bf0-924c-30bdf96affb9", "name": "Poll opaque Owner Command Center change hints while the app is foregrounded", "request": { "name": "Poll opaque Owner Command Center change hints while the app is foregrounded", "description": { "content": "Return safe change hints after a tenant-local high-watermark.\n\nThe first request returns a small recent slice to invalidate freshly loaded screens;\nit does not replay audit history. Each subsequent call must send ``next_cursor`` and\nreceives only entries committed after that immutable version. Cursor validation is\nperformed against the current tenant's allowed source rows, not merely by decoding it.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "change-feed" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "17d240e7-dbc8-4cd7-9930-8d923849af50", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "change-feed" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"version\": \"string\",\n \"target\": {\n \"kind\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"version\": \"string\",\n \"target\": {\n \"kind\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c53f11b9-ea45-405c-a03b-17763a426be5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "change-feed" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e3f2d922-aa01-487f-a072-a15264224c43", "name": "mobile-coach", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "310c486a-32bb-4495-971f-21d28d399cdd", "name": "Read the current device's finite Mobile Coach preferences", "request": { "name": "Read the current device's finite Mobile Coach preferences", "description": {}, "url": { "path": [ "v1", "mobile", "coach", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad6db428-b73c-4ef1-87b9-7b09d68f77ca", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "preferences" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"telemetry_opt_in\": false,\n \"recommendations\": [\n {\n \"key\": \"capacity\",\n \"state\": \"snoozed\",\n \"snoozed_until\": \"2012-08-15T18:56:40.078Z\"\n },\n {\n \"key\": \"capacity\",\n \"state\": \"snoozed\",\n \"snoozed_until\": \"1968-11-24T18:44:58.656Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bf9d375-deec-4ff8-91cf-92fc93d3e4a7", "name": "Dismiss, snooze, or restore one fixed Coach recommendation on this device", "request": { "name": "Dismiss, snooze, or restore one fixed Coach recommendation on this device", "description": {}, "url": { "path": [ "v1", "mobile", "coach", "recommendations", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "notifications", "key": "key", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"dismiss\",\n \"snooze_duration\": \"one_week\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "05797e14-9c1c-4040-b004-55e89b359553", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "recommendations", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "notifications", "key": "key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action\": \"dismiss\",\n \"snooze_duration\": \"one_week\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"capacity\",\n \"state\": \"active\",\n \"snoozed_until\": \"1985-01-10T18:19:32.343Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d9d2518-3308-4a51-8d8c-c17f99d47835", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "recommendations", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "notifications", "key": "key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action\": \"dismiss\",\n \"snooze_duration\": \"one_week\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5455c923-7166-42f9-a3da-3d4284b3e6d8", "name": "Set this device's optional anonymous Coach telemetry election", "request": { "name": "Set this device's optional anonymous Coach telemetry election", "description": {}, "url": { "path": [ "v1", "mobile", "coach", "telemetry-consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"telemetry_opt_in\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26f0a986-15af-400b-a1d4-aa2300cdd4b2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "telemetry-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": "PUT", "body": { "mode": "raw", "raw": "{\n \"telemetry_opt_in\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"telemetry_opt_in\": false,\n \"recommendations\": [\n {\n \"key\": \"capacity\",\n \"state\": \"snoozed\",\n \"snoozed_until\": \"2012-08-15T18:56:40.078Z\"\n },\n {\n \"key\": \"capacity\",\n \"state\": \"snoozed\",\n \"snoozed_until\": \"1968-11-24T18:44:58.656Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c80325-52b2-447d-91ed-af201b35a4e9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "telemetry-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": "PUT", "body": { "mode": "raw", "raw": "{\n \"telemetry_opt_in\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd3442bc-b74c-4cdd-baa6-7dac0c37b4e1", "name": "Record one opted-in anonymous aggregate Coach telemetry bucket", "request": { "name": "Record one opted-in anonymous aggregate Coach telemetry bucket", "description": { "content": "Increment no bucket unless this current device explicitly opted in.\n\nThe repository function receives the five finite aggregate dimensions only. In\nparticular, it is never passed the tenant, membership, device, recommendation key,\nrequest id, customer/call resource, or a raw duration.", "type": "text/plain" }, "url": { "path": [ "v1", "mobile", "coach", "telemetry" ], "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 \"action\": \"recommendation_restored\",\n \"duration_bucket\": \"5_to_30_seconds\",\n \"app_version\": \"1.415.6\",\n \"role\": \"manager\",\n \"window_class\": \"resumed_foreground\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0eb34828-dea9-4362-a474-62ec426898ab", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "telemetry" ], "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 \"action\": \"recommendation_restored\",\n \"duration_bucket\": \"5_to_30_seconds\",\n \"app_version\": \"1.415.6\",\n \"role\": \"manager\",\n \"window_class\": \"resumed_foreground\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recorded\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e15a4b-b837-46ba-af2c-8c5e8d4bf7dd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "coach", "telemetry" ], "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 \"action\": \"recommendation_restored\",\n \"duration_bucket\": \"5_to_30_seconds\",\n \"app_version\": \"1.415.6\",\n \"role\": \"manager\",\n \"window_class\": \"resumed_foreground\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4eae2727-ec17-4731-b085-cc4bec1ade50", "name": "mobile-availability", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cdf23053-3e78-4042-b923-db95a5207c79", "name": "Read the caller's finite availability declaration", "request": { "name": "Read the caller's finite availability declaration", "description": {}, "url": { "path": [ "v1", "mobile", "availability", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3d174754-da73-4205-945e-907026613e22", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "availability", "me" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"available\",\n \"available\": false,\n \"available_until\": \"1981-12-18T09:28:09.107Z\",\n \"declared_at\": \"2005-12-26T06:58:44.192Z\",\n \"ended_at\": \"2003-07-14T08:19:06.723Z\",\n \"updated_at\": \"1977-09-07T20:09:58.207Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b716534c-bb60-4ef1-acef-72d9ed7ac558", "name": "Declare the caller available until a selected expiry", "request": { "name": "Declare the caller available until a selected expiry", "description": {}, "url": { "path": [ "v1", "mobile", "availability", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"available_until\": \"1974-10-02T05:44:18.036Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "88135800-89ac-4838-82cd-072ec0a633d2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "availability", "me" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"available_until\": \"1974-10-02T05:44:18.036Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"available\",\n \"available\": false,\n \"available_until\": \"1981-12-18T09:28:09.107Z\",\n \"declared_at\": \"2005-12-26T06:58:44.192Z\",\n \"ended_at\": \"2003-07-14T08:19:06.723Z\",\n \"updated_at\": \"1977-09-07T20:09:58.207Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d19da4a-8594-4a77-a8c3-6283e3f1870f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "availability", "me" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"available_until\": \"1974-10-02T05:44:18.036Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1eb45149-7b18-4e6c-9a0c-f1ac7797bb02", "name": "End the caller's availability early", "request": { "name": "End the caller's availability early", "description": {}, "url": { "path": [ "v1", "mobile", "availability", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9bcc314e-557e-4ce6-90cb-7e9b4a939ba0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "availability", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a7c8a00-3719-4597-9ae1-1bf485e5a95c", "name": "List current team availability without exposing transfer phone numbers", "request": { "name": "List current team availability without exposing transfer phone numbers", "description": {}, "url": { "path": [ "v1", "mobile", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f56a44b5-802a-4808-9ca4-73b7519ff6e6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "availability" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"expired\",\n \"available\": true,\n \"available_until\": \"1975-07-04T10:46:39.403Z\",\n \"declared_at\": \"1974-12-22T23:56:26.041Z\",\n \"ended_at\": \"1971-04-23T06:34:34.692Z\",\n \"updated_at\": \"2022-11-07T06:57:36.309Z\"\n },\n {\n \"membership_id\": \"string\",\n \"rep_id\": \"string\",\n \"status\": \"expired\",\n \"available\": true,\n \"available_until\": \"2012-10-26T16:00:58.898Z\",\n \"declared_at\": \"1973-01-17T18:08:26.435Z\",\n \"ended_at\": \"1980-12-09T04:28:53.238Z\",\n \"updated_at\": \"1996-12-07T15:58:56.509Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "eb417f7c-856e-44fc-a6d8-ec582292a0e7", "name": "mobile-handoff-booking", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fe06e925-cd0c-4d78-acfd-3f2e809f06ca", "name": "Issue short-lived calendar choices for a carrier-confirmed handoff", "request": { "name": "Issue short-lived calendar choices for a carrier-confirmed handoff", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "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 \"start_date\": \"8045-51-68\",\n \"end_date\": \"5033-24-94\",\n \"duration_minutes\": 234,\n \"timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e2f5f821-990c-4267-93df-126670d203fc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "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 \"start_date\": \"8045-51-68\",\n \"end_date\": \"5033-24-94\",\n \"duration_minutes\": 234,\n \"timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"handoff_id\": \"string\",\n \"timezone\": \"string\",\n \"duration_minutes\": 49,\n \"slots\": [\n {\n \"id\": \"string\",\n \"starts_at\": \"1959-06-14T11:47:27.393Z\",\n \"ends_at\": \"1969-11-01T04:20:44.721Z\",\n \"expires_at\": \"2022-07-20T10:18:49.611Z\"\n },\n {\n \"id\": \"string\",\n \"starts_at\": \"1993-08-23T06:17:26.748Z\",\n \"ends_at\": \"2022-01-28T00:53:29.790Z\",\n \"expires_at\": \"2000-04-08T01:28:56.552Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b6cfad1-6191-4550-b9bc-0ab11684d4ca", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "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 \"start_date\": \"8045-51-68\",\n \"end_date\": \"5033-24-94\",\n \"duration_minutes\": 234,\n \"timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97ac298f-6990-43d8-a2b9-659130ee1230", "name": "Book one server-issued handoff calendar slot", "request": { "name": "Book one server-issued handoff calendar slot", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this mobile booking request, so a retry replays the original calendar receipt instead of creating another invitation. Stored for 24 hours; a replay carries `Idempotent-Replay: true`.", "key": "Idempotency-Key", "value": "string" }, { "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 \"slot_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f5d12eb-e777-437a-b125-9ef59e631d45", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this mobile booking request, so a retry replays the original calendar receipt instead of creating another invitation. Stored for 24 hours; a replay carries `Idempotent-Replay: true`.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"slot_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"handoff_id\": \"string\",\n \"starts_at\": \"1982-07-21T20:09:07.594Z\",\n \"ends_at\": \"2005-03-16T18:58:14.879Z\",\n \"timezone\": \"string\",\n \"status\": \"calendar_event_created\",\n \"booked_at\": \"2024-07-28T10:29:02.547Z\",\n \"appointment_id\": \"string\",\n \"materialized_at\": \"2003-02-09T05:28:59.872Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "240f4911-04a5-4e3d-b540-6dee69a0253c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this mobile booking request, so a retry replays the original calendar receipt instead of creating another invitation. Stored for 24 hours; a replay carries `Idempotent-Replay: true`.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"slot_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a33a75a-5119-45a4-9c1e-ca2a5ad559aa", "name": "Read a handoff booking receipt without calendar or contact data", "request": { "name": "Read a handoff booking receipt without calendar or contact data", "description": {}, "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "368fedda-7ece-4b10-a782-7f65b32b1176", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"handoff_id\": \"string\",\n \"starts_at\": \"1982-07-21T20:09:07.594Z\",\n \"ends_at\": \"2005-03-16T18:58:14.879Z\",\n \"timezone\": \"string\",\n \"status\": \"calendar_event_created\",\n \"booked_at\": \"2024-07-28T10:29:02.547Z\",\n \"appointment_id\": \"string\",\n \"materialized_at\": \"2003-02-09T05:28:59.872Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "766d2356-7513-4f44-aade-4ffc231bcc55", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "mobile", "receptionist", "handoffs", ":handoff_id", "booking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "handoff_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ed7e370c-3769-44c6-b555-873224b257bd", "name": "agreements", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "176746f0-e421-4dc6-bf12-41289ac2b783", "name": "The served legal documents and this tenant's acceptances", "request": { "name": "The served legal documents and this tenant's acceptances", "description": {}, "url": { "path": [ "v1", "agreements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ca860641-0c2c-436a-8020-29c90032b7b5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agreements" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"documents\": [\n {\n \"kind\": \"test_calls_addendum\",\n \"version\": \"string\",\n \"content_sha256\": \"string\",\n \"gate_scope\": \"production\",\n \"draft\": true,\n \"accepted\": true,\n \"markdown\": \"string\",\n \"accepted_version\": \"string\",\n \"accepted_at\": \"2015-11-27T19:16:13.726Z\"\n },\n {\n \"kind\": \"telecom_addendum\",\n \"version\": \"string\",\n \"content_sha256\": \"string\",\n \"gate_scope\": \"cold_outreach\",\n \"draft\": true,\n \"accepted\": false,\n \"markdown\": \"string\",\n \"accepted_version\": \"string\",\n \"accepted_at\": \"2016-06-02T01:29:38.042Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12f4ba16-1ef4-447a-b6d4-2a4a09a5b3ed", "name": "Accept the current version of one legal document", "request": { "name": "Accept the current version of one legal document", "description": {}, "url": { "path": [ "v1", "agreements", "accept" ], "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 \"agreement_kind\": \"three_year_commitment_addendum\",\n \"version\": \"string\",\n \"content_sha256\": \"111290d3236a4f050ae008d9f98b7c49ce1819b649f20a836a07abf35d0d87b9\",\n \"signer_name\": \"st\",\n \"signer_title\": \"string\",\n \"signer_email\": \"eb?^sk!}`S}@pJ[>4GHp.)km?\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e7db9bf8-9d1f-4d12-82fe-2ead3bc8ad60", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agreements", "accept" ], "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 \"agreement_kind\": \"three_year_commitment_addendum\",\n \"version\": \"string\",\n \"content_sha256\": \"111290d3236a4f050ae008d9f98b7c49ce1819b649f20a836a07abf35d0d87b9\",\n \"signer_name\": \"st\",\n \"signer_title\": \"string\",\n \"signer_email\": \"eb?^sk!}`S}@pJ[>4GHp.)km?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agreement_kind\": \"cold_outreach_waiver\",\n \"version\": \"string\",\n \"content_sha256\": \"string\",\n \"signer_name\": \"string\",\n \"signer_title\": \"string\",\n \"signer_email\": \"string\",\n \"accepted_at\": \"2019-03-17T19:13:15.096Z\",\n \"signer_ip\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5d9d590-1f33-4500-878b-e17120c41b16", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agreements", "accept" ], "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 \"agreement_kind\": \"three_year_commitment_addendum\",\n \"version\": \"string\",\n \"content_sha256\": \"111290d3236a4f050ae008d9f98b7c49ce1819b649f20a836a07abf35d0d87b9\",\n \"signer_name\": \"st\",\n \"signer_title\": \"string\",\n \"signer_email\": \"eb?^sk!}`S}@pJ[>4GHp.)km?\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "71a53fdf-7a04-4d91-a158-c5c3f2acb77d", "name": "agents", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7b6fcdc1-755f-4819-81f2-26505bd41d9a", "name": "List this tenant's agents", "request": { "name": "List this tenant's agents", "description": {}, "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." }, { "disabled": true, "key": "use_case", "value": "string", "description": "Filter on `use_case`. Comma-separated values are OR." }, { "disabled": true, "key": "use_case.gte", "value": "string", "description": "Filter on `use_case` with the `gte` operator." }, { "disabled": true, "key": "use_case.lte", "value": "string", "description": "Filter on `use_case` with the `lte` operator." }, { "disabled": true, "key": "use_case.gt", "value": "string", "description": "Filter on `use_case` with the `gt` operator." }, { "disabled": true, "key": "use_case.lt", "value": "string", "description": "Filter on `use_case` with the `lt` operator." }, { "disabled": true, "key": "use_case.in", "value": "string", "description": "Filter on `use_case` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f83424c0-368e-43d9-a77f-406c614271d9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" }, { "key": "use_case", "value": "string" }, { "key": "use_case.gte", "value": "string" }, { "key": "use_case.lte", "value": "string" }, { "key": "use_case.gt", "value": "string" }, { "key": "use_case.lt", "value": "string" }, { "key": "use_case.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"reminder\",\n \"status\": \"active\",\n \"created_at\": \"1958-12-07T16:51:13.806Z\",\n \"updated_at\": \"1986-01-02T07:51:03.327Z\",\n \"latest_version\": 8202,\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"seeded_from_template_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"recruiting\",\n \"status\": \"active\",\n \"created_at\": \"1997-10-10T16:56:49.631Z\",\n \"updated_at\": \"1951-06-04T19:01:03.363Z\",\n \"latest_version\": 3226,\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"seeded_from_template_id\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a43a62-af6c-415d-ae91-f146019dfbad", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" }, { "key": "use_case", "value": "string" }, { "key": "use_case.gte", "value": "string" }, { "key": "use_case.lte", "value": "string" }, { "key": "use_case.gt", "value": "string" }, { "key": "use_case.lt", "value": "string" }, { "key": "use_case.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c51ae5b-55d8-4be0-85b9-65d58fdd72df", "name": "Create an agent definition", "request": { "name": "Create an agent definition", "description": {}, "url": { "path": [ "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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\": \"string\",\n \"use_case\": \"staffing\",\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"persona\": {\n \"key_0\": \"string\"\n },\n \"objectives\": [\n {\n \"key_0\": \"string\",\n \"key_1\": true\n },\n {\n \"key_0\": 7029.7006615344635\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": 1445.595805824995,\n \"key_1\": true,\n \"key_2\": 2138.0148222502935\n },\n \"max_call_seconds\": 239,\n \"max_turns\": 5923\n },\n \"tools\": [\n \"record_sms_consent\",\n \"record_survey_answer\"\n ],\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_target_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"llm_route\": {\n \"primary\": \"s\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 3120,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"callback_e164\": \"+19995323640\"\n },\n \"compliance_profile_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "954bc83d-52b7-44be-92fb-612bc16aab4b", "name": "Successful Response", "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 " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"use_case\": \"survey\",\n \"disclosure_config\": {\n \"key_0\": \"string\"\n },\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"en\",\n \"en\"\n ],\n \"allow_language_switch\": true\n },\n \"persona\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 160.91652684627977,\n \"key_3\": \"string\"\n },\n \"objectives\": [\n {\n \"key_0\": 9230,\n \"key_1\": true\n },\n {\n \"key_0\": true,\n \"key_1\": 6323,\n \"key_2\": true,\n \"key_3\": \"string\"\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": 6486.914968446191\n },\n \"max_call_seconds\": 161,\n \"max_turns\": 5301\n },\n \"tools\": [\n \"take_message\",\n \"send_verification_code\"\n ],\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_target_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 5421,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+720928823\"\n },\n \"compliance_profile_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"survey\",\n \"status\": \"draft\",\n \"created_at\": \"2023-07-29T09:08:59.211Z\",\n \"updated_at\": \"2014-03-23T08:00:07.459Z\",\n \"persona\": {\n \"key_0\": 6876.821731519262,\n \"key_1\": 7908.15360930931,\n \"key_2\": true,\n \"key_3\": 4831.524335626847\n },\n \"objectives\": [\n {\n \"key_0\": 2539,\n \"key_1\": false\n },\n {\n \"key_0\": 9152,\n \"key_1\": false\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 843.2035797727599\n },\n \"max_call_seconds\": 843,\n \"max_turns\": 42\n },\n \"tools\": [\n \"open_ticket\",\n \"record_qualification\"\n ],\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"latest_version\": 5183,\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"seeded_from_template_id\": \"string\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_targets\": [\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n },\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n }\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"knowledge_pack_version\": 9803,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+343967268\"\n },\n \"compliance_profile_id\": \"string\",\n \"seeded_from_template_version\": 7196\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b0d2f6d-e6bc-4653-8dc0-1139f6064cc9", "name": "Validation Error", "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 " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"use_case\": \"survey\",\n \"disclosure_config\": {\n \"key_0\": \"string\"\n },\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"en\",\n \"en\"\n ],\n \"allow_language_switch\": true\n },\n \"persona\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 160.91652684627977,\n \"key_3\": \"string\"\n },\n \"objectives\": [\n {\n \"key_0\": 9230,\n \"key_1\": true\n },\n {\n \"key_0\": true,\n \"key_1\": 6323,\n \"key_2\": true,\n \"key_3\": \"string\"\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": 6486.914968446191\n },\n \"max_call_seconds\": 161,\n \"max_turns\": 5301\n },\n \"tools\": [\n \"take_message\",\n \"send_verification_code\"\n ],\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_target_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 5421,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+720928823\"\n },\n \"compliance_profile_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d18a7e1e-55e4-4f3c-9a65-f636b685fb89", "name": "Read one agent definition", "request": { "name": "Read one agent definition", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "683f2dcc-7860-4fa0-a561-4aaf938cebd8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"survey\",\n \"status\": \"draft\",\n \"created_at\": \"2023-07-29T09:08:59.211Z\",\n \"updated_at\": \"2014-03-23T08:00:07.459Z\",\n \"persona\": {\n \"key_0\": 6876.821731519262,\n \"key_1\": 7908.15360930931,\n \"key_2\": true,\n \"key_3\": 4831.524335626847\n },\n \"objectives\": [\n {\n \"key_0\": 2539,\n \"key_1\": false\n },\n {\n \"key_0\": 9152,\n \"key_1\": false\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 843.2035797727599\n },\n \"max_call_seconds\": 843,\n \"max_turns\": 42\n },\n \"tools\": [\n \"open_ticket\",\n \"record_qualification\"\n ],\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"latest_version\": 5183,\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"seeded_from_template_id\": \"string\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_targets\": [\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n },\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n }\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"knowledge_pack_version\": 9803,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+343967268\"\n },\n \"compliance_profile_id\": \"string\",\n \"seeded_from_template_version\": 7196\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "259199ba-6512-44b9-8820-badee8d7fa19", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eee22f11-d61e-41d7-b882-a835d9a22608", "name": "Edit an agent definition", "request": { "name": "Edit an agent definition", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"use_case\": \"receptionist\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"en\"\n ],\n \"allow_language_switch\": true\n },\n \"persona\": {\n \"key_0\": 9838,\n \"key_1\": 4977.004286280912,\n \"key_2\": 7294\n },\n \"objectives\": [\n {\n \"key_0\": 8971.211692048071,\n \"key_1\": \"string\"\n },\n {\n \"key_0\": \"string\",\n \"key_1\": 8411.210229016828\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": 1599,\n \"key_1\": 2274,\n \"key_2\": 2421.327178854813\n },\n \"max_call_seconds\": 59,\n \"max_turns\": 5324\n },\n \"tools\": [\n \"send_sms\",\n \"take_message\"\n ],\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_target_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 8179,\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"callback_e164\": \"+16918576707478\"\n },\n \"compliance_profile_id\": \"string\",\n \"status\": \"archived\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b687dbaf-ea96-4060-9d87-60552fdb7b75", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"use_case\": \"sdr\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"persona\": {\n \"key_0\": \"string\"\n },\n \"objectives\": [\n {\n \"key_0\": 7266.096518030611,\n \"key_1\": \"string\"\n },\n {\n \"key_0\": 9935,\n \"key_1\": \"string\"\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": true,\n \"key_1\": 2340\n },\n \"max_call_seconds\": 579,\n \"max_turns\": 6695\n },\n \"tools\": [\n \"end_call\",\n \"schedule_callback\"\n ],\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_target_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 6536,\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+204465645734557\"\n },\n \"compliance_profile_id\": \"string\",\n \"status\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"survey\",\n \"status\": \"draft\",\n \"created_at\": \"2023-07-29T09:08:59.211Z\",\n \"updated_at\": \"2014-03-23T08:00:07.459Z\",\n \"persona\": {\n \"key_0\": 6876.821731519262,\n \"key_1\": 7908.15360930931,\n \"key_2\": true,\n \"key_3\": 4831.524335626847\n },\n \"objectives\": [\n {\n \"key_0\": 2539,\n \"key_1\": false\n },\n {\n \"key_0\": 9152,\n \"key_1\": false\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 843.2035797727599\n },\n \"max_call_seconds\": 843,\n \"max_turns\": 42\n },\n \"tools\": [\n \"open_ticket\",\n \"record_qualification\"\n ],\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"latest_version\": 5183,\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"seeded_from_template_id\": \"string\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_targets\": [\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n },\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n }\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"knowledge_pack_version\": 9803,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+343967268\"\n },\n \"compliance_profile_id\": \"string\",\n \"seeded_from_template_version\": 7196\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32e57ee7-9357-48c1-8c90-92943fb4335e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"use_case\": \"sdr\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"persona\": {\n \"key_0\": \"string\"\n },\n \"objectives\": [\n {\n \"key_0\": 7266.096518030611,\n \"key_1\": \"string\"\n },\n {\n \"key_0\": 9935,\n \"key_1\": \"string\"\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": true,\n \"key_1\": 2340\n },\n \"max_call_seconds\": 579,\n \"max_turns\": 6695\n },\n \"tools\": [\n \"end_call\",\n \"schedule_callback\"\n ],\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_target_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 6536,\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+204465645734557\"\n },\n \"compliance_profile_id\": \"string\",\n \"status\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20d65ca8-ca41-4c05-9f8b-bcf762925c64", "name": "Queue a scripted golden-transcript release evaluation", "request": { "name": "Queue a scripted golden-transcript release evaluation", "description": { "content": "Queue one replay of the exact draft the customer sees now.\n\nThis route does not run a model or any tenant integration. It only snapshots the\ndraft, locks the definition while it deduplicates a request retry, and leaves the\ndeployment's scripted release worker to later replay built-in goldens with sandboxed tools.\nUntil that worker is deployed and claims the run, the customer-visible state remains queued.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":agent_id", "release-gate-evaluations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f6ccb551-dea0-467a-8ffe-368a10e496e8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "release-gate-evaluations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"status\": \"failed\",\n \"mode\": \"scripted_stand_in\",\n \"draft_hash\": \"string\",\n \"draft_updated_at\": \"1983-02-12T10:09:21.316Z\",\n \"results\": {\n \"key_0\": 1840.695758035842,\n \"key_1\": true,\n \"key_2\": 4399\n },\n \"passed\": false,\n \"created_at\": \"2018-05-04T08:40:15.799Z\",\n \"reused\": false,\n \"dataset_ref\": \"string\",\n \"aggregate_score\": \"000000070553651469\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e35f9271-7cdb-42ed-9bb4-573315cf6294", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "release-gate-evaluations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbf7e8ce-e9ce-44f3-a92d-e71cb7cc92cf", "name": "List release-gate evaluations for an agent", "request": { "name": "List release-gate evaluations for an agent", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "release-gate-evaluations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "890888fe-b794-43ed-b96a-9c5617f850b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "release-gate-evaluations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"status\": \"queued\",\n \"mode\": \"scripted_stand_in\",\n \"draft_hash\": \"string\",\n \"draft_updated_at\": \"1967-12-02T22:54:04.990Z\",\n \"results\": {\n \"key_0\": true,\n \"key_1\": 4426,\n \"key_2\": 8245.554939739712,\n \"key_3\": \"string\"\n },\n \"passed\": true,\n \"created_at\": \"1984-07-06T09:55:26.823Z\",\n \"dataset_ref\": \"string\",\n \"aggregate_score\": \"06499088108.59970180\"\n },\n {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"status\": \"running\",\n \"mode\": \"routing_chain\",\n \"draft_hash\": \"string\",\n \"draft_updated_at\": \"2017-02-21T08:04:29.933Z\",\n \"results\": {\n \"key_0\": 1765.076553608882,\n \"key_1\": true,\n \"key_2\": 2348.2365397405338,\n \"key_3\": false\n },\n \"passed\": true,\n \"created_at\": \"1972-11-02T21:51:39.957Z\",\n \"dataset_ref\": \"string\",\n \"aggregate_score\": \"+41232763.06327\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d76c3fac-f892-42cf-aa6f-f930ba1de023", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "release-gate-evaluations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac402813-ad57-4126-95f3-7d7be8939f34", "name": "Read receptionist release readiness, evidence status, and rollback availability", "request": { "name": "Read receptionist release readiness, evidence status, and rollback availability", "description": { "content": "Expose a compact control-center view without leaking sealed prompt knowledge.\n\nA passing scripted replay keeps its historic meaning (publish-ready), while\n``production_ready`` requires the separate live-model and carrier evidence that a\nsilent or misrouted PSTN session actually depends on.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0999075f-256b-44cf-94b3-06eceb9fd122", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_definition_id\": \"string\",\n \"publish_ready\": false,\n \"rollback_ready\": false,\n \"active_version\": {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 6820,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 893,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"1959-04-24T08:49:40.306Z\",\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 847.5272534612666\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"2021-05-09T07:49:33.948Z\",\n \"published_by\": \"string\"\n },\n \"rollback_candidate\": {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 2256,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 5898,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"2023-09-20T09:27:03.880Z\",\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": 6604,\n \"key_1\": 4281,\n \"key_2\": \"string\"\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"1984-08-10T04:57:03.042Z\",\n \"published_by\": \"string\"\n },\n \"current_draft_hash\": \"string\",\n \"current_gate\": {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"status\": \"running\",\n \"mode\": \"scripted_stand_in\",\n \"draft_hash\": \"string\",\n \"draft_updated_at\": \"2014-06-12T15:32:35.043Z\",\n \"results\": {\n \"key_0\": 7109.8950056403055\n },\n \"passed\": false,\n \"created_at\": \"1987-02-02T13:28:09.336Z\",\n \"dataset_ref\": \"string\",\n \"aggregate_score\": \"0000643687\"\n },\n \"current_live_model_preflight\": {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"status\": \"completed\",\n \"mode\": \"routing_chain\",\n \"draft_hash\": \"string\",\n \"draft_updated_at\": \"1979-08-07T10:00:48.566Z\",\n \"results\": {\n \"key_0\": 2107,\n \"key_1\": 4942\n },\n \"passed\": true,\n \"created_at\": \"1952-09-07T03:21:31.896Z\",\n \"dataset_ref\": \"string\",\n \"aggregate_score\": \"-000000475414711\"\n },\n \"live_model_preflight_evidence\": {\n \"capability_manifest_hash\": \"c25f51cbf0d186a436eabd96a8268b129f3a5648ccb44624350c973af5768fab\",\n \"rendered_token_budget\": {\n \"context_capacity_tokens\": {\n \"value\": \"\"\n },\n \"rendered_prompt_tokens\": {\n \"value\": \"\"\n },\n \"completion_reserve_tokens\": {\n \"value\": \"\"\n },\n \"requested_tokens\": {\n \"value\": \"\"\n },\n \"request_fits\": {\n \"value\": \"\"\n }\n },\n \"nonempty_stream\": false,\n \"automatic_tool_choice\": false,\n \"automatic_tool_call\": true,\n \"tool_result_continuation\": true,\n \"parser_name\": \"string\",\n \"parser_validated\": false,\n \"authenticated_runtime_access\": false,\n \"loopback_only_access\": true\n },\n \"production_ready\": false,\n \"checks\": [\n {\n \"key\": \"string\",\n \"status\": \"ready\",\n \"detail\": \"string\"\n },\n {\n \"key\": \"string\",\n \"status\": \"ready\",\n \"detail\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94d64cd4-def7-4764-9385-cef8306af348", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37d90358-8828-40b0-866e-0181d1c20ae6", "name": "Immediately restore a policy-compatible healthy receptionist snapshot", "request": { "name": "Immediately restore a policy-compatible healthy receptionist snapshot", "description": { "content": "Clone a prior healthy snapshot into a new active immutable version.\n\nThe prior row is never mutated. New inbound calls follow the definition's new latest\nversion, existing calls retain their original pinned version, and the endpoint refuses\nif any current policy would select a location missing from the rollback target.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-release", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"target_version\": 4531\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c8758e88-6e5e-4374-83cb-70a1022a8452", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-release", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_version\": 4531\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_definition_id\": \"string\",\n \"restored_from_version\": {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 2858,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 2073,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"1962-05-11T19:23:50.866Z\",\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": true\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"1994-05-10T23:39:07.988Z\",\n \"published_by\": \"string\"\n },\n \"active_version\": {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 8559,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 2967,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"2001-06-29T11:20:50.454Z\",\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": true\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"1954-03-06T20:17:13.418Z\",\n \"published_by\": \"string\"\n },\n \"checked_policy_number_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b10ff00-8f64-49e2-9a5e-2ab5088d081d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-release", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_version\": 4531\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b9d5ed4-fca6-4125-9893-9eb63ba06f05", "name": "The exact voicemail message one published version leaves", "request": { "name": "The exact voicemail message one published version leaves", "description": { "content": "Show the customer the text that will actually be spoken.\n\nServed from the **same composer the drop uses**, on the **same pinned snapshot** the\ndrop reads, which is what makes this a proof rather than a mock-up: if this endpoint\nand a live drop could disagree, the platform would not really be the one composing the\nmessage. `estimated_seconds` is named an estimate because `` renders at Twilio's\nrate, not ours.\n\nThe compliance-profile extension text is deliberately omitted, exactly as at publish:\nit can only lengthen the opener, so the text here is the shortest lawful form of the\nmessage rather than a different one.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":agent_id", "versions", ":version", "voicemail-message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "93bd48c0-3b0c-40c5-bf3d-24dc637cdcfd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "versions", ":version", "voicemail-message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_version_id\": \"string\",\n \"composable\": false,\n \"refusal\": \"string\",\n \"text\": \"string\",\n \"elements\": [\n \"string\",\n \"string\"\n ],\n \"language\": \"string\",\n \"callback_e164\": \"string\",\n \"content_sha256\": \"string\",\n \"estimated_seconds\": 2293\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9533fc8c-3a13-421c-a52a-6f63864b2fef", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "versions", ":version", "voicemail-message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3143c427-5541-4c58-9c1c-5a745bdafb07", "name": "Publish an immutable version of an agent", "request": { "name": "Publish an immutable version of an agent", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0cbe67ee-2c3f-4548-a5b9-187c23d39169", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 4458,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 5630,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"1965-05-03T06:53:20.954Z\",\n \"persona\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 3801\n },\n \"objectives\": [\n {\n \"key_0\": 1233,\n \"key_1\": 4742.023667716262,\n \"key_2\": \"string\",\n \"key_3\": 8364.378219820554\n },\n {\n \"key_0\": \"string\",\n \"key_1\": false\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": 5732,\n \"key_1\": 3735\n },\n \"max_call_seconds\": 756,\n \"max_turns\": 8737\n },\n \"tools\": [\n \"send_sms\",\n \"transfer_to_human\"\n ],\n \"disclosure_config\": {\n \"key_0\": \"string\"\n },\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 6960\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"1950-12-13T14:02:55.914Z\",\n \"published_by\": \"string\",\n \"use_case\": \"custom\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"en\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_targets\": [\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n },\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n }\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+750426769731\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ddc2031-d1af-48c9-98fb-944a7594cde3", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b577c20c-d03b-4303-934f-e5ef43d5540a", "name": "List an agent's published versions", "request": { "name": "List an agent's published versions", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "63aa14ca-ffad-487f-bb2a-7f732a1c9388", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 8341,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 8517,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"1964-05-11T15:45:29.059Z\",\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": true\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"2002-12-17T15:08:04.429Z\",\n \"published_by\": \"string\"\n },\n {\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"version\": 4056,\n \"content_hash\": \"string\",\n \"max_call_seconds\": 8715,\n \"compliance_profile_id\": \"string\",\n \"gate_eval_run_id\": \"string\",\n \"published_at\": \"1972-06-15T16:42:43.727Z\",\n \"action_confirmation_policy\": \"legacy_v0\",\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_version_id\": \"string\",\n \"receptionist_intelligence_version_id\": \"string\",\n \"receptionist_release_status\": \"not_applicable\",\n \"receptionist_capability_manifest_hash\": \"string\",\n \"receptionist_rendered_token_budget\": {\n \"key_0\": \"string\"\n },\n \"receptionist_live_preflight_eval_run_id\": \"string\",\n \"receptionist_canary_route_fingerprint\": \"string\",\n \"receptionist_qualified_at\": \"1949-03-17T16:29:25.677Z\",\n \"published_by\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a291263-61c4-40b0-8c9b-0de95646c430", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c0e43a9-6c53-4215-9cdd-7ee896757e8e", "name": "List the platform template library", "request": { "name": "List the platform template library", "description": {}, "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "outcome_type", "value": "string", "description": "Filter on `outcome_type`. Comma-separated values are OR." }, { "disabled": true, "key": "outcome_type.gte", "value": "string", "description": "Filter on `outcome_type` with the `gte` operator." }, { "disabled": true, "key": "outcome_type.lte", "value": "string", "description": "Filter on `outcome_type` with the `lte` operator." }, { "disabled": true, "key": "outcome_type.gt", "value": "string", "description": "Filter on `outcome_type` with the `gt` operator." }, { "disabled": true, "key": "outcome_type.lt", "value": "string", "description": "Filter on `outcome_type` with the `lt` operator." }, { "disabled": true, "key": "outcome_type.in", "value": "string", "description": "Filter on `outcome_type` with the `in` operator." }, { "disabled": true, "key": "use_case", "value": "string", "description": "Filter on `use_case`. Comma-separated values are OR." }, { "disabled": true, "key": "use_case.gte", "value": "string", "description": "Filter on `use_case` with the `gte` operator." }, { "disabled": true, "key": "use_case.lte", "value": "string", "description": "Filter on `use_case` with the `lte` operator." }, { "disabled": true, "key": "use_case.gt", "value": "string", "description": "Filter on `use_case` with the `gt` operator." }, { "disabled": true, "key": "use_case.lt", "value": "string", "description": "Filter on `use_case` with the `lt` operator." }, { "disabled": true, "key": "use_case.in", "value": "string", "description": "Filter on `use_case` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "37c59c71-a170-4dba-927e-338963120a36", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "outcome_type", "value": "string" }, { "key": "outcome_type.gte", "value": "string" }, { "key": "outcome_type.lte", "value": "string" }, { "key": "outcome_type.gt", "value": "string" }, { "key": "outcome_type.lt", "value": "string" }, { "key": "outcome_type.in", "value": "string" }, { "key": "use_case", "value": "string" }, { "key": "use_case.gte", "value": "string" }, { "key": "use_case.lte", "value": "string" }, { "key": "use_case.gt", "value": "string" }, { "key": "use_case.lt", "value": "string" }, { "key": "use_case.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"staffing\",\n \"version\": 7081,\n \"outcome_type\": \"appointment\",\n \"tool_grants\": [\n \"record_sms_consent\",\n \"end_call\"\n ],\n \"webhook_payload_schema\": {\n \"key_0\": \"string\"\n },\n \"content_hash\": \"string\",\n \"status\": \"deprecated\",\n \"created_at\": \"1986-11-19T01:26:09.492Z\",\n \"updated_at\": \"1993-08-13T04:24:41.116Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"custom\",\n \"version\": 8176,\n \"outcome_type\": \"appointment\",\n \"tool_grants\": [\n \"end_call\",\n \"confirm_shift\"\n ],\n \"webhook_payload_schema\": {\n \"key_0\": 1894.1246286577828\n },\n \"content_hash\": \"string\",\n \"status\": \"published\",\n \"created_at\": \"1962-12-22T10:32:25.330Z\",\n \"updated_at\": \"2013-12-24T19:37:40.884Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c6d76d9-473b-46b3-a93f-377687a6686d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "outcome_type", "value": "string" }, { "key": "outcome_type.gte", "value": "string" }, { "key": "outcome_type.lte", "value": "string" }, { "key": "outcome_type.gt", "value": "string" }, { "key": "outcome_type.lt", "value": "string" }, { "key": "outcome_type.in", "value": "string" }, { "key": "use_case", "value": "string" }, { "key": "use_case.gte", "value": "string" }, { "key": "use_case.lte", "value": "string" }, { "key": "use_case.gt", "value": "string" }, { "key": "use_case.lt", "value": "string" }, { "key": "use_case.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76ef4db6-ce29-4184-a6fa-7ced26f6bdbc", "name": "Read one template, seed included", "request": { "name": "Read one template, seed included", "description": {}, "url": { "path": [ "v1", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f83f11d7-bc59-4b71-a698-368b0b269f4c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"reminder\",\n \"version\": 5627,\n \"outcome_type\": \"none\",\n \"tool_grants\": [\n \"record_optout\",\n \"check_calendar\"\n ],\n \"webhook_payload_schema\": {\n \"key_0\": 1299.791567745361,\n \"key_1\": \"string\"\n },\n \"content_hash\": \"string\",\n \"status\": \"draft\",\n \"created_at\": \"1964-06-27T05:30:14.218Z\",\n \"updated_at\": \"1957-12-28T23:22:06.750Z\",\n \"objectives\": [\n {\n \"key_0\": 8633,\n \"key_1\": \"string\"\n },\n {\n \"key_0\": \"string\",\n \"key_1\": 8210\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85d5cdcc-1ae2-4bee-9936-fe09cc6b58b0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cc4f90d-6495-4a8c-88ba-b1c5707bebf3", "name": "Create an editable agent from a template", "request": { "name": "Create an editable agent from a template", "description": {}, "url": { "path": [ "v1", "templates", ":template_id", "instantiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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\": \"string\",\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"persona\": {\n \"key_0\": 7399,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\"\n },\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 7110,\n \"compliance_profile_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "19ac5a93-663f-4e99-aafb-a096b741dae6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "templates", ":template_id", "instantiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"persona\": {\n \"key_0\": 7399,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\"\n },\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 7110,\n \"compliance_profile_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"survey\",\n \"status\": \"draft\",\n \"created_at\": \"2023-07-29T09:08:59.211Z\",\n \"updated_at\": \"2014-03-23T08:00:07.459Z\",\n \"persona\": {\n \"key_0\": 6876.821731519262,\n \"key_1\": 7908.15360930931,\n \"key_2\": true,\n \"key_3\": 4831.524335626847\n },\n \"objectives\": [\n {\n \"key_0\": 2539,\n \"key_1\": false\n },\n {\n \"key_0\": 9152,\n \"key_1\": false\n }\n ],\n \"guardrails\": {\n \"disallowed_topics\": [\n \"string\",\n \"string\"\n ],\n \"blocklist_patterns\": [\n \"string\",\n \"string\"\n ],\n \"judge\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 843.2035797727599\n },\n \"max_call_seconds\": 843,\n \"max_turns\": 42\n },\n \"tools\": [\n \"open_ticket\",\n \"record_qualification\"\n ],\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"latest_version\": 5183,\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"seeded_from_template_id\": \"string\",\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"sms_template_ids\": [\n \"string\",\n \"string\"\n ],\n \"handoff_targets\": [\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n },\n {\n \"rep_id\": \"string\",\n \"display_name\": \"string\"\n }\n ],\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"knowledge_pack_version\": 9803,\n \"voicemail_config\": {\n \"body\": {\n \"key_0\": \"string\"\n },\n \"callback_e164\": \"+343967268\"\n },\n \"compliance_profile_id\": \"string\",\n \"seeded_from_template_version\": 7196\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c59d15-df29-4202-9af8-2ad77c13f33b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":template_id", "instantiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"disclosure_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"persona\": {\n \"key_0\": 7399,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\"\n },\n \"conversation_settings\": {\n \"default_language\": \"en\",\n \"supported_languages\": [\n \"es\",\n \"es\"\n ],\n \"allow_language_switch\": true\n },\n \"llm_route\": {\n \"primary\": \"string\",\n \"fallbacks\": [\n \"string\",\n \"string\"\n ]\n },\n \"stock_voice_id\": \"string\",\n \"voice_profile_id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"knowledge_pack_version\": 7110,\n \"compliance_profile_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1b97b85f-9ff5-4599-9bdd-f3737af54042", "name": "receptionist-intelligence", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5f802c5a-815a-4aa0-bf04-e396feee5fca", "name": "Read a receptionist's structured business intelligence draft", "request": { "name": "Read a receptionist's structured business intelligence draft", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3dacee21-5768-4e96-a4b2-e3693c44b837", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"update_lead\",\n \"confirm_shift\"\n ]\n },\n \"updated_at\": \"2020-06-04T04:15:44.219Z\",\n \"created_at\": \"2014-12-01T23:35:55.569Z\",\n \"current_version\": 6368\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4905e7b-e572-4c4f-af2e-e02e6f6f7d69", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b910557-a271-4965-b9f7-b4fa134b9f9d", "name": "Create or replace a receptionist's structured business intelligence draft", "request": { "name": "Create or replace a receptionist's structured business intelligence draft", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"confirm_shift\",\n \"record_shift_response\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3c97bb6c-fb74-4a3b-a5b4-2a2a4032a378", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"confirm_shift\",\n \"record_shift_response\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"update_lead\",\n \"confirm_shift\"\n ]\n },\n \"updated_at\": \"2020-06-04T04:15:44.219Z\",\n \"created_at\": \"2014-12-01T23:35:55.569Z\",\n \"current_version\": 6368\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe3e50e-3b6e-47d7-9337-95f98abd9839", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"confirm_shift\",\n \"record_shift_response\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f93ee208-6c0b-4b72-b8a4-11b8e053fbb7", "name": "Preview the compact business knowledge a receptionist version would receive", "request": { "name": "Preview the compact business knowledge a receptionist version would receive", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5f52eb88-cdce-4325-b540-943cce2efffb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"compiled_knowledge\": \"string\",\n \"compiled_character_count\": 505,\n \"compiled_token_count\": 7029,\n \"location_token_counts\": {\n \"rtmz5fevyfmkd0f_c1uaklb137li84t-s76m3shueaiuqniq_be6lv98e6cnz\": 7831\n },\n \"source_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bce9028-d5be-463f-a5b3-f292b1403b6d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1565584-b2c0-48db-b369-1d718c7e8bf3", "name": "List immutable source snapshots backing receptionist intelligence", "request": { "name": "List immutable source snapshots backing receptionist intelligence", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "510e2d76-88ef-4e57-aa59-5ae0dd04fe0e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"kind\": \"document\",\n \"label\": \"string\",\n \"provenance\": \"customer_upload\",\n \"content_hash\": \"string\",\n \"content_characters\": 8226,\n \"content_token_count\": 4713,\n \"extraction_report\": {\n \"extracted_characters\": 5375,\n \"title\": {\n \"value\": \"\"\n },\n \"warnings\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1995-01-05T16:57:13.320Z\",\n \"review_status\": \"approved\",\n \"created_at\": \"2001-07-12T08:15:46.212Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"2025-01-26T04:38:53.577Z\",\n \"approved_at\": \"1950-04-26T23:25:47.483Z\"\n },\n {\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_upload\",\n \"content_hash\": \"string\",\n \"content_characters\": 6782,\n \"content_token_count\": 7632,\n \"extraction_report\": {\n \"extracted_characters\": 55397,\n \"title\": {\n \"value\": \"\"\n },\n \"warnings\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1984-07-10T02:00:54.776Z\",\n \"review_status\": \"pending\",\n \"created_at\": \"1961-01-25T10:52:31.141Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"1969-08-02T04:45:44.143Z\",\n \"approved_at\": \"1959-06-10T17:47:57.779Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e72fa196-8a96-43e3-9f2a-749c3e210098", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6504c4c5-1f01-47b6-acce-7d52d5f881a6", "name": "Add a pending document or website snapshot for receptionist fact review", "request": { "name": "Add a pending document or website snapshot for receptionist fact review", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"kind\": \"website\",\n \"label\": \"string\",\n \"content\": \"string\",\n \"source_url\": \"string\",\n \"provenance\": \"customer_upload\",\n \"extraction_report\": {\n \"extracted_characters\": 2403,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da856007-464a-479e-a8ee-d305f35ef7d9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"kind\": \"website\",\n \"label\": \"string\",\n \"content\": \"string\",\n \"source_url\": \"string\",\n \"provenance\": \"customer_upload\",\n \"extraction_report\": {\n \"extracted_characters\": 2403,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4558,\n \"content_token_count\": 6819,\n \"extraction_report\": {\n \"extracted_characters\": 66565,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1965-05-26T19:08:43.147Z\",\n \"review_status\": \"rejected\",\n \"created_at\": \"2005-11-04T15:22:00.054Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"2011-02-26T19:04:38.802Z\",\n \"approved_at\": \"1996-08-09T05:38:43.979Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e90def8a-0a9e-49d8-af95-86b1e371bb4f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"kind\": \"website\",\n \"label\": \"string\",\n \"content\": \"string\",\n \"source_url\": \"string\",\n \"provenance\": \"customer_upload\",\n \"extraction_report\": {\n \"extracted_characters\": 2403,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8ecb1e0-d275-4093-9fe3-2c4529f07e1b", "name": "Read an immutable receptionist source snapshot for fact review", "request": { "name": "Read an immutable receptionist source snapshot for fact review", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9c21785d-9bc0-4604-814d-93593441c75a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4951,\n \"content_token_count\": 1662,\n \"extraction_report\": {\n \"extracted_characters\": 20732,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"2016-05-07T02:20:58.792Z\",\n \"review_status\": \"rejected\",\n \"created_at\": \"1958-12-31T15:53:34.948Z\",\n \"content\": \"string\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"1992-12-19T23:23:07.958Z\",\n \"approved_at\": \"1987-06-02T12:38:22.672Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f68bad-f65f-4c20-81e7-8b10413a6034", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc1458cc-4ee7-4b9f-be5f-3c326e3258f9", "name": "Approve an immutable source snapshot for cited receptionist facts", "request": { "name": "Approve an immutable source snapshot for cited receptionist facts", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "27f94d5e-246a-4344-8891-e3a2bd372a12", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4558,\n \"content_token_count\": 6819,\n \"extraction_report\": {\n \"extracted_characters\": 66565,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1965-05-26T19:08:43.147Z\",\n \"review_status\": \"rejected\",\n \"created_at\": \"2005-11-04T15:22:00.054Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"2011-02-26T19:04:38.802Z\",\n \"approved_at\": \"1996-08-09T05:38:43.979Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1e709ea-6a36-4c02-9257-d7c7648d171e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b969a2d7-58d5-4467-bbd5-5d5ec07ba5f1", "name": "Reject an immutable source snapshot and preserve the review reason", "request": { "name": "Reject an immutable source snapshot and preserve the review reason", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "245b7f16-212b-467f-b74b-3a211b5b4978", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4558,\n \"content_token_count\": 6819,\n \"extraction_report\": {\n \"extracted_characters\": 66565,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1965-05-26T19:08:43.147Z\",\n \"review_status\": \"rejected\",\n \"created_at\": \"2005-11-04T15:22:00.054Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"2011-02-26T19:04:38.802Z\",\n \"approved_at\": \"1996-08-09T05:38:43.979Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01f3ae62-6d5d-4d8f-b292-e8de19c19426", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57583e6d-5369-4ec6-8f7a-7e21284006f1", "name": "Create a manually refreshed immutable website snapshot", "request": { "name": "Create a manually refreshed immutable website snapshot", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"content\": \"string\",\n \"extraction_report\": {\n \"extracted_characters\": 16488,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ee992807-650b-4728-991c-05bede7aeccb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"content\": \"string\",\n \"extraction_report\": {\n \"extracted_characters\": 16488,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4951,\n \"content_token_count\": 1662,\n \"extraction_report\": {\n \"extracted_characters\": 20732,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"2016-05-07T02:20:58.792Z\",\n \"review_status\": \"rejected\",\n \"created_at\": \"1958-12-31T15:53:34.948Z\",\n \"content\": \"string\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"1992-12-19T23:23:07.958Z\",\n \"approved_at\": \"1987-06-02T12:38:22.672Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2861022f-45fd-496d-8d71-e7a689819654", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "sources", ":source_id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "source_id", "description": "(Required) " } ] }, "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 \"content\": \"string\",\n \"extraction_report\": {\n \"extracted_characters\": 16488,\n \"title\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c3c9f30-1491-468d-a1e8-57e50d59b772", "name": "Publish the current reviewed receptionist intelligence as an immutable revision", "request": { "name": "Publish the current reviewed receptionist intelligence as an immutable revision", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "424009f1-fd33-4b8c-8c5f-3bedb471f1ac", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"receptionist_intelligence_id\": \"string\",\n \"version\": 9594,\n \"content_hash\": \"string\",\n \"compiled_knowledge\": \"string\",\n \"compiled_character_count\": 8732,\n \"compiled_token_count\": 5297,\n \"created_at\": \"1994-11-07T09:28:33.543Z\",\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"record_shift_response\",\n \"confirm_shift\"\n ]\n },\n \"source_ids\": [\n \"string\",\n \"string\"\n ],\n \"location_token_counts\": {\n \"ja6ku8dyv4sl7szi8w6zbo5y1\": 1733\n },\n \"sources\": [\n {\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4014,\n \"content_token_count\": 2497,\n \"extraction_report\": {\n \"extracted_characters\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1989-10-19T07:18:19.028Z\",\n \"review_status\": \"approved\",\n \"created_at\": \"2019-01-20T23:15:31.121Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"1998-04-09T10:06:28.671Z\",\n \"approved_at\": \"1962-09-03T07:01:20.268Z\"\n },\n {\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 1567,\n \"content_token_count\": 2209,\n \"extraction_report\": {\n \"extracted_characters\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"2002-06-26T08:26:32.895Z\",\n \"review_status\": \"pending\",\n \"created_at\": \"1991-01-19T14:03:14.422Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"2014-07-13T21:52:14.511Z\",\n \"approved_at\": \"1971-06-30T04:49:39.828Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00111662-5951-47f6-8d93-b744618e1d46", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee8491e6-3f57-4e65-9bda-31e3b2d16ae5", "name": "List a receptionist's immutable business-intelligence release history", "request": { "name": "List a receptionist's immutable business-intelligence release history", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "41a9c347-9d8c-47e9-8f09-8453e8bed54f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"receptionist_intelligence_id\": \"string\",\n \"version\": 1834,\n \"content_hash\": \"string\",\n \"compiled_knowledge\": \"string\",\n \"compiled_character_count\": 7846,\n \"compiled_token_count\": 6199,\n \"created_at\": \"2009-11-02T13:15:38.448Z\",\n \"source_ids\": [\n \"string\",\n \"string\"\n ],\n \"location_token_counts\": {\n \"duc4izyb8w1n-z\": 5265\n }\n },\n {\n \"id\": \"string\",\n \"receptionist_intelligence_id\": \"string\",\n \"version\": 2554,\n \"content_hash\": \"string\",\n \"compiled_knowledge\": \"string\",\n \"compiled_character_count\": 3660,\n \"compiled_token_count\": 3298,\n \"created_at\": \"1958-04-20T16:22:10.689Z\",\n \"source_ids\": [\n \"string\",\n \"string\"\n ],\n \"location_token_counts\": {\n \"bjy0-x\": 2967\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7454eea-3559-4cf1-be00-e70209ff527c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "933870a1-cf35-4db3-a299-150fc12fc8ab", "name": "Read one immutable receptionist intelligence revision", "request": { "name": "Read one immutable receptionist intelligence revision", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4594cef1-5f81-4e47-9996-bf0a0a519ca2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"receptionist_intelligence_id\": \"string\",\n \"version\": 9594,\n \"content_hash\": \"string\",\n \"compiled_knowledge\": \"string\",\n \"compiled_character_count\": 8732,\n \"compiled_token_count\": 5297,\n \"created_at\": \"1994-11-07T09:28:33.543Z\",\n \"draft\": {\n \"business_name\": \"string\",\n \"business_summary\": \"string\",\n \"business_summary_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"locations\": [\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"ref\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"service_area\": {\n \"value\": \"\"\n },\n \"facts\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"services\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"availability_note\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"pricing_policy\": \"string\",\n \"pricing_policy_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"faqs\": [\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"question\": {\n \"value\": \"\"\n },\n \"answer\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"customer_policies\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source_refs\": {\n \"value\": \"\"\n }\n }\n ],\n \"supported_intents\": [\n \"string\",\n \"string\"\n ],\n \"tone\": \"string\",\n \"escalation_rules\": \"string\",\n \"escalation_rules_source_refs\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"approved_actions\": [\n \"record_shift_response\",\n \"confirm_shift\"\n ]\n },\n \"source_ids\": [\n \"string\",\n \"string\"\n ],\n \"location_token_counts\": {\n \"ja6ku8dyv4sl7szi8w6zbo5y1\": 1733\n },\n \"sources\": [\n {\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 4014,\n \"content_token_count\": 2497,\n \"extraction_report\": {\n \"extracted_characters\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"1989-10-19T07:18:19.028Z\",\n \"review_status\": \"approved\",\n \"created_at\": \"2019-01-20T23:15:31.121Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"1998-04-09T10:06:28.671Z\",\n \"approved_at\": \"1962-09-03T07:01:20.268Z\"\n },\n {\n \"id\": \"string\",\n \"kind\": \"website\",\n \"label\": \"string\",\n \"provenance\": \"customer_website_snapshot\",\n \"content_hash\": \"string\",\n \"content_characters\": 1567,\n \"content_token_count\": 2209,\n \"extraction_report\": {\n \"extracted_characters\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"refresh_status\": \"string\",\n \"captured_at\": \"2002-06-26T08:26:32.895Z\",\n \"review_status\": \"pending\",\n \"created_at\": \"1991-01-19T14:03:14.422Z\",\n \"source_url\": \"string\",\n \"refresh_of_source_id\": \"string\",\n \"review_note\": \"string\",\n \"reviewed_at\": \"2014-07-13T21:52:14.511Z\",\n \"approved_at\": \"1971-06-30T04:49:39.828Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f84fecd-c5b7-43ba-9ead-e22a4c26cb34", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-intelligence", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "da6b02a6-1bac-4c27-9e08-df9b527666b7", "name": "receptionist-regression-cases", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c63499b9-66e9-47e4-b42f-f960ab751066", "name": "List the current immutable revisions of a receptionist's regression cases", "request": { "name": "List the current immutable revisions of a receptionist's regression cases", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "include_archived", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "16a74611-a1e8-439f-baec-1c24f30a8a7b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include_archived", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 3604,\n \"content_hash\": \"string\",\n \"created_at\": \"1986-07-20T08:43:42.501Z\",\n \"agent_definition_id\": \"string\",\n \"status\": \"active\",\n \"updated_at\": \"1959-04-09T11:39:46.485Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": {\n \"value\": \"\"\n },\n \"step_type\": {\n \"value\": \"\"\n },\n \"location_ref\": {\n \"value\": \"\"\n }\n },\n \"intended_action\": \"open_ticket\",\n \"dry_run_action\": {\n \"tool\": {\n \"value\": \"\"\n },\n \"expected_effect\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 7395,\n \"content_hash\": \"string\",\n \"created_at\": \"1974-04-29T07:01:01.837Z\",\n \"agent_definition_id\": \"string\",\n \"status\": \"archived\",\n \"updated_at\": \"1964-05-21T04:52:15.742Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": {\n \"value\": \"\"\n },\n \"step_type\": {\n \"value\": \"\"\n },\n \"location_ref\": {\n \"value\": \"\"\n }\n },\n \"intended_action\": \"book_meeting\",\n \"dry_run_action\": {\n \"tool\": {\n \"value\": \"\"\n },\n \"expected_effect\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e591b7-73c4-4365-831d-274a66ba866f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include_archived", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b7453a1-368e-4e3b-a5e1-7705d68bf857", "name": "Create a versioned customer-authored receptionist regression case", "request": { "name": "Create a versioned customer-authored receptionist regression case", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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\": \"string\",\n \"caller_utterance\": \"string\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"closed\",\n \"step_type\": \"forward\",\n \"location_ref\": \"ghjw2_j-_jr1sdkv9dbmpq0da16lteg5h08upvfva62_m0zl\"\n },\n \"intended_action\": \"book_meeting\",\n \"dry_run_action\": {\n \"tool\": \"book_meeting\",\n \"expected_effect\": \"message_recorded\",\n \"mode\": \"dry_run\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d302ad87-3b74-481c-b118-3a2e58e35b0a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"closed\",\n \"step_type\": \"forward\",\n \"location_ref\": \"ghjw2_j-_jr1sdkv9dbmpq0da16lteg5h08upvfva62_m0zl\"\n },\n \"intended_action\": \"book_meeting\",\n \"dry_run_action\": {\n \"tool\": \"book_meeting\",\n \"expected_effect\": \"message_recorded\",\n \"mode\": \"dry_run\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 85,\n \"content_hash\": \"string\",\n \"created_at\": \"1966-01-29T10:59:38.911Z\",\n \"agent_definition_id\": \"string\",\n \"status\": \"archived\",\n \"updated_at\": \"1950-11-13T22:36:47.061Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"voicemail\",\n \"location_ref\": \"p70wr18uiareel\"\n },\n \"intended_action\": \"open_ticket\",\n \"dry_run_action\": {\n \"tool\": \"open_ticket\",\n \"expected_effect\": \"booking_created\",\n \"mode\": \"dry_run\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "224301c1-488c-41e4-8b41-e441678fa032", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"closed\",\n \"step_type\": \"forward\",\n \"location_ref\": \"ghjw2_j-_jr1sdkv9dbmpq0da16lteg5h08upvfva62_m0zl\"\n },\n \"intended_action\": \"book_meeting\",\n \"dry_run_action\": {\n \"tool\": \"book_meeting\",\n \"expected_effect\": \"message_recorded\",\n \"mode\": \"dry_run\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f946c724-3e60-45a1-af38-7b8ba317b8d8", "name": "List an immutable receptionist regression case's revision history", "request": { "name": "List an immutable receptionist regression case's revision history", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e70efa2e-37b1-4e52-aef3-444693e620e6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 1655,\n \"content_hash\": \"string\",\n \"created_at\": \"1986-03-18T04:01:39.449Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": {\n \"value\": \"\"\n },\n \"step_type\": {\n \"value\": \"\"\n },\n \"location_ref\": {\n \"value\": \"\"\n }\n },\n \"intended_action\": \"update_lead\",\n \"dry_run_action\": {\n \"tool\": {\n \"value\": \"\"\n },\n \"expected_effect\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 2577,\n \"content_hash\": \"string\",\n \"created_at\": \"1983-05-20T09:59:13.350Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": {\n \"value\": \"\"\n },\n \"step_type\": {\n \"value\": \"\"\n },\n \"location_ref\": {\n \"value\": \"\"\n }\n },\n \"intended_action\": \"update_lead\",\n \"dry_run_action\": {\n \"tool\": {\n \"value\": \"\"\n },\n \"expected_effect\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90889d4a-94af-429b-a347-281162d8217b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95111bfa-aff6-4b9d-8ad5-175824ee8cfa", "name": "Read one immutable receptionist regression case revision", "request": { "name": "Read one immutable receptionist regression case revision", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "212ea1ca-8659-4cb3-a266-c973fd35f1c9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 2946,\n \"content_hash\": \"string\",\n \"created_at\": \"1989-01-02T07:39:38.828Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"closed\",\n \"step_type\": \"menu\",\n \"location_ref\": \"k4v72x-l\"\n },\n \"intended_action\": \"open_ticket\",\n \"dry_run_action\": {\n \"tool\": \"book_meeting\",\n \"expected_effect\": \"callback_scheduled\",\n \"mode\": \"dry_run\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91a8a12e-9d10-4243-9583-406849b85e0e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d4660a9-70c5-41d8-8607-969999cbdc68", "name": "Append a new immutable receptionist regression case revision", "request": { "name": "Append a new immutable receptionist regression case revision", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"expected_version\": 4684,\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"menu\",\n \"location_ref\": \"nlkybv0xqebsh\"\n },\n \"intended_action\": \"end_call\",\n \"dry_run_action\": {\n \"tool\": \"update_lead\",\n \"expected_effect\": \"lead_updated\",\n \"mode\": \"dry_run\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da861643-6366-4852-a90d-651c0a8a8d11", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"expected_version\": 4684,\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"menu\",\n \"location_ref\": \"nlkybv0xqebsh\"\n },\n \"intended_action\": \"end_call\",\n \"dry_run_action\": {\n \"tool\": \"update_lead\",\n \"expected_effect\": \"lead_updated\",\n \"mode\": \"dry_run\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 85,\n \"content_hash\": \"string\",\n \"created_at\": \"1966-01-29T10:59:38.911Z\",\n \"agent_definition_id\": \"string\",\n \"status\": \"archived\",\n \"updated_at\": \"1950-11-13T22:36:47.061Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"voicemail\",\n \"location_ref\": \"p70wr18uiareel\"\n },\n \"intended_action\": \"open_ticket\",\n \"dry_run_action\": {\n \"tool\": \"open_ticket\",\n \"expected_effect\": \"booking_created\",\n \"mode\": \"dry_run\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "549c5fe0-a2ee-447e-a638-96ca68685474", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"expected_version\": 4684,\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"menu\",\n \"location_ref\": \"nlkybv0xqebsh\"\n },\n \"intended_action\": \"end_call\",\n \"dry_run_action\": {\n \"tool\": \"update_lead\",\n \"expected_effect\": \"lead_updated\",\n \"mode\": \"dry_run\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60ab9980-b0ad-428f-b125-90ba4243c56c", "name": "Read the current immutable revision of a receptionist regression case", "request": { "name": "Read the current immutable revision of a receptionist regression case", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a818893d-3f71-4808-b038-2335c485f971", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 85,\n \"content_hash\": \"string\",\n \"created_at\": \"1966-01-29T10:59:38.911Z\",\n \"agent_definition_id\": \"string\",\n \"status\": \"archived\",\n \"updated_at\": \"1950-11-13T22:36:47.061Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"voicemail\",\n \"location_ref\": \"p70wr18uiareel\"\n },\n \"intended_action\": \"open_ticket\",\n \"dry_run_action\": {\n \"tool\": \"open_ticket\",\n \"expected_effect\": \"booking_created\",\n \"mode\": \"dry_run\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b48cf957-ea4f-4f19-a008-bdcc032bed45", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2adbf184-e582-45b6-bbaa-058eac64bf49", "name": "Archive a regression case so later release gates no longer execute it", "request": { "name": "Archive a regression case so later release gates no longer execute it", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "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 \"expected_version\": 3598\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4a1e656a-4595-4b08-beb8-14296f774c7b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "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 \"expected_version\": 3598\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"caller_utterance\": \"string\",\n \"id\": \"string\",\n \"receptionist_regression_case_id\": \"string\",\n \"version\": 85,\n \"content_hash\": \"string\",\n \"created_at\": \"1966-01-29T10:59:38.911Z\",\n \"agent_definition_id\": \"string\",\n \"status\": \"archived\",\n \"updated_at\": \"1950-11-13T22:36:47.061Z\",\n \"expected_facts\": [\n \"string\",\n \"string\"\n ],\n \"prohibited_claims\": [\n \"string\",\n \"string\"\n ],\n \"routing\": {\n \"branch\": \"open\",\n \"step_type\": \"voicemail\",\n \"location_ref\": \"p70wr18uiareel\"\n },\n \"intended_action\": \"open_ticket\",\n \"dry_run_action\": {\n \"tool\": \"open_ticket\",\n \"expected_effect\": \"booking_created\",\n \"mode\": \"dry_run\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9423670d-5969-453e-ba45-b5d218334a98", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "receptionist-regression-cases", ":case_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "case_id", "description": "(Required) " } ] }, "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 \"expected_version\": 3598\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d03cf108-85e3-4066-a4b8-7a373f5f4c73", "name": "voices", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2100ac18-8313-40de-ba85-1dc330c148a9", "name": "List the platform stock-voice catalog", "request": { "name": "List the platform stock-voice catalog", "description": {}, "url": { "path": [ "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b25ef79f-dc91-4ccc-b3f7-be427e6cd4d0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"language\": \"string\",\n \"gender\": \"male\",\n \"style_tags\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"available\",\n \"preview_uri\": \"string\",\n \"previews\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"language\": \"string\",\n \"gender\": \"male\",\n \"style_tags\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"available\",\n \"preview_uri\": \"string\",\n \"previews\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdd5efd4-adc5-4b02-a0ad-8b24ba786626", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "57589d60-e434-4417-bf63-e1e54a60133b", "name": "knowledge", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "71c3ae11-f43c-49c6-a5d3-d5e422ee4cfa", "name": "List this tenant's knowledge packs", "request": { "name": "List this tenant's knowledge packs", "description": {}, "url": { "path": [ "v1", "knowledge-packs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b3efd2a1-5cf9-4a95-9c72-56d6e57aafa5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"created_at\": \"1973-10-26T05:38:13.594Z\",\n \"updated_at\": \"1976-09-29T11:26:10.563Z\",\n \"current_version\": 8378\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"created_at\": \"1979-07-18T18:46:48.420Z\",\n \"updated_at\": \"2022-08-25T21:06:43.246Z\",\n \"current_version\": 6763\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f9b563-b36d-4ac3-9215-81e57743af95", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f505467-faca-4a01-8f71-16ce45f79b18", "name": "Create a knowledge pack", "request": { "name": "Create a knowledge pack", "description": {}, "url": { "path": [ "v1", "knowledge-packs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c752000f-9e6b-4cd4-b442-b87e178ff370", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"created_at\": \"1967-08-10T14:48:07.657Z\",\n \"updated_at\": \"1997-08-31T07:53:57.817Z\",\n \"current_version\": 9591\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c6256c0-daf5-487a-a8e4-17ed0f1303f8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11445016-f3dc-4295-8411-e7ac5bec510a", "name": "Publish an edit as the pack's next immutable version", "request": { "name": "Publish an edit as the pack's next immutable version", "description": {}, "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " } ] }, "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 \"sources\": [\n {\n \"kind\": \"pdf\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n }\n ],\n \"compiled_token_count\": 9946\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0dd5f36d-bb4f-44c1-9ba8-ab95a78db7b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " } ] }, "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 \"sources\": [\n {\n \"kind\": \"pdf\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n }\n ],\n \"compiled_token_count\": 9946\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"version\": 6626,\n \"content_hash\": \"string\",\n \"status\": \"failed\",\n \"sources\": [\n {\n \"kind\": \"text\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n },\n {\n \"kind\": \"pdf\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n }\n ],\n \"created_at\": \"1946-11-25T06:07:59.270Z\",\n \"updated_at\": \"1965-03-17T12:17:28.021Z\",\n \"over_default_budget\": true,\n \"compiled_token_count\": 2640\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab9b502-d202-439b-96ed-0b9ee5fcf6b2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " } ] }, "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 \"sources\": [\n {\n \"kind\": \"pdf\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n }\n ],\n \"compiled_token_count\": 9946\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f414187e-1674-4411-bdd8-2a43fd20859a", "name": "Ingest uploaded documents as the pack's next immutable version", "request": { "name": "Ingest uploaded documents as the pack's next immutable version", "description": { "content": "Upload pdf/docx/csv/md/txt and publish the extraction as the next version.\n\nEverything that can refuse the upload - decoding, extraction, sectioning, the real\ntoken count, the hard cap - runs first and touches no database. Only a pack that has\nalready compiled inside the cap reaches `create_version`, which re-checks the cap\nitself before its own first statement. The ordering CANON fact 12 depends on therefore\nholds twice over: an over-cap upload consumes no version number and writes nothing.", "type": "text/plain" }, "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " } ] }, "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 \"documents\": [\n {\n \"file_name\": \"string\",\n \"content\": \"string\",\n \"content_base64\": \"string\",\n \"format\": \"md\"\n }\n ],\n \"budget_tokens\": 7234\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e2f865d-e48b-4e3a-acf5-376a2f6b0f21", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " } ] }, "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 \"documents\": [\n {\n \"file_name\": \"string\",\n \"content\": \"string\",\n \"content_base64\": \"string\",\n \"format\": \"md\"\n }\n ],\n \"budget_tokens\": 7234\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"version\": {\n \"id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"version\": 737,\n \"content_hash\": \"string\",\n \"status\": \"failed\",\n \"sources\": [\n {\n \"kind\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"uri\": {\n \"value\": \"\"\n }\n },\n {\n \"kind\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"uri\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"1968-01-02T03:06:00.574Z\",\n \"updated_at\": \"2005-04-19T05:35:03.133Z\",\n \"over_default_budget\": true,\n \"compiled_token_count\": 4419\n },\n \"documents\": [\n {\n \"file_name\": \"string\",\n \"format\": \"string\",\n \"sections\": 3853,\n \"tokens\": 9012\n },\n {\n \"file_name\": \"string\",\n \"format\": \"string\",\n \"sections\": 5857,\n \"tokens\": 3832\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "286d7b6a-4a67-4478-8f69-73cfcefbf0f7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " } ] }, "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 \"documents\": [\n {\n \"file_name\": \"string\",\n \"content\": \"string\",\n \"content_base64\": \"string\",\n \"format\": \"md\"\n }\n ],\n \"budget_tokens\": 7234\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fbcfb79-53e7-43cd-ba80-2671c6f29738", "name": "Read one compiled version - the exact text the model sees", "request": { "name": "Read one compiled version - the exact text the model sees", "description": {}, "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ae803393-3966-4eda-9990-c51540678c63", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"knowledge_pack_id\": \"string\",\n \"version\": 6626,\n \"content_hash\": \"string\",\n \"status\": \"failed\",\n \"sources\": [\n {\n \"kind\": \"text\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n },\n {\n \"kind\": \"pdf\",\n \"label\": \"string\",\n \"text\": \"string\",\n \"uri\": \"string\"\n }\n ],\n \"created_at\": \"1946-11-25T06:07:59.270Z\",\n \"updated_at\": \"1965-03-17T12:17:28.021Z\",\n \"over_default_budget\": true,\n \"compiled_token_count\": 2640\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d305d0d-6b62-4510-ad7f-e769d5f71f96", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "knowledge-packs", ":pack_id", "versions", ":version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pack_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2410", "key": "version", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46e8d681-00eb-417c-8849-965b557a3b76", "name": "List this tenant's voice profiles", "request": { "name": "List this tenant's voice profiles", "description": {}, "url": { "path": [ "v1", "voice-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "language", "value": "string", "description": "Filter on `language`. Comma-separated values are OR." }, { "disabled": true, "key": "language.gte", "value": "string", "description": "Filter on `language` with the `gte` operator." }, { "disabled": true, "key": "language.lte", "value": "string", "description": "Filter on `language` with the `lte` operator." }, { "disabled": true, "key": "language.gt", "value": "string", "description": "Filter on `language` with the `gt` operator." }, { "disabled": true, "key": "language.lt", "value": "string", "description": "Filter on `language` with the `lt` operator." }, { "disabled": true, "key": "language.in", "value": "string", "description": "Filter on `language` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b25c369f-772a-4da1-9b73-c8afc0239ce3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "language", "value": "string" }, { "key": "language.gte", "value": "string" }, { "key": "language.lte", "value": "string" }, { "key": "language.gt", "value": "string" }, { "key": "language.lt", "value": "string" }, { "key": "language.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"provider\": \"string\",\n \"status\": \"approved\",\n \"created_at\": \"1975-02-20T20:38:20.641Z\",\n \"updated_at\": \"1972-01-26T07:38:05.922Z\",\n \"language\": \"string\",\n \"sample_recording_uri\": \"string\",\n \"model_artifact_uri\": \"string\",\n \"consent_proof_uri\": \"string\",\n \"consent_verified_by\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"provider\": \"string\",\n \"status\": \"rejected\",\n \"created_at\": \"1966-10-20T01:15:00.336Z\",\n \"updated_at\": \"1997-04-07T02:14:30.884Z\",\n \"language\": \"string\",\n \"sample_recording_uri\": \"string\",\n \"model_artifact_uri\": \"string\",\n \"consent_proof_uri\": \"string\",\n \"consent_verified_by\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11c9344-9a6f-4161-90ff-4d0099245e21", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "voice-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "language", "value": "string" }, { "key": "language.gte", "value": "string" }, { "key": "language.lte", "value": "string" }, { "key": "language.gt", "value": "string" }, { "key": "language.lt", "value": "string" }, { "key": "language.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b42653ba-e473-4907-a0ce-77d005d16409", "name": "Withdrawn - voice profiles can no longer be created", "request": { "name": "Withdrawn - voice profiles can no longer be created", "description": {}, "url": { "path": [ "v1", "voice-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "902897fd-ce86-48f5-8b2f-1f2b8dc95abb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-profiles" ], "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": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea1e47e6-f221-4361-a0b6-4341becb1e1f", "name": "The Voice Rights & Consent Attestation this deployment serves", "request": { "name": "The Voice Rights & Consent Attestation this deployment serves", "description": {}, "url": { "path": [ "v1", "voice-rights-attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cdffbbda-696d-4d25-b952-02163ebe65ab", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-rights-attestation" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"version\": \"string\",\n \"content_sha256\": \"string\",\n \"markdown\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e774402-1183-479e-bd18-f40147ac343f", "name": "The printable consent form the voice owner signs", "request": { "name": "The printable consent form the voice owner signs", "description": {}, "url": { "path": [ "v1", "voice-clone-consent-form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "292f6557-7224-4510-9e60-2e8316452750", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-clone-consent-form" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"version\": \"string\",\n \"content_sha256\": \"string\",\n \"markdown\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26a37769-b10f-4e3b-8cb6-73c770ee752d", "name": "Read one voice profile", "request": { "name": "Read one voice profile", "description": {}, "url": { "path": [ "v1", "voice-profiles", ":profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed0fdf9c-4ae6-4feb-97d1-78bb92a8b110", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"provider\": \"string\",\n \"status\": \"approved\",\n \"created_at\": \"1984-04-06T22:49:31.127Z\",\n \"updated_at\": \"1965-03-17T12:20:49.581Z\",\n \"language\": \"string\",\n \"sample_recording_uri\": \"string\",\n \"model_artifact_uri\": \"string\",\n \"consent_proof_uri\": \"string\",\n \"consent_verified_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4c3e368-5b37-4956-84ce-83ac4de80aef", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "630a0eaa-5da3-4ab1-8035-953afab3210e", "name": "Withdrawn - voice samples are no longer accepted", "request": { "name": "Withdrawn - voice samples are no longer accepted", "description": {}, "url": { "path": [ "v1", "voice-profiles", ":profile_id", "sample-recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5b25b1df-5dbd-4dde-9c1d-f73e273f4b1e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id", "sample-recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "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": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee2eac2a-c176-4b0b-831e-fe8ca996fc25", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id", "sample-recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "655727c9-e96e-4223-a6cd-f3eff1073646", "name": "Withdrawn - consent artifacts are no longer accepted", "request": { "name": "Withdrawn - consent artifacts are no longer accepted", "description": {}, "url": { "path": [ "v1", "voice-profiles", ":profile_id", "consent-recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4bcf32d2-8121-49e8-86e4-22a01460880e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id", "consent-recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "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": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b887a11-7245-4a63-b7fc-4e971fc10124", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id", "consent-recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a690a68-f8cd-4da3-899a-7abfbef0f387", "name": "Withdrawn - consent releases are no longer accepted", "request": { "name": "Withdrawn - consent releases are no longer accepted", "description": {}, "url": { "path": [ "v1", "voice-profiles", ":profile_id", "consent-proof" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "77dccc58-3486-4534-ab1a-9c573b42d6dc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id", "consent-proof" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "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": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd93ca47-1860-4d41-baff-92e8e632c1bd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "voice-profiles", ":profile_id", "consent-proof" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "profile_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "263ec018-84ab-44a0-929c-29c3512a3702", "name": "contacts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "54c2b2aa-7718-4ba9-9911-55456742e8ec", "name": "List contacts", "request": { "name": "List contacts", "description": {}, "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "best_consent_class", "value": "string", "description": "Filter on `best_consent_class`. Comma-separated values are OR." }, { "disabled": true, "key": "best_consent_class.gte", "value": "string", "description": "Filter on `best_consent_class` with the `gte` operator." }, { "disabled": true, "key": "best_consent_class.lte", "value": "string", "description": "Filter on `best_consent_class` with the `lte` operator." }, { "disabled": true, "key": "best_consent_class.gt", "value": "string", "description": "Filter on `best_consent_class` with the `gt` operator." }, { "disabled": true, "key": "best_consent_class.lt", "value": "string", "description": "Filter on `best_consent_class` with the `lt` operator." }, { "disabled": true, "key": "best_consent_class.in", "value": "string", "description": "Filter on `best_consent_class` with the `in` operator." }, { "disabled": true, "key": "company", "value": "string", "description": "Filter on `company`. Comma-separated values are OR." }, { "disabled": true, "key": "company.gte", "value": "string", "description": "Filter on `company` with the `gte` operator." }, { "disabled": true, "key": "company.lte", "value": "string", "description": "Filter on `company` with the `lte` operator." }, { "disabled": true, "key": "company.gt", "value": "string", "description": "Filter on `company` with the `gt` operator." }, { "disabled": true, "key": "company.lt", "value": "string", "description": "Filter on `company` with the `lt` operator." }, { "disabled": true, "key": "company.in", "value": "string", "description": "Filter on `company` with the `in` operator." }, { "disabled": true, "key": "contact_list_id", "value": "string", "description": "Filter on `contact_list_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_list_id.gte", "value": "string", "description": "Filter on `contact_list_id` with the `gte` operator." }, { "disabled": true, "key": "contact_list_id.lte", "value": "string", "description": "Filter on `contact_list_id` with the `lte` operator." }, { "disabled": true, "key": "contact_list_id.gt", "value": "string", "description": "Filter on `contact_list_id` with the `gt` operator." }, { "disabled": true, "key": "contact_list_id.lt", "value": "string", "description": "Filter on `contact_list_id` with the `lt` operator." }, { "disabled": true, "key": "contact_list_id.in", "value": "string", "description": "Filter on `contact_list_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "do_not_call", "value": "string", "description": "Filter on `do_not_call`. Comma-separated values are OR." }, { "disabled": true, "key": "do_not_call.gte", "value": "string", "description": "Filter on `do_not_call` with the `gte` operator." }, { "disabled": true, "key": "do_not_call.lte", "value": "string", "description": "Filter on `do_not_call` with the `lte` operator." }, { "disabled": true, "key": "do_not_call.gt", "value": "string", "description": "Filter on `do_not_call` with the `gt` operator." }, { "disabled": true, "key": "do_not_call.lt", "value": "string", "description": "Filter on `do_not_call` with the `lt` operator." }, { "disabled": true, "key": "do_not_call.in", "value": "string", "description": "Filter on `do_not_call` with the `in` operator." }, { "disabled": true, "key": "lead_status", "value": "string", "description": "Filter on `lead_status`. Comma-separated values are OR." }, { "disabled": true, "key": "lead_status.gte", "value": "string", "description": "Filter on `lead_status` with the `gte` operator." }, { "disabled": true, "key": "lead_status.lte", "value": "string", "description": "Filter on `lead_status` with the `lte` operator." }, { "disabled": true, "key": "lead_status.gt", "value": "string", "description": "Filter on `lead_status` with the `gt` operator." }, { "disabled": true, "key": "lead_status.lt", "value": "string", "description": "Filter on `lead_status` with the `lt` operator." }, { "disabled": true, "key": "lead_status.in", "value": "string", "description": "Filter on `lead_status` with the `in` operator." }, { "disabled": true, "key": "owner_user_id", "value": "string", "description": "Filter on `owner_user_id`. Comma-separated values are OR." }, { "disabled": true, "key": "owner_user_id.gte", "value": "string", "description": "Filter on `owner_user_id` with the `gte` operator." }, { "disabled": true, "key": "owner_user_id.lte", "value": "string", "description": "Filter on `owner_user_id` with the `lte` operator." }, { "disabled": true, "key": "owner_user_id.gt", "value": "string", "description": "Filter on `owner_user_id` with the `gt` operator." }, { "disabled": true, "key": "owner_user_id.lt", "value": "string", "description": "Filter on `owner_user_id` with the `lt` operator." }, { "disabled": true, "key": "owner_user_id.in", "value": "string", "description": "Filter on `owner_user_id` with the `in` operator." }, { "disabled": true, "key": "phone_e164", "value": "string", "description": "Filter on `phone_e164`. Comma-separated values are OR." }, { "disabled": true, "key": "phone_e164.gte", "value": "string", "description": "Filter on `phone_e164` with the `gte` operator." }, { "disabled": true, "key": "phone_e164.lte", "value": "string", "description": "Filter on `phone_e164` with the `lte` operator." }, { "disabled": true, "key": "phone_e164.gt", "value": "string", "description": "Filter on `phone_e164` with the `gt` operator." }, { "disabled": true, "key": "phone_e164.lt", "value": "string", "description": "Filter on `phone_e164` with the `lt` operator." }, { "disabled": true, "key": "phone_e164.in", "value": "string", "description": "Filter on `phone_e164` with the `in` operator." }, { "disabled": true, "key": "q", "value": "string", "description": "Filter on `q`. Comma-separated values are OR." }, { "disabled": true, "key": "q.gte", "value": "string", "description": "Filter on `q` with the `gte` operator." }, { "disabled": true, "key": "q.lte", "value": "string", "description": "Filter on `q` with the `lte` operator." }, { "disabled": true, "key": "q.gt", "value": "string", "description": "Filter on `q` with the `gt` operator." }, { "disabled": true, "key": "q.lt", "value": "string", "description": "Filter on `q` with the `lt` operator." }, { "disabled": true, "key": "q.in", "value": "string", "description": "Filter on `q` with the `in` operator." }, { "disabled": true, "key": "tag", "value": "string", "description": "Filter on `tag`. Comma-separated values are OR." }, { "disabled": true, "key": "tag.gte", "value": "string", "description": "Filter on `tag` with the `gte` operator." }, { "disabled": true, "key": "tag.lte", "value": "string", "description": "Filter on `tag` with the `lte` operator." }, { "disabled": true, "key": "tag.gt", "value": "string", "description": "Filter on `tag` with the `gt` operator." }, { "disabled": true, "key": "tag.lt", "value": "string", "description": "Filter on `tag` with the `lt` operator." }, { "disabled": true, "key": "tag.in", "value": "string", "description": "Filter on `tag` with the `in` operator." }, { "disabled": true, "key": "timezone", "value": "string", "description": "Filter on `timezone`. Comma-separated values are OR." }, { "disabled": true, "key": "timezone.gte", "value": "string", "description": "Filter on `timezone` with the `gte` operator." }, { "disabled": true, "key": "timezone.lte", "value": "string", "description": "Filter on `timezone` with the `lte` operator." }, { "disabled": true, "key": "timezone.gt", "value": "string", "description": "Filter on `timezone` with the `gt` operator." }, { "disabled": true, "key": "timezone.lt", "value": "string", "description": "Filter on `timezone` with the `lt` operator." }, { "disabled": true, "key": "timezone.in", "value": "string", "description": "Filter on `timezone` with the `in` operator." }, { "disabled": true, "key": "updated_at", "value": "string", "description": "Filter on `updated_at`. Comma-separated values are OR." }, { "disabled": true, "key": "updated_at.gte", "value": "string", "description": "Filter on `updated_at` with the `gte` operator." }, { "disabled": true, "key": "updated_at.lte", "value": "string", "description": "Filter on `updated_at` with the `lte` operator." }, { "disabled": true, "key": "updated_at.gt", "value": "string", "description": "Filter on `updated_at` with the `gt` operator." }, { "disabled": true, "key": "updated_at.lt", "value": "string", "description": "Filter on `updated_at` with the `lt` operator." }, { "disabled": true, "key": "updated_at.in", "value": "string", "description": "Filter on `updated_at` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6f5cfe80-2265-468c-90bf-143c8b04df4a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "best_consent_class", "value": "string" }, { "key": "best_consent_class.gte", "value": "string" }, { "key": "best_consent_class.lte", "value": "string" }, { "key": "best_consent_class.gt", "value": "string" }, { "key": "best_consent_class.lt", "value": "string" }, { "key": "best_consent_class.in", "value": "string" }, { "key": "company", "value": "string" }, { "key": "company.gte", "value": "string" }, { "key": "company.lte", "value": "string" }, { "key": "company.gt", "value": "string" }, { "key": "company.lt", "value": "string" }, { "key": "company.in", "value": "string" }, { "key": "contact_list_id", "value": "string" }, { "key": "contact_list_id.gte", "value": "string" }, { "key": "contact_list_id.lte", "value": "string" }, { "key": "contact_list_id.gt", "value": "string" }, { "key": "contact_list_id.lt", "value": "string" }, { "key": "contact_list_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "do_not_call", "value": "string" }, { "key": "do_not_call.gte", "value": "string" }, { "key": "do_not_call.lte", "value": "string" }, { "key": "do_not_call.gt", "value": "string" }, { "key": "do_not_call.lt", "value": "string" }, { "key": "do_not_call.in", "value": "string" }, { "key": "lead_status", "value": "string" }, { "key": "lead_status.gte", "value": "string" }, { "key": "lead_status.lte", "value": "string" }, { "key": "lead_status.gt", "value": "string" }, { "key": "lead_status.lt", "value": "string" }, { "key": "lead_status.in", "value": "string" }, { "key": "owner_user_id", "value": "string" }, { "key": "owner_user_id.gte", "value": "string" }, { "key": "owner_user_id.lte", "value": "string" }, { "key": "owner_user_id.gt", "value": "string" }, { "key": "owner_user_id.lt", "value": "string" }, { "key": "owner_user_id.in", "value": "string" }, { "key": "phone_e164", "value": "string" }, { "key": "phone_e164.gte", "value": "string" }, { "key": "phone_e164.lte", "value": "string" }, { "key": "phone_e164.gt", "value": "string" }, { "key": "phone_e164.lt", "value": "string" }, { "key": "phone_e164.in", "value": "string" }, { "key": "q", "value": "string" }, { "key": "q.gte", "value": "string" }, { "key": "q.lte", "value": "string" }, { "key": "q.gt", "value": "string" }, { "key": "q.lt", "value": "string" }, { "key": "q.in", "value": "string" }, { "key": "tag", "value": "string" }, { "key": "tag.gte", "value": "string" }, { "key": "tag.lte", "value": "string" }, { "key": "tag.gt", "value": "string" }, { "key": "tag.lt", "value": "string" }, { "key": "tag.in", "value": "string" }, { "key": "timezone", "value": "string" }, { "key": "timezone.gte", "value": "string" }, { "key": "timezone.lte", "value": "string" }, { "key": "timezone.gt", "value": "string" }, { "key": "timezone.lt", "value": "string" }, { "key": "timezone.in", "value": "string" }, { "key": "updated_at", "value": "string" }, { "key": "updated_at.gte", "value": "string" }, { "key": "updated_at.lte", "value": "string" }, { "key": "updated_at.gt", "value": "string" }, { "key": "updated_at.lt", "value": "string" }, { "key": "updated_at.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"2000-01-24T23:18:13.595Z\",\n \"updated_at\": \"2006-12-02T14:40:20.608Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": {\n \"value\": \"\"\n },\n \"do_not_call\": false,\n \"lead_status\": {\n \"value\": \"\"\n },\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"1996-10-15T05:33:53.756Z\",\n \"updated_at\": \"2009-06-18T17:25:15.038Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": {\n \"value\": \"\"\n },\n \"do_not_call\": false,\n \"lead_status\": {\n \"value\": \"\"\n },\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51d310c1-8031-49f5-8482-c9bb6b1ca641", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "best_consent_class", "value": "string" }, { "key": "best_consent_class.gte", "value": "string" }, { "key": "best_consent_class.lte", "value": "string" }, { "key": "best_consent_class.gt", "value": "string" }, { "key": "best_consent_class.lt", "value": "string" }, { "key": "best_consent_class.in", "value": "string" }, { "key": "company", "value": "string" }, { "key": "company.gte", "value": "string" }, { "key": "company.lte", "value": "string" }, { "key": "company.gt", "value": "string" }, { "key": "company.lt", "value": "string" }, { "key": "company.in", "value": "string" }, { "key": "contact_list_id", "value": "string" }, { "key": "contact_list_id.gte", "value": "string" }, { "key": "contact_list_id.lte", "value": "string" }, { "key": "contact_list_id.gt", "value": "string" }, { "key": "contact_list_id.lt", "value": "string" }, { "key": "contact_list_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "do_not_call", "value": "string" }, { "key": "do_not_call.gte", "value": "string" }, { "key": "do_not_call.lte", "value": "string" }, { "key": "do_not_call.gt", "value": "string" }, { "key": "do_not_call.lt", "value": "string" }, { "key": "do_not_call.in", "value": "string" }, { "key": "lead_status", "value": "string" }, { "key": "lead_status.gte", "value": "string" }, { "key": "lead_status.lte", "value": "string" }, { "key": "lead_status.gt", "value": "string" }, { "key": "lead_status.lt", "value": "string" }, { "key": "lead_status.in", "value": "string" }, { "key": "owner_user_id", "value": "string" }, { "key": "owner_user_id.gte", "value": "string" }, { "key": "owner_user_id.lte", "value": "string" }, { "key": "owner_user_id.gt", "value": "string" }, { "key": "owner_user_id.lt", "value": "string" }, { "key": "owner_user_id.in", "value": "string" }, { "key": "phone_e164", "value": "string" }, { "key": "phone_e164.gte", "value": "string" }, { "key": "phone_e164.lte", "value": "string" }, { "key": "phone_e164.gt", "value": "string" }, { "key": "phone_e164.lt", "value": "string" }, { "key": "phone_e164.in", "value": "string" }, { "key": "q", "value": "string" }, { "key": "q.gte", "value": "string" }, { "key": "q.lte", "value": "string" }, { "key": "q.gt", "value": "string" }, { "key": "q.lt", "value": "string" }, { "key": "q.in", "value": "string" }, { "key": "tag", "value": "string" }, { "key": "tag.gte", "value": "string" }, { "key": "tag.lte", "value": "string" }, { "key": "tag.gt", "value": "string" }, { "key": "tag.lt", "value": "string" }, { "key": "tag.in", "value": "string" }, { "key": "timezone", "value": "string" }, { "key": "timezone.gte", "value": "string" }, { "key": "timezone.lte", "value": "string" }, { "key": "timezone.gt", "value": "string" }, { "key": "timezone.lt", "value": "string" }, { "key": "timezone.in", "value": "string" }, { "key": "updated_at", "value": "string" }, { "key": "updated_at.gte", "value": "string" }, { "key": "updated_at.lte", "value": "string" }, { "key": "updated_at.gt", "value": "string" }, { "key": "updated_at.lt", "value": "string" }, { "key": "updated_at.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b86aedb6-df08-4ad7-9b15-070bddff890d", "name": "Create a contact", "request": { "name": "Create a contact", "description": {}, "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"phone_e164\": \"+1436800192\",\n \"consent\": {\n \"consent_basis\": \"pewc\",\n \"captured_at\": \"1970-06-30T22:58:41.792Z\",\n \"scope\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2846.711028393676\n },\n \"evidence\": {\n \"artifact_type\": \"string\",\n \"artifact_ref\": \"string\",\n \"content_hash\": \"6b5bee1fbd20e220d2c4ddb003ae8c7e56fa8bf714eda98a8629390a830f687b\"\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1987-08-05T23:14:19.330Z\"\n },\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": 8804\n },\n \"lead_status\": \"lost\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e8a4aee-a970-4e0c-8f54-ea351b04635d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_e164\": \"+367820039533631\",\n \"consent\": {\n \"consent_basis\": \"ebr\",\n \"captured_at\": \"1964-08-08T08:24:12.780Z\",\n \"scope\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"evidence\": {\n \"artifact_type\": \"string\",\n \"artifact_ref\": \"string\",\n \"content_hash\": \"9219edee67d588f27b159307600bb40c19df6d36069a7ede8f35a333ff27ca36\"\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1986-02-27T15:28:12.021Z\"\n },\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": 8281.86497673173\n },\n \"lead_status\": \"working\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"2001-06-23T10:26:30.880Z\",\n \"updated_at\": \"1965-03-17T19:56:15.356Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": \"ebr\",\n \"do_not_call\": false,\n \"lead_status\": \"lost\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 7908,\n \"key_2\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8adf0bc6-32f3-43d7-bf82-8c3d75e3b6a5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_e164\": \"+367820039533631\",\n \"consent\": {\n \"consent_basis\": \"ebr\",\n \"captured_at\": \"1964-08-08T08:24:12.780Z\",\n \"scope\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"evidence\": {\n \"artifact_type\": \"string\",\n \"artifact_ref\": \"string\",\n \"content_hash\": \"9219edee67d588f27b159307600bb40c19df6d36069a7ede8f35a333ff27ca36\"\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1986-02-27T15:28:12.021Z\"\n },\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": 8281.86497673173\n },\n \"lead_status\": \"working\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0598a4f-eaf4-4a83-a60e-6f1dd8b06e24", "name": "Read a contact", "request": { "name": "Read a contact", "description": {}, "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5136a00c-fae7-4a00-b658-b43288cc84ff", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"2001-06-23T10:26:30.880Z\",\n \"updated_at\": \"1965-03-17T19:56:15.356Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": \"ebr\",\n \"do_not_call\": false,\n \"lead_status\": \"lost\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 7908,\n \"key_2\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b988c59-a766-4948-8386-faf4b5b7fc48", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0b030a5-88d9-4d54-86b7-63f2b108df50", "name": "Update a contact", "request": { "name": "Update a contact", "description": {}, "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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 \"phone_e164\": \"+599938017813004\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": 7173.8015285063675,\n \"key_1\": false\n },\n \"lead_status\": \"working\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"st\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67535475-2c6b-4e45-b7c8-09815043d5ca", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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 \"phone_e164\": \"+5200857\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 551,\n \"key_2\": 1938,\n \"key_3\": false\n },\n \"lead_status\": \"qualified\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"2001-06-23T10:26:30.880Z\",\n \"updated_at\": \"1965-03-17T19:56:15.356Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": \"ebr\",\n \"do_not_call\": false,\n \"lead_status\": \"lost\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 7908,\n \"key_2\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58185752-ba2a-4d74-9744-7475f51249ff", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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 \"phone_e164\": \"+5200857\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 551,\n \"key_2\": 1938,\n \"key_3\": false\n },\n \"lead_status\": \"qualified\",\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae5aeae7-8db4-4b11-ba27-a4e6f14fb7d8", "name": "Soft-delete a contact", "request": { "name": "Soft-delete a contact", "description": {}, "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e9940ed-68f0-4f32-8e8e-358711c806dc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d30bca94-f238-4168-b3f9-26e2edc9a65c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bb39c5e-895b-4b81-b272-929fbdce44ef", "name": "Check whether this contact may be dialed right now", "request": { "name": "Check whether this contact may be dialed right now", "description": { "content": "Evaluate the canonical dialability gate over this contact's record.\n\nThe same evaluator every dial passes, given the facts a contact row holds: the\ndenormalized internal-DNC flag, the consent class, the jurisdictions, and the callee's\nlocal clock. Bureau scrub stages are billed per query and belong to a ScrubRun, so\nnone of them run here and `policy_snapshot.stages` is empty.\n\nThe same *resolution*, too - `outbound_effective_policy`, at this request's clock. A\npreview that answered \"dialable\" for a state whose pack is not yet in force would be\nreporting a permission the dial path itself refuses, which is the one direction a\npreview must never be wrong in.", "type": "text/plain" }, "url": { "path": [ "v1", "contacts", ":contact_id", "dialability" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "purpose", "value": "marketing" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad9cdc20-7564-4bb8-8b0e-4d4cb5c003ec", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "dialability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "marketing" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact_id\": \"string\",\n \"phone_e164\": \"string\",\n \"purpose\": \"marketing\",\n \"dialable\": true,\n \"timezone\": \"string\",\n \"evaluated_at\": \"2012-06-12T23:45:37.151Z\",\n \"blocked_reasons\": [\n \"string\",\n \"string\"\n ],\n \"policy_refusals\": [\n \"string\",\n \"string\"\n ],\n \"risk_flags\": [\n \"string\",\n \"string\"\n ],\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ],\n \"policy_snapshot\": {\n \"key_0\": 2314.1187192704283,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6105c688-50ac-4126-8409-da1205b1e1bc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "dialability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "marketing" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05383af5-86af-4feb-a9a5-cfe50767f639", "name": "List a contact's notes", "request": { "name": "List a contact's notes", "description": {}, "url": { "path": [ "v1", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1b0d2b3d-2e69-48eb-b793-da06a437b14a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"author_ref\": \"string\",\n \"body\": \"string\",\n \"created_at\": \"1972-11-26T07:05:47.131Z\",\n \"updated_at\": \"2001-11-30T20:47:05.539Z\",\n \"call_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"author_ref\": \"string\",\n \"body\": \"string\",\n \"created_at\": \"1991-09-04T19:58:10.665Z\",\n \"updated_at\": \"2013-04-03T13:58:09.463Z\",\n \"call_id\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1fb969b-f4c6-496f-acea-b8e9b7f0820c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3c9e8e6-e8d3-4b24-84a9-0b6a4c5a4488", "name": "Leave a note on a contact", "request": { "name": "Leave a note on a contact", "description": { "content": "Append one working note.\n\nA note is what a rep typed. It is not consent evidence and not a suppression: those\nare `POST /v1/consents` and `POST /v1/dnc-entries`, both of which write records this\nendpoint cannot produce and the dial gate actually reads. Writing \"they asked not to\nbe called\" here suppresses nothing.\n\n`author_ref` is the credential that wrote it - the API key id here, because an API-key\nprincipal names no person and inventing one would put a name in an audit trail that\nnobody signed.", "type": "text/plain" }, "url": { "path": [ "v1", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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 \"body\": \"string\",\n \"call_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0339c4d8-b692-4310-a1c3-6dc01ae4e789", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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 \"body\": \"string\",\n \"call_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"author_ref\": \"string\",\n \"body\": \"string\",\n \"created_at\": \"1958-12-07T01:38:43.136Z\",\n \"updated_at\": \"1955-03-22T16:38:09.856Z\",\n \"call_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f9558eb-40d6-4a0d-b818-fb26e9eb5cc5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "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 \"body\": \"string\",\n \"call_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f593a22-d86d-4bb3-87f2-916c2fc0e191", "name": "Remove a note", "request": { "name": "Remove a note", "description": {}, "url": { "path": [ "v1", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed8f2141-3801-488a-9aa9-8d7f8c623f14", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50dd79ec-3602-4d6b-9940-a3afec8fbe7d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e8bd971-cbc5-46e2-926c-ee67df6f3cab", "name": "Apply one action to up to 1000 contacts", "request": { "name": "Apply one action to up to 1000 contacts", "description": { "content": "The morning-after actions, in one request instead of one at a time.\n\nEvery branch is the *existing* per-contact write, run over a batch - the suppression\ngoes through the revocation path with all its derived writes, the delete is the same\nsoft delete `DELETE /contacts/{id}` performs, and list membership is the same join\n`POST /contact-lists/{id}/members` writes. None of them invents a shortcut, which is\nwhy a bulk suppress cannot end up weaker than a single one.\n\n`suppress` additionally requires `dnc:manage`: it writes the internal DNC list, and a\nkey trusted to edit contacts is not thereby trusted to change what may be dialed.", "type": "text/plain" }, "url": { "path": [ "v1", "contacts", "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 \"contact_ids\": [\n \"string\"\n ],\n \"action\": \"add_to_list\",\n \"contact_list_id\": \"string\",\n \"lead_status\": \"lost\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "16aed5c7-725f-4c7c-b826-b8f29e4e7f12", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contacts", "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 \"contact_ids\": [\n \"string\"\n ],\n \"action\": \"add_to_list\",\n \"contact_list_id\": \"string\",\n \"lead_status\": \"lost\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"action\": \"suppress\",\n \"requested\": 1292,\n \"matched\": 9783,\n \"changed\": 2375,\n \"unknown_contact_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c76b4df2-507d-4944-aeba-c4452359d914", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contacts", "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 \"contact_ids\": [\n \"string\"\n ],\n \"action\": \"add_to_list\",\n \"contact_list_id\": \"string\",\n \"lead_status\": \"lost\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f82aa6a8-18f5-4ab6-9275-5c763d73e58f", "name": "List contact lists", "request": { "name": "List contact lists", "description": {}, "url": { "path": [ "v1", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "192b7752-7151-4fa7-a138-7f8b48eb294a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"source\": \"api\",\n \"contact_count\": 7616,\n \"created_at\": \"1975-05-30T11:26:24.229Z\",\n \"updated_at\": \"2021-04-18T17:20:36.624Z\",\n \"consent_basis\": {\n \"value\": \"\"\n },\n \"attestation_ref\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"source\": \"upload\",\n \"contact_count\": 4645,\n \"created_at\": \"1960-07-12T22:21:12.998Z\",\n \"updated_at\": \"1957-04-11T01:56:23.905Z\",\n \"consent_basis\": {\n \"value\": \"\"\n },\n \"attestation_ref\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9e769db-6c94-4394-bcba-9c76326db038", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "758d98e4-4137-44f7-8cff-dc81cb608b69", "name": "Create a contact list", "request": { "name": "Create a contact list", "description": {}, "url": { "path": [ "v1", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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\": \"string\",\n \"source\": \"api\",\n \"consent_basis\": \"pec\",\n \"attestation_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ef130452-7878-4bdd-8795-8ff4e67f182e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"source\": \"api\",\n \"consent_basis\": \"pec\",\n \"attestation_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"source\": \"upload\",\n \"contact_count\": 6497,\n \"created_at\": \"1970-06-18T19:15:00.220Z\",\n \"updated_at\": \"1999-01-22T02:31:40.729Z\",\n \"consent_basis\": \"pewc\",\n \"attestation_ref\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06f0cf65-acda-4c9f-9494-2aa35e20e701", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"source\": \"api\",\n \"consent_basis\": \"pec\",\n \"attestation_ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0004a11c-5348-427b-8867-5ec3748c0d0c", "name": "Add contacts to a list", "request": { "name": "Add contacts to a list", "description": {}, "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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 \"contact_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f4225a99-4655-4617-bbea-280bbc1ccae1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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 \"contact_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact_list_id\": \"string\",\n \"added\": 2617,\n \"already_present\": 2869,\n \"contact_count\": 3687,\n \"unknown_contact_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc370de-7145-48fa-a7c5-78c5ae43006e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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 \"contact_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dd88916-2309-4f05-8349-9dfe9acfd67f", "name": "List the contacts on a list", "request": { "name": "List the contacts on a list", "description": {}, "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ddc0722-94dc-4b92-b02e-a41c75208237", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"2000-01-24T23:18:13.595Z\",\n \"updated_at\": \"2006-12-02T14:40:20.608Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": {\n \"value\": \"\"\n },\n \"do_not_call\": false,\n \"lead_status\": {\n \"value\": \"\"\n },\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"created_at\": \"1996-10-15T05:33:53.756Z\",\n \"updated_at\": \"2009-06-18T17:25:15.038Z\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"company\": \"string\",\n \"title\": \"string\",\n \"email\": \"string\",\n \"timezone\": \"string\",\n \"best_consent_class\": {\n \"value\": \"\"\n },\n \"do_not_call\": false,\n \"lead_status\": {\n \"value\": \"\"\n },\n \"owner_user_id\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aab630b1-a5c7-4951-b320-cacb9386ea5d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9521750-d2d1-4003-a788-176498460101", "name": "Remove contacts from a list", "request": { "name": "Remove contacts from a list", "description": { "content": "Take contacts off a list. The contacts themselves are untouched.\n\nMirrors `POST .../members` - same request shape, same 1000-id cap - because a caller\nwho can build the add call should not have to build a different one to undo it. A\ncustomer who imported the wrong CSV into the wrong list unwinds it here.", "type": "text/plain" }, "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ee0c16f-3740-4876-a2a4-df922435557f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact_list_id\": \"string\",\n \"removed\": 8201,\n \"not_present\": 7133,\n \"contact_count\": 6902\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faee5f1f-3f36-4a9b-9b58-fbda93e0294b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c07e2252-3484-4853-ab0f-0c8f0a7d8389", "name": "Read a contact list", "request": { "name": "Read a contact list", "description": {}, "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c146522a-c1ae-4d46-80ec-c9c12160d575", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"source\": \"upload\",\n \"contact_count\": 6497,\n \"created_at\": \"1970-06-18T19:15:00.220Z\",\n \"updated_at\": \"1999-01-22T02:31:40.729Z\",\n \"consent_basis\": \"pewc\",\n \"attestation_ref\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8122960e-ce62-4d68-b89e-4debaa9c3f2a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6acb1a15-3684-401f-9c60-117e85bd2d2c", "name": "Rename a contact list", "request": { "name": "Rename a contact list", "description": { "content": "Rename it, and nothing else.\n\n`consent_basis` and `attestation_ref` are not writable here. They record what a named\nhuman affirmed about these rows at import time, and every dial made against the list\ncites them - an attestation that can be edited afterwards is not evidence.", "type": "text/plain" }, "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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 \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "123e3e1b-7cc5-4bfb-829b-15eaf741ad8e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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 \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"source\": \"upload\",\n \"contact_count\": 6497,\n \"created_at\": \"1970-06-18T19:15:00.220Z\",\n \"updated_at\": \"1999-01-22T02:31:40.729Z\",\n \"consent_basis\": \"pewc\",\n \"attestation_ref\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f0d8c3f-ac81-422f-81f0-a9a6fd94dca0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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 \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da33e701-9714-4a22-865a-6dd5cd25d476", "name": "Delete a contact list", "request": { "name": "Delete a contact list", "description": { "content": "Drop the list and its memberships. The contacts on it are untouched.\n\nRefused while a campaign still targets it: the campaign's configuration is what its\ncalls were made under, and a target that could be deleted out from under a finished\ncampaign would break the record of who it was run against.", "type": "text/plain" }, "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "872f3b13-c49f-425f-a4ae-fdf39950c04f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a181743-1dbb-40c3-b229-e3bf6dad6048", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "list_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cd6d322-d90a-48bd-9883-fc360b5b0a7a", "name": "Import contacts from a CSV", "request": { "name": "Import contacts from a CSV", "description": { "content": "Land a CSV in a contact list and report every row that could not be taken.\n\nAnswered at 202 with the documented poll contract on `GET /contact-imports/{id}`; the\nP1 import runs inside this request, so the job is already terminal when it answers.", "type": "text/plain" }, "url": { "path": [ "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"file_name\": \"string\",\n \"content\": \"string\",\n \"column_mapping\": {\n \"key_0\": \"title\"\n },\n \"consent_attestation\": {\n \"signer_name\": \"string\",\n \"signer_title\": \"string\",\n \"affirmation\": \"string\",\n \"consent_basis\": \"pewc\"\n },\n \"target_list_id\": \"string\",\n \"list_name\": \"string\",\n \"on_duplicate\": \"reject\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "87c50916-e300-44af-b92d-b894c2262cb9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_name\": \"string\",\n \"content\": \"string\",\n \"column_mapping\": {\n \"key_0\": \"title\"\n },\n \"consent_attestation\": {\n \"signer_name\": \"string\",\n \"signer_title\": \"string\",\n \"affirmation\": \"string\",\n \"consent_basis\": \"pewc\"\n },\n \"target_list_id\": \"string\",\n \"list_name\": \"string\",\n \"on_duplicate\": \"reject\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"queued\",\n \"file_uri\": \"string\",\n \"consent_attestation\": {\n \"signer_name\": \"string\",\n \"signer_title\": \"string\",\n \"affirmation\": \"string\",\n \"consent_basis\": \"pewc\",\n \"signed_at\": \"1995-02-20T20:58:37.705Z\",\n \"signer_ip\": \"string\"\n },\n \"rows_accepted\": 5891,\n \"rows_rejected\": 2917,\n \"created_at\": \"1988-05-20T22:21:03.613Z\",\n \"updated_at\": \"1990-04-20T06:06:11.191Z\",\n \"column_mapping\": {\n \"key_0\": \"string\"\n },\n \"target_list_id\": \"string\",\n \"rows_skipped\": 0,\n \"on_duplicate\": \"reject\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed82572-50f0-4ada-bb27-08621aefcb56", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_name\": \"string\",\n \"content\": \"string\",\n \"column_mapping\": {\n \"key_0\": \"title\"\n },\n \"consent_attestation\": {\n \"signer_name\": \"string\",\n \"signer_title\": \"string\",\n \"affirmation\": \"string\",\n \"consent_basis\": \"pewc\"\n },\n \"target_list_id\": \"string\",\n \"list_name\": \"string\",\n \"on_duplicate\": \"reject\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf09f394-ebe1-4d1f-a881-01dda24967a1", "name": "List past imports", "request": { "name": "List past imports", "description": { "content": "Import history, newest first.\n\nEach row carries the consent attestation the import was submitted under - the named\nsigner, their title, the server-stamped address and time. Those are the evidence\nbehind every dial made against the list the import built, so the history is a record\nto be kept rather than a convenience.", "type": "text/plain" }, "url": { "path": [ "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "67b7e4cd-a36c-4c10-86a5-840b21c71f07", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"status\": \"failed\",\n \"file_uri\": \"string\",\n \"consent_attestation\": {\n \"signer_name\": {\n \"value\": \"\"\n },\n \"signer_title\": {\n \"value\": \"\"\n },\n \"affirmation\": {\n \"value\": \"\"\n },\n \"consent_basis\": {\n \"value\": \"\"\n },\n \"signed_at\": {\n \"value\": \"\"\n },\n \"signer_ip\": {\n \"value\": \"\"\n }\n },\n \"rows_accepted\": 6689,\n \"rows_rejected\": 5717,\n \"created_at\": \"1972-08-16T15:25:58.261Z\",\n \"updated_at\": \"1965-10-17T03:18:51.877Z\",\n \"column_mapping\": {\n \"key_0\": \"string\"\n },\n \"target_list_id\": \"string\",\n \"rows_skipped\": 0,\n \"on_duplicate\": \"reject\"\n },\n {\n \"id\": \"string\",\n \"status\": \"failed\",\n \"file_uri\": \"string\",\n \"consent_attestation\": {\n \"signer_name\": {\n \"value\": \"\"\n },\n \"signer_title\": {\n \"value\": \"\"\n },\n \"affirmation\": {\n \"value\": \"\"\n },\n \"consent_basis\": {\n \"value\": \"\"\n },\n \"signed_at\": {\n \"value\": \"\"\n },\n \"signer_ip\": {\n \"value\": \"\"\n }\n },\n \"rows_accepted\": 1931,\n \"rows_rejected\": 6792,\n \"created_at\": \"1949-11-15T13:16:06.039Z\",\n \"updated_at\": \"1977-11-11T22:36:10.054Z\",\n \"column_mapping\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"target_list_id\": \"string\",\n \"rows_skipped\": 0,\n \"on_duplicate\": \"reject\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ee94e96-9b42-4307-ae9e-426f13c5d437", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "483a714c-2625-4a02-a5ec-9b71926be271", "name": "Read an import job", "request": { "name": "Read an import job", "description": {}, "url": { "path": [ "v1", "contact-imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "import_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fcd5a8ac-f2d1-4b62-9400-79bdd9da19fe", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "import_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"queued\",\n \"file_uri\": \"string\",\n \"consent_attestation\": {\n \"signer_name\": \"string\",\n \"signer_title\": \"string\",\n \"affirmation\": \"string\",\n \"consent_basis\": \"pewc\",\n \"signed_at\": \"1995-02-20T20:58:37.705Z\",\n \"signer_ip\": \"string\"\n },\n \"rows_accepted\": 5891,\n \"rows_rejected\": 2917,\n \"created_at\": \"1988-05-20T22:21:03.613Z\",\n \"updated_at\": \"1990-04-20T06:06:11.191Z\",\n \"column_mapping\": {\n \"key_0\": \"string\"\n },\n \"target_list_id\": \"string\",\n \"rows_skipped\": 0,\n \"on_duplicate\": \"reject\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc0ccd3-d071-4b8f-8777-258fbc788fe9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "import_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "967b0071-e744-4a37-9792-b1e809617abb", "name": "List the rows an import rejected (JSON, or CSV with Accept: text/csv)", "request": { "name": "List the rows an import rejected (JSON, or CSV with Accept: text/csv)", "description": {}, "url": { "path": [ "v1", "contact-imports", ":import_id", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "import_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c0643389-9084-4b13-ac49-6e377481ffff", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-imports", ":import_id", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "import_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"row\": 9054,\n \"code\": \"parse_failure\",\n \"detail\": \"string\",\n \"column\": \"string\",\n \"value\": \"string\"\n },\n {\n \"row\": 4660,\n \"code\": \"parse_failure\",\n \"detail\": \"string\",\n \"column\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0592776-6013-4e85-9629-b8ca7ecc547d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-imports", ":import_id", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "import_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "key": "accept", "value": "", "description": "" }, { "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d5fb0f4f-6bb3-4142-a20d-1563e9d80f5b", "name": "campaigns", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f67f4e78-6a3c-4f7b-9b32-d98b1f91ca01", "name": "Follow-up feed: every attempt this tenant owns, across campaigns", "request": { "name": "Follow-up feed: every attempt this tenant owns, across campaigns", "description": { "content": "The board an operator works the morning after, and the only place callbacks surface.\n\nEvery attempt this tenant owns - campaign-backed and campaign-less alike - filterable\non `next_eligible_at`, which is what makes \"who is due before noon\" a range query\ninstead of a scan: `?state=scheduled&next_eligible_at.lte=2026-08-11T17:00:00Z`.\n\nIt reports scheduling facts, not promises. `scheduled_for` is the earliest instant the\nwindow layers allowed when the row was written; every attempt is re-gated at dial time\nand one listed here can still be refused then (docs/07-compliance.md).", "type": "text/plain" }, "url": { "path": [ "v1", "contact-attempts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "disposition", "value": "string", "description": "Filter on `disposition`. Comma-separated values are OR." }, { "disabled": true, "key": "disposition.gte", "value": "string", "description": "Filter on `disposition` with the `gte` operator." }, { "disabled": true, "key": "disposition.lte", "value": "string", "description": "Filter on `disposition` with the `lte` operator." }, { "disabled": true, "key": "disposition.gt", "value": "string", "description": "Filter on `disposition` with the `gt` operator." }, { "disabled": true, "key": "disposition.lt", "value": "string", "description": "Filter on `disposition` with the `lt` operator." }, { "disabled": true, "key": "disposition.in", "value": "string", "description": "Filter on `disposition` with the `in` operator." }, { "disabled": true, "key": "next_eligible_at", "value": "string", "description": "Filter on `next_eligible_at`. Comma-separated values are OR." }, { "disabled": true, "key": "next_eligible_at.gte", "value": "string", "description": "Filter on `next_eligible_at` with the `gte` operator." }, { "disabled": true, "key": "next_eligible_at.lte", "value": "string", "description": "Filter on `next_eligible_at` with the `lte` operator." }, { "disabled": true, "key": "next_eligible_at.gt", "value": "string", "description": "Filter on `next_eligible_at` with the `gt` operator." }, { "disabled": true, "key": "next_eligible_at.lt", "value": "string", "description": "Filter on `next_eligible_at` with the `lt` operator." }, { "disabled": true, "key": "next_eligible_at.in", "value": "string", "description": "Filter on `next_eligible_at` with the `in` operator." }, { "disabled": true, "key": "origin_kind", "value": "string", "description": "Filter on `origin_kind`. Comma-separated values are OR." }, { "disabled": true, "key": "origin_kind.gte", "value": "string", "description": "Filter on `origin_kind` with the `gte` operator." }, { "disabled": true, "key": "origin_kind.lte", "value": "string", "description": "Filter on `origin_kind` with the `lte` operator." }, { "disabled": true, "key": "origin_kind.gt", "value": "string", "description": "Filter on `origin_kind` with the `gt` operator." }, { "disabled": true, "key": "origin_kind.lt", "value": "string", "description": "Filter on `origin_kind` with the `lt` operator." }, { "disabled": true, "key": "origin_kind.in", "value": "string", "description": "Filter on `origin_kind` with the `in` operator." }, { "disabled": true, "key": "state", "value": "string", "description": "Filter on `state`. Comma-separated values are OR." }, { "disabled": true, "key": "state.gte", "value": "string", "description": "Filter on `state` with the `gte` operator." }, { "disabled": true, "key": "state.lte", "value": "string", "description": "Filter on `state` with the `lte` operator." }, { "disabled": true, "key": "state.gt", "value": "string", "description": "Filter on `state` with the `gt` operator." }, { "disabled": true, "key": "state.lt", "value": "string", "description": "Filter on `state` with the `lt` operator." }, { "disabled": true, "key": "state.in", "value": "string", "description": "Filter on `state` with the `in` operator." }, { "disabled": true, "key": "updated_at", "value": "string", "description": "Filter on `updated_at`. Comma-separated values are OR." }, { "disabled": true, "key": "updated_at.gte", "value": "string", "description": "Filter on `updated_at` with the `gte` operator." }, { "disabled": true, "key": "updated_at.lte", "value": "string", "description": "Filter on `updated_at` with the `lte` operator." }, { "disabled": true, "key": "updated_at.gt", "value": "string", "description": "Filter on `updated_at` with the `gt` operator." }, { "disabled": true, "key": "updated_at.lt", "value": "string", "description": "Filter on `updated_at` with the `lt` operator." }, { "disabled": true, "key": "updated_at.in", "value": "string", "description": "Filter on `updated_at` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4e9b2178-4612-4f04-9a06-e4cc5f527cb3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "contact-attempts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "next_eligible_at", "value": "string" }, { "key": "next_eligible_at.gte", "value": "string" }, { "key": "next_eligible_at.lte", "value": "string" }, { "key": "next_eligible_at.gt", "value": "string" }, { "key": "next_eligible_at.lt", "value": "string" }, { "key": "next_eligible_at.in", "value": "string" }, { "key": "origin_kind", "value": "string" }, { "key": "origin_kind.gte", "value": "string" }, { "key": "origin_kind.lte", "value": "string" }, { "key": "origin_kind.gt", "value": "string" }, { "key": "origin_kind.lt", "value": "string" }, { "key": "origin_kind.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" }, { "key": "updated_at", "value": "string" }, { "key": "updated_at.gte", "value": "string" }, { "key": "updated_at.lte", "value": "string" }, { "key": "updated_at.gt", "value": "string" }, { "key": "updated_at.lt", "value": "string" }, { "key": "updated_at.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_phone\": \"string\",\n \"attempt_number\": 9645,\n \"state\": \"machine\",\n \"updated_at\": \"2008-09-13T06:11:08.097Z\",\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"failure_reason\": {\n \"value\": \"\"\n },\n \"call_id\": \"string\",\n \"scheduled_for\": \"2017-10-14T07:01:45.882Z\",\n \"dialed_at\": \"2011-01-31T08:26:40.957Z\",\n \"ended_at\": \"2013-04-26T00:18:06.127Z\",\n \"campaign_id\": \"string\",\n \"contact_first_name\": \"string\",\n \"contact_last_name\": \"string\",\n \"origin_kind\": \"string\",\n \"callback_reason\": \"string\"\n },\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_phone\": \"string\",\n \"attempt_number\": 5066,\n \"state\": \"answered\",\n \"updated_at\": \"1968-10-12T14:01:13.354Z\",\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"failure_reason\": {\n \"value\": \"\"\n },\n \"call_id\": \"string\",\n \"scheduled_for\": \"2016-10-28T18:08:27.713Z\",\n \"dialed_at\": \"2016-03-21T16:05:45.531Z\",\n \"ended_at\": \"1990-07-26T05:54:05.610Z\",\n \"campaign_id\": \"string\",\n \"contact_first_name\": \"string\",\n \"contact_last_name\": \"string\",\n \"origin_kind\": \"string\",\n \"callback_reason\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dabd3ab1-06bb-44f7-b44e-2d6926b97be6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "contact-attempts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "next_eligible_at", "value": "string" }, { "key": "next_eligible_at.gte", "value": "string" }, { "key": "next_eligible_at.lte", "value": "string" }, { "key": "next_eligible_at.gt", "value": "string" }, { "key": "next_eligible_at.lt", "value": "string" }, { "key": "next_eligible_at.in", "value": "string" }, { "key": "origin_kind", "value": "string" }, { "key": "origin_kind.gte", "value": "string" }, { "key": "origin_kind.lte", "value": "string" }, { "key": "origin_kind.gt", "value": "string" }, { "key": "origin_kind.lt", "value": "string" }, { "key": "origin_kind.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" }, { "key": "updated_at", "value": "string" }, { "key": "updated_at.gte", "value": "string" }, { "key": "updated_at.lte", "value": "string" }, { "key": "updated_at.gt", "value": "string" }, { "key": "updated_at.lt", "value": "string" }, { "key": "updated_at.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f61f387-9582-4dec-9e6a-9ef84df8f84b", "name": "List campaigns", "request": { "name": "List campaigns", "description": {}, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "agent_definition_id", "value": "string", "description": "Filter on `agent_definition_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_definition_id.gte", "value": "string", "description": "Filter on `agent_definition_id` with the `gte` operator." }, { "disabled": true, "key": "agent_definition_id.lte", "value": "string", "description": "Filter on `agent_definition_id` with the `lte` operator." }, { "disabled": true, "key": "agent_definition_id.gt", "value": "string", "description": "Filter on `agent_definition_id` with the `gt` operator." }, { "disabled": true, "key": "agent_definition_id.lt", "value": "string", "description": "Filter on `agent_definition_id` with the `lt` operator." }, { "disabled": true, "key": "agent_definition_id.in", "value": "string", "description": "Filter on `agent_definition_id` with the `in` operator." }, { "disabled": true, "key": "contact_list_id", "value": "string", "description": "Filter on `contact_list_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_list_id.gte", "value": "string", "description": "Filter on `contact_list_id` with the `gte` operator." }, { "disabled": true, "key": "contact_list_id.lte", "value": "string", "description": "Filter on `contact_list_id` with the `lte` operator." }, { "disabled": true, "key": "contact_list_id.gt", "value": "string", "description": "Filter on `contact_list_id` with the `gt` operator." }, { "disabled": true, "key": "contact_list_id.lt", "value": "string", "description": "Filter on `contact_list_id` with the `lt` operator." }, { "disabled": true, "key": "contact_list_id.in", "value": "string", "description": "Filter on `contact_list_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7ecf83cc-831c-4cd7-9795-88f228416d7d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_definition_id", "value": "string" }, { "key": "agent_definition_id.gte", "value": "string" }, { "key": "agent_definition_id.lte", "value": "string" }, { "key": "agent_definition_id.gt", "value": "string" }, { "key": "agent_definition_id.lt", "value": "string" }, { "key": "agent_definition_id.in", "value": "string" }, { "key": "contact_list_id", "value": "string" }, { "key": "contact_list_id.gte", "value": "string" }, { "key": "contact_list_id.lte", "value": "string" }, { "key": "contact_list_id.gt", "value": "string" }, { "key": "contact_list_id.lt", "value": "string" }, { "key": "contact_list_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"paused\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": {\n \"value\": \"\"\n }\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 4048,\n \"contacts_total\": 3878,\n \"dialed\": 7683,\n \"connected\": 9438,\n \"completed_goal\": 8603,\n \"created_at\": \"1965-08-10T14:44:37.047Z\",\n \"updated_at\": \"2022-04-09T10:22:15.523Z\",\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 6590\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"ready\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": {\n \"value\": \"\"\n }\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 974,\n \"contacts_total\": 6550,\n \"dialed\": 8214,\n \"connected\": 9241,\n \"completed_goal\": 3454,\n \"created_at\": \"1948-01-13T08:42:44.272Z\",\n \"updated_at\": \"1983-01-20T07:54:12.187Z\",\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 9465\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f7cdf74-86fd-4dd4-9160-9df1be13d9cf", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_definition_id", "value": "string" }, { "key": "agent_definition_id.gte", "value": "string" }, { "key": "agent_definition_id.lte", "value": "string" }, { "key": "agent_definition_id.gt", "value": "string" }, { "key": "agent_definition_id.lt", "value": "string" }, { "key": "agent_definition_id.in", "value": "string" }, { "key": "contact_list_id", "value": "string" }, { "key": "contact_list_id.gte", "value": "string" }, { "key": "contact_list_id.lte", "value": "string" }, { "key": "contact_list_id.gt", "value": "string" }, { "key": "contact_list_id.lt", "value": "string" }, { "key": "contact_list_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1aeac14b-9c50-42fe-97f7-cce1f0de1ff3", "name": "Create a campaign", "request": { "name": "Create a campaign", "description": {}, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"1967-02-17\",\n \"end_date\": \"1949-12-27\",\n \"paused_dates\": [\n \"1965-05-15\",\n \"1951-09-04\"\n ]\n },\n \"max_attempts_per_contact\": 3,\n \"retry_policy\": {\n \"backoff_minutes\": [\n 2480,\n 2309\n ],\n \"retry_dispositions\": [\n \"browser_unavailable\",\n \"voicemail_machine\"\n ]\n },\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"concurrency_cap\": 6342,\n \"goal\": {\n \"key_0\": 7055.821544442675,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "78ac4e5b-a844-4da1-9e58-c6e7f0c63afa", "name": "Successful Response", "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 " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"1967-02-17\",\n \"end_date\": \"1949-12-27\",\n \"paused_dates\": [\n \"1965-05-15\",\n \"1951-09-04\"\n ]\n },\n \"max_attempts_per_contact\": 3,\n \"retry_policy\": {\n \"backoff_minutes\": [\n 2480,\n 2309\n ],\n \"retry_dispositions\": [\n \"browser_unavailable\",\n \"voicemail_machine\"\n ]\n },\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"concurrency_cap\": 6342,\n \"goal\": {\n \"key_0\": 7055.821544442675,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"cancelled\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 3240,\n \"contacts_total\": 6435,\n \"dialed\": 371,\n \"connected\": 1199,\n \"completed_goal\": 3435,\n \"created_at\": \"1958-04-14T08:52:02.977Z\",\n \"updated_at\": \"2009-05-24T19:40:51.127Z\",\n \"retry_policy\": {\n \"backoff_minutes\": [\n 2216,\n 3165\n ],\n \"retry_dispositions\": [\n \"failed\",\n \"answered_incomplete\"\n ]\n },\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 4392,\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"goal\": {\n \"key_0\": 297\n },\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"1982-06-03\",\n \"end_date\": \"1991-06-01\",\n \"paused_dates\": [\n \"2009-04-25\",\n \"1969-10-09\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d384310-7dc8-4cb0-95f9-36ce39f3be4a", "name": "Validation Error", "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 " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"agent_definition_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"1967-02-17\",\n \"end_date\": \"1949-12-27\",\n \"paused_dates\": [\n \"1965-05-15\",\n \"1951-09-04\"\n ]\n },\n \"max_attempts_per_contact\": 3,\n \"retry_policy\": {\n \"backoff_minutes\": [\n 2480,\n 2309\n ],\n \"retry_dispositions\": [\n \"browser_unavailable\",\n \"voicemail_machine\"\n ]\n },\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"concurrency_cap\": 6342,\n \"goal\": {\n \"key_0\": 7055.821544442675,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6291b1c8-6662-494c-81e0-3cb6b2ea0112", "name": "Read workspace campaign totals and recent call activity", "request": { "name": "Read workspace campaign totals and recent call activity", "description": {}, "url": { "path": [ "v1", "campaigns", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "start", "value": "1956-10-10T06:03:29.566Z", "description": "(Required) Inclusive start, with timezone offset." }, { "disabled": false, "key": "end", "value": "1980-05-04T21:23:32.894Z", "description": "(Required) Exclusive end; maximum window 93 days." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "48b30a4e-7bfa-4ada-b319-b58868afa424", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1956-10-10T06:03:29.566Z" }, { "key": "end", "value": "1980-05-04T21:23:32.894Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"start\": \"1992-09-03T02:09:14.134Z\",\n \"end\": \"1995-10-28T10:59:00.405Z\",\n \"as_of\": \"1974-02-18T00:18:07.607Z\",\n \"total_campaigns\": 3480,\n \"status_counts\": [\n {\n \"status\": \"draft\",\n \"count\": 7256\n },\n {\n \"status\": \"draft\",\n \"count\": 4986\n }\n ],\n \"calls_started\": 9793,\n \"campaigns_with_calls\": 1910,\n \"most_active\": [\n {\n \"campaign_id\": \"string\",\n \"name\": \"string\",\n \"status\": \"running\",\n \"workflows\": [\n \"string\",\n \"string\"\n ],\n \"calls_started\": 4663,\n \"last_call_at\": \"1960-12-02T15:24:20.341Z\"\n },\n {\n \"campaign_id\": \"string\",\n \"name\": \"string\",\n \"status\": \"cancelled\",\n \"workflows\": [\n \"string\",\n \"string\"\n ],\n \"calls_started\": 141,\n \"last_call_at\": \"1977-04-16T15:36:27.906Z\"\n }\n ],\n \"most_active_limit\": 4538\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386b50e6-0871-4fe5-a696-6fdd65f562d9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1956-10-10T06:03:29.566Z" }, { "key": "end", "value": "1980-05-04T21:23:32.894Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1233956d-a447-476c-b1f2-34696b7afb43", "name": "Read one campaign", "request": { "name": "Read one campaign", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3c2324eb-6729-4f37-b94e-939c46e79e64", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"cancelled\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 3240,\n \"contacts_total\": 6435,\n \"dialed\": 371,\n \"connected\": 1199,\n \"completed_goal\": 3435,\n \"created_at\": \"1958-04-14T08:52:02.977Z\",\n \"updated_at\": \"2009-05-24T19:40:51.127Z\",\n \"retry_policy\": {\n \"backoff_minutes\": [\n 2216,\n 3165\n ],\n \"retry_dispositions\": [\n \"failed\",\n \"answered_incomplete\"\n ]\n },\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 4392,\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"goal\": {\n \"key_0\": 297\n },\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"1982-06-03\",\n \"end_date\": \"1991-06-01\",\n \"paused_dates\": [\n \"2009-04-25\",\n \"1969-10-09\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ecec17e-2fc4-4bed-beb8-ee1419593777", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2537bdea-4bb1-4a11-9cc0-bb6e2b7b206e", "name": "Edit a campaign", "request": { "name": "Edit a campaign", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"agent_definition_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"2014-07-15\",\n \"end_date\": \"1978-03-02\",\n \"paused_dates\": [\n \"1948-09-23\",\n \"1992-08-29\"\n ]\n },\n \"max_attempts_per_contact\": 1,\n \"retry_policy\": {\n \"backoff_minutes\": [\n 6281,\n 7471\n ],\n \"retry_dispositions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"concurrency_cap\": 961,\n \"goal\": {\n \"key_0\": 4409\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "93dfe891-471f-4614-8c11-e26c53f34935", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"agent_definition_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"2014-07-15\",\n \"end_date\": \"1978-03-02\",\n \"paused_dates\": [\n \"1948-09-23\",\n \"1992-08-29\"\n ]\n },\n \"max_attempts_per_contact\": 1,\n \"retry_policy\": {\n \"backoff_minutes\": [\n 6281,\n 7471\n ],\n \"retry_dispositions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"concurrency_cap\": 961,\n \"goal\": {\n \"key_0\": 4409\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"cancelled\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 3240,\n \"contacts_total\": 6435,\n \"dialed\": 371,\n \"connected\": 1199,\n \"completed_goal\": 3435,\n \"created_at\": \"1958-04-14T08:52:02.977Z\",\n \"updated_at\": \"2009-05-24T19:40:51.127Z\",\n \"retry_policy\": {\n \"backoff_minutes\": [\n 2216,\n 3165\n ],\n \"retry_dispositions\": [\n \"failed\",\n \"answered_incomplete\"\n ]\n },\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 4392,\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"goal\": {\n \"key_0\": 297\n },\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"1982-06-03\",\n \"end_date\": \"1991-06-01\",\n \"paused_dates\": [\n \"2009-04-25\",\n \"1969-10-09\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "342d973a-7562-440f-9704-38b461f81fb1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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 \"name\": \"string\",\n \"agent_definition_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"schedule\": {\n \"calling_windows\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"start_date\": \"2014-07-15\",\n \"end_date\": \"1978-03-02\",\n \"paused_dates\": [\n \"1948-09-23\",\n \"1992-08-29\"\n ]\n },\n \"max_attempts_per_contact\": 1,\n \"retry_policy\": {\n \"backoff_minutes\": [\n 6281,\n 7471\n ],\n \"retry_dispositions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"voicemail_drop\": {\n \"enabled\": false\n },\n \"concurrency_cap\": 961,\n \"goal\": {\n \"key_0\": 4409\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "544e960b-4c59-4ee7-9215-6bc08def2996", "name": "Launch a campaign, pinning the agent version it dials under", "request": { "name": "Launch a campaign, pinning the agent version it dials under", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c91ee7e1-c287-4640-a356-c2e09671f28b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"draft\",\n \"dialable_contacts\": 4372\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b920e32-e736-4fb7-82dd-75dbd3218018", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a18f1900-7f20-46b5-b7eb-fef319fb6f7b", "name": "Stop launching new dials", "request": { "name": "Stop launching new dials", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1af4c4f6-8724-435a-8abf-11cbbdb11ef3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 4560,\n \"contacts_total\": 8205,\n \"dialed\": 9071,\n \"connected\": 8437,\n \"completed_goal\": 9587,\n \"created_at\": \"1948-09-18T23:05:17.653Z\",\n \"updated_at\": \"1969-11-23T13:32:48.246Z\",\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 8814\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e7fc5d0-6aab-4624-b9b0-33a09e81839c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb58f3f8-ac46-473e-975e-073cf68a6dbe", "name": "Resume a paused campaign", "request": { "name": "Resume a paused campaign", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6dc3e6e2-b138-47a7-8f7c-ee3039c9a69d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 4560,\n \"contacts_total\": 8205,\n \"dialed\": 9071,\n \"connected\": 8437,\n \"completed_goal\": 9587,\n \"created_at\": \"1948-09-18T23:05:17.653Z\",\n \"updated_at\": \"1969-11-23T13:32:48.246Z\",\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 8814\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "106eef1c-250e-419c-9d61-0e11bca0a30a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f2b755a-1fa0-41db-a061-0a5fb493c926", "name": "Cancel a campaign for good", "request": { "name": "Cancel a campaign for good", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fc6e80f7-de9f-4d08-8201-407aa3fc9a7f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"agent_definition_id\": \"string\",\n \"target\": {\n \"contact_list_id\": \"string\"\n },\n \"number_pool_id\": \"string\",\n \"telephony_account_id\": \"string\",\n \"max_attempts_per_contact\": 4560,\n \"contacts_total\": 8205,\n \"dialed\": 9071,\n \"connected\": 8437,\n \"completed_goal\": 9587,\n \"created_at\": \"1948-09-18T23:05:17.653Z\",\n \"updated_at\": \"1969-11-23T13:32:48.246Z\",\n \"agent_version_id\": \"string\",\n \"compliance_profile_id\": \"string\",\n \"scrub_run_id\": \"string\",\n \"concurrency_cap\": 8814\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6458190a-34d3-491f-b214-ca472500ad65", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d3e58a0-74da-45ac-97c6-9bb9cc504943", "name": "Live campaign counters (polled at 5s; carries an ETag)", "request": { "name": "Live campaign counters (polled at 5s; carries an ETag)", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f247297-f819-431f-ade3-b51b628d679a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"dials\": 6752,\n \"connects\": 6563,\n \"connect_rate\": 8903.266576730814,\n \"live_calls_now\": 2379,\n \"goal_completions\": 2577,\n \"spend_to_date\": {\n \"amount_minor\": 7317,\n \"currency\": \"string\"\n },\n \"dispositions\": {\n \"key_0\": 4859,\n \"key_1\": 3617\n },\n \"sub_codes\": {\n \"key_0\": 8021,\n \"key_1\": 2191,\n \"key_2\": 4319\n },\n \"avg_call_duration_ms\": 4941\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3f6f1e6-6ece-46aa-9a6c-6981318591c1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c59876d8-fb17-48ec-956f-ebff11fb39e0", "name": "Fill-status board: one row per attempt, most recently updated first", "request": { "name": "Fill-status board: one row per attempt, most recently updated first", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "disposition", "value": "string", "description": "Filter on `disposition`. Comma-separated values are OR." }, { "disabled": true, "key": "disposition.gte", "value": "string", "description": "Filter on `disposition` with the `gte` operator." }, { "disabled": true, "key": "disposition.lte", "value": "string", "description": "Filter on `disposition` with the `lte` operator." }, { "disabled": true, "key": "disposition.gt", "value": "string", "description": "Filter on `disposition` with the `gt` operator." }, { "disabled": true, "key": "disposition.lt", "value": "string", "description": "Filter on `disposition` with the `lt` operator." }, { "disabled": true, "key": "disposition.in", "value": "string", "description": "Filter on `disposition` with the `in` operator." }, { "disabled": true, "key": "next_eligible_at", "value": "string", "description": "Filter on `next_eligible_at`. Comma-separated values are OR." }, { "disabled": true, "key": "next_eligible_at.gte", "value": "string", "description": "Filter on `next_eligible_at` with the `gte` operator." }, { "disabled": true, "key": "next_eligible_at.lte", "value": "string", "description": "Filter on `next_eligible_at` with the `lte` operator." }, { "disabled": true, "key": "next_eligible_at.gt", "value": "string", "description": "Filter on `next_eligible_at` with the `gt` operator." }, { "disabled": true, "key": "next_eligible_at.lt", "value": "string", "description": "Filter on `next_eligible_at` with the `lt` operator." }, { "disabled": true, "key": "next_eligible_at.in", "value": "string", "description": "Filter on `next_eligible_at` with the `in` operator." }, { "disabled": true, "key": "origin_kind", "value": "string", "description": "Filter on `origin_kind`. Comma-separated values are OR." }, { "disabled": true, "key": "origin_kind.gte", "value": "string", "description": "Filter on `origin_kind` with the `gte` operator." }, { "disabled": true, "key": "origin_kind.lte", "value": "string", "description": "Filter on `origin_kind` with the `lte` operator." }, { "disabled": true, "key": "origin_kind.gt", "value": "string", "description": "Filter on `origin_kind` with the `gt` operator." }, { "disabled": true, "key": "origin_kind.lt", "value": "string", "description": "Filter on `origin_kind` with the `lt` operator." }, { "disabled": true, "key": "origin_kind.in", "value": "string", "description": "Filter on `origin_kind` with the `in` operator." }, { "disabled": true, "key": "state", "value": "string", "description": "Filter on `state`. Comma-separated values are OR." }, { "disabled": true, "key": "state.gte", "value": "string", "description": "Filter on `state` with the `gte` operator." }, { "disabled": true, "key": "state.lte", "value": "string", "description": "Filter on `state` with the `lte` operator." }, { "disabled": true, "key": "state.gt", "value": "string", "description": "Filter on `state` with the `gt` operator." }, { "disabled": true, "key": "state.lt", "value": "string", "description": "Filter on `state` with the `lt` operator." }, { "disabled": true, "key": "state.in", "value": "string", "description": "Filter on `state` with the `in` operator." }, { "disabled": true, "key": "updated_at", "value": "string", "description": "Filter on `updated_at`. Comma-separated values are OR." }, { "disabled": true, "key": "updated_at.gte", "value": "string", "description": "Filter on `updated_at` with the `gte` operator." }, { "disabled": true, "key": "updated_at.lte", "value": "string", "description": "Filter on `updated_at` with the `lte` operator." }, { "disabled": true, "key": "updated_at.gt", "value": "string", "description": "Filter on `updated_at` with the `gt` operator." }, { "disabled": true, "key": "updated_at.lt", "value": "string", "description": "Filter on `updated_at` with the `lt` operator." }, { "disabled": true, "key": "updated_at.in", "value": "string", "description": "Filter on `updated_at` with the `in` operator." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6396cc83-a6b6-457d-b42a-724783e133c6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "next_eligible_at", "value": "string" }, { "key": "next_eligible_at.gte", "value": "string" }, { "key": "next_eligible_at.lte", "value": "string" }, { "key": "next_eligible_at.gt", "value": "string" }, { "key": "next_eligible_at.lt", "value": "string" }, { "key": "next_eligible_at.in", "value": "string" }, { "key": "origin_kind", "value": "string" }, { "key": "origin_kind.gte", "value": "string" }, { "key": "origin_kind.lte", "value": "string" }, { "key": "origin_kind.gt", "value": "string" }, { "key": "origin_kind.lt", "value": "string" }, { "key": "origin_kind.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" }, { "key": "updated_at", "value": "string" }, { "key": "updated_at.gte", "value": "string" }, { "key": "updated_at.lte", "value": "string" }, { "key": "updated_at.gt", "value": "string" }, { "key": "updated_at.lt", "value": "string" }, { "key": "updated_at.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_phone\": \"string\",\n \"attempt_number\": 1123,\n \"state\": \"pending\",\n \"updated_at\": \"2007-12-24T22:07:59.998Z\",\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"failure_reason\": {\n \"value\": \"\"\n },\n \"call_id\": \"string\",\n \"scheduled_for\": \"1969-04-10T20:26:28.240Z\",\n \"dialed_at\": \"1966-03-22T16:28:02.258Z\",\n \"ended_at\": \"1951-05-02T11:09:37.444Z\"\n },\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_phone\": \"string\",\n \"attempt_number\": 9147,\n \"state\": \"failed\",\n \"updated_at\": \"1990-05-31T09:11:15.635Z\",\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"failure_reason\": {\n \"value\": \"\"\n },\n \"call_id\": \"string\",\n \"scheduled_for\": \"1989-02-14T17:50:17.668Z\",\n \"dialed_at\": \"1978-11-24T00:26:14.121Z\",\n \"ended_at\": \"2006-04-26T11:12:34.981Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "439062cc-4353-450f-97e9-eda19808f9a0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "next_eligible_at", "value": "string" }, { "key": "next_eligible_at.gte", "value": "string" }, { "key": "next_eligible_at.lte", "value": "string" }, { "key": "next_eligible_at.gt", "value": "string" }, { "key": "next_eligible_at.lt", "value": "string" }, { "key": "next_eligible_at.in", "value": "string" }, { "key": "origin_kind", "value": "string" }, { "key": "origin_kind.gte", "value": "string" }, { "key": "origin_kind.lte", "value": "string" }, { "key": "origin_kind.gt", "value": "string" }, { "key": "origin_kind.lt", "value": "string" }, { "key": "origin_kind.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" }, { "key": "updated_at", "value": "string" }, { "key": "updated_at.gte", "value": "string" }, { "key": "updated_at.lte", "value": "string" }, { "key": "updated_at.gt", "value": "string" }, { "key": "updated_at.lt", "value": "string" }, { "key": "updated_at.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee008b41-e946-4be8-872a-cb70e9fe4ce8", "name": "Per-contact reconciliation: the latest attempt and its structured outcome", "request": { "name": "Per-contact reconciliation: the latest attempt and its structured outcome", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "disposition", "value": "string", "description": "Filter on `disposition`. Comma-separated values are OR." }, { "disabled": true, "key": "disposition.gte", "value": "string", "description": "Filter on `disposition` with the `gte` operator." }, { "disabled": true, "key": "disposition.lte", "value": "string", "description": "Filter on `disposition` with the `lte` operator." }, { "disabled": true, "key": "disposition.gt", "value": "string", "description": "Filter on `disposition` with the `gt` operator." }, { "disabled": true, "key": "disposition.lt", "value": "string", "description": "Filter on `disposition` with the `lt` operator." }, { "disabled": true, "key": "disposition.in", "value": "string", "description": "Filter on `disposition` with the `in` operator." }, { "disabled": true, "key": "has_outcome", "value": "string", "description": "Filter on `has_outcome`. Comma-separated values are OR." }, { "disabled": true, "key": "has_outcome.gte", "value": "string", "description": "Filter on `has_outcome` with the `gte` operator." }, { "disabled": true, "key": "has_outcome.lte", "value": "string", "description": "Filter on `has_outcome` with the `lte` operator." }, { "disabled": true, "key": "has_outcome.gt", "value": "string", "description": "Filter on `has_outcome` with the `gt` operator." }, { "disabled": true, "key": "has_outcome.lt", "value": "string", "description": "Filter on `has_outcome` with the `lt` operator." }, { "disabled": true, "key": "has_outcome.in", "value": "string", "description": "Filter on `has_outcome` with the `in` operator." }, { "disabled": true, "key": "sub_code", "value": "string", "description": "Filter on `sub_code`. Comma-separated values are OR." }, { "disabled": true, "key": "sub_code.gte", "value": "string", "description": "Filter on `sub_code` with the `gte` operator." }, { "disabled": true, "key": "sub_code.lte", "value": "string", "description": "Filter on `sub_code` with the `lte` operator." }, { "disabled": true, "key": "sub_code.gt", "value": "string", "description": "Filter on `sub_code` with the `gt` operator." }, { "disabled": true, "key": "sub_code.lt", "value": "string", "description": "Filter on `sub_code` with the `lt` operator." }, { "disabled": true, "key": "sub_code.in", "value": "string", "description": "Filter on `sub_code` with the `in` operator." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1cb2feb1-48e3-4439-9693-8311ad5d8d9b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "has_outcome", "value": "string" }, { "key": "has_outcome.gte", "value": "string" }, { "key": "has_outcome.lte", "value": "string" }, { "key": "has_outcome.gt", "value": "string" }, { "key": "has_outcome.lt", "value": "string" }, { "key": "has_outcome.in", "value": "string" }, { "key": "sub_code", "value": "string" }, { "key": "sub_code.gte", "value": "string" }, { "key": "sub_code.lte", "value": "string" }, { "key": "sub_code.gt", "value": "string" }, { "key": "sub_code.lt", "value": "string" }, { "key": "sub_code.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"contact_id\": \"string\",\n \"contact_phone\": \"string\",\n \"attempts\": 3750,\n \"latest_attempt_id\": \"string\",\n \"latest_attempt_state\": \"in_conversation\",\n \"last_activity_at\": \"1970-01-27T19:27:19.387Z\",\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"call_id\": \"string\",\n \"outcome\": {\n \"value\": \"\"\n }\n },\n {\n \"contact_id\": \"string\",\n \"contact_phone\": \"string\",\n \"attempts\": 7192,\n \"latest_attempt_id\": \"string\",\n \"latest_attempt_state\": \"answered\",\n \"last_activity_at\": \"2010-11-29T11:54:46.061Z\",\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"call_id\": \"string\",\n \"outcome\": {\n \"value\": \"\"\n }\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a492bce-1ff9-46e7-8d55-c31e6478f014", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "has_outcome", "value": "string" }, { "key": "has_outcome.gte", "value": "string" }, { "key": "has_outcome.lte", "value": "string" }, { "key": "has_outcome.gt", "value": "string" }, { "key": "has_outcome.lt", "value": "string" }, { "key": "has_outcome.in", "value": "string" }, { "key": "sub_code", "value": "string" }, { "key": "sub_code.gte", "value": "string" }, { "key": "sub_code.lte", "value": "string" }, { "key": "sub_code.gt", "value": "string" }, { "key": "sub_code.lt", "value": "string" }, { "key": "sub_code.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdc9aeb6-f372-4c86-a70f-7169864fcd97", "name": "Survey rollup: response funnel, per-question distributions, CSAT/NPS aggregates", "request": { "name": "Survey rollup: response funnel, per-question distributions, CSAT/NPS aggregates", "description": {}, "url": { "path": [ "v1", "campaigns", ":campaign_id", "survey-rollup" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "638587f8-a313-4227-82ba-dfda1bb9bb3b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "survey-rollup" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaign_id\": \"string\",\n \"window\": {\n \"from\": \"1955-07-08T10:16:45.565Z\",\n \"to\": \"1970-05-27T01:56:50.507Z\"\n },\n \"funnel\": {\n \"targeted\": 4599,\n \"dialed\": 8801,\n \"answered\": 5655,\n \"survey_started\": 9789,\n \"survey_complete\": 1970,\n \"survey_partial\": 6014,\n \"survey_refused\": 7653,\n \"response_rate\": 225.90291034618735,\n \"completion_rate\": 4567.610427980649\n },\n \"aggregate\": {\n \"scored_responses\": 4656,\n \"csat\": 708.035487685259,\n \"nps\": 4142.534776168221,\n \"weighted_score\": 7777.566591286644\n },\n \"agent_version_id\": \"string\",\n \"questions\": [\n {\n \"objective_id\": \"string\",\n \"scale\": \"csat\",\n \"points\": 5530,\n \"answered\": 9731,\n \"prompt\": \"string\",\n \"distribution\": {\n \"key_0\": 144,\n \"key_1\": 535\n },\n \"mean\": 9232.75688371833,\n \"top_2_box_rate\": 6129.841931841555,\n \"promoters\": 7577,\n \"passives\": 3453,\n \"detractors\": 7350\n },\n {\n \"objective_id\": \"string\",\n \"scale\": \"csat\",\n \"points\": 9252,\n \"answered\": 9314,\n \"prompt\": \"string\",\n \"distribution\": {\n \"key_0\": 6754\n },\n \"mean\": 3137.2193770483013,\n \"top_2_box_rate\": 4676.174021411337,\n \"promoters\": 9718,\n \"passives\": 6217,\n \"detractors\": 6387\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ee76b94-82bc-4e23-8c68-67ebaca7d526", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":campaign_id", "survey-rollup" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0cb40b78-40a8-4104-9fed-051bff0de36c", "name": "analytics", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7090bc59-47a2-44bd-98dd-eeda8a50c812", "name": "Read the compact customer-portal Home summary", "request": { "name": "Read the compact customer-portal Home summary", "description": { "content": "Return bounded carrier activity, current work, outcomes, and attention states.", "type": "text/plain" }, "url": { "path": [ "v1", "dashboard-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cbe40dc7-8965-4458-864b-ae789f7ebd6d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dashboard-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1993-01-24T00:26:00.902Z\",\n \"end\": \"1994-11-09T04:46:44.835Z\"\n },\n \"as_of\": \"1955-01-17T14:22:55.039Z\",\n \"call_totals\": {\n \"inbound_calls\": 4450,\n \"outbound_dials\": 6231\n },\n \"call_records\": {\n \"inbound_calls\": 3287,\n \"outbound_calls\": 5136,\n \"browser_calls\": 1259\n },\n \"open_caller_work\": {\n \"total\": 2681,\n \"messages\": 3133,\n \"support_tickets\": 5086,\n \"high_priority_tickets\": 1262\n },\n \"outcomes\": {\n \"leads_captured\": 1608,\n \"messages_taken\": 8101,\n \"tickets_opened\": 5397,\n \"callbacks_scheduled\": 1445,\n \"appointments_created\": 2678,\n \"shifts_confirmed\": 1135,\n \"survey_responses\": 2105\n },\n \"agents\": [\n {\n \"id\": \"str\",\n \"name\": \"string\",\n \"use_case\": \"staffing\",\n \"status\": \"archived\",\n \"health\": \"attention\",\n \"calls\": {\n \"inbound_calls\": {\n \"value\": \"\"\n },\n \"outbound_dials\": {\n \"value\": \"\"\n }\n },\n \"call_records\": {\n \"inbound_calls\": {\n \"value\": \"\"\n },\n \"outbound_calls\": {\n \"value\": \"\"\n },\n \"browser_calls\": {\n \"value\": \"\"\n }\n },\n \"latest_version\": 353\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"use_case\": \"sdr\",\n \"status\": \"archived\",\n \"health\": \"attention\",\n \"calls\": {\n \"inbound_calls\": {\n \"value\": \"\"\n },\n \"outbound_dials\": {\n \"value\": \"\"\n }\n },\n \"call_records\": {\n \"inbound_calls\": {\n \"value\": \"\"\n },\n \"outbound_calls\": {\n \"value\": \"\"\n },\n \"browser_calls\": {\n \"value\": \"\"\n }\n },\n \"latest_version\": 4664\n }\n ],\n \"attention\": [\n {\n \"key\": \"caller_work\",\n \"state\": \"attention\",\n \"count\": 462\n },\n {\n \"key\": \"receptionist_health\",\n \"state\": \"attention\",\n \"count\": 381\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b4e419-bc66-42ed-9cf7-bb5045143d55", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "dashboard-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c318b06-bf5e-4687-a43f-1ac3d9c11559", "name": "Dial → connect → conversation → outcome, with stage rates", "request": { "name": "Dial → connect → conversation → outcome, with stage rates", "description": {}, "url": { "path": [ "v1", "analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." }, { "disabled": true, "key": "group_by", "value": "day", "description": "Repeatable. Omit for a single total across the window." }, { "disabled": true, "key": "group_by", "value": "campaign", "description": "Repeatable. Omit for a single total across the window." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Narrow to one campaign." }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Narrow to one published agent version." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c362c501-a821-4e67-94c0-c505338a4376", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "day" }, { "key": "group_by", "value": "day" }, { "key": "campaign_id", "value": "string" }, { "key": "agent_version_id", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1965-11-15T03:44:30.836Z\",\n \"end\": \"1947-09-28T02:48:13.657Z\"\n },\n \"group_by\": [\n \"agent_version\",\n \"agent_version\"\n ],\n \"buckets\": [\n {\n \"attempts\": 4172,\n \"dials\": 7787,\n \"connects\": 9676,\n \"conversations\": 8648,\n \"outcomes\": 4340,\n \"goal_completions\": 2128,\n \"campaign_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"day\": \"1989-11-19\",\n \"connect_rate\": 8223.59672431713,\n \"conversation_rate\": 3024.4728604799297,\n \"outcome_rate\": 6600.747218500372,\n \"goal_rate\": 632.519494514161\n },\n {\n \"attempts\": 1180,\n \"dials\": 7103,\n \"connects\": 3562,\n \"conversations\": 255,\n \"outcomes\": 903,\n \"goal_completions\": 5984,\n \"campaign_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"day\": \"1962-08-03\",\n \"connect_rate\": 8983.654037038443,\n \"conversation_rate\": 4097.629357296666,\n \"outcome_rate\": 7099.299845784657,\n \"goal_rate\": 1432.9341493719849\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b519482-49c6-439e-809f-1d7478c151c3", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "day" }, { "key": "group_by", "value": "day" }, { "key": "campaign_id", "value": "string" }, { "key": "agent_version_id", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b0537f6-440e-4412-b456-65864fe7aee0", "name": "Disposition mix, with each disposition's share of its group", "request": { "name": "Disposition mix, with each disposition's share of its group", "description": {}, "url": { "path": [ "v1", "analytics", "dispositions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." }, { "disabled": true, "key": "group_by", "value": "day", "description": "Repeatable. Omit for a single total across the window." }, { "disabled": true, "key": "group_by", "value": "campaign", "description": "Repeatable. Omit for a single total across the window." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Narrow to one campaign." }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Narrow to one published agent version." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "96015525-0051-4a52-a33f-f89f09d97611", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "analytics", "dispositions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "day" }, { "key": "group_by", "value": "day" }, { "key": "campaign_id", "value": "string" }, { "key": "agent_version_id", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1989-01-21T00:38:58.920Z\",\n \"end\": \"1978-03-31T09:08:06.657Z\"\n },\n \"group_by\": [\n \"campaign\",\n \"day\"\n ],\n \"buckets\": [\n {\n \"disposition\": \"string\",\n \"attempts\": 8129,\n \"share\": 6576.624512580495,\n \"campaign_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"day\": \"2012-06-13\"\n },\n {\n \"disposition\": \"string\",\n \"attempts\": 8871,\n \"share\": 774.6459913215209,\n \"campaign_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"day\": \"1979-07-04\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "591b08e1-3322-46c1-a9de-6759ccba3a47", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "analytics", "dispositions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "day" }, { "key": "group_by", "value": "day" }, { "key": "campaign_id", "value": "string" }, { "key": "agent_version_id", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc5baef5-5b14-440c-ab3d-3872fb2bd8f6", "name": "Business-pathway counters: leads, messages, tickets, callbacks, appointments", "request": { "name": "Business-pathway counters: leads, messages, tickets, callbacks, appointments", "description": { "content": "What the receptionist's conversations actually left behind (ADR-0037).\n\nCounts durable rows only - never the outbox, which is a delivery artifact - so the\nreport and the resources it summarizes can never disagree.", "type": "text/plain" }, "url": { "path": [ "v1", "analytics", "pathways" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." }, { "disabled": true, "key": "group_by", "value": "day", "description": "Repeatable: agent_version and/or day. Omit for one total." }, { "disabled": true, "key": "group_by", "value": "day", "description": "Repeatable: agent_version and/or day. Omit for one total." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "76470ed7-1b2a-4781-8051-2b6287cc08d8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "analytics", "pathways" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "agent_version" }, { "key": "group_by", "value": "agent_version" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1959-05-21T11:09:56.463Z\",\n \"end\": \"1972-11-04T09:20:30.936Z\"\n },\n \"group_by\": [\n \"agent_version\",\n \"agent_version\"\n ],\n \"buckets\": [\n {\n \"messages_taken\": 1132,\n \"tickets_opened\": 6529,\n \"tickets_resolved\": 1540,\n \"callbacks_scheduled\": 7984,\n \"appointments_created\": 8868,\n \"agent_version_id\": \"string\",\n \"day\": \"2017-10-28\",\n \"leads_captured\": 3721\n },\n {\n \"messages_taken\": 2964,\n \"tickets_opened\": 2374,\n \"tickets_resolved\": 3913,\n \"callbacks_scheduled\": 1675,\n \"appointments_created\": 8642,\n \"agent_version_id\": \"string\",\n \"day\": \"2022-06-27\",\n \"leads_captured\": 7233\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea476fcf-2971-4465-849d-92ab3c9e7c12", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "analytics", "pathways" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "agent_version" }, { "key": "group_by", "value": "agent_version" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da4f7509-73d8-42d7-ac37-64acbfb9c498", "name": "Voice-to-voice and LLM-TTFT percentiles over the turn ledger", "request": { "name": "Voice-to-voice and LLM-TTFT percentiles over the turn ledger", "description": {}, "url": { "path": [ "v1", "analytics", "latency" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." }, { "disabled": true, "key": "group_by", "value": "day", "description": "Repeatable. Omit for a single total across the window." }, { "disabled": true, "key": "group_by", "value": "campaign", "description": "Repeatable. Omit for a single total across the window." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Narrow to one campaign." }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Narrow to one published agent version." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f95921bd-a79c-4063-b4ec-0f99d9a56f7f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "analytics", "latency" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "day" }, { "key": "group_by", "value": "day" }, { "key": "campaign_id", "value": "string" }, { "key": "agent_version_id", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1961-07-29T15:10:22.294Z\",\n \"end\": \"1954-03-02T22:58:34.936Z\"\n },\n \"group_by\": [\n \"agent_version\",\n \"day\"\n ],\n \"buckets\": [\n {\n \"turns\": 4625,\n \"voice_to_voice_samples\": 5146,\n \"llm_ttft_samples\": 8699,\n \"campaign_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"day\": \"1984-02-28\",\n \"voice_to_voice_p50_ms\": 3611.4246592805844,\n \"voice_to_voice_p95_ms\": 8868.802510736166,\n \"voice_to_voice_p99_ms\": 2521.1529243124487,\n \"llm_ttft_p50_ms\": 3403.5378799363134,\n \"llm_ttft_p95_ms\": 4772.656510121711,\n \"llm_ttft_p99_ms\": 3401.5940952769765\n },\n {\n \"turns\": 4488,\n \"voice_to_voice_samples\": 9186,\n \"llm_ttft_samples\": 2624,\n \"campaign_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"day\": \"2009-06-26\",\n \"voice_to_voice_p50_ms\": 8386.852039421326,\n \"voice_to_voice_p95_ms\": 4542.810621447821,\n \"voice_to_voice_p99_ms\": 9419.24965758082,\n \"llm_ttft_p50_ms\": 4273.609119863153,\n \"llm_ttft_p95_ms\": 9292.367201193973,\n \"llm_ttft_p99_ms\": 2260.282056685161\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2d065d9-2697-46ce-84c3-1f8382d30979", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "analytics", "latency" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "group_by", "value": "day" }, { "key": "group_by", "value": "day" }, { "key": "campaign_id", "value": "string" }, { "key": "agent_version_id", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c8aeccd2-887f-4522-b163-b816ad77b8a6", "name": "compliance", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b9fe1b6e-7686-4d1b-bc67-a2c2fc309bc7", "name": "Queue a pre-campaign scrub of a contact list", "request": { "name": "Queue a pre-campaign scrub of a contact list", "description": {}, "url": { "path": [ "v1", "scrub-runs" ], "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 \"target\": {\n \"contact_list_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e09a67f-da64-481f-9519-5992d4dc53e7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scrub-runs" ], "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 \"target\": {\n \"contact_list_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"contact_list_id\": \"string\",\n \"status\": \"queued\",\n \"totals\": {\n \"contacts\": 7388,\n \"dialable\": 8158,\n \"blocked\": 2509,\n \"flagged\": 4050\n },\n \"created_at\": \"1996-09-03T09:07:18.906Z\",\n \"blocked_breakdown\": {\n \"key_0\": 485\n },\n \"risk_flags\": [\n \"string\",\n \"string\"\n ],\n \"dataset_versions\": {\n \"key_0\": \"string\"\n },\n \"waived_stages\": [\n {\n \"stage\": \"string\",\n \"attestation_ref\": \"string\",\n \"attested_by\": \"string\"\n },\n {\n \"stage\": \"string\",\n \"attestation_ref\": \"string\",\n \"attested_by\": \"string\"\n }\n ],\n \"started_at\": \"2000-07-05T21:02:41.378Z\",\n \"completed_at\": \"2021-05-23T13:15:07.812Z\",\n \"expires_at\": \"1957-08-18T17:01:41.404Z\",\n \"is_stale\": false,\n \"acknowledged_by\": \"string\",\n \"acknowledged_at\": \"1981-11-26T17:29:34.308Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2161046f-39c9-435e-aae8-b066afd93410", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "scrub-runs" ], "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 \"target\": {\n \"contact_list_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54a78b46-74ae-4ebc-8b12-3a0d92eb0f57", "name": "Read a scrub report", "request": { "name": "Read a scrub report", "description": {}, "url": { "path": [ "v1", "scrub-runs", ":run_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "19049ba1-b151-4444-a88a-db171a8e4f78", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scrub-runs", ":run_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"contact_list_id\": \"string\",\n \"status\": \"queued\",\n \"totals\": {\n \"contacts\": 7388,\n \"dialable\": 8158,\n \"blocked\": 2509,\n \"flagged\": 4050\n },\n \"created_at\": \"1996-09-03T09:07:18.906Z\",\n \"blocked_breakdown\": {\n \"key_0\": 485\n },\n \"risk_flags\": [\n \"string\",\n \"string\"\n ],\n \"dataset_versions\": {\n \"key_0\": \"string\"\n },\n \"waived_stages\": [\n {\n \"stage\": \"string\",\n \"attestation_ref\": \"string\",\n \"attested_by\": \"string\"\n },\n {\n \"stage\": \"string\",\n \"attestation_ref\": \"string\",\n \"attested_by\": \"string\"\n }\n ],\n \"started_at\": \"2000-07-05T21:02:41.378Z\",\n \"completed_at\": \"2021-05-23T13:15:07.812Z\",\n \"expires_at\": \"1957-08-18T17:01:41.404Z\",\n \"is_stale\": false,\n \"acknowledged_by\": \"string\",\n \"acknowledged_at\": \"1981-11-26T17:29:34.308Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1550d7f5-f905-4f76-a541-3f2d3f3faf9d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "scrub-runs", ":run_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd5bf9da-182d-413f-9606-bbac747fc776", "name": "List a scrub run's per-contact rows", "request": { "name": "List a scrub run's per-contact rows", "description": {}, "url": { "path": [ "v1", "scrub-runs", ":run_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "verdict", "value": "string", "description": "Filter on `verdict`. Comma-separated values are OR." }, { "disabled": true, "key": "verdict.gte", "value": "string", "description": "Filter on `verdict` with the `gte` operator." }, { "disabled": true, "key": "verdict.lte", "value": "string", "description": "Filter on `verdict` with the `lte` operator." }, { "disabled": true, "key": "verdict.gt", "value": "string", "description": "Filter on `verdict` with the `gt` operator." }, { "disabled": true, "key": "verdict.lt", "value": "string", "description": "Filter on `verdict` with the `lt` operator." }, { "disabled": true, "key": "verdict.in", "value": "string", "description": "Filter on `verdict` with the `in` operator." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c955f7e7-6c3e-49ce-aff1-2c588bfa5da4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scrub-runs", ":run_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "verdict", "value": "string" }, { "key": "verdict.gte", "value": "string" }, { "key": "verdict.lte", "value": "string" }, { "key": "verdict.gt", "value": "string" }, { "key": "verdict.lt", "value": "string" }, { "key": "verdict.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"verdict\": \"dialable\",\n \"created_at\": \"1992-01-10T12:52:07.939Z\",\n \"blocked_reasons\": [\n \"string\",\n \"string\"\n ],\n \"risk_flags\": [\n \"string\",\n \"string\"\n ],\n \"line_type\": {\n \"value\": \"\"\n },\n \"consent_record_id\": \"string\",\n \"expires_at\": \"2024-03-04T09:52:56.524Z\"\n },\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"verdict\": \"dialable\",\n \"created_at\": \"1959-11-12T10:20:39.133Z\",\n \"blocked_reasons\": [\n \"string\",\n \"string\"\n ],\n \"risk_flags\": [\n \"string\",\n \"string\"\n ],\n \"line_type\": {\n \"value\": \"\"\n },\n \"consent_record_id\": \"string\",\n \"expires_at\": \"2025-06-01T18:41:22.373Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29773424-b561-45db-9ffd-02f1cf916c06", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "scrub-runs", ":run_id", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "verdict", "value": "string" }, { "key": "verdict.gte", "value": "string" }, { "key": "verdict.lte", "value": "string" }, { "key": "verdict.gt", "value": "string" }, { "key": "verdict.lt", "value": "string" }, { "key": "verdict.in", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "945fb626-b818-47fd-a858-bdccb5665889", "name": "Acknowledge a scrub report so it can authorize a launch", "request": { "name": "Acknowledge a scrub report so it can authorize a launch", "description": {}, "url": { "path": [ "v1", "scrub-runs", ":run_id", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "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 \"acknowledged_by\": \"string\",\n \"totals\": {\n \"contacts\": 204,\n \"dialable\": 2133,\n \"blocked\": 9485,\n \"flagged\": 7412\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0590bdd5-8425-474f-869a-cb1ece8623ed", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scrub-runs", ":run_id", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "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 \"acknowledged_by\": \"string\",\n \"totals\": {\n \"contacts\": 204,\n \"dialable\": 2133,\n \"blocked\": 9485,\n \"flagged\": 7412\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scrub_run_id\": \"string\",\n \"acknowledged_by\": \"string\",\n \"acknowledged_at\": \"1974-05-29T00:26:21.737Z\",\n \"totals\": {\n \"contacts\": 8589,\n \"dialable\": 92,\n \"blocked\": 3193,\n \"flagged\": 345\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aabb1dcc-f5d1-4007-be01-23bc9e0e76dd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "scrub-runs", ":run_id", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "run_id", "description": "(Required) " } ] }, "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 \"acknowledged_by\": \"string\",\n \"totals\": {\n \"contacts\": 204,\n \"dialable\": 2133,\n \"blocked\": 9485,\n \"flagged\": 7412\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51996af0-353a-4e3d-b52f-fdd3101788d4", "name": "List this tenant's internal DNC", "request": { "name": "List this tenant's internal DNC", "description": {}, "url": { "path": [ "v1", "dnc-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "phone_e164", "value": "string", "description": "Filter on `phone_e164`. Comma-separated values are OR." }, { "disabled": true, "key": "phone_e164.gte", "value": "string", "description": "Filter on `phone_e164` with the `gte` operator." }, { "disabled": true, "key": "phone_e164.lte", "value": "string", "description": "Filter on `phone_e164` with the `lte` operator." }, { "disabled": true, "key": "phone_e164.gt", "value": "string", "description": "Filter on `phone_e164` with the `gt` operator." }, { "disabled": true, "key": "phone_e164.lt", "value": "string", "description": "Filter on `phone_e164` with the `lt` operator." }, { "disabled": true, "key": "phone_e164.in", "value": "string", "description": "Filter on `phone_e164` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6c7a527d-deb0-4af2-a197-b08b876d44d8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dnc-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "phone_e164", "value": "string" }, { "key": "phone_e164.gte", "value": "string" }, { "key": "phone_e164.lte", "value": "string" }, { "key": "phone_e164.gt", "value": "string" }, { "key": "phone_e164.lt", "value": "string" }, { "key": "phone_e164.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"scope\": \"state\",\n \"source\": \"api\",\n \"added_at\": \"1952-01-29T07:41:36.409Z\",\n \"state_code\": \"string\",\n \"origin_call_id\": \"string\",\n \"expires_at\": \"2022-02-11T21:16:17.075Z\"\n },\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"scope\": \"internal\",\n \"source\": \"import\",\n \"added_at\": \"1953-11-12T02:38:28.520Z\",\n \"state_code\": \"string\",\n \"origin_call_id\": \"string\",\n \"expires_at\": \"1973-04-19T20:26:57.056Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f44df65d-e4a7-4820-b20b-940341fb612d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "dnc-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "phone_e164", "value": "string" }, { "key": "phone_e164.gte", "value": "string" }, { "key": "phone_e164.lte", "value": "string" }, { "key": "phone_e164.gt", "value": "string" }, { "key": "phone_e164.lt", "value": "string" }, { "key": "phone_e164.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32130cc9-9995-4cf6-ab70-379a41e1dcca", "name": "Record a revocation: suppress a number across every channel", "request": { "name": "Record a revocation: suppress a number across every channel", "description": { "content": "Suppress a number on this tenant's internal DNC - and everything that implies.\n\nA tenant writing this row is recording a revocation, so it takes the same path a\nmid-call opt-out takes: the suppression, `optout.recorded`, and the withdrawal of the\nconsent standing behind the number, in one transaction. Writing the row alone would\nleave the consent ledger saying this person still consents - the suppression blocks the\ndial either way (internal DNC is an unwaivable floor, CANON fact 71), but the ledger is\nwhat an evidence request is answered from, so it may not contradict the opt-out beside\nit.\n\nWhich is why a revocation may not be time-limited here, and `expires_at` is refused by\nname rather than accepted and quietly ignored - the same reason `scope` is expressible\nat all (docs/07-compliance.md: internal DNC is a suppression record that persists, and\nis carved out of erasure for exactly that reason).", "type": "text/plain" }, "url": { "path": [ "v1", "dnc-entries" ], "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 \"phone_e164\": \"+7673792381\",\n \"scope\": \"internal\",\n \"source\": \"api\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4fc4e427-3607-43d1-8b95-dfd57500f796", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dnc-entries" ], "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 \"phone_e164\": \"+7673792381\",\n \"scope\": \"internal\",\n \"source\": \"api\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"scope\": \"federal\",\n \"source\": \"sms_stop\",\n \"added_at\": \"2024-06-26T14:39:40.654Z\",\n \"state_code\": \"string\",\n \"origin_call_id\": \"string\",\n \"expires_at\": \"1955-12-28T20:41:58.652Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb6cdf8e-a321-44ae-bcd5-5010a1db7123", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "dnc-entries" ], "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 \"phone_e164\": \"+7673792381\",\n \"scope\": \"internal\",\n \"source\": \"api\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4cc7b5f-8956-463a-8147-37c9c47603f8", "name": "List this tenant's consent records", "request": { "name": "List this tenant's consent records", "description": {}, "url": { "path": [ "v1", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a6d6e243-c803-40fc-9aa3-4ef123b90ab0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"consent_class\": \"pewc\",\n \"source\": \"api_attestation\",\n \"captured_at\": \"2017-07-19T02:48:19.083Z\",\n \"status\": \"active\",\n \"created_at\": \"2003-10-14T14:38:48.166Z\",\n \"scope\": {\n \"key_0\": 3637\n },\n \"proof\": {\n \"key_0\": false\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"2018-04-06T23:37:58.740Z\",\n \"revokes_consent_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"consent_class\": \"pewc\",\n \"source\": \"web_form\",\n \"captured_at\": \"2000-08-09T12:56:38.312Z\",\n \"status\": \"active\",\n \"created_at\": \"1981-03-05T03:49:07.027Z\",\n \"scope\": {\n \"key_0\": 6645.646745047738\n },\n \"proof\": {\n \"key_0\": \"string\",\n \"key_1\": 7640\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"2003-06-26T14:38:26.532Z\",\n \"revokes_consent_id\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4b13533-e4ba-4d4b-bb76-cd0456537935", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b101badf-e698-4f13-ad91-f638cc8741a6", "name": "Append a consent record, or a revocation of one", "request": { "name": "Append a consent record, or a revocation of one", "description": {}, "url": { "path": [ "v1", "consents" ], "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 \"contact_id\": \"string\",\n \"consent_class\": \"pewc\",\n \"source\": \"paper\",\n \"captured_at\": \"1970-06-12T11:12:34.131Z\",\n \"scope\": {\n \"key_0\": 4943,\n \"key_1\": false,\n \"key_2\": 1466\n },\n \"proof\": {\n \"key_0\": \"string\",\n \"key_1\": 4077,\n \"key_2\": 2101.0269715925588\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1993-10-05T06:43:12.295Z\",\n \"revokes_consent_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "278bf926-b667-4441-8c15-094495c0951f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "consents" ], "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 \"contact_id\": \"string\",\n \"consent_class\": \"pewc\",\n \"source\": \"paper\",\n \"captured_at\": \"1970-06-12T11:12:34.131Z\",\n \"scope\": {\n \"key_0\": 4943,\n \"key_1\": false,\n \"key_2\": 1466\n },\n \"proof\": {\n \"key_0\": \"string\",\n \"key_1\": 4077,\n \"key_2\": 2101.0269715925588\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1993-10-05T06:43:12.295Z\",\n \"revokes_consent_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"consent_class\": \"ebr\",\n \"source\": \"web_form\",\n \"captured_at\": \"2019-12-02T15:11:35.540Z\",\n \"status\": \"active\",\n \"created_at\": \"1991-10-21T02:25:11.180Z\",\n \"scope\": {\n \"key_0\": true\n },\n \"proof\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1999-09-28T18:43:12.569Z\",\n \"revokes_consent_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03b2dcf2-d204-44d2-ba6c-ad1369fbd54c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "consents" ], "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 \"contact_id\": \"string\",\n \"consent_class\": \"pewc\",\n \"source\": \"paper\",\n \"captured_at\": \"1970-06-12T11:12:34.131Z\",\n \"scope\": {\n \"key_0\": 4943,\n \"key_1\": false,\n \"key_2\": 1466\n },\n \"proof\": {\n \"key_0\": \"string\",\n \"key_1\": 4077,\n \"key_2\": 2101.0269715925588\n },\n \"disclosure_text_shown\": \"string\",\n \"expires_at\": \"1993-10-05T06:43:12.295Z\",\n \"revokes_consent_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c857b49f-6e9b-4681-9d16-1c8bb1d2bf03", "name": "List this tenant's DNC registry subscriptions (SANs)", "request": { "name": "List this tenant's DNC registry subscriptions (SANs)", "description": {}, "url": { "path": [ "v1", "dnc-subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ea1da2a5-bfab-4f88-974a-a9fddcb515a1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dnc-subscriptions" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"account_ref\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"effective_at\": \"2010-09-11T08:21:08.636Z\",\n \"expires_at\": \"1977-12-29T14:50:54.024Z\"\n },\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"account_ref\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"effective_at\": \"1979-09-20T02:42:58.230Z\",\n \"expires_at\": \"1962-03-04T23:01:42.141Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08383926-808f-43fa-aed1-a2555d7b08a1", "name": "Register this tenant's federal SAN and the area codes it covers", "request": { "name": "Register this tenant's federal SAN and the area codes it covers", "description": { "content": "Register (or refresh) this tenant's own FTC SAN - its federal DNC authorization.\n\nThis records authorization, not data. The federal registry is platform reference data\nrefreshed by ingestion and shared across tenants (the same boundary\n`POST /dnc-entries` enforces when it refuses a federal scope); a tenant's subscription is\nwhat gates that tenant's access to it. Re-registering the same SAN updates its coverage\nrather than duplicating it. The credential is not accepted here - it is held in the\nplatform vault - so this endpoint records the account reference and coverage only.", "type": "text/plain" }, "url": { "path": [ "v1", "dnc-subscriptions" ], "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 \"account_ref\": \"stri\",\n \"area_codes\": [\n \"string\"\n ],\n \"expires_at\": \"1986-07-25T03:25:56.742Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ffc7f33-f1f0-49f5-878a-780f3f877c72", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dnc-subscriptions" ], "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 \"account_ref\": \"stri\",\n \"area_codes\": [\n \"string\"\n ],\n \"expires_at\": \"1986-07-25T03:25:56.742Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"string\",\n \"account_ref\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"effective_at\": \"2017-04-10T23:35:09.924Z\",\n \"expires_at\": \"2018-04-29T14:05:01.393Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbaff980-7dc7-46e7-b8d4-bc75a6390315", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "dnc-subscriptions" ], "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 \"account_ref\": \"stri\",\n \"area_codes\": [\n \"string\"\n ],\n \"expires_at\": \"1986-07-25T03:25:56.742Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f84033ed-27b1-43ac-a05d-59c9ea0fe0f5", "name": "calls", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "675f3fa3-c9fa-4d83-a8af-6f57bb02a6c3", "name": "List latest saved workforce and qualification responses", "request": { "name": "List latest saved workforce and qualification responses", "description": {}, "url": { "path": [ "v1", "workflow-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fit_status", "value": "good_fit" }, { "disabled": true, "key": "workflow", "value": "sales" }, { "disabled": true, "key": "response", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." }, { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c8b58826-0504-46c7-ae7f-4c01e1dc2a86", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fit_status", "value": "good_fit" }, { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"kind\": \"shift_response\",\n \"subject_ref\": \"string\",\n \"revision\": 3458,\n \"response\": \"string\",\n \"payload\": {\n \"key_0\": 4137,\n \"key_1\": 1742.3072179862609\n },\n \"created_at\": \"2018-01-21T08:40:03.176Z\",\n \"workflow\": \"sales\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"call_record_available\": false,\n \"source_turns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action_confirmation\": {\n \"value\": \"\"\n },\n \"contact_name\": \"string\",\n \"qualification_coverage\": {\n \"value\": \"\"\n },\n \"fit_review\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"kind\": \"identity_correction\",\n \"subject_ref\": \"string\",\n \"revision\": 7114,\n \"response\": \"string\",\n \"payload\": {\n \"key_0\": 8038\n },\n \"created_at\": \"1967-04-14T13:07:51.295Z\",\n \"workflow\": \"recruiting\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"call_record_available\": false,\n \"source_turns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action_confirmation\": {\n \"value\": \"\"\n },\n \"contact_name\": \"string\",\n \"qualification_coverage\": {\n \"value\": \"\"\n },\n \"fit_review\": {\n \"value\": \"\"\n }\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52c8a718-b6e2-41b6-9465-35c585e5dda5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fit_status", "value": "good_fit" }, { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3eb8f1ce-3174-47a3-a47c-9567b26812c6", "name": "List latest saved workforce and qualification responses", "request": { "name": "List latest saved workforce and qualification responses", "description": {}, "url": { "path": [ "v1", "workflow-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fit_status", "value": "good_fit" }, { "disabled": true, "key": "workflow", "value": "sales" }, { "disabled": true, "key": "response", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." }, { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "efce317e-5d66-4f29-b941-43fced2b7000", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fit_status", "value": "good_fit" }, { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"kind\": \"shift_response\",\n \"subject_ref\": \"string\",\n \"revision\": 1766,\n \"response\": \"string\",\n \"payload\": {\n \"key_0\": 4717.821542638032,\n \"key_1\": 692.7116688776414\n },\n \"created_at\": \"1982-04-26T12:57:42.291Z\",\n \"workflow\": \"recruiting\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"call_record_available\": true,\n \"source_turns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action_confirmation\": {\n \"value\": \"\"\n },\n \"contact_name\": \"string\",\n \"qualification_coverage\": {\n \"value\": \"\"\n },\n \"fit_review\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"kind\": \"identity_correction\",\n \"subject_ref\": \"string\",\n \"revision\": 8013,\n \"response\": \"string\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": 9654\n },\n \"created_at\": \"1968-11-20T19:53:34.670Z\",\n \"workflow\": \"sales\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"call_record_available\": true,\n \"source_turns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action_confirmation\": {\n \"value\": \"\"\n },\n \"contact_name\": \"string\",\n \"qualification_coverage\": {\n \"value\": \"\"\n },\n \"fit_review\": {\n \"value\": \"\"\n }\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76325d1b-b637-4074-aa87-28399939f0ea", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fit_status", "value": "good_fit" }, { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8ec42c5-fd1f-4878-8581-c6ddf043f5de", "name": "Count current team decisions for a response cohort", "request": { "name": "Count current team decisions for a response cohort", "description": {}, "url": { "path": [ "v1", "qualification-fit-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "workflow", "value": "sales" }, { "disabled": true, "key": "response", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e19ba698-9919-4f22-ac40-9eb976a4a7bb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "qualification-fit-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1978-12-12T08:48:28.044Z\",\n \"end\": \"2015-11-09T22:53:23.933Z\"\n },\n \"as_of\": \"1953-11-25T15:35:32.636Z\",\n \"counts\": [\n {\n \"workflow\": \"recruiting\",\n \"status\": \"unreviewed\",\n \"count\": 9387\n },\n {\n \"workflow\": \"sales\",\n \"status\": \"good_fit\",\n \"count\": 6883\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7645b1ed-9dbd-49aa-9e4a-2e9c6b38b451", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "qualification-fit-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e9a9d26-60e5-4744-b85a-e1772ce2a53d", "name": "Count current team decisions for a response cohort", "request": { "name": "Count current team decisions for a response cohort", "description": {}, "url": { "path": [ "v1", "qualification-fit-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "workflow", "value": "sales" }, { "disabled": true, "key": "response", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "51670364-79da-439b-b85a-353808d1c88f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "qualification-fit-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"2010-04-04T03:44:40.646Z\",\n \"end\": \"2012-05-12T17:50:58.114Z\"\n },\n \"as_of\": \"1954-10-09T15:03:24.838Z\",\n \"counts\": [\n {\n \"workflow\": \"recruiting\",\n \"status\": \"not_a_fit\",\n \"count\": 9233\n },\n {\n \"workflow\": \"recruiting\",\n \"status\": \"unreviewed\",\n \"count\": 6880\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8c359aa-8019-4b26-bb83-958c4302648b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "qualification-fit-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a30a656-6b21-4a3f-9600-c7b90376c8db", "name": "Count current saved responses across a bounded window", "request": { "name": "Count current saved responses across a bounded window", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "workflow", "value": "sales" }, { "disabled": true, "key": "response", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3092d20a-f748-4858-9b64-efc92b5d1bba", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"2023-04-19T12:05:59.071Z\",\n \"end\": \"1953-11-30T20:25:04.914Z\"\n },\n \"as_of\": \"2007-08-21T01:11:21.249Z\",\n \"counts\": [\n {\n \"workflow\": \"sales\",\n \"response\": \"string\",\n \"count\": 8815\n },\n {\n \"workflow\": \"sales\",\n \"response\": \"string\",\n \"count\": 8873\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44e185a1-319a-412f-8333-814bc09a4712", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c732c354-4216-4211-8627-c18c038df641", "name": "Count current saved responses across a bounded window", "request": { "name": "Count current saved responses across a bounded window", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "workflow", "value": "sales" }, { "disabled": true, "key": "response", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bc3a0b73-38fb-47d1-a608-b4fa44edbc0c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"1997-03-04T13:34:19.509Z\",\n \"end\": \"1982-09-04T10:34:03.065Z\"\n },\n \"as_of\": \"1974-04-21T12:52:35.653Z\",\n \"counts\": [\n {\n \"workflow\": \"recruiting\",\n \"response\": \"string\",\n \"count\": 4724\n },\n {\n \"workflow\": \"recruiting\",\n \"response\": \"string\",\n \"count\": 8803\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b952aac-cdef-4dcb-ac00-fa900d36bd06", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "workflow", "value": "sales" }, { "key": "response", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11a14870-d1f7-43fc-a952-3ed2c7747d81", "name": "Read the team review history for these exact answers", "request": { "name": "Read the team review history for these exact answers", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3b1a7e5e-302b-4fab-8749-e654a647dbda", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"revision\": 5896,\n \"decision\": \"good_fit\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"created_at\": \"2014-08-30T06:37:41.036Z\"\n },\n {\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"revision\": 6991,\n \"decision\": \"good_fit\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"created_at\": \"2026-01-10T06:23:15.110Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c266f0d-6aca-478b-bd4a-e0278f6df531", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3b2a345-3e49-4070-93ab-2a67912f089f", "name": "Read the team review history for these exact answers", "request": { "name": "Read the team review history for these exact answers", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f470a2fe-96e3-4379-bea2-37ff095754fc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"revision\": 2758,\n \"decision\": \"good_fit\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"created_at\": \"1958-09-29T15:52:52.921Z\"\n },\n {\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"revision\": 4473,\n \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"created_at\": \"2021-07-01T18:52:11.409Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1044080-16bf-4c48-80a6-0de614a1fc07", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c755a8b-e9ad-43c5-a9d3-732121ccdf51", "name": "Save a team decision against the current qualification answers", "request": { "name": "Save a team decision against the current qualification answers", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "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 \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"expected_revision\": 7850\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ec646621-cfc5-4642-97dc-75430c8ffa0c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"expected_revision\": 7850\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"revision\": 8895,\n \"decision\": \"good_fit\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"created_at\": \"1966-01-22T20:02:50.245Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8241b5ea-bd49-4ca7-a807-d7df12bf5905", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"expected_revision\": 7850\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8feb021b-ed35-4e16-9b30-d43d0478d5d9", "name": "Save a team decision against the current qualification answers", "request": { "name": "Save a team decision against the current qualification answers", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "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 \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"expected_revision\": 7850\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b101ad02-a52f-4567-8e5d-48673c14a035", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"expected_revision\": 7850\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"revision\": 8895,\n \"decision\": \"good_fit\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"created_at\": \"1966-01-22T20:02:50.245Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b965363-4a90-4625-b97b-4c8d221e4ae9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "fit-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"not_a_fit\",\n \"reason\": \"string\",\n \"expected_revision\": 7850\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efcbfbe4-861f-4e83-bc3a-2bb34d2fe0c3", "name": "Review a caller proposal against the current contact", "request": { "name": "Review a caller proposal against the current contact", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "38003d19-d5c3-40ea-a0f0-d62c93526fc0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"reviewed\",\n \"can_decide\": false,\n \"current_action_id\": \"string\",\n \"current_value\": \"string\",\n \"contact_updated_at\": \"1956-03-15T00:24:32.466Z\",\n \"review\": {\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"contact_id\": \"string\",\n \"field\": \"first_name\",\n \"decision\": \"applied\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"before_value\": \"string\",\n \"after_value\": \"string\",\n \"proposed_value\": \"string\",\n \"created_at\": \"2020-02-29T13:33:51.724Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02571f15-79c0-4c8f-807a-7bbef257a89f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1402aa8-ab69-49f8-abb9-6194daf19d4a", "name": "Review a caller proposal against the current contact", "request": { "name": "Review a caller proposal against the current contact", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e1fcb104-b1ec-4a5f-8997-da5271fe89b9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"reviewed\",\n \"can_decide\": false,\n \"current_action_id\": \"string\",\n \"current_value\": \"string\",\n \"contact_updated_at\": \"1956-03-15T00:24:32.466Z\",\n \"review\": {\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"contact_id\": \"string\",\n \"field\": \"first_name\",\n \"decision\": \"applied\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"before_value\": \"string\",\n \"after_value\": \"string\",\n \"proposed_value\": \"string\",\n \"created_at\": \"2020-02-29T13:33:51.724Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cfcc0e9-f56f-4f10-8c50-e7bb7f57e5d5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e730eeaf-cf04-4b56-8819-0eea22bced20", "name": "Apply or reject this caller correction with a final recorded decision", "request": { "name": "Apply or reject this caller correction with a final recorded decision", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "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 \"decision\": \"apply\",\n \"reason\": \"string\",\n \"expected_contact_updated_at\": \"1979-09-23T00:08:55.600Z\",\n \"expected_value\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bf5e65e9-c5de-4400-9d35-d7111d493a27", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"apply\",\n \"reason\": \"string\",\n \"expected_contact_updated_at\": \"1979-09-23T00:08:55.600Z\",\n \"expected_value\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"contact_id\": \"string\",\n \"field\": \"company\",\n \"decision\": \"applied\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"before_value\": \"string\",\n \"after_value\": \"string\",\n \"proposed_value\": \"string\",\n \"created_at\": \"2017-04-04T11:09:36.991Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e46467a-3c2b-4bff-b125-46523de3bcff", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"apply\",\n \"reason\": \"string\",\n \"expected_contact_updated_at\": \"1979-09-23T00:08:55.600Z\",\n \"expected_value\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86acb12e-71bd-4e68-ac5d-ec9194f04860", "name": "Apply or reject this caller correction with a final recorded decision", "request": { "name": "Apply or reject this caller correction with a final recorded decision", "description": {}, "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "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 \"decision\": \"apply\",\n \"reason\": \"string\",\n \"expected_contact_updated_at\": \"1979-09-23T00:08:55.600Z\",\n \"expected_value\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74f3cc85-c569-4ffe-94ab-2f75f4e6c7e3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"apply\",\n \"reason\": \"string\",\n \"expected_contact_updated_at\": \"1979-09-23T00:08:55.600Z\",\n \"expected_value\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"action_id\": \"string\",\n \"contact_id\": \"string\",\n \"field\": \"company\",\n \"decision\": \"applied\",\n \"reason\": \"string\",\n \"reviewer_ref\": \"string\",\n \"before_value\": \"string\",\n \"after_value\": \"string\",\n \"proposed_value\": \"string\",\n \"created_at\": \"2017-04-04T11:09:36.991Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1624ee81-4cc5-49da-a282-135f5bf03158", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workflow-outcomes", ":action_id", "contact-correction-reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "action_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"apply\",\n \"reason\": \"string\",\n \"expected_contact_updated_at\": \"1979-09-23T00:08:55.600Z\",\n \"expected_value\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed890f21-1481-4cba-a2de-d9b9508b1aa5", "name": "Queue one contact-bound campaign-less outbound call", "request": { "name": "Queue one contact-bound campaign-less outbound call", "description": { "content": "Queue one compliant API-key-originated campaign-less outbound call.", "type": "text/plain" }, "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "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 \"agent_id\": \"st\",\n \"contact_id\": \"string\",\n \"questions\": [\n {\n \"id\": \"cj-zNF_X1W\",\n \"prompt\": \"string\",\n \"scoring\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"dWL1Lr85b_\",\n \"prompt\": \"string\",\n \"scoring\": {\n \"value\": \"\"\n }\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "772a3adb-8c9b-4dcc-8a27-69683a8483dd", "name": "Successful Response", "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": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"st\",\n \"contact_id\": \"string\",\n \"questions\": [\n {\n \"id\": \"cj-zNF_X1W\",\n \"prompt\": \"string\",\n \"scoring\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"dWL1Lr85b_\",\n \"prompt\": \"string\",\n \"scoring\": {\n \"value\": \"\"\n }\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"contact_id\": \"string\",\n \"telephony\": \"byo\",\n \"state\": \"string\",\n \"created_at\": \"1963-01-01T15:50:26.675Z\",\n \"disposition\": \"string\",\n \"call_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c48880-a2bd-4d06-abba-536cdd560c58", "name": "Validation Error", "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": "(Required) Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape. **Required on this endpoint**: a retry without one would dial a human twice or spend money twice.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"st\",\n \"contact_id\": \"string\",\n \"questions\": [\n {\n \"id\": \"cj-zNF_X1W\",\n \"prompt\": \"string\",\n \"scoring\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"dWL1Lr85b_\",\n \"prompt\": \"string\",\n \"scoring\": {\n \"value\": \"\"\n }\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "151b9440-e704-4bde-8fdd-7ad6bd4ae098", "name": "List calls", "request": { "name": "List calls", "description": {}, "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string", "description": "Filter on `agent_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_id.gte", "value": "string", "description": "Filter on `agent_id` with the `gte` operator." }, { "disabled": true, "key": "agent_id.lte", "value": "string", "description": "Filter on `agent_id` with the `lte` operator." }, { "disabled": true, "key": "agent_id.gt", "value": "string", "description": "Filter on `agent_id` with the `gt` operator." }, { "disabled": true, "key": "agent_id.lt", "value": "string", "description": "Filter on `agent_id` with the `lt` operator." }, { "disabled": true, "key": "agent_id.in", "value": "string", "description": "Filter on `agent_id` with the `in` operator." }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Filter on `agent_version_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_version_id.gte", "value": "string", "description": "Filter on `agent_version_id` with the `gte` operator." }, { "disabled": true, "key": "agent_version_id.lte", "value": "string", "description": "Filter on `agent_version_id` with the `lte` operator." }, { "disabled": true, "key": "agent_version_id.gt", "value": "string", "description": "Filter on `agent_version_id` with the `gt` operator." }, { "disabled": true, "key": "agent_version_id.lt", "value": "string", "description": "Filter on `agent_version_id` with the `lt` operator." }, { "disabled": true, "key": "agent_version_id.in", "value": "string", "description": "Filter on `agent_version_id` with the `in` operator." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "direction", "value": "string", "description": "Filter on `direction`. Comma-separated values are OR." }, { "disabled": true, "key": "direction.gte", "value": "string", "description": "Filter on `direction` with the `gte` operator." }, { "disabled": true, "key": "direction.lte", "value": "string", "description": "Filter on `direction` with the `lte` operator." }, { "disabled": true, "key": "direction.gt", "value": "string", "description": "Filter on `direction` with the `gt` operator." }, { "disabled": true, "key": "direction.lt", "value": "string", "description": "Filter on `direction` with the `lt` operator." }, { "disabled": true, "key": "direction.in", "value": "string", "description": "Filter on `direction` with the `in` operator." }, { "disabled": true, "key": "disposition", "value": "string", "description": "Filter on `disposition`. Comma-separated values are OR." }, { "disabled": true, "key": "disposition.gte", "value": "string", "description": "Filter on `disposition` with the `gte` operator." }, { "disabled": true, "key": "disposition.lte", "value": "string", "description": "Filter on `disposition` with the `lte` operator." }, { "disabled": true, "key": "disposition.gt", "value": "string", "description": "Filter on `disposition` with the `gt` operator." }, { "disabled": true, "key": "disposition.lt", "value": "string", "description": "Filter on `disposition` with the `lt` operator." }, { "disabled": true, "key": "disposition.in", "value": "string", "description": "Filter on `disposition` with the `in` operator." }, { "disabled": true, "key": "has_campaign", "value": "string", "description": "Filter on `has_campaign`. Comma-separated values are OR." }, { "disabled": true, "key": "has_campaign.gte", "value": "string", "description": "Filter on `has_campaign` with the `gte` operator." }, { "disabled": true, "key": "has_campaign.lte", "value": "string", "description": "Filter on `has_campaign` with the `lte` operator." }, { "disabled": true, "key": "has_campaign.gt", "value": "string", "description": "Filter on `has_campaign` with the `gt` operator." }, { "disabled": true, "key": "has_campaign.lt", "value": "string", "description": "Filter on `has_campaign` with the `lt` operator." }, { "disabled": true, "key": "has_campaign.in", "value": "string", "description": "Filter on `has_campaign` with the `in` operator." }, { "disabled": true, "key": "started_at", "value": "string", "description": "Filter on `started_at`. Comma-separated values are OR." }, { "disabled": true, "key": "started_at.gte", "value": "string", "description": "Filter on `started_at` with the `gte` operator." }, { "disabled": true, "key": "started_at.lte", "value": "string", "description": "Filter on `started_at` with the `lte` operator." }, { "disabled": true, "key": "started_at.gt", "value": "string", "description": "Filter on `started_at` with the `gt` operator." }, { "disabled": true, "key": "started_at.lt", "value": "string", "description": "Filter on `started_at` with the `lt` operator." }, { "disabled": true, "key": "started_at.in", "value": "string", "description": "Filter on `started_at` with the `in` operator." }, { "disabled": true, "key": "state", "value": "string", "description": "Filter on `state`. Comma-separated values are OR." }, { "disabled": true, "key": "state.gte", "value": "string", "description": "Filter on `state` with the `gte` operator." }, { "disabled": true, "key": "state.lte", "value": "string", "description": "Filter on `state` with the `lte` operator." }, { "disabled": true, "key": "state.gt", "value": "string", "description": "Filter on `state` with the `gt` operator." }, { "disabled": true, "key": "state.lt", "value": "string", "description": "Filter on `state` with the `lt` operator." }, { "disabled": true, "key": "state.in", "value": "string", "description": "Filter on `state` with the `in` operator." }, { "disabled": true, "key": "sub_code", "value": "string", "description": "Filter on `sub_code`. Comma-separated values are OR." }, { "disabled": true, "key": "sub_code.gte", "value": "string", "description": "Filter on `sub_code` with the `gte` operator." }, { "disabled": true, "key": "sub_code.lte", "value": "string", "description": "Filter on `sub_code` with the `lte` operator." }, { "disabled": true, "key": "sub_code.gt", "value": "string", "description": "Filter on `sub_code` with the `gt` operator." }, { "disabled": true, "key": "sub_code.lt", "value": "string", "description": "Filter on `sub_code` with the `lt` operator." }, { "disabled": true, "key": "sub_code.in", "value": "string", "description": "Filter on `sub_code` with the `in` operator." }, { "disabled": true, "key": "use_case", "value": "string", "description": "Filter on `use_case`. Comma-separated values are OR." }, { "disabled": true, "key": "use_case.gte", "value": "string", "description": "Filter on `use_case` with the `gte` operator." }, { "disabled": true, "key": "use_case.lte", "value": "string", "description": "Filter on `use_case` with the `lte` operator." }, { "disabled": true, "key": "use_case.gt", "value": "string", "description": "Filter on `use_case` with the `gt` operator." }, { "disabled": true, "key": "use_case.lt", "value": "string", "description": "Filter on `use_case` with the `lt` operator." }, { "disabled": true, "key": "use_case.in", "value": "string", "description": "Filter on `use_case` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e530c39-8170-49aa-b5ed-cd717d2b8d26", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "agent_id.gte", "value": "string" }, { "key": "agent_id.lte", "value": "string" }, { "key": "agent_id.gt", "value": "string" }, { "key": "agent_id.lt", "value": "string" }, { "key": "agent_id.in", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "direction.gte", "value": "string" }, { "key": "direction.lte", "value": "string" }, { "key": "direction.gt", "value": "string" }, { "key": "direction.lt", "value": "string" }, { "key": "direction.in", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "has_campaign", "value": "string" }, { "key": "has_campaign.gte", "value": "string" }, { "key": "has_campaign.lte", "value": "string" }, { "key": "has_campaign.gt", "value": "string" }, { "key": "has_campaign.lt", "value": "string" }, { "key": "has_campaign.in", "value": "string" }, { "key": "started_at", "value": "string" }, { "key": "started_at.gte", "value": "string" }, { "key": "started_at.lte", "value": "string" }, { "key": "started_at.gt", "value": "string" }, { "key": "started_at.lt", "value": "string" }, { "key": "started_at.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" }, { "key": "sub_code", "value": "string" }, { "key": "sub_code.gte", "value": "string" }, { "key": "sub_code.lte", "value": "string" }, { "key": "sub_code.gt", "value": "string" }, { "key": "sub_code.lt", "value": "string" }, { "key": "sub_code.in", "value": "string" }, { "key": "use_case", "value": "string" }, { "key": "use_case.gte", "value": "string" }, { "key": "use_case.lte", "value": "string" }, { "key": "use_case.gt", "value": "string" }, { "key": "use_case.lt", "value": "string" }, { "key": "use_case.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"direction\": \"outbound\",\n \"state\": \"busy\",\n \"agent_version_id\": \"string\",\n \"started_at\": \"1980-05-16T12:18:09.442Z\",\n \"created_at\": \"1995-01-27T12:05:30.088Z\",\n \"campaign_id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_first_name\": \"string\",\n \"contact_last_name\": \"string\",\n \"contact_company\": \"string\",\n \"counterparty_e164\": \"string\",\n \"dialed_e164\": \"string\",\n \"contact_attempt_id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"summary\": \"string\",\n \"captured_fields\": {\n \"key_0\": 2059\n },\n \"recorded_responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recorded_response_count\": 0,\n \"ended_at\": \"2003-08-31T11:13:07.617Z\",\n \"duration_ms\": 6501,\n \"end_reason\": {\n \"value\": \"\"\n },\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"recording_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"direction\": \"browser\",\n \"state\": \"busy\",\n \"agent_version_id\": \"string\",\n \"started_at\": \"1974-03-31T01:24:04.210Z\",\n \"created_at\": \"2010-08-07T00:43:15.208Z\",\n \"campaign_id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_first_name\": \"string\",\n \"contact_last_name\": \"string\",\n \"contact_company\": \"string\",\n \"counterparty_e164\": \"string\",\n \"dialed_e164\": \"string\",\n \"contact_attempt_id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"summary\": \"string\",\n \"captured_fields\": {\n \"key_0\": 370.7600087751528,\n \"key_1\": false\n },\n \"recorded_responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recorded_response_count\": 0,\n \"ended_at\": \"1950-07-20T23:29:15.534Z\",\n \"duration_ms\": 1481,\n \"end_reason\": {\n \"value\": \"\"\n },\n \"disposition\": {\n \"value\": \"\"\n },\n \"sub_code\": \"string\",\n \"recording_id\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ed8162-4db5-4cd7-b37f-45d3dc526053", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "agent_id.gte", "value": "string" }, { "key": "agent_id.lte", "value": "string" }, { "key": "agent_id.gt", "value": "string" }, { "key": "agent_id.lt", "value": "string" }, { "key": "agent_id.in", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "direction.gte", "value": "string" }, { "key": "direction.lte", "value": "string" }, { "key": "direction.gt", "value": "string" }, { "key": "direction.lt", "value": "string" }, { "key": "direction.in", "value": "string" }, { "key": "disposition", "value": "string" }, { "key": "disposition.gte", "value": "string" }, { "key": "disposition.lte", "value": "string" }, { "key": "disposition.gt", "value": "string" }, { "key": "disposition.lt", "value": "string" }, { "key": "disposition.in", "value": "string" }, { "key": "has_campaign", "value": "string" }, { "key": "has_campaign.gte", "value": "string" }, { "key": "has_campaign.lte", "value": "string" }, { "key": "has_campaign.gt", "value": "string" }, { "key": "has_campaign.lt", "value": "string" }, { "key": "has_campaign.in", "value": "string" }, { "key": "started_at", "value": "string" }, { "key": "started_at.gte", "value": "string" }, { "key": "started_at.lte", "value": "string" }, { "key": "started_at.gt", "value": "string" }, { "key": "started_at.lt", "value": "string" }, { "key": "started_at.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" }, { "key": "sub_code", "value": "string" }, { "key": "sub_code.gte", "value": "string" }, { "key": "sub_code.lte", "value": "string" }, { "key": "sub_code.gt", "value": "string" }, { "key": "sub_code.lt", "value": "string" }, { "key": "sub_code.in", "value": "string" }, { "key": "use_case", "value": "string" }, { "key": "use_case.gte", "value": "string" }, { "key": "use_case.lte", "value": "string" }, { "key": "use_case.gt", "value": "string" }, { "key": "use_case.lt", "value": "string" }, { "key": "use_case.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81aa15f5-c04e-4d33-aa20-d8f171155af5", "name": "List inbound voicemail inbox receipts", "request": { "name": "List inbound voicemail inbox receipts", "description": { "content": "List admitted inbound messages, including explicit import failures and absences.\n\nThis is a receipt inbox, not a second recordings API. When an item says ``available``,\nits ``call_id`` can be read through the ordinary call detail and recording endpoints;\nevery other state is intentionally non-playable.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", "inbound-voicemails" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8866f42b-ef0a-43bd-af16-4b5fc3d291e6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", "inbound-voicemails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"status\": \"available\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"from_e164\": \"string\",\n \"to_e164\": \"string\",\n \"received_at\": \"2001-08-30T11:57:17.864Z\",\n \"updated_at\": \"1951-03-17T20:27:59.456Z\",\n \"call_id\": \"string\",\n \"recording_id\": \"string\",\n \"contact_id\": \"string\",\n \"duration_seconds\": 8944,\n \"completed_at\": \"1954-01-19T18:22:06.784Z\",\n \"failure_code\": \"string\"\n },\n {\n \"id\": \"string\",\n \"status\": \"available\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"from_e164\": \"string\",\n \"to_e164\": \"string\",\n \"received_at\": \"1954-06-05T22:17:19.773Z\",\n \"updated_at\": \"2018-08-15T19:33:41.795Z\",\n \"call_id\": \"string\",\n \"recording_id\": \"string\",\n \"contact_id\": \"string\",\n \"duration_seconds\": 9552,\n \"completed_at\": \"2011-08-15T19:59:25.285Z\",\n \"failure_code\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb4d42a-6667-4636-b6a7-9afb919c7acc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", "inbound-voicemails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "604c00ed-de63-46d6-812f-c974960fc110", "name": "Read one inbound voicemail receipt", "request": { "name": "Read one inbound voicemail receipt", "description": { "content": "Return receipt state and timing, never audio bytes or a carrier callback URL.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", "inbound-voicemails", ":voicemail_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "voicemail_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e9746698-021f-4ee6-972d-ed2388f292b9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", "inbound-voicemails", ":voicemail_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "voicemail_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"recording\",\n \"phone_number_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"from_e164\": \"string\",\n \"to_e164\": \"string\",\n \"received_at\": \"2006-07-27T23:01:02.078Z\",\n \"updated_at\": \"1976-10-25T03:04:13.435Z\",\n \"max_recording_seconds\": 1900,\n \"call_id\": \"string\",\n \"recording_id\": \"string\",\n \"contact_id\": \"string\",\n \"duration_seconds\": 3148,\n \"completed_at\": \"2009-05-30T15:09:06.696Z\",\n \"failure_code\": \"string\",\n \"recording_action_at\": \"1984-08-15T00:11:14.805Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7f0f62b-b4f6-4f88-8a65-cca960964224", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", "inbound-voicemails", ":voicemail_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "voicemail_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f63a4518-6fad-4039-9821-bab0dcd78f97", "name": "Read a call", "request": { "name": "Read a call", "description": { "content": "The call detail, with its `analysis` object once post-call scoring has run.\n\n`analysis` is null until the worker scores the call (docs/04-api.md Step 8a). It is\nalso served null - with a warning logged - when the stored verdict was written by a\nresults schema this deploy cannot read (a rollback across a schema bump): the call\ndetail is the primary resource and must not fail for a sidecar document, and the\nverdict itself stays in the `eval_runs` ledger, readable again once the deploy\ncatches up.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b781f3b1-eb90-4de9-a42d-058e372cedd5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"direction\": \"browser\",\n \"state\": \"no_answer\",\n \"agent_version_id\": \"string\",\n \"started_at\": \"1992-09-18T18:10:29.863Z\",\n \"created_at\": \"2004-10-15T20:04:10.619Z\",\n \"updated_at\": \"2022-07-15T00:03:29.467Z\",\n \"campaign_id\": \"string\",\n \"contact_id\": \"string\",\n \"contact_first_name\": \"string\",\n \"contact_last_name\": \"string\",\n \"contact_company\": \"string\",\n \"counterparty_e164\": \"string\",\n \"dialed_e164\": \"string\",\n \"contact_attempt_id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_name\": \"string\",\n \"use_case\": \"string\",\n \"summary\": \"string\",\n \"captured_fields\": {\n \"key_0\": 7050.194798601597\n },\n \"recorded_responses\": [\n {\n \"id\": \"string\",\n \"kind\": \"shift_response\",\n \"subject_ref\": \"string\",\n \"response\": \"string\",\n \"revision\": 1983,\n \"source_turn_number\": 8514,\n \"note\": \"string\",\n \"note_truncated\": false,\n \"value\": \"string\",\n \"value_truncated\": false,\n \"fit_review\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"string\",\n \"kind\": \"qualification\",\n \"subject_ref\": \"string\",\n \"response\": \"string\",\n \"revision\": 8902,\n \"source_turn_number\": 5533,\n \"note\": \"string\",\n \"note_truncated\": false,\n \"value\": \"string\",\n \"value_truncated\": false,\n \"fit_review\": {\n \"value\": \"\"\n }\n }\n ],\n \"recorded_response_count\": 0,\n \"ended_at\": \"1990-04-25T08:53:54.439Z\",\n \"duration_ms\": 743,\n \"end_reason\": \"agent_completed\",\n \"disposition\": \"completed_no_goal\",\n \"sub_code\": \"string\",\n \"recording_id\": \"string\",\n \"gpu_node_id\": \"string\",\n \"llm_provider_used\": \"string\",\n \"cost\": {\n \"key_0\": 7376\n },\n \"disposition_id\": \"string\",\n \"disposition_notes\": \"string\",\n \"disposition_set_by\": \"agent_llm\",\n \"structured_outcome\": {\n \"key_0\": false\n },\n \"conversation_actions\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"kind\": \"identity_correction\",\n \"subject_ref\": \"string\",\n \"revision\": 6813,\n \"response\": \"string\",\n \"payload\": {\n \"key_0\": 1001,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"created_at\": \"1950-07-18T17:59:45.522Z\",\n \"source_turns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action_confirmation\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"kind\": \"shift_response\",\n \"subject_ref\": \"string\",\n \"revision\": 4103,\n \"response\": \"string\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 933.4243906941331\n },\n \"created_at\": \"2020-11-02T17:38:22.275Z\",\n \"source_turns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action_confirmation\": {\n \"value\": \"\"\n }\n }\n ],\n \"qualification_reviews\": {\n \"key_0\": {\n \"fit_review\": {\n \"status\": {\n \"value\": \"\"\n },\n \"current_action_id\": {\n \"value\": \"\"\n },\n \"latest_review\": {\n \"value\": \"\"\n }\n },\n \"qualification_coverage\": {\n \"value\": \"\"\n }\n }\n },\n \"analysis\": {\n \"success_evaluation\": {\n \"verdict\": {\n \"value\": \"\"\n },\n \"rubric_version\": {\n \"value\": \"\"\n },\n \"dimensions\": {\n \"value\": \"\"\n },\n \"score\": {\n \"value\": \"\"\n }\n },\n \"summary\": \"string\",\n \"structured_data\": {\n \"key_0\": 5456.830342246463\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ceda31d-c6b4-487e-8d11-5df21a1712dc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24b7ae1c-ced8-47c6-86d6-c382edef0725", "name": "A call's disposition history, oldest first", "request": { "name": "A call's disposition history, oldest first", "description": { "content": "Every verdict ever written for this call, agent and human alike.\n\nNot paginated: the list is one agent row plus however many times a person revisited\nit, which is a handful, and a review UI needs all of them at once to show what changed.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "dispositions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5ac7241b-0705-472e-a4ae-2097d5062cf6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "dispositions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"code\": \"abandoned_no_slot\",\n \"set_by\": \"agent_llm\",\n \"created_at\": \"1994-02-13T19:46:19.445Z\",\n \"sub_code\": \"string\",\n \"notes\": \"string\",\n \"structured_outcome\": {\n \"key_0\": true\n }\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"code\": \"scrub_blocked\",\n \"set_by\": \"agent_llm\",\n \"created_at\": \"1990-07-13T01:06:35.293Z\",\n \"sub_code\": \"string\",\n \"notes\": \"string\",\n \"structured_outcome\": {\n \"key_0\": 1697,\n \"key_1\": true\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "670a320a-e861-4e1c-90c9-1e52d03263c1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "dispositions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e304aa1f-fd06-4cb8-bcdc-c4806e1fe8e3", "name": "Record a human's verdict on a reviewed call", "request": { "name": "Record a human's verdict on a reviewed call", "description": { "content": "Append a `human_review` disposition and make it the call's current one.\n\nAn append, never an edit. The agent's original verdict stays exactly as written - the\n`dispositions` table carries no `updated_at` for that reason - and this row becomes\nwhat `GET /v1/calls/{id}` reports. `GET /calls/{id}/dispositions` shows both.\n\nReporting only. A disposition authorizes nothing and suppresses nothing: labelling a\ncall `opt_out` here does not put the number on the internal DNC list, and labelling it\n`completed_goal` does not make the contact dialable. Suppression is\n`POST /v1/dnc-entries`, which writes the entry, withdraws the consent standing behind\nthe number, and emits `optout.recorded`.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "disposition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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 \"code\": \"failed\",\n \"sub_code\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cddd204e-c260-4feb-825c-c367a1831616", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "disposition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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 \"code\": \"failed\",\n \"sub_code\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"code\": \"completed_no_goal\",\n \"set_by\": \"human_review\",\n \"created_at\": \"1989-04-19T18:50:42.620Z\",\n \"sub_code\": \"string\",\n \"notes\": \"string\",\n \"structured_outcome\": {\n \"key_0\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "476a8248-47d4-40f8-b433-e5426dc5c74b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "disposition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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 \"code\": \"failed\",\n \"sub_code\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3b74fe3-cc22-4a1e-9671-d9ea914ec8c9", "name": "List a call's turns in order", "request": { "name": "List a call's turns in order", "description": {}, "url": { "path": [ "v1", "calls", ":call_id", "turns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7482afb-c500-40a6-8e66-fce2769ad4f5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "turns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"seq\": 8232,\n \"speaker\": \"contact\",\n \"text\": \"string\",\n \"started_at_ms\": 1299,\n \"created_at\": \"1964-05-15T03:46:29.527Z\",\n \"ended_at_ms\": 3666,\n \"interrupted\": false,\n \"revision\": 0,\n \"llm_ttft_ms\": 6572,\n \"voice_to_voice_ms\": 2881\n },\n {\n \"id\": \"string\",\n \"seq\": 1157,\n \"speaker\": \"contact\",\n \"text\": \"string\",\n \"started_at_ms\": 5190,\n \"created_at\": \"1997-02-17T00:22:38.830Z\",\n \"ended_at_ms\": 8243,\n \"interrupted\": false,\n \"revision\": 0,\n \"llm_ttft_ms\": 290,\n \"voice_to_voice_ms\": 4934\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7216c083-0a2a-4703-b3d3-c03cc8b51162", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "turns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9eb8060-c6ed-42d3-8174-e4de79f5df70", "name": "Read a call's transcript with its turns", "request": { "name": "Read a call's transcript with its turns", "description": {}, "url": { "path": [ "v1", "calls", ":call_id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ef6bb095-67fb-40a8-9872-a932e86679a3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"full_text\": \"string\",\n \"redaction_status\": \"raw\",\n \"created_at\": \"1998-12-24T22:27:20.082Z\",\n \"updated_at\": \"1947-06-13T21:19:06.255Z\",\n \"summary\": \"string\",\n \"turns\": [\n {\n \"id\": \"string\",\n \"seq\": 3736,\n \"speaker\": \"contact\",\n \"text\": \"string\",\n \"started_at_ms\": 878,\n \"created_at\": \"1992-09-08T09:37:55.279Z\",\n \"ended_at_ms\": 7879,\n \"interrupted\": false,\n \"revision\": 0,\n \"llm_ttft_ms\": 8971,\n \"voice_to_voice_ms\": 4527\n },\n {\n \"id\": \"string\",\n \"seq\": 2370,\n \"speaker\": \"contact\",\n \"text\": \"string\",\n \"started_at_ms\": 3261,\n \"created_at\": \"1991-03-10T02:25:04.522Z\",\n \"ended_at_ms\": 8434,\n \"interrupted\": false,\n \"revision\": 0,\n \"llm_ttft_ms\": 9488,\n \"voice_to_voice_ms\": 9264\n }\n ],\n \"turns_truncated\": false,\n \"extracted_entities\": {\n \"key_0\": \"string\"\n },\n \"language\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8936ed3-7fa2-413a-a9bf-bed1f995c8ca", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9c29c3d-8d4c-4a4c-ba3c-01fd3cbc2229", "name": "Redirect to a short-lived signed URL for a call's recording", "request": { "name": "Redirect to a short-lived signed URL for a call's recording", "description": {}, "url": { "path": [ "v1", "calls", ":call_id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6b92db57-1e85-4326-b71c-6c68f5e71764", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a750f9fa-005b-4815-bd0d-40b0eef76127", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25377bc9-4897-4d60-ab11-06d336153b6f", "name": "List booked appointments", "request": { "name": "List booked appointments", "description": {}, "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "call_id", "value": "string", "description": "Filter on `call_id`. Comma-separated values are OR." }, { "disabled": true, "key": "call_id.gte", "value": "string", "description": "Filter on `call_id` with the `gte` operator." }, { "disabled": true, "key": "call_id.lte", "value": "string", "description": "Filter on `call_id` with the `lte` operator." }, { "disabled": true, "key": "call_id.gt", "value": "string", "description": "Filter on `call_id` with the `gt` operator." }, { "disabled": true, "key": "call_id.lt", "value": "string", "description": "Filter on `call_id` with the `lt` operator." }, { "disabled": true, "key": "call_id.in", "value": "string", "description": "Filter on `call_id` with the `in` operator." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "starts_at", "value": "string", "description": "Filter on `starts_at`. Comma-separated values are OR." }, { "disabled": true, "key": "starts_at.gte", "value": "string", "description": "Filter on `starts_at` with the `gte` operator." }, { "disabled": true, "key": "starts_at.lte", "value": "string", "description": "Filter on `starts_at` with the `lte` operator." }, { "disabled": true, "key": "starts_at.gt", "value": "string", "description": "Filter on `starts_at` with the `gt` operator." }, { "disabled": true, "key": "starts_at.lt", "value": "string", "description": "Filter on `starts_at` with the `lt` operator." }, { "disabled": true, "key": "starts_at.in", "value": "string", "description": "Filter on `starts_at` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "61f40474-b9f4-45f8-b948-ae408c3e3b06", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "starts_at", "value": "string" }, { "key": "starts_at.gte", "value": "string" }, { "key": "starts_at.lte", "value": "string" }, { "key": "starts_at.gt", "value": "string" }, { "key": "starts_at.lt", "value": "string" }, { "key": "starts_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"starts_at\": \"1970-08-08T22:48:07.430Z\",\n \"ends_at\": \"2025-03-28T03:48:55.005Z\",\n \"status\": \"booked\",\n \"created_at\": \"2014-02-25T01:57:49.142Z\",\n \"updated_at\": \"1951-06-04T04:37:22.975Z\",\n \"integration_connection_id\": \"string\",\n \"external_event_id\": \"string\",\n \"contact_timezone\": \"string\",\n \"invite_sent_at\": \"1996-08-01T06:53:31.402Z\"\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"starts_at\": \"1992-02-17T19:32:29.802Z\",\n \"ends_at\": \"1956-07-19T03:10:04.870Z\",\n \"status\": \"rescheduled\",\n \"created_at\": \"1997-10-04T07:37:52.864Z\",\n \"updated_at\": \"1974-05-03T14:08:29.329Z\",\n \"integration_connection_id\": \"string\",\n \"external_event_id\": \"string\",\n \"contact_timezone\": \"string\",\n \"invite_sent_at\": \"2026-07-27T01:31:57.185Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da926c1c-1ea2-4f9c-8a09-32194ac17246", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "starts_at", "value": "string" }, { "key": "starts_at.gte", "value": "string" }, { "key": "starts_at.lte", "value": "string" }, { "key": "starts_at.gt", "value": "string" }, { "key": "starts_at.lt", "value": "string" }, { "key": "starts_at.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7d827f9-1e84-466f-81d6-be0f2d63701b", "name": "List survey responses", "request": { "name": "List survey responses", "description": {}, "url": { "path": [ "v1", "survey-responses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Filter on `agent_version_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_version_id.gte", "value": "string", "description": "Filter on `agent_version_id` with the `gte` operator." }, { "disabled": true, "key": "agent_version_id.lte", "value": "string", "description": "Filter on `agent_version_id` with the `lte` operator." }, { "disabled": true, "key": "agent_version_id.gt", "value": "string", "description": "Filter on `agent_version_id` with the `gt` operator." }, { "disabled": true, "key": "agent_version_id.lt", "value": "string", "description": "Filter on `agent_version_id` with the `lt` operator." }, { "disabled": true, "key": "agent_version_id.in", "value": "string", "description": "Filter on `agent_version_id` with the `in` operator." }, { "disabled": true, "key": "call_id", "value": "string", "description": "Filter on `call_id`. Comma-separated values are OR." }, { "disabled": true, "key": "call_id.gte", "value": "string", "description": "Filter on `call_id` with the `gte` operator." }, { "disabled": true, "key": "call_id.lte", "value": "string", "description": "Filter on `call_id` with the `lte` operator." }, { "disabled": true, "key": "call_id.gt", "value": "string", "description": "Filter on `call_id` with the `gt` operator." }, { "disabled": true, "key": "call_id.lt", "value": "string", "description": "Filter on `call_id` with the `lt` operator." }, { "disabled": true, "key": "call_id.in", "value": "string", "description": "Filter on `call_id` with the `in` operator." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "completion_status", "value": "string", "description": "Filter on `completion_status`. Comma-separated values are OR." }, { "disabled": true, "key": "completion_status.gte", "value": "string", "description": "Filter on `completion_status` with the `gte` operator." }, { "disabled": true, "key": "completion_status.lte", "value": "string", "description": "Filter on `completion_status` with the `lte` operator." }, { "disabled": true, "key": "completion_status.gt", "value": "string", "description": "Filter on `completion_status` with the `gt` operator." }, { "disabled": true, "key": "completion_status.lt", "value": "string", "description": "Filter on `completion_status` with the `lt` operator." }, { "disabled": true, "key": "completion_status.in", "value": "string", "description": "Filter on `completion_status` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8ca6d224-58de-4d27-a158-82ec498923a7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "survey-responses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "completion_status", "value": "string" }, { "key": "completion_status.gte", "value": "string" }, { "key": "completion_status.lte", "value": "string" }, { "key": "completion_status.gt", "value": "string" }, { "key": "completion_status.lt", "value": "string" }, { "key": "completion_status.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"completion_status\": \"partial\",\n \"created_at\": \"2007-08-24T21:00:00.421Z\",\n \"updated_at\": \"2003-04-13T22:27:11.909Z\",\n \"answers\": {\n \"key_0\": 7265,\n \"key_1\": 3189\n },\n \"score\": 9030.886514862232\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"completion_status\": \"complete\",\n \"created_at\": \"1976-11-18T02:38:41.582Z\",\n \"updated_at\": \"1966-05-24T09:43:34.239Z\",\n \"answers\": {\n \"key_0\": 6566.447469289796,\n \"key_1\": 5054.9046198915985\n },\n \"score\": 7022.122868565006\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a83042f9-0140-4ff9-888d-619f183f2857", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "survey-responses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "completion_status", "value": "string" }, { "key": "completion_status.gte", "value": "string" }, { "key": "completion_status.lte", "value": "string" }, { "key": "completion_status.gt", "value": "string" }, { "key": "completion_status.lt", "value": "string" }, { "key": "completion_status.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33bea56f-fe03-4bf0-b75c-83797bba23d5", "name": "Read the one survey response a call produced", "request": { "name": "Read the one survey response a call produced", "description": { "content": "The single-fetch convenience over the collection filter.\n\nA call produces at most one response (`uq_survey_responses_call_id`), so the\nintegrator's common path - \"the webhook named this call; give me its answers\" - is\none GET rather than a filtered list walk. 404 when the call collected none.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "survey-response" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "67c1a2ab-de65-43a5-83d8-44c41d596d17", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "survey-response" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"completion_status\": \"partial\",\n \"created_at\": \"2009-07-29T09:38:03.674Z\",\n \"updated_at\": \"1987-07-14T10:36:34.940Z\",\n \"answers\": {\n \"key_0\": 772\n },\n \"score\": 742.7016829679434\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c316c4a-cfc9-4326-916c-df3b226b27fd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "survey-response" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "171ffb31-a1d8-4332-bc16-ef0068a6aa17", "name": "List shift confirmations", "request": { "name": "List shift confirmations", "description": {}, "url": { "path": [ "v1", "shift-confirmations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "call_id", "value": "string", "description": "Filter on `call_id`. Comma-separated values are OR." }, { "disabled": true, "key": "call_id.gte", "value": "string", "description": "Filter on `call_id` with the `gte` operator." }, { "disabled": true, "key": "call_id.lte", "value": "string", "description": "Filter on `call_id` with the `lte` operator." }, { "disabled": true, "key": "call_id.gt", "value": "string", "description": "Filter on `call_id` with the `gt` operator." }, { "disabled": true, "key": "call_id.lt", "value": "string", "description": "Filter on `call_id` with the `lt` operator." }, { "disabled": true, "key": "call_id.in", "value": "string", "description": "Filter on `call_id` with the `in` operator." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "response", "value": "string", "description": "Filter on `response`. Comma-separated values are OR." }, { "disabled": true, "key": "response.gte", "value": "string", "description": "Filter on `response` with the `gte` operator." }, { "disabled": true, "key": "response.lte", "value": "string", "description": "Filter on `response` with the `lte` operator." }, { "disabled": true, "key": "response.gt", "value": "string", "description": "Filter on `response` with the `gt` operator." }, { "disabled": true, "key": "response.lt", "value": "string", "description": "Filter on `response` with the `lt` operator." }, { "disabled": true, "key": "response.in", "value": "string", "description": "Filter on `response` with the `in` operator." }, { "disabled": true, "key": "shift_ref", "value": "string", "description": "Filter on `shift_ref`. Comma-separated values are OR." }, { "disabled": true, "key": "shift_ref.gte", "value": "string", "description": "Filter on `shift_ref` with the `gte` operator." }, { "disabled": true, "key": "shift_ref.lte", "value": "string", "description": "Filter on `shift_ref` with the `lte` operator." }, { "disabled": true, "key": "shift_ref.gt", "value": "string", "description": "Filter on `shift_ref` with the `gt` operator." }, { "disabled": true, "key": "shift_ref.lt", "value": "string", "description": "Filter on `shift_ref` with the `lt` operator." }, { "disabled": true, "key": "shift_ref.in", "value": "string", "description": "Filter on `shift_ref` with the `in` operator." }, { "disabled": true, "key": "shift_starts_at", "value": "string", "description": "Filter on `shift_starts_at`. Comma-separated values are OR." }, { "disabled": true, "key": "shift_starts_at.gte", "value": "string", "description": "Filter on `shift_starts_at` with the `gte` operator." }, { "disabled": true, "key": "shift_starts_at.lte", "value": "string", "description": "Filter on `shift_starts_at` with the `lte` operator." }, { "disabled": true, "key": "shift_starts_at.gt", "value": "string", "description": "Filter on `shift_starts_at` with the `gt` operator." }, { "disabled": true, "key": "shift_starts_at.lt", "value": "string", "description": "Filter on `shift_starts_at` with the `lt` operator." }, { "disabled": true, "key": "shift_starts_at.in", "value": "string", "description": "Filter on `shift_starts_at` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2a4be52c-2cb0-4d69-9c23-356275838f37", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "shift-confirmations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "response", "value": "string" }, { "key": "response.gte", "value": "string" }, { "key": "response.lte", "value": "string" }, { "key": "response.gt", "value": "string" }, { "key": "response.lt", "value": "string" }, { "key": "response.in", "value": "string" }, { "key": "shift_ref", "value": "string" }, { "key": "shift_ref.gte", "value": "string" }, { "key": "shift_ref.lte", "value": "string" }, { "key": "shift_ref.gt", "value": "string" }, { "key": "shift_ref.lt", "value": "string" }, { "key": "shift_ref.in", "value": "string" }, { "key": "shift_starts_at", "value": "string" }, { "key": "shift_starts_at.gte", "value": "string" }, { "key": "shift_starts_at.lte", "value": "string" }, { "key": "shift_starts_at.gt", "value": "string" }, { "key": "shift_starts_at.lt", "value": "string" }, { "key": "shift_starts_at.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"shift_ref\": \"string\",\n \"shift_starts_at\": \"1999-10-19T10:13:58.885Z\",\n \"response\": \"declined\",\n \"created_at\": \"2011-02-18T19:18:22.809Z\",\n \"updated_at\": \"2006-04-10T22:16:56.121Z\",\n \"site\": \"string\",\n \"decline_reason\": \"string\",\n \"confirmed_at\": \"1983-03-12T22:30:19.357Z\"\n },\n {\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"shift_ref\": \"string\",\n \"shift_starts_at\": \"2023-11-13T21:25:04.814Z\",\n \"response\": \"declined\",\n \"created_at\": \"1961-07-23T06:25:55.807Z\",\n \"updated_at\": \"1994-08-19T19:13:56.987Z\",\n \"site\": \"string\",\n \"decline_reason\": \"string\",\n \"confirmed_at\": \"1997-01-22T04:10:16.472Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3131acae-79ce-4558-a08b-79b58fa58423", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "shift-confirmations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "response", "value": "string" }, { "key": "response.gte", "value": "string" }, { "key": "response.lte", "value": "string" }, { "key": "response.gt", "value": "string" }, { "key": "response.lt", "value": "string" }, { "key": "response.in", "value": "string" }, { "key": "shift_ref", "value": "string" }, { "key": "shift_ref.gte", "value": "string" }, { "key": "shift_ref.lte", "value": "string" }, { "key": "shift_ref.gt", "value": "string" }, { "key": "shift_ref.lt", "value": "string" }, { "key": "shift_ref.in", "value": "string" }, { "key": "shift_starts_at", "value": "string" }, { "key": "shift_starts_at.gte", "value": "string" }, { "key": "shift_starts_at.lte", "value": "string" }, { "key": "shift_starts_at.gt", "value": "string" }, { "key": "shift_starts_at.lt", "value": "string" }, { "key": "shift_starts_at.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8066f80e-c8e2-4933-b229-c0020ae8063c", "name": "Read the ledger-backed usage and current-plan projection for a call", "request": { "name": "Read the ledger-backed usage and current-plan projection for a call", "description": { "content": "One tenant-owned call's exact recorded usage and conservative cost visibility.\n\nA live call receives ``completed: false``. Its ``live_projection`` is populated only\nfor a verified managed prepaid test-call receipt; every other active lane is explicitly\npending rather than a partial carrier cost. For a completed call, `meters` combines\ndirect runtime attribution with a managed carrier's attempt-linked minute row. That\ncarrier row may still be absent while the callback is in flight; an empty list means no\nusage row has landed, not that a future invoice is $0.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "85ec3250-e661-418e-8b85-a68a76ad9097", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"call_id\": \"string\",\n \"completed\": false,\n \"rating_status\": \"rated\",\n \"projection_status\": \"estimated\",\n \"meters\": [\n {\n \"meter\": \"stt_audio_seconds\",\n \"quantity\": \"00936849576.6301369839\",\n \"event_count\": 9601,\n \"unrated_event_count\": 3980,\n \"rated_amount_minor\": 3568,\n \"prepaid_event_count\": 0\n },\n {\n \"meter\": \"telephony_minutes\",\n \"quantity\": \"-000003620401207\",\n \"event_count\": 8148,\n \"unrated_event_count\": 8331,\n \"rated_amount_minor\": 719,\n \"prepaid_event_count\": 0\n }\n ],\n \"rated_usage_amount_minor\": 5176,\n \"currency\": \"string\",\n \"billing_period_start\": \"1949-11-14T07:47:41.363Z\",\n \"billing_period_end\": \"2003-07-18T05:16:40.846Z\",\n \"projected_marginal_usage_amount_minor\": 706,\n \"projection_unpriced_meters\": [\n \"llm_cached_prompt_tokens\",\n \"llm_completion_tokens\"\n ],\n \"prepaid_authorization_status\": \"not_applicable\",\n \"prepaid_reserved_amount_minor\": 2738,\n \"prepaid_captured_amount_minor\": 417,\n \"live_projection\": {\n \"status\": \"not_available\",\n \"basis\": \"string\",\n \"connected_at\": \"1990-12-20T20:38:27.721Z\",\n \"projected_through\": \"1990-06-22T21:49:25.618Z\",\n \"elapsed_seconds\": 8281,\n \"projected_billable_seconds\": 8717,\n \"projected_amount_minor\": 8582,\n \"platform_rate_per_minute_minor\": \"425984025877308\",\n \"currency\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1c80000-dd4e-4581-b7aa-ebaed9b169bf", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a03a5d6d-9056-4339-afc6-359adc6fb313", "name": "inbox", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fe682e78-82c9-4694-bfb9-b34569f6d14f", "name": "Current resolution of messages and tickets received in a bounded period", "request": { "name": "Current resolution of messages and tickets received in a bounded period", "description": {}, "url": { "path": [ "v1", "caller-request-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "agent_id", "value": "string" }, { "disabled": true, "key": "campaign_id", "value": "string" }, { "disabled": true, "key": "start", "value": "1971-10-01T12:24:10.449Z", "description": "Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days." }, { "disabled": true, "key": "end", "value": "1971-10-01T12:24:10.449Z", "description": "Exclusive upper bound, ISO-8601." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6864ff74-f8f2-4c1a-b78e-9a5e5d6f9f91", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "caller-request-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"window\": {\n \"start\": \"2020-12-18T20:43:23.273Z\",\n \"end\": \"1974-04-27T06:58:00.958Z\"\n },\n \"as_of\": \"1998-03-25T09:13:48.178Z\",\n \"counts\": [\n {\n \"kind\": \"support_ticket\",\n \"open_count\": 0,\n \"acknowledged_count\": 0,\n \"resolved_count\": 0\n },\n {\n \"kind\": \"support_ticket\",\n \"open_count\": 0,\n \"acknowledged_count\": 0,\n \"resolved_count\": 0\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac2ca36-6e86-492c-9c26-48ac455594db", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "caller-request-metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "agent_id", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "start", "value": "1971-10-01T12:24:10.449Z" }, { "key": "end", "value": "1971-10-01T12:24:10.449Z" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6aab044-1479-4056-9642-84f22fe47840", "name": "The caller-request queue: messages and tickets the AI took mid-call", "request": { "name": "The caller-request queue: messages and tickets the AI took mid-call", "description": { "content": "Cursor + filters + a watermark ETag, exactly like the attempt feed it sits beside.", "type": "text/plain" }, "url": { "path": [ "v1", "caller-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Filter on `agent_version_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_version_id.gte", "value": "string", "description": "Filter on `agent_version_id` with the `gte` operator." }, { "disabled": true, "key": "agent_version_id.lte", "value": "string", "description": "Filter on `agent_version_id` with the `lte` operator." }, { "disabled": true, "key": "agent_version_id.gt", "value": "string", "description": "Filter on `agent_version_id` with the `gt` operator." }, { "disabled": true, "key": "agent_version_id.lt", "value": "string", "description": "Filter on `agent_version_id` with the `lt` operator." }, { "disabled": true, "key": "agent_version_id.in", "value": "string", "description": "Filter on `agent_version_id` with the `in` operator." }, { "disabled": true, "key": "call_id", "value": "string", "description": "Filter on `call_id`. Comma-separated values are OR." }, { "disabled": true, "key": "call_id.gte", "value": "string", "description": "Filter on `call_id` with the `gte` operator." }, { "disabled": true, "key": "call_id.lte", "value": "string", "description": "Filter on `call_id` with the `lte` operator." }, { "disabled": true, "key": "call_id.gt", "value": "string", "description": "Filter on `call_id` with the `gt` operator." }, { "disabled": true, "key": "call_id.lt", "value": "string", "description": "Filter on `call_id` with the `lt` operator." }, { "disabled": true, "key": "call_id.in", "value": "string", "description": "Filter on `call_id` with the `in` operator." }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "kind", "value": "string", "description": "Filter on `kind`. Comma-separated values are OR." }, { "disabled": true, "key": "kind.gte", "value": "string", "description": "Filter on `kind` with the `gte` operator." }, { "disabled": true, "key": "kind.lte", "value": "string", "description": "Filter on `kind` with the `lte` operator." }, { "disabled": true, "key": "kind.gt", "value": "string", "description": "Filter on `kind` with the `gt` operator." }, { "disabled": true, "key": "kind.lt", "value": "string", "description": "Filter on `kind` with the `lt` operator." }, { "disabled": true, "key": "kind.in", "value": "string", "description": "Filter on `kind` with the `in` operator." }, { "disabled": true, "key": "severity", "value": "string", "description": "Filter on `severity`. Comma-separated values are OR." }, { "disabled": true, "key": "severity.gte", "value": "string", "description": "Filter on `severity` with the `gte` operator." }, { "disabled": true, "key": "severity.lte", "value": "string", "description": "Filter on `severity` with the `lte` operator." }, { "disabled": true, "key": "severity.gt", "value": "string", "description": "Filter on `severity` with the `gt` operator." }, { "disabled": true, "key": "severity.lt", "value": "string", "description": "Filter on `severity` with the `lt` operator." }, { "disabled": true, "key": "severity.in", "value": "string", "description": "Filter on `severity` with the `in` operator." }, { "disabled": true, "key": "state", "value": "string", "description": "Filter on `state`. Comma-separated values are OR." }, { "disabled": true, "key": "state.gte", "value": "string", "description": "Filter on `state` with the `gte` operator." }, { "disabled": true, "key": "state.lte", "value": "string", "description": "Filter on `state` with the `lte` operator." }, { "disabled": true, "key": "state.gt", "value": "string", "description": "Filter on `state` with the `gt` operator." }, { "disabled": true, "key": "state.lt", "value": "string", "description": "Filter on `state` with the `lt` operator." }, { "disabled": true, "key": "state.in", "value": "string", "description": "Filter on `state` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ac1eab49-f96c-4d5e-bcf7-182a1f4ebef1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "caller-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind.gte", "value": "string" }, { "key": "kind.lte", "value": "string" }, { "key": "kind.gt", "value": "string" }, { "key": "kind.lt", "value": "string" }, { "key": "kind.in", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity.gte", "value": "string" }, { "key": "severity.lte", "value": "string" }, { "key": "severity.gt", "value": "string" }, { "key": "severity.lt", "value": "string" }, { "key": "severity.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"kind\": \"support_ticket\",\n \"state\": \"resolved\",\n \"body\": \"string\",\n \"version\": 1223,\n \"created_at\": \"2024-08-07T08:58:58.629Z\",\n \"updated_at\": \"1968-12-06T04:15:35.598Z\",\n \"severity\": \"high\",\n \"contact_id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"caller_name\": \"string\",\n \"subject\": \"string\",\n \"assignee_user_id\": \"string\",\n \"acknowledged_by_ref\": \"string\",\n \"acknowledged_at\": \"1962-02-27T00:07:23.279Z\",\n \"resolved_by_ref\": \"string\",\n \"resolved_at\": \"2018-04-12T02:22:13.426Z\"\n },\n {\n \"id\": \"string\",\n \"kind\": \"message\",\n \"state\": \"resolved\",\n \"body\": \"string\",\n \"version\": 9686,\n \"created_at\": \"2017-01-14T10:40:23.262Z\",\n \"updated_at\": \"2005-10-24T18:28:40.221Z\",\n \"severity\": \"critical\",\n \"contact_id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"caller_name\": \"string\",\n \"subject\": \"string\",\n \"assignee_user_id\": \"string\",\n \"acknowledged_by_ref\": \"string\",\n \"acknowledged_at\": \"2024-03-26T23:36:08.152Z\",\n \"resolved_by_ref\": \"string\",\n \"resolved_at\": \"2022-03-12T14:57:17.193Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08fe995b-8b2c-41ae-a114-4c08113497fc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "caller-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind.gte", "value": "string" }, { "key": "kind.lte", "value": "string" }, { "key": "kind.gt", "value": "string" }, { "key": "kind.lt", "value": "string" }, { "key": "kind.in", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity.gte", "value": "string" }, { "key": "severity.lte", "value": "string" }, { "key": "severity.gt", "value": "string" }, { "key": "severity.lt", "value": "string" }, { "key": "severity.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "885afda0-0719-46c6-a910-e1123bdd9746", "name": "Read one caller request with its full event trail", "request": { "name": "Read one caller request with its full event trail", "description": {}, "url": { "path": [ "v1", "caller-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2b0f3bd1-a8ee-4a62-8ca1-84845cf31739", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "caller-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"support_ticket\",\n \"state\": \"open\",\n \"body\": \"string\",\n \"version\": 8651,\n \"created_at\": \"1958-03-28T23:56:52.264Z\",\n \"updated_at\": \"2002-12-16T00:34:06.124Z\",\n \"severity\": \"low\",\n \"contact_id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"caller_name\": \"string\",\n \"subject\": \"string\",\n \"assignee_user_id\": \"string\",\n \"acknowledged_by_ref\": \"string\",\n \"acknowledged_at\": \"2002-06-21T06:14:32.916Z\",\n \"resolved_by_ref\": \"string\",\n \"resolved_at\": \"1963-12-12T07:09:16.105Z\",\n \"events\": [\n {\n \"id\": \"string\",\n \"action\": \"opened\",\n \"actor_ref\": \"string\",\n \"created_at\": \"2016-12-08T13:39:07.658Z\",\n \"note\": \"string\"\n },\n {\n \"id\": \"string\",\n \"action\": \"assigned\",\n \"actor_ref\": \"string\",\n \"created_at\": \"1975-12-09T07:16:38.693Z\",\n \"note\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "051e19de-d192-43de-971e-7b9de55420b9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "caller-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f63ab84e-cc35-4e62-9541-2c7e1f311147", "name": "Acknowledge, resolve, or assign a caller request", "request": { "name": "Acknowledge, resolve, or assign a caller request", "description": { "content": "One optimistic-concurrency move: the caller names the version they read.\n\nA version mismatch and an illegal transition are both 409s with distinct codes, so\nthe portal can tell \"refresh and retry\" from \"someone already resolved this\".\n`ticket.resolved` is appended in this same transaction (`append_once` on the request\nid - resolved is terminal, so once is all there ever is).", "type": "text/plain" }, "url": { "path": [ "v1", "caller-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "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 \"version\": 8071,\n \"state\": \"acknowledged\",\n \"assignee_user_id\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0c1b3d1d-768c-4e60-8ad7-4e16aa7b1a93", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "caller-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "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 \"version\": 8071,\n \"state\": \"acknowledged\",\n \"assignee_user_id\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"kind\": \"support_ticket\",\n \"state\": \"open\",\n \"body\": \"string\",\n \"version\": 8651,\n \"created_at\": \"1958-03-28T23:56:52.264Z\",\n \"updated_at\": \"2002-12-16T00:34:06.124Z\",\n \"severity\": \"low\",\n \"contact_id\": \"string\",\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"caller_name\": \"string\",\n \"subject\": \"string\",\n \"assignee_user_id\": \"string\",\n \"acknowledged_by_ref\": \"string\",\n \"acknowledged_at\": \"2002-06-21T06:14:32.916Z\",\n \"resolved_by_ref\": \"string\",\n \"resolved_at\": \"1963-12-12T07:09:16.105Z\",\n \"events\": [\n {\n \"id\": \"string\",\n \"action\": \"opened\",\n \"actor_ref\": \"string\",\n \"created_at\": \"2016-12-08T13:39:07.658Z\",\n \"note\": \"string\"\n },\n {\n \"id\": \"string\",\n \"action\": \"assigned\",\n \"actor_ref\": \"string\",\n \"created_at\": \"1975-12-09T07:16:38.693Z\",\n \"note\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3854db69-fb89-4f9e-942d-8cadd8c08fd2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "caller-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) " } ] }, "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 \"version\": 8071,\n \"state\": \"acknowledged\",\n \"assignee_user_id\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ec83675-29d8-4ade-b020-2d13ce343d84", "name": "The merged inbox: everything a caller asked the business to do", "request": { "name": "The merged inbox: everything a caller asked the business to do", "description": { "content": "One keyset timeline (created_at desc) over the five inbox kinds, caller included.\n\nThe per-kind resources remain authoritative for their own lifecycles - a client\nnavigates by the returned durable id, and this feed synthesizes no event table.\n\nWithout a `created_at.gte`, the feed defaults to the last 30 days\n(`DEFAULT_INBOX_WINDOW`): five sources - one month-partitioned - must not make the\nlaziest request the most expensive one. An explicit `created_at.gte` overrides the\ndefault entirely (docs/04-api.md §2).", "type": "text/plain" }, "url": { "path": [ "v1", "inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "agent_id", "value": "string", "description": "Filter on `agent_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_id.gte", "value": "string", "description": "Filter on `agent_id` with the `gte` operator." }, { "disabled": true, "key": "agent_id.lte", "value": "string", "description": "Filter on `agent_id` with the `lte` operator." }, { "disabled": true, "key": "agent_id.gt", "value": "string", "description": "Filter on `agent_id` with the `gt` operator." }, { "disabled": true, "key": "agent_id.lt", "value": "string", "description": "Filter on `agent_id` with the `lt` operator." }, { "disabled": true, "key": "agent_id.in", "value": "string", "description": "Filter on `agent_id` with the `in` operator." }, { "disabled": true, "key": "agent_version_id", "value": "string", "description": "Filter on `agent_version_id`. Comma-separated values are OR." }, { "disabled": true, "key": "agent_version_id.gte", "value": "string", "description": "Filter on `agent_version_id` with the `gte` operator." }, { "disabled": true, "key": "agent_version_id.lte", "value": "string", "description": "Filter on `agent_version_id` with the `lte` operator." }, { "disabled": true, "key": "agent_version_id.gt", "value": "string", "description": "Filter on `agent_version_id` with the `gt` operator." }, { "disabled": true, "key": "agent_version_id.lt", "value": "string", "description": "Filter on `agent_version_id` with the `lt` operator." }, { "disabled": true, "key": "agent_version_id.in", "value": "string", "description": "Filter on `agent_version_id` with the `in` operator." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "kind", "value": "string", "description": "Filter on `kind`. Comma-separated values are OR." }, { "disabled": true, "key": "kind.gte", "value": "string", "description": "Filter on `kind` with the `gte` operator." }, { "disabled": true, "key": "kind.lte", "value": "string", "description": "Filter on `kind` with the `lte` operator." }, { "disabled": true, "key": "kind.gt", "value": "string", "description": "Filter on `kind` with the `gt` operator." }, { "disabled": true, "key": "kind.lt", "value": "string", "description": "Filter on `kind` with the `lt` operator." }, { "disabled": true, "key": "kind.in", "value": "string", "description": "Filter on `kind` with the `in` operator." }, { "disabled": true, "key": "phone_number_id", "value": "string", "description": "Filter on `phone_number_id`. Comma-separated values are OR." }, { "disabled": true, "key": "phone_number_id.gte", "value": "string", "description": "Filter on `phone_number_id` with the `gte` operator." }, { "disabled": true, "key": "phone_number_id.lte", "value": "string", "description": "Filter on `phone_number_id` with the `lte` operator." }, { "disabled": true, "key": "phone_number_id.gt", "value": "string", "description": "Filter on `phone_number_id` with the `gt` operator." }, { "disabled": true, "key": "phone_number_id.lt", "value": "string", "description": "Filter on `phone_number_id` with the `lt` operator." }, { "disabled": true, "key": "phone_number_id.in", "value": "string", "description": "Filter on `phone_number_id` with the `in` operator." }, { "disabled": true, "key": "state", "value": "string", "description": "Filter on `state`. Comma-separated values are OR." }, { "disabled": true, "key": "state.gte", "value": "string", "description": "Filter on `state` with the `gte` operator." }, { "disabled": true, "key": "state.lte", "value": "string", "description": "Filter on `state` with the `lte` operator." }, { "disabled": true, "key": "state.gt", "value": "string", "description": "Filter on `state` with the `gt` operator." }, { "disabled": true, "key": "state.lt", "value": "string", "description": "Filter on `state` with the `lt` operator." }, { "disabled": true, "key": "state.in", "value": "string", "description": "Filter on `state` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8d77f938-0517-430b-ad80-d533f548c987", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "agent_id.gte", "value": "string" }, { "key": "agent_id.lte", "value": "string" }, { "key": "agent_id.gt", "value": "string" }, { "key": "agent_id.lt", "value": "string" }, { "key": "agent_id.in", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind.gte", "value": "string" }, { "key": "kind.lte", "value": "string" }, { "key": "kind.gt", "value": "string" }, { "key": "kind.lt", "value": "string" }, { "key": "kind.in", "value": "string" }, { "key": "phone_number_id", "value": "string" }, { "key": "phone_number_id.gte", "value": "string" }, { "key": "phone_number_id.lte", "value": "string" }, { "key": "phone_number_id.gt", "value": "string" }, { "key": "phone_number_id.lt", "value": "string" }, { "key": "phone_number_id.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"kind\": \"appointment\",\n \"id\": \"string\",\n \"created_at\": \"2023-06-23T01:06:28.331Z\",\n \"state\": \"string\",\n \"contact\": {\n \"value\": \"\"\n },\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"snippet\": \"string\"\n },\n {\n \"kind\": \"callback\",\n \"id\": \"string\",\n \"created_at\": \"1987-09-04T00:38:57.277Z\",\n \"state\": \"string\",\n \"contact\": {\n \"value\": \"\"\n },\n \"call_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"snippet\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8370c88-5336-40f5-8f18-f2c4d2ca839b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "agent_id", "value": "string" }, { "key": "agent_id.gte", "value": "string" }, { "key": "agent_id.lte", "value": "string" }, { "key": "agent_id.gt", "value": "string" }, { "key": "agent_id.lt", "value": "string" }, { "key": "agent_id.in", "value": "string" }, { "key": "agent_version_id", "value": "string" }, { "key": "agent_version_id.gte", "value": "string" }, { "key": "agent_version_id.lte", "value": "string" }, { "key": "agent_version_id.gt", "value": "string" }, { "key": "agent_version_id.lt", "value": "string" }, { "key": "agent_version_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind.gte", "value": "string" }, { "key": "kind.lte", "value": "string" }, { "key": "kind.gt", "value": "string" }, { "key": "kind.lt", "value": "string" }, { "key": "kind.in", "value": "string" }, { "key": "phone_number_id", "value": "string" }, { "key": "phone_number_id.gte", "value": "string" }, { "key": "phone_number_id.lte", "value": "string" }, { "key": "phone_number_id.gt", "value": "string" }, { "key": "phone_number_id.lt", "value": "string" }, { "key": "phone_number_id.in", "value": "string" }, { "key": "state", "value": "string" }, { "key": "state.gte", "value": "string" }, { "key": "state.lte", "value": "string" }, { "key": "state.gt", "value": "string" }, { "key": "state.lt", "value": "string" }, { "key": "state.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0ad7a9c0-0f11-44bb-979d-09f1c2c5174d", "name": "handoff", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7eb64b37-8d67-4935-a3dc-553ccc3d2c49", "name": "List human handoff destinations", "request": { "name": "List human handoff destinations", "description": {}, "url": { "path": [ "v1", "human-reps" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8851c0c7-a18d-4991-aa78-01afa18d3a93", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "human-reps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"destination_e164\": \"string\",\n \"status\": \"active\",\n \"transfer_enabled\": true,\n \"created_at\": \"2001-05-24T00:44:52.546Z\",\n \"updated_at\": \"1967-10-13T00:35:21.314Z\",\n \"user_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"destination_e164\": \"string\",\n \"status\": \"inactive\",\n \"transfer_enabled\": false,\n \"created_at\": \"2018-01-25T08:40:01.492Z\",\n \"updated_at\": \"1948-07-05T15:13:06.123Z\",\n \"user_id\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "261490f6-b959-491a-b622-a5dbecfb8203", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "human-reps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c7d9cd0-d271-4869-a959-a641dcef405c", "name": "Create a tenant-owned human handoff destination", "request": { "name": "Create a tenant-owned human handoff destination", "description": {}, "url": { "path": [ "v1", "human-reps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"display_name\": \"string\",\n \"destination_e164\": \"+4485447412\",\n \"user_id\": \"string\",\n \"transfer_enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7a8d2300-ea62-4b9d-8a93-f51d9c01f266", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "human-reps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"display_name\": \"string\",\n \"destination_e164\": \"+4485447412\",\n \"user_id\": \"string\",\n \"transfer_enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"destination_e164\": \"string\",\n \"status\": \"active\",\n \"transfer_enabled\": true,\n \"created_at\": \"2022-10-21T02:39:47.656Z\",\n \"updated_at\": \"2005-10-27T23:32:11.407Z\",\n \"user_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "099d8091-3e1a-4768-9dba-65318837b92a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "human-reps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"display_name\": \"string\",\n \"destination_e164\": \"+4485447412\",\n \"user_id\": \"string\",\n \"transfer_enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3773855-7406-43c4-84fc-8b33a8ec8127", "name": "Update a human handoff destination", "request": { "name": "Update a human handoff destination", "description": {}, "url": { "path": [ "v1", "human-reps", ":rep_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "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 \"display_name\": \"string\",\n \"destination_e164\": \"+749629779064\",\n \"user_id\": \"string\",\n \"status\": \"inactive\",\n \"transfer_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e55b43ea-34c8-47d1-aaec-fa265b5bbdd5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "human-reps", ":rep_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "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 \"display_name\": \"string\",\n \"destination_e164\": \"+749629779064\",\n \"user_id\": \"string\",\n \"status\": \"inactive\",\n \"transfer_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"display_name\": \"string\",\n \"destination_e164\": \"string\",\n \"status\": \"active\",\n \"transfer_enabled\": true,\n \"created_at\": \"2022-10-21T02:39:47.656Z\",\n \"updated_at\": \"2005-10-27T23:32:11.407Z\",\n \"user_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3251f0cb-2835-4b1b-96ed-aa279c9a6fb4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "human-reps", ":rep_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "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 \"display_name\": \"string\",\n \"destination_e164\": \"+749629779064\",\n \"user_id\": \"string\",\n \"status\": \"inactive\",\n \"transfer_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2785b88d-3aff-4109-b32e-54de357510f1", "name": "List human-rep groups", "request": { "name": "List human-rep groups", "description": {}, "url": { "path": [ "v1", "rep-groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e389ff37-675a-4037-97ec-cb8f3db9ce06", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "rep-groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"selection_strategy\": \"string\",\n \"created_at\": \"1967-03-06T17:32:35.747Z\",\n \"updated_at\": \"1970-05-08T02:48:44.008Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"selection_strategy\": \"string\",\n \"created_at\": \"2007-03-27T23:09:41.739Z\",\n \"updated_at\": \"1982-12-30T23:25:58.379Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fefa903-5bd4-442e-95d6-e01ef9f696a1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "rep-groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df9fe3d0-258a-4c44-86bb-e0edbd9f881a", "name": "Create a tenant-owned human-rep group", "request": { "name": "Create a tenant-owned human-rep group", "description": {}, "url": { "path": [ "v1", "rep-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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\": \"string\",\n \"selection_strategy\": \"first_available\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e95bf036-4f10-4daa-938b-e5585a50ed57", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "rep-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"selection_strategy\": \"first_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"selection_strategy\": \"string\",\n \"created_at\": \"1993-05-25T03:42:26.464Z\",\n \"updated_at\": \"1950-03-27T08:10:15.740Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd5191e-d3d2-4221-95bc-c6b6c321426b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "rep-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"selection_strategy\": \"first_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5d01737-fb2f-4ce4-b6fd-2f8ee429e548", "name": "List members of a human-rep group", "request": { "name": "List members of a human-rep group", "description": {}, "url": { "path": [ "v1", "rep-groups", ":rep_group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1ab59bd1-e131-4cbf-9a69-bac10936968a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "rep-groups", ":rep_group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"rep_group_id\": \"string\",\n \"rep_id\": \"string\",\n \"added_at\": \"2006-11-25T09:36:35.338Z\"\n },\n {\n \"id\": \"string\",\n \"rep_group_id\": \"string\",\n \"rep_id\": \"string\",\n \"added_at\": \"2018-03-06T11:02:36.217Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92103a37-c977-44c5-acd1-e78c1e718f3a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "rep-groups", ":rep_group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1dd0eae-93e8-47f0-bc1f-af53c5358330", "name": "Ensure a human rep belongs to a group", "request": { "name": "Ensure a human rep belongs to a group", "description": {}, "url": { "path": [ "v1", "rep-groups", ":rep_group_id", "members", ":rep_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_group_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "de47ec70-fb39-4af6-8b95-4c12e1fcadb3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "rep-groups", ":rep_group_id", "members", ":rep_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_group_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"rep_group_id\": \"string\",\n \"rep_id\": \"string\",\n \"added_at\": \"1987-06-12T09:22:08.725Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad63bb9-5b6f-4d09-bcf3-b6d565981ee6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "rep-groups", ":rep_group_id", "members", ":rep_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_group_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "249f9ee4-dc05-4109-b56b-6d5dab1fc32d", "name": "Renew a short-lived manual human-rep availability lease", "request": { "name": "Renew a short-lived manual human-rep availability lease", "description": {}, "url": { "path": [ "v1", "human-reps", ":rep_id", "presence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"busy\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2f05f6cf-6518-495f-b317-ed9dce28c5d1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "human-reps", ":rep_id", "presence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"busy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rep_id\": \"string\",\n \"status\": \"available\",\n \"lease_expires_at\": \"2007-01-09T10:18:41.044Z\",\n \"last_heartbeat_at\": \"1960-08-31T05:23:44.325Z\",\n \"fresh\": true,\n \"manual_only\": true,\n \"automatic_transfer_eligible\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70335e0a-b2a6-4f88-9d14-3c621b982932", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "human-reps", ":rep_id", "presence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "rep_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"busy\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc1459d7-45e4-4b62-9917-d0232a521e90", "name": "Read truthful live handoff and supervision prerequisites for a call", "request": { "name": "Read truthful live handoff and supervision prerequisites for a call", "description": { "content": "Return a conservative capability answer; never imply carrier media exists.\n\nIt intentionally yields `200` with ``active: false`` for an absent/expired call rather\nthan using the permanent ``calls`` resource as a live-state oracle. A caller can poll\nthis during a conversation without learning whether an arbitrary historical call id\nexists, and no follow-up mutation becomes possible from this response alone.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "handoff-readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0e1c4070-c749-43bc-9ae3-d0f4c1e56966", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "handoff-readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"call_id\": \"string\",\n \"active\": true,\n \"transfer_available\": true,\n \"listen_in_available\": false,\n \"transport\": \"phone\",\n \"state\": \"expired\",\n \"expires_at\": \"2017-12-07T14:51:22.561Z\",\n \"manual_available_rep_ids\": [\n \"string\",\n \"string\"\n ],\n \"blockers\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eb6649f-da36-4c7b-b893-b6b3386d4dbb", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "handoff-readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "710dd7c1-71ad-471a-95c9-de35a25c727f", "name": "Mint a single-use short-lived listener capability for an eligible live call", "request": { "name": "Mint a single-use short-lived listener capability for an eligible live call", "description": { "content": "Issue no token unless the external listener will have a real, lawful source.\n\nThe token goes in the first WSS frame, never a URL. Its opaque JTI is consumed by the\ngateway's private attach request only after the socket is established; no bearer bytes\nland in the database or audit log.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "live-listen-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "81539770-efaf-4bfd-ae08-cec23673fafa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "live-listen-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"string\",\n \"token_id\": \"string\",\n \"call_id\": \"string\",\n \"actor_api_key_id\": \"string\",\n \"channel\": \"string\",\n \"expires_at\": \"2005-07-30T05:54:37.119Z\",\n \"listener_url\": \"string\",\n \"single_use\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a69bc3e6-610e-42b0-b7be-c3e53db87ff9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "live-listen-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "72881f44-48c3-4a9e-9038-cd7eb7e8d663", "name": "billing", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8be90a62-dad4-4f81-b5f8-ec52b2fa2826", "name": "Read the ledger-backed usage and current-plan projection for a call", "request": { "name": "Read the ledger-backed usage and current-plan projection for a call", "description": { "content": "One tenant-owned call's exact recorded usage and conservative cost visibility.\n\nA live call receives ``completed: false``. Its ``live_projection`` is populated only\nfor a verified managed prepaid test-call receipt; every other active lane is explicitly\npending rather than a partial carrier cost. For a completed call, `meters` combines\ndirect runtime attribution with a managed carrier's attempt-linked minute row. That\ncarrier row may still be absent while the callback is in flight; an empty list means no\nusage row has landed, not that a future invoice is $0.", "type": "text/plain" }, "url": { "path": [ "v1", "calls", ":call_id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "de8c5392-77c8-4128-98c5-5b56e1a50713", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"call_id\": \"string\",\n \"completed\": false,\n \"rating_status\": \"no_usage_recorded\",\n \"projection_status\": \"not_available\",\n \"meters\": [\n {\n \"meter\": \"llm_prompt_tokens\",\n \"quantity\": \"00000651838792.14370\",\n \"event_count\": 215,\n \"unrated_event_count\": 8003,\n \"rated_amount_minor\": 6086,\n \"prepaid_event_count\": 0\n },\n {\n \"meter\": \"tts_characters\",\n \"quantity\": \"-0008058296119968494\",\n \"event_count\": 8782,\n \"unrated_event_count\": 6393,\n \"rated_amount_minor\": 8814,\n \"prepaid_event_count\": 0\n }\n ],\n \"rated_usage_amount_minor\": 846,\n \"currency\": \"string\",\n \"billing_period_start\": \"1977-10-09T21:00:57.396Z\",\n \"billing_period_end\": \"1992-09-11T21:30:55.046Z\",\n \"projected_marginal_usage_amount_minor\": 7909,\n \"projection_unpriced_meters\": [\n \"llm_completion_tokens\",\n \"gpu_seconds\"\n ],\n \"prepaid_authorization_status\": \"not_applicable\",\n \"prepaid_reserved_amount_minor\": 4196,\n \"prepaid_captured_amount_minor\": 2664,\n \"live_projection\": {\n \"status\": \"not_available\",\n \"basis\": \"string\",\n \"connected_at\": \"2020-04-10T14:49:57.624Z\",\n \"projected_through\": \"2018-09-09T21:14:12.599Z\",\n \"elapsed_seconds\": 9610,\n \"projected_billable_seconds\": 4750,\n \"projected_amount_minor\": 7586,\n \"platform_rate_per_minute_minor\": \"-000000003879\",\n \"currency\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a37bd079-2d60-47c4-a448-e954fb11d01e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calls", ":call_id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "call_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37207d1d-fa01-4621-bc2e-2cc90ed0334e", "name": "One billing month across all nine meters", "request": { "name": "One billing month across all nine meters", "description": {}, "url": { "path": [ "v1", "usage", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "period", "value": "6109-12", "description": "Billing month, YYYY-MM" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7973473e-b8c6-4c0d-9056-8c42f0a815e5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "usage", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "6109-12" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"period\": \"string\",\n \"period_start\": \"2014-07-28T17:05:25.605Z\",\n \"period_end\": \"2008-12-29T01:05:46.998Z\",\n \"telephony_mode\": \"mixed\",\n \"meters\": [\n {\n \"meter\": \"telephony_minutes\",\n \"billing\": \"carrier_billed\",\n \"quantity\": \"+0000486034.8624\",\n \"event_count\": 5062,\n \"rated_amount_minor\": 1124,\n \"included_quantity\": \"+000758396.609840\",\n \"overage_quantity\": \"+000000062195.4854\"\n },\n {\n \"meter\": \"lookup_requests\",\n \"billing\": \"internal\",\n \"quantity\": \"2258663\",\n \"event_count\": 9740,\n \"rated_amount_minor\": 1598,\n \"included_quantity\": \"-0004945\",\n \"overage_quantity\": \"-00000003184842.60826\"\n }\n ],\n \"currency\": \"string\",\n \"rated_total_minor\": 3474,\n \"billing_period_estimate\": {\n \"period_start\": \"2011-12-17T09:47:56.886Z\",\n \"period_end\": \"2008-11-27T10:11:28.650Z\",\n \"base_price_minor\": 1622,\n \"usage_amount_minor\": 4170,\n \"total_amount_minor\": 6981,\n \"minutes_amount_minor\": 7778,\n \"call_fees_amount_minor\": 4876,\n \"volume_tier\": {\n \"value\": \"\"\n },\n \"unpriced_meters\": [\n \"llm_prompt_tokens\",\n \"llm_cached_prompt_tokens\"\n ],\n \"excluded_usage_types\": [\n \"separately_settled_prepaid_test_calls\",\n \"byo_carrier_usage\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcc4583d-a429-41eb-9c8c-5cb313942caa", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "usage", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "6109-12" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6ffd02a-da05-44dc-bb77-69a708590364", "name": "Page through the usage-event ledger", "request": { "name": "Page through the usage-event ledger", "description": {}, "url": { "path": [ "v1", "usage", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "call_id", "value": "string", "description": "Filter on `call_id`. Comma-separated values are OR." }, { "disabled": true, "key": "call_id.gte", "value": "string", "description": "Filter on `call_id` with the `gte` operator." }, { "disabled": true, "key": "call_id.lte", "value": "string", "description": "Filter on `call_id` with the `lte` operator." }, { "disabled": true, "key": "call_id.gt", "value": "string", "description": "Filter on `call_id` with the `gt` operator." }, { "disabled": true, "key": "call_id.lt", "value": "string", "description": "Filter on `call_id` with the `lt` operator." }, { "disabled": true, "key": "call_id.in", "value": "string", "description": "Filter on `call_id` with the `in` operator." }, { "disabled": true, "key": "campaign_id", "value": "string", "description": "Filter on `campaign_id`. Comma-separated values are OR." }, { "disabled": true, "key": "campaign_id.gte", "value": "string", "description": "Filter on `campaign_id` with the `gte` operator." }, { "disabled": true, "key": "campaign_id.lte", "value": "string", "description": "Filter on `campaign_id` with the `lte` operator." }, { "disabled": true, "key": "campaign_id.gt", "value": "string", "description": "Filter on `campaign_id` with the `gt` operator." }, { "disabled": true, "key": "campaign_id.lt", "value": "string", "description": "Filter on `campaign_id` with the `lt` operator." }, { "disabled": true, "key": "campaign_id.in", "value": "string", "description": "Filter on `campaign_id` with the `in` operator." }, { "disabled": true, "key": "meter", "value": "string", "description": "Filter on `meter`. Comma-separated values are OR." }, { "disabled": true, "key": "meter.gte", "value": "string", "description": "Filter on `meter` with the `gte` operator." }, { "disabled": true, "key": "meter.lte", "value": "string", "description": "Filter on `meter` with the `lte` operator." }, { "disabled": true, "key": "meter.gt", "value": "string", "description": "Filter on `meter` with the `gt` operator." }, { "disabled": true, "key": "meter.lt", "value": "string", "description": "Filter on `meter` with the `lt` operator." }, { "disabled": true, "key": "meter.in", "value": "string", "description": "Filter on `meter` with the `in` operator." }, { "disabled": true, "key": "occurred_at", "value": "string", "description": "Filter on `occurred_at`. Comma-separated values are OR." }, { "disabled": true, "key": "occurred_at.gte", "value": "string", "description": "Filter on `occurred_at` with the `gte` operator." }, { "disabled": true, "key": "occurred_at.lte", "value": "string", "description": "Filter on `occurred_at` with the `lte` operator." }, { "disabled": true, "key": "occurred_at.gt", "value": "string", "description": "Filter on `occurred_at` with the `gt` operator." }, { "disabled": true, "key": "occurred_at.lt", "value": "string", "description": "Filter on `occurred_at` with the `lt` operator." }, { "disabled": true, "key": "occurred_at.in", "value": "string", "description": "Filter on `occurred_at` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ef103071-579c-4890-9383-b922d5f29476", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "usage", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "meter", "value": "string" }, { "key": "meter.gte", "value": "string" }, { "key": "meter.lte", "value": "string" }, { "key": "meter.gt", "value": "string" }, { "key": "meter.lt", "value": "string" }, { "key": "meter.in", "value": "string" }, { "key": "occurred_at", "value": "string" }, { "key": "occurred_at.gte", "value": "string" }, { "key": "occurred_at.lte", "value": "string" }, { "key": "occurred_at.gt", "value": "string" }, { "key": "occurred_at.lt", "value": "string" }, { "key": "occurred_at.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"meter\": \"lookup_requests\",\n \"quantity\": \"-000000310158414.752263174\",\n \"occurred_at\": \"1967-07-13T04:22:40.648Z\",\n \"created_at\": \"1972-01-26T03:32:22.290Z\",\n \"call_id\": \"string\",\n \"campaign_id\": \"string\",\n \"rated_amount_minor\": 5287,\n \"attributes\": {\n \"key_0\": 49,\n \"key_1\": 6881.152188561994,\n \"key_2\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"meter\": \"stt_audio_seconds\",\n \"quantity\": \"+05642124720931\",\n \"occurred_at\": \"2014-11-03T19:15:24.892Z\",\n \"created_at\": \"2003-08-10T21:53:42.567Z\",\n \"call_id\": \"string\",\n \"campaign_id\": \"string\",\n \"rated_amount_minor\": 527,\n \"attributes\": {\n \"key_0\": 9001,\n \"key_1\": true\n }\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "805280fe-2761-451c-8ccc-b2b339131776", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "usage", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "call_id", "value": "string" }, { "key": "call_id.gte", "value": "string" }, { "key": "call_id.lte", "value": "string" }, { "key": "call_id.gt", "value": "string" }, { "key": "call_id.lt", "value": "string" }, { "key": "call_id.in", "value": "string" }, { "key": "campaign_id", "value": "string" }, { "key": "campaign_id.gte", "value": "string" }, { "key": "campaign_id.lte", "value": "string" }, { "key": "campaign_id.gt", "value": "string" }, { "key": "campaign_id.lt", "value": "string" }, { "key": "campaign_id.in", "value": "string" }, { "key": "meter", "value": "string" }, { "key": "meter.gte", "value": "string" }, { "key": "meter.lte", "value": "string" }, { "key": "meter.gt", "value": "string" }, { "key": "meter.lt", "value": "string" }, { "key": "meter.in", "value": "string" }, { "key": "occurred_at", "value": "string" }, { "key": "occurred_at.gte", "value": "string" }, { "key": "occurred_at.lte", "value": "string" }, { "key": "occurred_at.gt", "value": "string" }, { "key": "occurred_at.lt", "value": "string" }, { "key": "occurred_at.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b327056-3ac3-4d2b-a27d-a65c1ce6da8c", "name": "List invoices", "request": { "name": "List invoices", "description": {}, "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "period_start", "value": "string", "description": "Filter on `period_start`. Comma-separated values are OR." }, { "disabled": true, "key": "period_start.gte", "value": "string", "description": "Filter on `period_start` with the `gte` operator." }, { "disabled": true, "key": "period_start.lte", "value": "string", "description": "Filter on `period_start` with the `lte` operator." }, { "disabled": true, "key": "period_start.gt", "value": "string", "description": "Filter on `period_start` with the `gt` operator." }, { "disabled": true, "key": "period_start.lt", "value": "string", "description": "Filter on `period_start` with the `lt` operator." }, { "disabled": true, "key": "period_start.in", "value": "string", "description": "Filter on `period_start` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d3737595-4b86-4a2a-bb71-4762d6a68b64", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "period_start", "value": "string" }, { "key": "period_start.gte", "value": "string" }, { "key": "period_start.lte", "value": "string" }, { "key": "period_start.gt", "value": "string" }, { "key": "period_start.lt", "value": "string" }, { "key": "period_start.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"period_start\": \"1969-10-30T03:08:09.891Z\",\n \"period_end\": \"2012-01-01T20:15:15.105Z\",\n \"total_minor\": 2659,\n \"currency\": \"string\",\n \"status\": \"void\",\n \"created_at\": \"2020-10-09T01:35:39.477Z\",\n \"updated_at\": \"1958-09-21T05:55:50.093Z\",\n \"external_ref\": \"string\",\n \"hosted_invoice_url\": \"string\"\n },\n {\n \"id\": \"string\",\n \"period_start\": \"1991-09-01T13:27:41.826Z\",\n \"period_end\": \"1959-04-13T13:34:10.698Z\",\n \"total_minor\": 9069,\n \"currency\": \"string\",\n \"status\": \"void\",\n \"created_at\": \"1978-11-17T06:03:43.318Z\",\n \"updated_at\": \"2005-10-09T10:06:04.120Z\",\n \"external_ref\": \"string\",\n \"hosted_invoice_url\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67d4fbee-5294-4353-a6a2-7ff57b88c6b8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "period_start", "value": "string" }, { "key": "period_start.gte", "value": "string" }, { "key": "period_start.lte", "value": "string" }, { "key": "period_start.gt", "value": "string" }, { "key": "period_start.lt", "value": "string" }, { "key": "period_start.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc6931ba-300b-4ecd-ab15-2858e5e4748d", "name": "Read this tenant's subscription", "request": { "name": "Read this tenant's subscription", "description": {}, "url": { "path": [ "v1", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d24194f8-0aca-4b91-945d-d9b5f7e216da", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"active\",\n \"plan\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"base_price_minor\": 6774,\n \"currency\": \"string\",\n \"concurrency_limit\": 8121,\n \"included_quantities\": {\n \"key_0\": \"-06661103168.76768301\"\n },\n \"overage_rates\": {\n \"key_0\": \"000000006695713654473202\",\n \"key_1\": \"00048433089.83497\"\n },\n \"receptionist_connections_included\": 0,\n \"term\": \"mtm\",\n \"feature_flags\": {\n \"key_0\": 162,\n \"key_1\": \"string\"\n }\n },\n \"total_sessions\": 8460,\n \"total_receptionist_connections\": 9982,\n \"minute_rate_minor\": \"0000081.21621494\",\n \"current_period_start\": \"1985-06-21T11:19:46.808Z\",\n \"current_period_end\": \"1975-05-29T11:30:32.961Z\",\n \"created_at\": \"1964-02-08T16:38:21.185Z\",\n \"updated_at\": \"1995-10-23T18:41:24.935Z\",\n \"workload_class\": \"sales\",\n \"extra_sessions\": 0,\n \"receptionist_connections\": 0,\n \"overrides\": {\n \"key_0\": 147.62208372160134\n },\n \"spend_cap\": {\n \"amount_minor\": 1380,\n \"source\": \"wallet\",\n \"period\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d049600c-8a00-4bc1-b7c3-6a6dbff4860b", "name": "Start this tenant's production subscription", "request": { "name": "Start this tenant's production subscription", "description": { "content": "Subscribe this tenant without ever retrying an ambiguous Stripe create blindly.\n\nThe request has three independently committed phases: a tenant-unique operation before\nStripe I/O, the provider correlation after Stripe answers, then the local subscription\nmirror. A crash after any phase leaves a durable recovery point. In particular, a\nretry that finds ``pending`` does **not** make another Stripe POST: its first outcome is\nunknown and a signed ``customer.subscription.created`` webhook must reconcile it.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription" ], "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 \"workload_class\": \"sales\",\n \"term\": \"mtm\",\n \"extra_sessions\": 0,\n \"receptionist_connections\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "85844c54-a1d0-4acb-9ecd-633c5286e278", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription" ], "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 \"workload_class\": \"sales\",\n \"term\": \"mtm\",\n \"extra_sessions\": 0,\n \"receptionist_connections\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscription_id\": \"string\",\n \"external_ref\": \"string\",\n \"status\": \"string\",\n \"plan_id\": \"string\",\n \"plan_name\": \"string\",\n \"workload_class\": \"engage\",\n \"term\": \"mtm\",\n \"base_price_minor\": 5734,\n \"currency\": \"string\",\n \"extra_sessions\": 9243,\n \"total_sessions\": 8995,\n \"extra_session_monthly_minor\": 2345,\n \"receptionist_connections\": 3106,\n \"total_receptionist_connections\": 5375,\n \"receptionist_base_monthly_minor\": 3719,\n \"receptionist_connection_monthly_minor\": 6845,\n \"current_period_start\": \"2020-07-12T17:19:46.490Z\",\n \"current_period_end\": \"1965-02-02T11:25:57.106Z\",\n \"sandbox_credit_redeemed_minor\": 4823,\n \"sandbox_credit_unconfirmed\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "872fc8e7-4f7b-4875-9b2e-049e0dcdb9d9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription" ], "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 \"workload_class\": \"sales\",\n \"term\": \"mtm\",\n \"extra_sessions\": 0,\n \"receptionist_connections\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f21c87bd-fdcf-4270-b4ec-c7044baa9b64", "name": "Read verified original commitment dates", "request": { "name": "Read verified original commitment dates", "description": { "content": "Read the original 36-calendar-month term without changing billing or service.\n\nDates require verified checkout and agreement provenance and survive paid plan upgrades.\nMonthly terms return `not_committed`; unverified histories return `review_required`.\n`term_elapsed` reports the anniversary only, not a renewal or cancellation decision.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription", "commitment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "91e0c900-eefb-4d12-98ca-947246224a2f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "commitment" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"starts_at\": \"1967-07-19T14:10:10.039Z\",\n \"ends_at\": \"1969-12-25T21:15:39.569Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9bb1cec-85cc-4297-bba4-999aca587565", "name": "Read this tenant's budget", "request": { "name": "Read this tenant's budget", "description": {}, "url": { "path": [ "v1", "billing", "budget" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a67f15b6-1c5e-46fd-bdd3-4b7b66e83365", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "budget" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"string\",\n \"balance_minor\": 9745,\n \"spend_cap_minor\": 6814,\n \"spend_cap_period\": \"string\",\n \"low_balance_threshold_minor\": 5769,\n \"period_spend_minor\": 9032,\n \"unpriced_meters\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36320268-4dc2-494f-a701-2edabcb3e20c", "name": "Set this tenant's budget", "request": { "name": "Set this tenant's budget", "description": { "content": "Set the spend cap and the low-balance floor. This is the cap the pacer enforces.\n\nNo audit action id and no step-up: this is the *tenant* setting its own budget on its\nown money, not staff moving someone else's (that path is\n`PATCH /admin/tenants/{id}/subscription`, which is `critical` and step-up-gated for\nexactly that reason - docs/19 §6.1).", "type": "text/plain" }, "url": { "path": [ "v1", "billing", "budget" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"spend_cap_minor\": 2841,\n \"spend_cap_period\": \"month\",\n \"low_balance_threshold_minor\": 2119\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7a55647f-e727-4580-8a4e-ce62c4a8f772", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "budget" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"spend_cap_minor\": 2841,\n \"spend_cap_period\": \"month\",\n \"low_balance_threshold_minor\": 2119\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"string\",\n \"balance_minor\": 9745,\n \"spend_cap_minor\": 6814,\n \"spend_cap_period\": \"string\",\n \"low_balance_threshold_minor\": 5769,\n \"period_spend_minor\": 9032,\n \"unpriced_meters\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29673959-16db-4912-88e9-8a2fb4a6d762", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "billing", "budget" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"spend_cap_minor\": 2841,\n \"spend_cap_period\": \"month\",\n \"low_balance_threshold_minor\": 2119\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88d787b4-a545-43f6-be57-0305a9d2596d", "name": "Set this tenant's purchased extra concurrent sessions", "request": { "name": "Set this tenant's purchased extra concurrent sessions", "description": { "content": "Set purchased outbound capacity using a durable provider operation.\n\nRead live items before claiming the frozen mutation. A committed claim owns the\nsource across provider I/O; exact provider correlation and local completion are\nrequired before returning success. A retry can recover an earlier request before\napplying a different absolute target. Stripe's default proration is retained.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription", "extra-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"extra_sessions\": 2017\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a0ecc7d-03b8-47d3-9b7d-bed3f03585aa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "extra-sessions" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"extra_sessions\": 2017\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"active\",\n \"plan\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"base_price_minor\": 6774,\n \"currency\": \"string\",\n \"concurrency_limit\": 8121,\n \"included_quantities\": {\n \"key_0\": \"-06661103168.76768301\"\n },\n \"overage_rates\": {\n \"key_0\": \"000000006695713654473202\",\n \"key_1\": \"00048433089.83497\"\n },\n \"receptionist_connections_included\": 0,\n \"term\": \"mtm\",\n \"feature_flags\": {\n \"key_0\": 162,\n \"key_1\": \"string\"\n }\n },\n \"total_sessions\": 8460,\n \"total_receptionist_connections\": 9982,\n \"minute_rate_minor\": \"0000081.21621494\",\n \"current_period_start\": \"1985-06-21T11:19:46.808Z\",\n \"current_period_end\": \"1975-05-29T11:30:32.961Z\",\n \"created_at\": \"1964-02-08T16:38:21.185Z\",\n \"updated_at\": \"1995-10-23T18:41:24.935Z\",\n \"workload_class\": \"sales\",\n \"extra_sessions\": 0,\n \"receptionist_connections\": 0,\n \"overrides\": {\n \"key_0\": 147.62208372160134\n },\n \"spend_cap\": {\n \"amount_minor\": 1380,\n \"source\": \"wallet\",\n \"period\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ffb0d8-57c5-4668-a1cd-bd5071a109ec", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "extra-sessions" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"extra_sessions\": 2017\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e52ef62-e973-4112-8d3a-df95bd77874a", "name": "Set this tenant's purchased receptionist connections", "request": { "name": "Set this tenant's purchased receptionist connections", "description": { "content": "Converge the receptionist connection count at Stripe and locally (ADR-0025).\n\n**An added connection is paid for before it is reserved, and it is paid for a full\nmonth** (the owner's decision of 2026-08-18). A receptionist connection is not a line\non a bill - it is a GPU slot withheld from every other claim on this platform for as\nlong as the tenant holds it, so granting one on the strength of an invoice that\nrenders up to a month later hands out physical capacity on credit. So an INCREASE\ncollects `250·Δbase + 150·Δadditional` immediately\n(`_receptionist_month_due_minor`), and only a collected charge reaches\n`set_receptionist_connections` and the capacity refresh below. The recurring items are\nmoved with `proration_behavior=\"none\"` because Stripe would otherwise ALSO invoice a\nprorated stub for the same days at the next renewal - the customer would pay the\nremainder of this month twice - and the recurring price then simply starts at the next\nrenewal.\n\nA DECREASE is gated on no payment and on no billing state a customer can be trapped\nin: giving capacity back costs this platform nothing to accept, and refusing it would\nbe refusing to stop charging someone. That last clause used to be a claim the code did\nnot keep - the `subscription_inactive` guard ran before the direction was known and\nrefused BOTH directions, so a `past_due` tenant could not lower the bill it was\nalready behind on, which is the one tenant most likely to be asking. The guard is now\nsplit by direction: only an INCREASE is held to `_RECEPTIONIST_PURCHASE_STATUSES`,\nwhile a decrease is accepted wherever the Stripe subscription still has items to\nchange (`_RECEPTIONIST_RELEASE_STATUSES`). It refunds nothing either - the month was\nprepaid, which is the honest consequence of the decision above and which the portal\nstates before the customer confirms rather than this endpoint discovering for them.\n\nThe extra-sessions endpoint's discipline over TWO items instead of one. Absolute\nsemantics are what make it safely retryable without a durable provisioning operation:\nan ambiguous outcome cannot double a fee, because setting N twice is setting N. A\ndefinite Stripe success updates the local row; an ambiguous outcome leaves it untouched\nand answers 502 `receptionist_connections_update_unconfirmed`, with the signed\n`customer.subscription.updated` webhook as the reconciler.\n\nThe charge is under that same definite-versus-ambiguous split and carries codes of its\nown, because \"your card said no\" and \"the item change failed\" send the customer to\ndifferent places: `402 receptionist_connections_charge_declined` is a clean refusal\nthat changed nothing at all, and `502 receptionist_connections_charge_unconfirmed`\nsays the money may have moved while no subscription item did - the local count is\nuntouched, no webhook is coming for it, and the resolution is re-sending the same\nabsolute target, which replays the same charge instead of collecting a second month\n(`_receptionist_charge_idempotency_key`).\n\nA third, `402 receptionist_connections_charge_authentication_required`, makes the same\nstatement about the money as the decline and the opposite statement about the cure: the\ncard works and the issuer wants the customer present to authenticate, so the invoice\nthe attempt left open is where the payment is completed and the card must NOT be\nreplaced. It is a separate code because the code is the only thing a client can branch\non, and while it shared the decline's every portal pinned to that code told the\ncustomer to change a payment method that was never refused.\n\nBoth 402s name the invoice their attempt left behind rather than pretending it is not\nthere. A failed `pay` leaves a FINALIZED, OPEN invoice that the tenant's own\n`GET /v1/invoices` mirror shows, voiding it would break the \"send the same number\nagain\" cure that replays onto it, and a refusal that told a customer to ignore an\ninvoice they can see is how a support ticket becomes a chargeback.\n\nThat promise needs one thing absolute semantics cannot supply on their own, and it is\nthe same thing in every part of the request: what Stripe actually holds. Every\nambiguous outcome here leaves the local row behind on purpose, so the row lags a change\nthat landed - in its item ids, which would make a retried 0 -> N first purchase ADD a\nsecond item and invoice $250 or $150 twice, AND in its count, which would make the\nnext genuinely different target collect a month for connections Stripe already bills.\nSo the request reads the live item set once (`_held_licensed_items`) and that one read\ndecides all four of whether there is anything to do, the mutation, the amount, and the\ncharge's idempotency key.\n\n**Whether there is anything to do is the one that is not obvious, and it is not a\nquestion the local row may answer.** A target equal to the count the row shows looks\nlike a request with nothing to do - and that is precisely the shape of the customer's\nnatural \"give the connection back\" after an ambiguous 1 -> 2 landed at Stripe and not\nhere: it answered 200, sent Stripe nothing, and left the $150 item billing for as long\nas the subscription lived. The undocumented cure was to set a HIGHER number first and\nthen the lower one, which no customer discovers. So a request that would change\nStripe's items now makes that change whatever the local row says, and only a\nsubscription Stripe already holds at the target quantities is answered without a\nmutation. The money rules are unmoved by it: a decrease still collects nothing, and an\nincrease is still priced from what Stripe holds, so converging a row onto items the\ncustomer already paid for is free.\n\nTwo items rather than one because the first connection is $250 and the rest are $150\neach, and which of them a subscription holds depends on its plan: a standalone\nreceptionist plan already includes the first, an outbound plan attaching a receptionist\nbuys it. `rate_card.receptionist_line_items` owns that split; this route only converges\nwhatever it returns, and it moves both items in ONE Stripe request so no invoice can\nshow the additional connections billed while the first one is not.\n\n**A comped or internal tenant skips the prepay entirely**\n(`_PREPAY_EXEMPT_COMMERCIAL_STATUSES`): the ADR-0026 d3 hardening removed their\ndefault payment method on purpose, so collecting would 402 on every increase forever.\nThe items move, the local count is written, no invoice is raised and no card exists to\ncharge - the recurring price simply lands on the next `send_invoice` invoice at full\nvalue, where the credit note offsets it.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription", "receptionist-connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"receptionist_connections\": 5945\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e5500fdd-3b8e-463c-9610-2a1be7c2f94c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-connections" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"receptionist_connections\": 5945\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"active\",\n \"plan\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"base_price_minor\": 6774,\n \"currency\": \"string\",\n \"concurrency_limit\": 8121,\n \"included_quantities\": {\n \"key_0\": \"-06661103168.76768301\"\n },\n \"overage_rates\": {\n \"key_0\": \"000000006695713654473202\",\n \"key_1\": \"00048433089.83497\"\n },\n \"receptionist_connections_included\": 0,\n \"term\": \"mtm\",\n \"feature_flags\": {\n \"key_0\": 162,\n \"key_1\": \"string\"\n }\n },\n \"total_sessions\": 8460,\n \"total_receptionist_connections\": 9982,\n \"minute_rate_minor\": \"0000081.21621494\",\n \"current_period_start\": \"1985-06-21T11:19:46.808Z\",\n \"current_period_end\": \"1975-05-29T11:30:32.961Z\",\n \"created_at\": \"1964-02-08T16:38:21.185Z\",\n \"updated_at\": \"1995-10-23T18:41:24.935Z\",\n \"workload_class\": \"sales\",\n \"extra_sessions\": 0,\n \"receptionist_connections\": 0,\n \"overrides\": {\n \"key_0\": 147.62208372160134\n },\n \"spend_cap\": {\n \"amount_minor\": 1380,\n \"source\": \"wallet\",\n \"period\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8928dde8-9b37-4d20-8e8f-9440e4e6f5b0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-connections" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"receptionist_connections\": 5945\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d58859f5-7eed-4fe4-8d2c-b75a6180bd67", "name": "Active Expansion", "request": { "name": "Active Expansion", "description": { "content": "Recover the in-progress purchase when the customer returns on another device.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription", "expansions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f4becc83-5b3a-4937-a734-1b542e1a724b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c2cea29-7796-4d7e-97f9-61da6295d657", "name": "Quote Expansion", "request": { "name": "Quote Expansion", "description": {}, "url": { "path": [ "v1", "subscription", "expansions" ], "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 \"target_class\": \"workforce\",\n \"request_key\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0f0fb20-a789-4b80-b7cf-59de25fc106e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions" ], "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 \"target_class\": \"workforce\",\n \"request_key\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d9aaf8c-4ba2-42f5-bb9c-acdd4a69fc12", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions" ], "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 \"target_class\": \"workforce\",\n \"request_key\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b3394ca-707c-4312-b6da-f5214ff1ac7d", "name": "Get Expansion", "request": { "name": "Get Expansion", "description": {}, "url": { "path": [ "v1", "subscription", "expansions", ":intent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "77d2be5e-611d-4784-a7ae-8c223d4221bf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0202c33a-dabc-4de6-b689-a35341e83c24", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d801dc4f-8468-48ce-ad96-d2116b0099f6", "name": "Cancel Expansion", "request": { "name": "Cancel Expansion", "description": {}, "url": { "path": [ "v1", "subscription", "expansions", ":intent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6ee76a78-d0b7-40ed-9a0d-161e2fb056c0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e0bb13-3f23-41ea-8bc1-c65eccc0fbf1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e01b49ae-1d02-4b82-a104-48641c9bbfcd", "name": "Checkout Expansion", "request": { "name": "Checkout Expansion", "description": { "content": "Confirm a reviewed price and open its original hosted payment page.\n\nA 202 response retains the same purchase for recovery; it is not proof of payment.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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 \"amount_due_minor\": 753,\n \"currency\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5390c870-0dfc-4513-aa35-933943547aa1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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 \"amount_due_minor\": 753,\n \"currency\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "244067bb-0838-45ac-a79b-c5add5f6ad7d", "name": "Purchase remains pending", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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 \"amount_due_minor\": 753,\n \"currency\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2be937f-2722-4576-914b-3ac95c522b4b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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 \"amount_due_minor\": 753,\n \"currency\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "305f87ea-f537-4e34-aa60-a1d862c64cbb", "name": "Recover Expansion", "request": { "name": "Recover Expansion", "description": { "content": "Recover the original payment and activation; never create another Checkout.\n\nRecovery remains available when new purchases are disabled. A verified payment\ncan finish its existing plan change and refresh purchased capacity.", "type": "text/plain" }, "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e527317d-c17b-4022-9d76-a28b8ff6bdec", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba4836f8-af69-47df-bb2b-f6e7ff0d4ded", "name": "Recovery remains pending", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"source_plan_id\": \"string\",\n \"target_plan_id\": \"string\",\n \"source_class\": \"engage\",\n \"target_class\": \"engage\",\n \"term\": \"mtm\",\n \"amount_due_minor\": 5024,\n \"currency\": \"string\",\n \"source_monthly_minor\": 7922,\n \"target_monthly_minor\": 7121,\n \"total_inbound_connections\": 3716,\n \"total_outbound_sessions\": 1753,\n \"minute_rate_minor\": \"+000784777192\",\n \"attempt_fee_minor\": \"000000000022945628.523894\",\n \"volume_ladder_applies\": true,\n \"expires_at\": \"2020-12-16T15:02:48.171Z\",\n \"checkout_available\": false,\n \"checkout_url\": \"string\",\n \"checkout_expires_at\": \"1988-09-17T05:55:23.886Z\",\n \"payment_received\": false,\n \"failure_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1f5ed6-c913-4423-a302-8ca6f3269a91", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "expansions", ":intent_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "intent_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cab5741-b0d6-41df-ae81-7e8e87985c6f", "name": "Quote Receptionist Connections", "request": { "name": "Quote Receptionist Connections", "description": {}, "url": { "path": [ "v1", "subscription", "receptionist-connections", "quote" ], "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 \"receptionist_connections\": 7635\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b17708a1-4656-4a80-bd91-113e0f068333", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-connections", "quote" ], "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 \"receptionist_connections\": 7635\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"receptionist_connections\": 4524,\n \"total_inbound_connections\": 7044,\n \"amount_due_minor\": 4243,\n \"recurring_connections_minor\": 3193,\n \"renewal_at\": \"1959-01-04T19:31:18.601Z\",\n \"quote_fingerprint\": \"string\",\n \"purchase_available\": false,\n \"prepay_exempt\": true,\n \"currency\": \"usd\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99b6e342-f7a2-4498-8ddc-312fab588ec0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-connections", "quote" ], "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 \"receptionist_connections\": 7635\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c593bb85-d759-4c1d-94ea-54873f7f763b", "name": "Active Receptionist Purchase", "request": { "name": "Active Receptionist Purchase", "description": {}, "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "request_key", "value": "n" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "499b0a0b-46f5-42d4-9887-85a83c9d2539", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "request_key", "value": "n" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"receptionist_connections\": 8043,\n \"total_inbound_connections\": 7176,\n \"amount_due_minor\": 9563,\n \"recurring_connections_minor\": 6060,\n \"renewal_at\": \"1951-08-15T00:12:01.298Z\",\n \"failure_code\": \"string\",\n \"currency\": \"usd\",\n \"payment_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9327c0f2-8b10-4073-8b5e-05f7c72be252", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "request_key", "value": "n" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba2ef1f8-c924-4401-8a9c-2514454b26f1", "name": "Purchase Receptionist Connections", "request": { "name": "Purchase Receptionist Connections", "description": {}, "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "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 \"receptionist_connections\": 5857,\n \"request_key\": \"+\",\n \"amount_due_minor\": 6596,\n \"currency\": \"string\",\n \"quote_fingerprint\": \"618e8d586f74b45c480757a3a341b5c9efeedd2bad89c5f7400b1fc1e4aa1bdf\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ffb7b243-e867-498b-939a-c5d25cde7e9f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "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 \"receptionist_connections\": 5857,\n \"request_key\": \"+\",\n \"amount_due_minor\": 6596,\n \"currency\": \"string\",\n \"quote_fingerprint\": \"618e8d586f74b45c480757a3a341b5c9efeedd2bad89c5f7400b1fc1e4aa1bdf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"receptionist_connections\": 8043,\n \"total_inbound_connections\": 7176,\n \"amount_due_minor\": 9563,\n \"recurring_connections_minor\": 6060,\n \"renewal_at\": \"1951-08-15T00:12:01.298Z\",\n \"failure_code\": \"string\",\n \"currency\": \"usd\",\n \"payment_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e046e0ff-9b51-4aae-b599-a23e735206f6", "name": "Purchase remains pending", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "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 \"receptionist_connections\": 5857,\n \"request_key\": \"+\",\n \"amount_due_minor\": 6596,\n \"currency\": \"string\",\n \"quote_fingerprint\": \"618e8d586f74b45c480757a3a341b5c9efeedd2bad89c5f7400b1fc1e4aa1bdf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"receptionist_connections\": 8043,\n \"total_inbound_connections\": 7176,\n \"amount_due_minor\": 9563,\n \"recurring_connections_minor\": 6060,\n \"renewal_at\": \"1951-08-15T00:12:01.298Z\",\n \"failure_code\": \"string\",\n \"currency\": \"usd\",\n \"payment_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cec730e9-4da7-46ca-916c-c1ffe3fc61ca", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases" ], "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 \"receptionist_connections\": 5857,\n \"request_key\": \"+\",\n \"amount_due_minor\": 6596,\n \"currency\": \"string\",\n \"quote_fingerprint\": \"618e8d586f74b45c480757a3a341b5c9efeedd2bad89c5f7400b1fc1e4aa1bdf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5c20284-fc6e-4690-b939-9ed00b9769e5", "name": "Get Receptionist Purchase", "request": { "name": "Get Receptionist Purchase", "description": {}, "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "776ec5b5-52db-4c8c-82df-027804746f7b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"receptionist_connections\": 8043,\n \"total_inbound_connections\": 7176,\n \"amount_due_minor\": 9563,\n \"recurring_connections_minor\": 6060,\n \"renewal_at\": \"1951-08-15T00:12:01.298Z\",\n \"failure_code\": \"string\",\n \"currency\": \"usd\",\n \"payment_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d87ea897-716e-4133-bbfa-57b625196204", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98e5ccf7-7a91-455b-b10b-b34c411c5beb", "name": "Recover Receptionist Purchase", "request": { "name": "Recover Receptionist Purchase", "description": {}, "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "02db2f85-edcb-4bac-a220-825550697c54", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"receptionist_connections\": 8043,\n \"total_inbound_connections\": 7176,\n \"amount_due_minor\": 9563,\n \"recurring_connections_minor\": 6060,\n \"renewal_at\": \"1951-08-15T00:12:01.298Z\",\n \"failure_code\": \"string\",\n \"currency\": \"usd\",\n \"payment_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db5b6e1c-7fe2-43eb-9bca-bfa76c22a37b", "name": "Recovery remains pending", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"receptionist_connections\": 8043,\n \"total_inbound_connections\": 7176,\n \"amount_due_minor\": 9563,\n \"recurring_connections_minor\": 6060,\n \"renewal_at\": \"1951-08-15T00:12:01.298Z\",\n \"failure_code\": \"string\",\n \"currency\": \"usd\",\n \"payment_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4271e5b4-d4ba-410f-bd8e-2e135577b14b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "subscription", "receptionist-purchases", ":purchase_id", "recover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "purchase_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72712d50-5e9a-471d-a98c-46506bb67a2c", "name": "Read prepaid managed-call credit", "request": { "name": "Read prepaid managed-call credit", "description": {}, "url": { "path": [ "v1", "billing", "prepaid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1d75fea0-d5a8-4e08-8c1c-bbc990a865ae", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "prepaid" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"string\",\n \"prepaid_balance_minor\": 3837,\n \"prepaid_reserved_minor\": 9051,\n \"prepaid_available_minor\": 3482,\n \"spend_cap_minor\": 7898,\n \"spend_cap_period\": \"string\",\n \"low_balance_threshold_minor\": 5521,\n \"funding_min_minor\": 475,\n \"funding_max_minor\": 9725,\n \"funding_intents\": [\n {\n \"id\": \"string\",\n \"amount_minor\": 8645,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"checkout_url\": \"string\",\n \"expires_at\": \"1988-07-29T09:01:26.750Z\",\n \"pending\": false\n },\n {\n \"id\": \"string\",\n \"amount_minor\": 8280,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"checkout_url\": \"string\",\n \"expires_at\": \"1998-06-17T10:20:02.710Z\",\n \"pending\": false\n }\n ],\n \"receipts\": [\n {\n \"id\": \"string\",\n \"funding_intent_id\": \"string\",\n \"kind\": \"string\",\n \"amount_minor\": 7526,\n \"currency\": \"string\",\n \"created_at\": \"1998-08-09T03:58:01.325Z\"\n },\n {\n \"id\": \"string\",\n \"funding_intent_id\": \"string\",\n \"kind\": \"string\",\n \"amount_minor\": 3532,\n \"currency\": \"string\",\n \"created_at\": \"1978-04-05T17:10:16.447Z\"\n }\n ],\n \"reconciliations\": [\n {\n \"id\": \"string\",\n \"contact_attempt_id\": \"string\",\n \"status\": \"string\",\n \"reason\": \"string\",\n \"provider_call_id\": \"string\",\n \"actual_billed_seconds\": \"+000078304.36825448\",\n \"actual_amount_minor\": 3388,\n \"required_at\": \"1994-04-08T02:21:40.778Z\",\n \"resolved_at\": \"2009-12-07T17:57:21.359Z\",\n \"created_at\": \"1950-05-01T01:32:27.661Z\"\n },\n {\n \"id\": \"string\",\n \"contact_attempt_id\": \"string\",\n \"status\": \"string\",\n \"reason\": \"string\",\n \"provider_call_id\": \"string\",\n \"actual_billed_seconds\": \"813454372187423409\",\n \"actual_amount_minor\": 140,\n \"required_at\": \"1995-06-27T23:18:05.964Z\",\n \"resolved_at\": \"1956-09-26T03:54:26.185Z\",\n \"created_at\": \"2014-03-17T18:45:05.763Z\"\n }\n ],\n \"applies_to\": \"managed_verified_number_test_calls_only\",\n \"auto_recharge_supported\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b456fbf-a0fd-4153-972e-8141367b4615", "name": "Open Stripe Checkout for manual prepaid managed-call credit", "request": { "name": "Open Stripe Checkout for manual prepaid managed-call credit", "description": { "content": "Create/recover one funding intent, then ask Stripe for its hosted Checkout URL.\n\nA transport timeout deliberately returns ``202`` *without* rolling the new intent\nback. Stripe may have accepted the request, so retrying the same key reuses the local\nintent id and Stripe idempotency key instead of risking a second charge.", "type": "text/plain" }, "url": { "path": [ "v1", "billing", "prepaid", "funding-intents" ], "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 \"amount_minor\": 9260,\n \"idempotency_key\": \"stringstring\",\n \"currency\": \"usd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d637bc90-34cf-4f8d-985d-ac7a441e555c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "prepaid", "funding-intents" ], "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 \"amount_minor\": 9260,\n \"idempotency_key\": \"stringstring\",\n \"currency\": \"usd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"amount_minor\": 7476,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"checkout_url\": \"string\",\n \"expires_at\": \"1992-03-21T17:39:21.590Z\",\n \"pending\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd66fec3-ba4b-45e0-bd29-9931c071abf6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "billing", "prepaid", "funding-intents" ], "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 \"amount_minor\": 9260,\n \"idempotency_key\": \"stringstring\",\n \"currency\": \"usd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86924e9f-0dc7-4698-a174-a328a3f19716", "name": "Read automatic prepaid managed-test-call funding configuration", "request": { "name": "Read automatic prepaid managed-test-call funding configuration", "description": {}, "url": { "path": [ "v1", "billing", "prepaid", "auto-fund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad2cb7a8-2093-439f-96d0-03ad8858a5b0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "prepaid", "auto-fund" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"available\": true,\n \"funding_min_minor\": 2730,\n \"funding_max_minor\": 6559,\n \"period_cap_max_minor\": 337,\n \"enabled\": true,\n \"status\": \"string\",\n \"currency\": \"string\",\n \"threshold_minor\": 5448,\n \"amount_minor\": 7346,\n \"period_cap_minor\": 9958,\n \"period_remaining_minor\": 777,\n \"period\": \"calendar_month\",\n \"period_used_minor\": 0,\n \"period_pending_minor\": 0,\n \"setup\": {\n \"id\": \"string\",\n \"status\": \"string\",\n \"checkout_url\": \"string\",\n \"pending\": false\n },\n \"active_operation\": {\n \"id\": \"string\",\n \"status\": \"string\",\n \"amount_minor\": 6846,\n \"provider_requested_at\": \"2008-06-01T15:16:55.977Z\",\n \"payment_intent_id\": \"string\",\n \"failure_code\": \"string\"\n },\n \"last_failure_code\": \"string\",\n \"applies_to\": \"managed_verified_number_test_calls_only\",\n \"byo_campaigns_chargeable\": false,\n \"schedule\": \"server_threshold_polling\",\n \"cadence\": \"as_needed\",\n \"minimum_charge_interval_seconds\": 0,\n \"cadence_options\": [\n {\n \"cadence\": \"at_most_once_per_24h\",\n \"minimum_charge_interval_seconds\": 8660\n },\n {\n \"cadence\": \"at_most_once_per_24h\",\n \"minimum_charge_interval_seconds\": 7136\n }\n ],\n \"cadence_hold_until\": \"1968-02-13T03:56:38.161Z\",\n \"accepted_mandate_version\": \"string\",\n \"accepted_mandate_text\": \"string\",\n \"mandate_version\": \"2026-08-12-cadence-v2\",\n \"mandate_text\": \"I authorize Vocapable to charge the payment method I set up for future automatic prepaid managed verified-number test-call credit when my eligible prepaid balance is at or below my selected threshold, for my selected amount, up to my selected calendar-month cap and no more often than my selected cadence measured from the prior submitted charge attempt. Vocapable does not promise a clock time or catch up a missed attempt. I can disable this at any time before a charge is submitted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c82bb578-f687-42c3-b1fb-fe2de0537592", "name": "Enable, change, or disable automatic prepaid managed-test-call funding", "request": { "name": "Enable, change, or disable automatic prepaid managed-test-call funding", "description": {}, "url": { "path": [ "v1", "billing", "prepaid", "auto-fund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"threshold_minor\": 8544,\n \"amount_minor\": 6591,\n \"period_cap_minor\": 9769,\n \"period\": \"calendar_month\",\n \"cadence\": \"as_needed\",\n \"mandate_accepted\": false,\n \"idempotency_key\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "69491e09-a144-4b45-99cd-2da96be33c40", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "prepaid", "auto-fund" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"threshold_minor\": 8544,\n \"amount_minor\": 6591,\n \"period_cap_minor\": 9769,\n \"period\": \"calendar_month\",\n \"cadence\": \"as_needed\",\n \"mandate_accepted\": false,\n \"idempotency_key\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"available\": true,\n \"funding_min_minor\": 2730,\n \"funding_max_minor\": 6559,\n \"period_cap_max_minor\": 337,\n \"enabled\": true,\n \"status\": \"string\",\n \"currency\": \"string\",\n \"threshold_minor\": 5448,\n \"amount_minor\": 7346,\n \"period_cap_minor\": 9958,\n \"period_remaining_minor\": 777,\n \"period\": \"calendar_month\",\n \"period_used_minor\": 0,\n \"period_pending_minor\": 0,\n \"setup\": {\n \"id\": \"string\",\n \"status\": \"string\",\n \"checkout_url\": \"string\",\n \"pending\": false\n },\n \"active_operation\": {\n \"id\": \"string\",\n \"status\": \"string\",\n \"amount_minor\": 6846,\n \"provider_requested_at\": \"2008-06-01T15:16:55.977Z\",\n \"payment_intent_id\": \"string\",\n \"failure_code\": \"string\"\n },\n \"last_failure_code\": \"string\",\n \"applies_to\": \"managed_verified_number_test_calls_only\",\n \"byo_campaigns_chargeable\": false,\n \"schedule\": \"server_threshold_polling\",\n \"cadence\": \"as_needed\",\n \"minimum_charge_interval_seconds\": 0,\n \"cadence_options\": [\n {\n \"cadence\": \"at_most_once_per_24h\",\n \"minimum_charge_interval_seconds\": 8660\n },\n {\n \"cadence\": \"at_most_once_per_24h\",\n \"minimum_charge_interval_seconds\": 7136\n }\n ],\n \"cadence_hold_until\": \"1968-02-13T03:56:38.161Z\",\n \"accepted_mandate_version\": \"string\",\n \"accepted_mandate_text\": \"string\",\n \"mandate_version\": \"2026-08-12-cadence-v2\",\n \"mandate_text\": \"I authorize Vocapable to charge the payment method I set up for future automatic prepaid managed verified-number test-call credit when my eligible prepaid balance is at or below my selected threshold, for my selected amount, up to my selected calendar-month cap and no more often than my selected cadence measured from the prior submitted charge attempt. Vocapable does not promise a clock time or catch up a missed attempt. I can disable this at any time before a charge is submitted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5eca634-6cf5-4266-a92a-da6ac8e0c07b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "billing", "prepaid", "auto-fund" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"threshold_minor\": 8544,\n \"amount_minor\": 6591,\n \"period_cap_minor\": 9769,\n \"period\": \"calendar_month\",\n \"cadence\": \"as_needed\",\n \"mandate_accepted\": false,\n \"idempotency_key\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80e55c9a-3043-4a56-aad9-3952bccd957f", "name": "Open Stripe-hosted payment, invoice, and subscription management", "request": { "name": "Open Stripe-hosted payment, invoice, and subscription management", "description": { "content": "Mint a customer-scoped Stripe portal session for the authenticated tenant.\n\nWe resolve the customer and subscription from the tenant database rather than accepting\neither ID from the browser. Otherwise a tenant that guessed another ``cus_`` or ``sub_``\nidentifier could be handed a management link for someone else's account.", "type": "text/plain" }, "url": { "path": [ "v1", "billing", "customer-portal" ], "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 \"flow\": \"manage\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "53a16640-1dc6-4907-985c-4af143fa249c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "billing", "customer-portal" ], "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 \"flow\": \"manage\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"string\",\n \"flow\": \"subscription_cancel\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb1d57e2-e5b8-44de-8b8e-a2b68fc98c5e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "billing", "customer-portal" ], "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 \"flow\": \"manage\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1db61765-3cf0-4d0b-adc0-5dacc49004dd", "name": "test-calls", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "de6b7d6b-0f04-4213-a18a-defdfdbc4cc5", "name": "Hear your agent: one campaign-less call to a verified own number", "request": { "name": "Hear your agent: one campaign-less call to a verified own number", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "test-call" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"to\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e3541d6-5d78-4d62-acea-295e85d3ef9c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "test-call" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"to\": \"string\",\n \"contact_id\": \"string\",\n \"telephony\": \"platform\",\n \"state\": \"string\",\n \"created_at\": \"2019-04-26T07:45:35.874Z\",\n \"disposition\": \"string\",\n \"call_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "848bf8f5-e29b-42d2-8f70-7010bfe570e2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "test-call" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"string\",\n \"timezone\": \"string\",\n \"jurisdictions\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d92c4192-3645-43c4-a6b0-a6f755e6fad2", "name": "voice-sessions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7ddab69d-64b7-42f6-8fa9-2e0258c284c5", "name": "Open an in-browser voice session - the published version, or the draft when none is published (no phone call)", "request": { "name": "Open an in-browser voice session - the published version, or the draft when none is published (no phone call)", "description": { "content": "Mint one browser session against the agent's latest published version.\n\nEverything that can refuse this session refuses it **here, in HTTP, with a body**. The\nalternative is what the runtime would otherwise do: accept the socket, redeem the token,\nfail a floor check, and close with a WSS 1008 and no payload - the worst diagnostic in\nthe product, because the operator learns only that \"it didn't work\". So the same four\nchecks the redemption runs (`modules/internal/bootstrap_checks.py`, imported rather than\nreimplemented) run against the same pinned version before a token is minted at all:\n`voice_profile_missing` and `disclosure_opener_missing` as 409s the tenant can fix,\n`llm_chain_unresolvable` and `runtime_plane_unavailable` as 503s only a deployment can.\n\nNothing is written. A browser session's durable state begins at teardown, which is where\nits `calls` row and its compliance evidence land (migration 0031) - so a session the\noperator never connects leaves no attempt, no call and no meter behind it.\n\n## The admission gates, and why they run where they do\n\nThe budget gates (`.admission`) run **first**, before any read: a caller who has spent\ntheir address's hourly budget or their account's daily one must not cost us four queries\nto find that out, and both refusals are the same whatever agent was named.\n\nThe lane reservation runs **last**, immediately before the mint. It is the one gate that\n*holds* something, so it is taken only once every reason to refuse this session has been\nruled out - a reservation abandoned behind a `voice_profile_missing` would block that\naccount's next attempt for the reservation's whole life. If minting fails after it is\ntaken, it is given back in the same request.", "type": "text/plain" }, "url": { "path": [ "v1", "agents", ":agent_id", "voice-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4d6e5468-58da-4f94-a9d3-da6f54bddafa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "voice-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"call_id\": \"string\",\n \"agent_id\": \"string\",\n \"agent_version_id\": \"string\",\n \"ws_url\": \"string\",\n \"session_token\": \"string\",\n \"expires_at\": \"1998-03-19T11:12:18.698Z\",\n \"audio\": {\n \"sample_rate_hz\": 7978,\n \"channels\": 7126,\n \"encoding\": \"pcm16\"\n },\n \"max_call_seconds\": 1795,\n \"disclosure_opener\": \"string\",\n \"created_at\": \"1977-11-19T22:10:58.446Z\",\n \"gpu_node_id\": \"string\",\n \"protocol\": \"browser.v1\",\n \"runs_draft\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c82c6e07-7a48-408f-b598-9955647776d7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "voice-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "332b9234-8985-433e-bf97-031367ab6064", "name": "agent-chat", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "95291ca8-523a-4d87-bac8-3ca621dd1ed6", "name": "Chat with this agent draft in text - no publish, no dial, no recording", "request": { "name": "Chat with this agent draft in text - no publish, no dial, no recording", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "chat" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08f5e61e-0f50-4ba0-9e6c-6191085ebb6e", "name": "Server-sent events: delta / guard / proposal / done / problem.", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "chat" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbe684bf-165d-493e-8447-ec663dd6b48a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "chat" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2dfb128-9cbb-483e-8b67-6e4ad808aab2", "name": "Assisted setup: interview + reviewable draft-patch proposals, never writes", "request": { "name": "Assisted setup: interview + reviewable draft-patch proposals, never writes", "description": {}, "url": { "path": [ "v1", "agents", ":agent_id", "setup-chat" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "338fcff9-1dd3-4698-b1a9-b6e2cb7591c5", "name": "Server-sent events: delta / guard / proposal / done / problem.", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "setup-chat" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6294953c-1a28-45c9-80ad-4f8d70a2be97", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "agents", ":agent_id", "setup-chat" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "agent_id", "description": "(Required) " } ] }, "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 \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5334a895-1b53-4a6f-8829-3b7a2162adf7", "name": "numbers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "394ea504-3003-438e-85a5-c6d89cb21138", "name": "List this tenant's telephony accounts", "request": { "name": "List this tenant's telephony accounts", "description": {}, "url": { "path": [ "v1", "telephony-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "mode", "value": "string", "description": "Filter on `mode`. Comma-separated values are OR." }, { "disabled": true, "key": "mode.gte", "value": "string", "description": "Filter on `mode` with the `gte` operator." }, { "disabled": true, "key": "mode.lte", "value": "string", "description": "Filter on `mode` with the `lte` operator." }, { "disabled": true, "key": "mode.gt", "value": "string", "description": "Filter on `mode` with the `gt` operator." }, { "disabled": true, "key": "mode.lt", "value": "string", "description": "Filter on `mode` with the `lt` operator." }, { "disabled": true, "key": "mode.in", "value": "string", "description": "Filter on `mode` with the `in` operator." }, { "disabled": true, "key": "provider", "value": "string", "description": "Filter on `provider`. Comma-separated values are OR." }, { "disabled": true, "key": "provider.gte", "value": "string", "description": "Filter on `provider` with the `gte` operator." }, { "disabled": true, "key": "provider.lte", "value": "string", "description": "Filter on `provider` with the `lte` operator." }, { "disabled": true, "key": "provider.gt", "value": "string", "description": "Filter on `provider` with the `gt` operator." }, { "disabled": true, "key": "provider.lt", "value": "string", "description": "Filter on `provider` with the `lt` operator." }, { "disabled": true, "key": "provider.in", "value": "string", "description": "Filter on `provider` with the `in` operator." }, { "disabled": true, "key": "verification_status", "value": "string", "description": "Filter on `verification_status`. Comma-separated values are OR." }, { "disabled": true, "key": "verification_status.gte", "value": "string", "description": "Filter on `verification_status` with the `gte` operator." }, { "disabled": true, "key": "verification_status.lte", "value": "string", "description": "Filter on `verification_status` with the `lte` operator." }, { "disabled": true, "key": "verification_status.gt", "value": "string", "description": "Filter on `verification_status` with the `gt` operator." }, { "disabled": true, "key": "verification_status.lt", "value": "string", "description": "Filter on `verification_status` with the `lt` operator." }, { "disabled": true, "key": "verification_status.in", "value": "string", "description": "Filter on `verification_status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d7376e34-36ee-4cb0-b6cf-05957f57a5ea", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "mode", "value": "string" }, { "key": "mode.gte", "value": "string" }, { "key": "mode.lte", "value": "string" }, { "key": "mode.gt", "value": "string" }, { "key": "mode.lt", "value": "string" }, { "key": "mode.in", "value": "string" }, { "key": "provider", "value": "string" }, { "key": "provider.gte", "value": "string" }, { "key": "provider.lte", "value": "string" }, { "key": "provider.gt", "value": "string" }, { "key": "provider.lt", "value": "string" }, { "key": "provider.in", "value": "string" }, { "key": "verification_status", "value": "string" }, { "key": "verification_status.gte", "value": "string" }, { "key": "verification_status.lte", "value": "string" }, { "key": "verification_status.gt", "value": "string" }, { "key": "verification_status.lt", "value": "string" }, { "key": "verification_status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"mode\": \"managed\",\n \"provider\": \"string\",\n \"credentials_stored\": true,\n \"verification_status\": \"suspended\",\n \"telephony_minutes_metered\": true,\n \"created_at\": \"1992-06-15T15:01:25.098Z\",\n \"cps_limit\": 2596,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"verified_at\": \"1966-10-24T03:32:31.204Z\"\n },\n {\n \"id\": \"string\",\n \"mode\": \"byo\",\n \"provider\": \"string\",\n \"credentials_stored\": true,\n \"verification_status\": \"failed\",\n \"telephony_minutes_metered\": true,\n \"created_at\": \"1969-02-09T19:01:46.958Z\",\n \"cps_limit\": 3117,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"verified_at\": \"1971-10-01T22:50:41.601Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74424029-9a36-4e07-a8a8-ed62d87c07f5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "mode", "value": "string" }, { "key": "mode.gte", "value": "string" }, { "key": "mode.lte", "value": "string" }, { "key": "mode.gt", "value": "string" }, { "key": "mode.lt", "value": "string" }, { "key": "mode.in", "value": "string" }, { "key": "provider", "value": "string" }, { "key": "provider.gte", "value": "string" }, { "key": "provider.lte", "value": "string" }, { "key": "provider.gt", "value": "string" }, { "key": "provider.lt", "value": "string" }, { "key": "provider.in", "value": "string" }, { "key": "verification_status", "value": "string" }, { "key": "verification_status.gte", "value": "string" }, { "key": "verification_status.lte", "value": "string" }, { "key": "verification_status.gt", "value": "string" }, { "key": "verification_status.lt", "value": "string" }, { "key": "verification_status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "892594a5-75c5-494e-abdc-387ba1e92263", "name": "Connect a BYO subaccount or elect the platform account", "request": { "name": "Connect a BYO subaccount or elect the platform account", "description": {}, "url": { "path": [ "v1", "telephony-accounts" ], "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 \"mode\": \"managed\",\n \"provider\": \"twilio\",\n \"credentials\": {\n \"account_sid\": \"string\",\n \"auth_token\": \"string\"\n },\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "65e1c457-ba0b-40f7-a116-02025950723c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts" ], "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 \"mode\": \"managed\",\n \"provider\": \"twilio\",\n \"credentials\": {\n \"account_sid\": \"string\",\n \"auth_token\": \"string\"\n },\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"mode\": \"managed\",\n \"provider\": \"string\",\n \"credentials_stored\": false,\n \"verification_status\": \"failed\",\n \"telephony_minutes_metered\": false,\n \"created_at\": \"2016-05-31T00:43:03.095Z\",\n \"cps_limit\": 9362,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"verified_at\": \"2001-02-13T20:21:16.643Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c964168-041c-4e0b-8fa2-4b698c7d262c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts" ], "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 \"mode\": \"managed\",\n \"provider\": \"twilio\",\n \"credentials\": {\n \"account_sid\": \"string\",\n \"auth_token\": \"string\"\n },\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bc3940c-d14d-499e-8748-b3ac387605e6", "name": "Read one telephony account", "request": { "name": "Read one telephony account", "description": {}, "url": { "path": [ "v1", "telephony-accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bcc4762f-adc3-4fcf-96fb-1786a65321c0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"mode\": \"managed\",\n \"provider\": \"string\",\n \"credentials_stored\": false,\n \"verification_status\": \"failed\",\n \"telephony_minutes_metered\": false,\n \"created_at\": \"2016-05-31T00:43:03.095Z\",\n \"cps_limit\": 9362,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"verified_at\": \"2001-02-13T20:21:16.643Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82fa29b5-06db-4af4-9ebb-51c707e4c4b8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d319923-befc-4d40-84fd-2feaa72b6a10", "name": "Update an account, or rotate its carrier credentials", "request": { "name": "Update an account, or rotate its carrier credentials", "description": {}, "url": { "path": [ "v1", "telephony-accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "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 \"credentials\": {\n \"account_sid\": \"string\",\n \"auth_token\": \"string\"\n },\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da4b7df5-f609-48bf-a3ea-89c673c5d5dd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "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 \"credentials\": {\n \"account_sid\": \"string\",\n \"auth_token\": \"string\"\n },\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"mode\": \"managed\",\n \"provider\": \"string\",\n \"credentials_stored\": false,\n \"verification_status\": \"failed\",\n \"telephony_minutes_metered\": false,\n \"created_at\": \"2016-05-31T00:43:03.095Z\",\n \"cps_limit\": 9362,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"verified_at\": \"2001-02-13T20:21:16.643Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9ac4d5-9194-4c00-9b9a-5fbdd2c89aa1", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "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 \"credentials\": {\n \"account_sid\": \"string\",\n \"auth_token\": \"string\"\n },\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6ad7eea-2d18-406a-8cc2-6e0a1a9c7d54", "name": "Make a verified telephony account the default for future account-omitted calls", "request": { "name": "Make a verified telephony account the default for future account-omitted calls", "description": { "content": "Move only the tenant fallback; existing campaigns keep their elected account.\n\nThis is intentionally explicit rather than a side effect of connecting a later BYO\naccount. It lets a sandbox customer use the managed verified-number test lane first,\nthen choose verified BYO Twilio as the production fallback without silently rerouting\nany campaign that already named an account.", "type": "text/plain" }, "url": { "path": [ "v1", "telephony-accounts", ":account_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "93d1b092-c250-4d05-a90d-1a5e8daa1f07", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"mode\": \"managed\",\n \"provider\": \"string\",\n \"credentials_stored\": false,\n \"verification_status\": \"failed\",\n \"telephony_minutes_metered\": false,\n \"created_at\": \"2016-05-31T00:43:03.095Z\",\n \"cps_limit\": 9362,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"verified_at\": \"2001-02-13T20:21:16.643Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab3ce2fe-ff29-4d0c-b093-5f9e45537cb9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29bc40f5-63c7-4e9a-9057-99ab0984e95a", "name": "Get the signed Twilio inbound-SMS webhook URL for a verified BYO account", "request": { "name": "Get the signed Twilio inbound-SMS webhook URL for a verified BYO account", "description": { "content": "Return the one account-level URL a customer copies into Twilio's Messaging config.\n\nThe route is visible only after the BYO account is verified. It does not try to make an\nunverified credential or a platform-managed account look messaging-ready, and it never\nserializes the credential reference or either credential field.", "type": "text/plain" }, "url": { "path": [ "v1", "telephony-accounts", ":account_id", "inbound-sms-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9c277ea-bab8-41b8-a434-eb30cc339607", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "inbound-sms-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc6eae9-c8ad-4c3d-ba4b-7433f6a5d3d2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "inbound-sms-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2939a82b-712d-4923-a00d-b04683f91a6d", "name": "Get the signed Twilio inbound-Voice webhook URL for a verified BYO account", "request": { "name": "Get the signed Twilio inbound-Voice webhook URL for a verified BYO account", "description": { "content": "Return the account-level Voice URL a customer copies into Twilio's number config.\n\nThe URL remains useless without Twilio's account-specific request signature, and every\naccepted callback re-resolves its signed destination against an active carrier-owned\nvoice number with a selected published agent. Managed or unverified accounts cannot\npublish an inbound route, so they never become a back door around the BYO verification\nboundary.", "type": "text/plain" }, "url": { "path": [ "v1", "telephony-accounts", ":account_id", "inbound-voice-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2e83d488-c5e2-4f61-969c-0e6cb9d0cd1a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "inbound-voice-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"string\",\n \"status_callback_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5715baa2-0e06-4cb2-9eed-c5b53927cba6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "inbound-voice-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b82d8252-46c6-4f18-a6a1-9dba21c61cd5", "name": "Prove the account's credentials and read its CPS ceiling back", "request": { "name": "Prove the account's credentials and read its CPS ceiling back", "description": {}, "url": { "path": [ "v1", "telephony-accounts", ":account_id", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c00d1be1-32b8-4480-acd4-3d7a4633d19f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"mode\": \"managed\",\n \"provider\": \"string\",\n \"credentials_stored\": false,\n \"verification_status\": \"failed\",\n \"telephony_minutes_metered\": false,\n \"created_at\": \"2016-05-31T00:43:03.095Z\",\n \"cps_limit\": 9362,\n \"a2p_brand_ref\": \"string\",\n \"ftc_san_refs\": [\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"san\": \"string\",\n \"area_codes\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"verified_at\": \"2001-02-13T20:21:16.643Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d22633ea-1372-4537-8352-1d06e6fa5c7d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "telephony-accounts", ":account_id", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88a12c67-a97c-440a-9e94-e8eb8e03ce9b", "name": "List numbers and inventory", "request": { "name": "List numbers and inventory", "description": { "content": "This tenant's numbers plus the unassigned platform inventory it may claim.", "type": "text/plain" }, "url": { "path": [ "v1", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "reputation_state", "value": "string", "description": "Filter on `reputation_state`. Comma-separated values are OR." }, { "disabled": true, "key": "reputation_state.gte", "value": "string", "description": "Filter on `reputation_state` with the `gte` operator." }, { "disabled": true, "key": "reputation_state.lte", "value": "string", "description": "Filter on `reputation_state` with the `lte` operator." }, { "disabled": true, "key": "reputation_state.gt", "value": "string", "description": "Filter on `reputation_state` with the `gt` operator." }, { "disabled": true, "key": "reputation_state.lt", "value": "string", "description": "Filter on `reputation_state` with the `lt` operator." }, { "disabled": true, "key": "reputation_state.in", "value": "string", "description": "Filter on `reputation_state` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." }, { "disabled": true, "key": "telephony_account_id", "value": "string", "description": "Filter on `telephony_account_id`. Comma-separated values are OR." }, { "disabled": true, "key": "telephony_account_id.gte", "value": "string", "description": "Filter on `telephony_account_id` with the `gte` operator." }, { "disabled": true, "key": "telephony_account_id.lte", "value": "string", "description": "Filter on `telephony_account_id` with the `lte` operator." }, { "disabled": true, "key": "telephony_account_id.gt", "value": "string", "description": "Filter on `telephony_account_id` with the `gt` operator." }, { "disabled": true, "key": "telephony_account_id.lt", "value": "string", "description": "Filter on `telephony_account_id` with the `lt` operator." }, { "disabled": true, "key": "telephony_account_id.in", "value": "string", "description": "Filter on `telephony_account_id` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "23e00257-7336-4262-be48-5dbfb6f7ca14", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "reputation_state", "value": "string" }, { "key": "reputation_state.gte", "value": "string" }, { "key": "reputation_state.lte", "value": "string" }, { "key": "reputation_state.gt", "value": "string" }, { "key": "reputation_state.lt", "value": "string" }, { "key": "reputation_state.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" }, { "key": "telephony_account_id", "value": "string" }, { "key": "telephony_account_id.gte", "value": "string" }, { "key": "telephony_account_id.lte", "value": "string" }, { "key": "telephony_account_id.gt", "value": "string" }, { "key": "telephony_account_id.lt", "value": "string" }, { "key": "telephony_account_id.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"telephony_account_id\": \"string\",\n \"status\": \"provisioning\",\n \"dials_today\": 843,\n \"reputation_state\": \"flagged\",\n \"created_at\": \"1995-06-20T13:45:56.704Z\",\n \"provider_sid\": \"string\",\n \"capabilities\": [\n \"voice\",\n \"voice\"\n ],\n \"a2p_campaign_ref\": \"string\",\n \"assigned_at\": \"1949-08-12T01:52:46.849Z\",\n \"daily_dial_cap\": 9464,\n \"inbound_agent_id\": \"string\",\n \"inbound_route_mode\": \"agent\",\n \"inbound_voicemail_greeting\": \"string\"\n },\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"telephony_account_id\": \"string\",\n \"status\": \"active\",\n \"dials_today\": 6786,\n \"reputation_state\": \"flagged\",\n \"created_at\": \"1983-10-26T14:40:50.874Z\",\n \"provider_sid\": \"string\",\n \"capabilities\": [\n \"voice\",\n \"voice\"\n ],\n \"a2p_campaign_ref\": \"string\",\n \"assigned_at\": \"1984-12-05T00:17:52.262Z\",\n \"daily_dial_cap\": 767,\n \"inbound_agent_id\": \"string\",\n \"inbound_route_mode\": \"agent\",\n \"inbound_voicemail_greeting\": \"string\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b7bea3b-b1f5-4fe3-87c2-78464d95bfeb", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "reputation_state", "value": "string" }, { "key": "reputation_state.gte", "value": "string" }, { "key": "reputation_state.lte", "value": "string" }, { "key": "reputation_state.gt", "value": "string" }, { "key": "reputation_state.lt", "value": "string" }, { "key": "reputation_state.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" }, { "key": "telephony_account_id", "value": "string" }, { "key": "telephony_account_id.gte", "value": "string" }, { "key": "telephony_account_id.lte", "value": "string" }, { "key": "telephony_account_id.gt", "value": "string" }, { "key": "telephony_account_id.lt", "value": "string" }, { "key": "telephony_account_id.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b78f71da-e53b-418b-9e5b-10d61f8dfff5", "name": "Buy or connect a number on one of this tenant's telephony accounts", "request": { "name": "Buy or connect a number on one of this tenant's telephony accounts", "description": {}, "url": { "path": [ "v1", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"phone_e164\": \"+46772370380\",\n \"telephony_account_id\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"voice\"\n ],\n \"provider_sid\": \"string\",\n \"a2p_campaign_ref\": \"string\",\n \"daily_dial_cap\": 6921\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a27345f-ec53-4b69-997a-4c3ded195b8f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_e164\": \"+6630089937198\",\n \"telephony_account_id\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"sms\"\n ],\n \"provider_sid\": \"string\",\n \"a2p_campaign_ref\": \"string\",\n \"daily_dial_cap\": 6829\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"telephony_account_id\": \"string\",\n \"status\": \"provisioning\",\n \"dials_today\": 3922,\n \"reputation_state\": \"burned\",\n \"created_at\": \"1968-10-10T08:07:04.522Z\",\n \"provider_sid\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"sms\"\n ],\n \"a2p_campaign_ref\": \"string\",\n \"assigned_at\": \"1978-06-26T12:20:36.971Z\",\n \"daily_dial_cap\": 8020,\n \"inbound_agent_id\": \"string\",\n \"inbound_route_mode\": \"agent\",\n \"inbound_voicemail_greeting\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fa56536-8953-4d77-aa45-7d8d926a2fe2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_e164\": \"+6630089937198\",\n \"telephony_account_id\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"sms\"\n ],\n \"provider_sid\": \"string\",\n \"a2p_campaign_ref\": \"string\",\n \"daily_dial_cap\": 6829\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9590aac2-c91a-4962-b970-d1e7f02072a4", "name": "Claim a number for this tenant and put it into service", "request": { "name": "Claim a number for this tenant and put it into service", "description": {}, "url": { "path": [ "v1", "phone-numbers", ":number_id", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5acae6f6-3a01-4dcd-8079-1621d5b26314", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"telephony_account_id\": \"string\",\n \"status\": \"provisioning\",\n \"dials_today\": 3922,\n \"reputation_state\": \"burned\",\n \"created_at\": \"1968-10-10T08:07:04.522Z\",\n \"provider_sid\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"sms\"\n ],\n \"a2p_campaign_ref\": \"string\",\n \"assigned_at\": \"1978-06-26T12:20:36.971Z\",\n \"daily_dial_cap\": 8020,\n \"inbound_agent_id\": \"string\",\n \"inbound_route_mode\": \"agent\",\n \"inbound_voicemail_greeting\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82bb489f-4395-4546-8760-d98f466aecde", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4da5c295-279c-482a-b11a-9bdd1a47d166", "name": "Take a number out of service", "request": { "name": "Take a number out of service", "description": {}, "url": { "path": [ "v1", "phone-numbers", ":number_id", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "de542bc3-7c8e-4c4a-8e31-2ccf245af4b4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"telephony_account_id\": \"string\",\n \"status\": \"provisioning\",\n \"dials_today\": 3922,\n \"reputation_state\": \"burned\",\n \"created_at\": \"1968-10-10T08:07:04.522Z\",\n \"provider_sid\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"sms\"\n ],\n \"a2p_campaign_ref\": \"string\",\n \"assigned_at\": \"1978-06-26T12:20:36.971Z\",\n \"daily_dial_cap\": 8020,\n \"inbound_agent_id\": \"string\",\n \"inbound_route_mode\": \"agent\",\n \"inbound_voicemail_greeting\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6005f5-0f39-4d16-8769-e0abef458b79", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60fe1a57-ab33-4ce0-9c8f-deafe0711f44", "name": "Choose the live-agent or consent-gated voicemail route for a verified BYO number", "request": { "name": "Choose the live-agent or consent-gated voicemail route for a verified BYO number", "description": { "content": "Set or clear a number's inbound receiving route without widening carrier ingress.\n\nOnly an active number this tenant owns, whose carrier `PN…` identity was confirmed on a\nverified BYO Twilio account, can carry a non-null route. Setting an agent additionally proves\nthe tenant has already published an immutable version; the carrier callback freezes that\nversion before returning TwiML, so this mutable setting is never read by a live stream.\nClearing remains allowed after an account is unverified or a number is released, because\nthe safe way to turn a stale route off must never depend on a carrier.", "type": "text/plain" }, "url": { "path": [ "v1", "phone-numbers", ":number_id", "inbound-voice-routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"inbound_agent_id\": \"string\",\n \"mode\": \"agent\",\n \"voicemail_greeting\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ea394e1c-747b-4f22-a89d-64e8d7273979", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "inbound-voice-routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"inbound_agent_id\": \"string\",\n \"mode\": \"agent\",\n \"voicemail_greeting\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"telephony_account_id\": \"string\",\n \"status\": \"provisioning\",\n \"dials_today\": 3922,\n \"reputation_state\": \"burned\",\n \"created_at\": \"1968-10-10T08:07:04.522Z\",\n \"provider_sid\": \"string\",\n \"capabilities\": [\n \"sms\",\n \"sms\"\n ],\n \"a2p_campaign_ref\": \"string\",\n \"assigned_at\": \"1978-06-26T12:20:36.971Z\",\n \"daily_dial_cap\": 8020,\n \"inbound_agent_id\": \"string\",\n \"inbound_route_mode\": \"agent\",\n \"inbound_voicemail_greeting\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e426104-4ded-4323-9bfc-98821f4baf5f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "inbound-voice-routing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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 \"inbound_agent_id\": \"string\",\n \"mode\": \"agent\",\n \"voicemail_greeting\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6e493f7-1f26-410c-9aea-31caa1e69355", "name": "Read the answering policy one number answers by", "request": { "name": "Read the answering policy one number answers by", "description": { "content": "The stored document, re-validated against the contract on the way out.\n\nReadable without any carrier eligibility: a customer whose account has since been\nunverified must still be able to see what their number is configured to do, exactly as\nclearing a stale route never depends on a carrier.", "type": "text/plain" }, "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8867f6b0-e884-4653-9610-1cfcb86f9498", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_number_id\": \"string\",\n \"timezone\": \"string\",\n \"open_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"1\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"4\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ],\n \"version\": 7677,\n \"created_at\": \"2015-08-16T15:47:07.943Z\",\n \"updated_at\": \"2006-12-22T20:02:23.039Z\",\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"22:03\",\n \"end\": \"10:40\"\n },\n {\n \"start\": \"21:12\",\n \"end\": \"22:53\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:43\",\n \"end\": \"09:01\"\n },\n {\n \"start\": \"19:58\",\n \"end\": \"22:11\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"01:32\",\n \"end\": \"23:39\"\n },\n {\n \"start\": \"15:01\",\n \"end\": \"22:27\"\n }\n ]\n },\n \"holiday_dates\": [\n \"1983-01-23\",\n \"1989-01-26\"\n ],\n \"closed_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"6\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"0\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edf784df-ecaa-4fbd-a179-31137298ae31", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8697c53-db2a-4c59-b7c6-af5fc2f70816", "name": "Write the answering policy a verified BYO number answers by", "request": { "name": "Write the answering policy a verified BYO number answers by", "description": { "content": "Replace one number's whole answering document and put it on the `policy` route.\n\nThe same eligibility a live-agent route requires, for the same reason: a policy arms\ncarrier ingress just as an agent does. What it additionally proves is that every\nreference inside the document resolves *now* - each `ai` step's agent has a published\nimmutable version, and every `ring_humans` rep is an active transfer-enabled rep of this\ntenant. Those are the two ways a policy could otherwise be written that answers a real\ncaller with a dead end, and a carrier callback is the wrong place to discover either.\n\nThe document is written before the route is moved, so a number is never in `policy` mode\nwith nothing to execute; both statements share the request transaction, so a failure at\neither point leaves the number on the route it already had.", "type": "text/plain" }, "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"timezone\": \"string\",\n \"open_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"0\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ],\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"23:28\",\n \"end\": \"22:47\"\n },\n {\n \"start\": \"13:08\",\n \"end\": \"15:38\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:31\",\n \"end\": \"20:40\"\n },\n {\n \"start\": \"00:25\",\n \"end\": \"23:22\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"00:09\",\n \"end\": \"00:07\"\n },\n {\n \"start\": \"21:20\",\n \"end\": \"04:56\"\n }\n ]\n },\n \"holiday_dates\": [\n \"1997-11-12\",\n \"1991-06-27\"\n ],\n \"closed_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"6\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"1\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e739972a-2e6e-4e63-8ceb-3a3584b7cebd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"timezone\": \"string\",\n \"open_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"0\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ],\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"23:28\",\n \"end\": \"22:47\"\n },\n {\n \"start\": \"13:08\",\n \"end\": \"15:38\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:31\",\n \"end\": \"20:40\"\n },\n {\n \"start\": \"00:25\",\n \"end\": \"23:22\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"00:09\",\n \"end\": \"00:07\"\n },\n {\n \"start\": \"21:20\",\n \"end\": \"04:56\"\n }\n ]\n },\n \"holiday_dates\": [\n \"1997-11-12\",\n \"1991-06-27\"\n ],\n \"closed_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"6\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"1\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_number_id\": \"string\",\n \"timezone\": \"string\",\n \"open_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"1\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"4\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ],\n \"version\": 7677,\n \"created_at\": \"2015-08-16T15:47:07.943Z\",\n \"updated_at\": \"2006-12-22T20:02:23.039Z\",\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"22:03\",\n \"end\": \"10:40\"\n },\n {\n \"start\": \"21:12\",\n \"end\": \"22:53\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:43\",\n \"end\": \"09:01\"\n },\n {\n \"start\": \"19:58\",\n \"end\": \"22:11\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"01:32\",\n \"end\": \"23:39\"\n },\n {\n \"start\": \"15:01\",\n \"end\": \"22:27\"\n }\n ]\n },\n \"holiday_dates\": [\n \"1983-01-23\",\n \"1989-01-26\"\n ],\n \"closed_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"6\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"0\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e702b77c-6fdb-42f5-9f23-a361d8156470", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"timezone\": \"string\",\n \"open_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"0\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ],\n \"business_hours\": {\n \"key_0\": [\n {\n \"start\": \"23:28\",\n \"end\": \"22:47\"\n },\n {\n \"start\": \"13:08\",\n \"end\": \"15:38\"\n }\n ],\n \"key_1\": [\n {\n \"start\": \"21:31\",\n \"end\": \"20:40\"\n },\n {\n \"start\": \"00:25\",\n \"end\": \"23:22\"\n }\n ],\n \"key_2\": [\n {\n \"start\": \"00:09\",\n \"end\": \"00:07\"\n },\n {\n \"start\": \"21:20\",\n \"end\": \"04:56\"\n }\n ]\n },\n \"holiday_dates\": [\n \"1997-11-12\",\n \"1991-06-27\"\n ],\n \"closed_steps\": [\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"6\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n },\n {\n \"prompt\": \"string\",\n \"branches\": {\n \"1\": [\n \"\"\n ]\n },\n \"timeout_branch\": [\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"menu\",\n \"timeout_seconds\": 5,\n \"max_invalid_attempts\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66e64716-5144-4011-817a-e2ef16f82766", "name": "Remove a number's answering policy and return it to the agent route", "request": { "name": "Remove a number's answering policy and return it to the agent route", "description": { "content": "Delete the document and restore the `agent` route the number had before.\n\nDeliberately not gated on carrier eligibility or on a live key. This is the only way to\ndisarm a policy route, and the safe way to turn a route off must never depend on the\ncarrier account still verifying - the same rule the legacy clear already follows.\n\nThe route is only moved when the number is actually on `policy`: a number a later\n`inbound-voice-routing` PATCH already returned to an agent keeps that agent instead of\nhaving it silently cleared by this call.", "type": "text/plain" }, "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ceeff457-062b-48b8-aef2-d86a2232390c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43922864-a7ba-4994-84ea-cb80d9cda877", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "phone-numbers", ":number_id", "answering-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "number_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1086604-dfc3-4b5b-a5d0-1edf0cf59d52", "name": "List caller-ID pools", "request": { "name": "List caller-ID pools", "description": {}, "url": { "path": [ "v1", "number-pools" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f5a33af8-af50-4780-9284-6e3f7209dc51", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "number-pools" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"rotation_strategy\": \"string\",\n \"created_at\": \"2016-04-24T17:25:08.563Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"rotation_strategy\": \"string\",\n \"created_at\": \"1991-04-01T21:52:28.159Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c03143-6d48-4eb8-b479-30d2797784bc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "number-pools" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a69bd24c-145e-42dc-aa51-d9057db92721", "name": "Create a caller-ID pool", "request": { "name": "Create a caller-ID pool", "description": {}, "url": { "path": [ "v1", "number-pools" ], "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\": \"string\",\n \"rotation_strategy\": \"round_robin\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "261a5386-2c77-411f-8b23-7e3152dafb3d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "number-pools" ], "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 \"name\": \"string\",\n \"rotation_strategy\": \"round_robin\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"rotation_strategy\": \"string\",\n \"created_at\": \"1991-06-11T18:27:34.862Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e753849e-1b0d-41f4-a02e-4b9dff1bde48", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "number-pools" ], "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 \"name\": \"string\",\n \"rotation_strategy\": \"round_robin\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "441e2dca-53d0-4ba0-bd5e-1b2ea044ca25", "name": "Add a phone number to a caller-ID pool", "request": { "name": "Add a phone number to a caller-ID pool", "description": {}, "url": { "path": [ "v1", "number-pools", ":pool_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pool_id", "description": "(Required) " } ] }, "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 \"phone_number_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e68ab65-f0cf-4a01-b06b-37fc41370484", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "number-pools", ":pool_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pool_id", "description": "(Required) " } ] }, "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 \"phone_number_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"number_pool_id\": \"string\",\n \"phone_number_id\": \"string\",\n \"added_at\": \"1995-11-15T04:35:30.831Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1b76d81-ae9d-4fbb-b044-3bcfaf01076c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "number-pools", ":pool_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "pool_id", "description": "(Required) " } ] }, "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 \"phone_number_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "89d1d33a-fb83-4406-ac74-f2a3ff68d7c3", "name": "verified-numbers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e757d589-50f4-4916-8880-65e42c6750bb", "name": "List this tenant's verified-number registrations", "request": { "name": "List this tenant's verified-number registrations", "description": {}, "url": { "path": [ "v1", "verified-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ebe2f22f-a050-4e88-9332-a06ee21b2b8b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "verified-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"status\": \"revoked\",\n \"verification_attempts\": 4583,\n \"created_at\": \"1955-04-27T19:10:08.181Z\",\n \"label\": \"string\",\n \"code_expires_at\": \"2010-03-20T19:20:22.636Z\",\n \"verified_at\": \"1958-10-03T11:59:23.813Z\"\n },\n {\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"status\": \"expired\",\n \"verification_attempts\": 2559,\n \"created_at\": \"2016-01-24T14:26:17.372Z\",\n \"label\": \"string\",\n \"code_expires_at\": \"1977-04-17T18:21:59.128Z\",\n \"verified_at\": \"1963-10-31T23:40:58.427Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4de5c476-e0b9-4daa-b224-674ecc1d8c68", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "verified-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4019b68b-42ec-41a3-8206-3050b6565783", "name": "Register a destination and deliver its one-time code", "request": { "name": "Register a destination and deliver its one-time code", "description": {}, "url": { "path": [ "v1", "verified-numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"phone_e164\": \"+55473299\",\n \"label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b22c6353-1eed-4523-bd4b-0d39fdbf3c85", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "verified-numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_e164\": \"+55473299\",\n \"label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"status\": \"pending\",\n \"verification_attempts\": 7038,\n \"created_at\": \"1998-05-12T22:24:17.565Z\",\n \"label\": \"string\",\n \"code_expires_at\": \"1993-09-21T11:41:27.345Z\",\n \"verified_at\": \"2004-02-06T19:47:25.758Z\",\n \"verification_code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d773876-c07d-44a8-916f-64c217069584", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "verified-numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_e164\": \"+55473299\",\n \"label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3328309-8eae-4a33-bc4c-73f9db2e4ca4", "name": "Confirm the one-time code delivered to the number", "request": { "name": "Confirm the one-time code delivered to the number", "description": {}, "url": { "path": [ "v1", "verified-numbers", ":verified_number_id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "verified_number_id", "description": "(Required) " } ] }, "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 \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30c14a49-81ca-44b5-b011-b63991f11144", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "verified-numbers", ":verified_number_id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "verified_number_id", "description": "(Required) " } ] }, "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 \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"phone_e164\": \"string\",\n \"status\": \"pending\",\n \"verification_attempts\": 829,\n \"created_at\": \"2006-02-18T20:51:55.957Z\",\n \"label\": \"string\",\n \"code_expires_at\": \"1997-09-24T14:19:45.361Z\",\n \"verified_at\": \"1947-08-06T10:40:58.170Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25488b0d-49e9-4cb3-a72f-69cfaf8135c8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "verified-numbers", ":verified_number_id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "verified_number_id", "description": "(Required) " } ] }, "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 \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "447bf2cb-4f58-4b85-8eb4-8a9daed6fc00", "name": "scheduling", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "105f89cd-e3a2-45f1-822f-399b085a3e0f", "name": "Start a calendar OAuth consent", "request": { "name": "Start a calendar OAuth consent", "description": { "content": "Mint the tenant-bound consent state and hand back the provider's consent URL.\n\n**No row is written here.** `integration_connections.status` has no `pending` value\n(docs/03-domain-model.md) - a connection exists only once consent has completed at the\ncallback, so an abandoned consent leaves nothing behind to expire or clean up.", "type": "text/plain" }, "url": { "path": [ "v1", "integration-connections" ], "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 \"provider\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "923105eb-fc35-4ed6-a35d-1ab727eadbb9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "integration-connections" ], "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 \"provider\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"provider\": \"string\",\n \"authorization_url\": \"string\",\n \"state_expires_at\": \"1957-09-28T16:26:59.375Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d37270c-afeb-43b6-a0da-65385dc6a80e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "integration-connections" ], "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 \"provider\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e441d8f8-0590-4ce4-85da-16ae7d9a9d1a", "name": "List this tenant's integration connections", "request": { "name": "List this tenant's integration connections", "description": {}, "url": { "path": [ "v1", "integration-connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "provider", "value": "string", "description": "Filter on `provider`. Comma-separated values are OR." }, { "disabled": true, "key": "provider.gte", "value": "string", "description": "Filter on `provider` with the `gte` operator." }, { "disabled": true, "key": "provider.lte", "value": "string", "description": "Filter on `provider` with the `lte` operator." }, { "disabled": true, "key": "provider.gt", "value": "string", "description": "Filter on `provider` with the `gt` operator." }, { "disabled": true, "key": "provider.lt", "value": "string", "description": "Filter on `provider` with the `lt` operator." }, { "disabled": true, "key": "provider.in", "value": "string", "description": "Filter on `provider` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4e7acad1-ede8-489f-80b9-13966de164a0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "integration-connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "provider", "value": "string" }, { "key": "provider.gte", "value": "string" }, { "key": "provider.lte", "value": "string" }, { "key": "provider.gt", "value": "string" }, { "key": "provider.lt", "value": "string" }, { "key": "provider.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"provider\": \"string\",\n \"status\": \"revoked\",\n \"created_at\": \"1947-05-30T02:47:27.450Z\",\n \"updated_at\": \"1961-05-26T16:34:51.062Z\",\n \"external_account_id\": \"string\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"last_refreshed_at\": \"1946-10-22T12:45:36.846Z\"\n },\n {\n \"id\": \"string\",\n \"provider\": \"string\",\n \"status\": \"revoked\",\n \"created_at\": \"1969-10-16T07:22:35.623Z\",\n \"updated_at\": \"2019-11-08T07:09:39.455Z\",\n \"external_account_id\": \"string\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"last_refreshed_at\": \"1980-08-25T17:49:05.737Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dde3f0ee-076d-4cf9-bfb7-cd74b2130bc9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "integration-connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "provider", "value": "string" }, { "key": "provider.gte", "value": "string" }, { "key": "provider.lte", "value": "string" }, { "key": "provider.gt", "value": "string" }, { "key": "provider.lt", "value": "string" }, { "key": "provider.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa0a348e-c8cb-4873-a909-0741b13f23d2", "name": "Complete a calendar OAuth consent", "request": { "name": "Complete a calendar OAuth consent", "description": { "content": "Unauthenticated by design: the customer's admin lands here from the provider's\nconsent screen carrying no API key, so the signed, tenant-bound, 10-minute state **is**\nthe admission control (docs/04-api.md §7).", "type": "text/plain" }, "url": { "path": [ "v1", "integration-connections", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "state", "value": "string", "description": "(Required) " }, { "disabled": true, "key": "code", "value": "string" }, { "disabled": true, "key": "error", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9902ddea-8d67-4703-bac8-10c07aea2175", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "integration-connections", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "string" }, { "key": "code", "value": "string" }, { "key": "error", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"provider\": \"string\",\n \"status\": \"expired\",\n \"created_at\": \"2001-01-06T01:39:22.835Z\",\n \"updated_at\": \"1962-04-11T22:43:13.591Z\",\n \"external_account_id\": \"string\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"last_refreshed_at\": \"2007-06-23T21:30:41.343Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef681611-4a08-4a60-8084-959c33fb8fc3", "name": "Consent completed and the browser was redirected to the deployment's fixed portal Settings URL.", "originalRequest": { "url": { "path": [ "v1", "integration-connections", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "string" }, { "key": "code", "value": "string" }, { "key": "error", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "See Other", "code": 303, "header": [ { "disabled": true, "description": "The fixed portal Settings URL.", "key": "Location", "value": "http://Vm.mgxsRG-KjmFx4gJrG" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45c67c48-7723-43d4-a47a-0ca37feb163b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "integration-connections", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "string" }, { "key": "code", "value": "string" }, { "key": "error", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d558205-2bdd-43c9-a088-7a4a0a49696b", "name": "Free slots on the connected calendar (check_calendar's backing operation)", "request": { "name": "Free slots on the connected calendar (check_calendar's backing operation)", "description": {}, "url": { "path": [ "v1", "calendar", "availability" ], "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 \"start_date\": \"7179-28-51\",\n \"end_date\": \"3946-19-20\",\n \"duration_minutes\": 43,\n \"timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d3d7b40d-0e48-4060-bb89-d8157be096a6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calendar", "availability" ], "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 \"start_date\": \"7179-28-51\",\n \"end_date\": \"3946-19-20\",\n \"duration_minutes\": 43,\n \"timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connection_id\": \"string\",\n \"timezone\": \"string\",\n \"slots\": [\n {\n \"starts_at\": \"2024-01-28T06:03:29.860Z\",\n \"ends_at\": \"1964-11-10T03:53:37.760Z\"\n },\n {\n \"starts_at\": \"1993-04-10T04:00:30.516Z\",\n \"ends_at\": \"2003-06-23T14:27:46.718Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87076ba7-81f1-41dc-9c5b-050be6a267ef", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calendar", "availability" ], "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 \"start_date\": \"7179-28-51\",\n \"end_date\": \"3946-19-20\",\n \"duration_minutes\": 43,\n \"timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "850d275a-65ee-498e-9a8b-44425347af75", "name": "Book a meeting (book_meeting's backing operation)", "request": { "name": "Book a meeting (book_meeting's backing operation)", "description": { "content": "Replay-safe without idempotency middleware.\n\nThe runtime derives its tool idempotency key from the same arguments, so a replayed\n`book_meeting` turn re-presents the same `(call_id, start_time)` pair:\n`find_for_call` returns the existing appointment **before any provider call**, and\n`uq_appointments_integration_connection_id_external_event_id` closes the race two\nconcurrent replays could still slip through.", "type": "text/plain" }, "url": { "path": [ "v1", "calendar", "events" ], "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 \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"start_time\": \"5183-08-90T93:66.09991096513-40:74\",\n \"duration_minutes\": 15,\n \"attendee_email\": \"Hi@kvzN]sG.|uYZ1\\\"iO*\",\n \"attendee_name\": \"string\",\n \"notes\": \"string\",\n \"contact_timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "692a065b-b3ca-4a28-b019-86e30c282f10", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "calendar", "events" ], "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 \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"start_time\": \"5183-08-90T93:66.09991096513-40:74\",\n \"duration_minutes\": 15,\n \"attendee_email\": \"Hi@kvzN]sG.|uYZ1\\\"iO*\",\n \"attendee_name\": \"string\",\n \"notes\": \"string\",\n \"contact_timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"starts_at\": \"2004-02-05T03:51:52.785Z\",\n \"ends_at\": \"1974-07-06T11:19:44.539Z\",\n \"status\": \"booked\",\n \"created_at\": \"1980-09-27T10:23:11.762Z\",\n \"updated_at\": \"1971-02-03T18:20:41.721Z\",\n \"integration_connection_id\": \"string\",\n \"external_event_id\": \"string\",\n \"contact_timezone\": \"string\",\n \"invite_sent_at\": \"1995-04-16T15:49:23.134Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "753f4099-e925-49e4-be14-a361e06ea9ee", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "calendar", "events" ], "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 \"call_id\": \"string\",\n \"contact_id\": \"string\",\n \"start_time\": \"5183-08-90T93:66.09991096513-40:74\",\n \"duration_minutes\": 15,\n \"attendee_email\": \"Hi@kvzN]sG.|uYZ1\\\"iO*\",\n \"attendee_name\": \"string\",\n \"notes\": \"string\",\n \"contact_timezone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b58a9741-c277-44f0-b338-8195132ab353", "name": "exports", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fdeeedb5-3241-4766-99d6-46038d7fcf31", "name": "Submit an async CSV export", "request": { "name": "Submit an async CSV export", "description": { "content": "Queue one extraction and answer 202 with the poll contract on `GET /exports/{id}`.", "type": "text/plain" }, "url": { "path": [ "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"resource\": \"contacts\",\n \"format\": \"csv\",\n \"filters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "711eca77-ebf9-4148-9145-79882f3b4f0a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"dnc_entries\",\n \"format\": \"csv\",\n \"filters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"resource\": \"usage_events\",\n \"status\": \"running\",\n \"created_at\": \"1954-02-01T11:48:24.005Z\",\n \"updated_at\": \"2015-12-08T18:05:40.027Z\",\n \"format\": \"csv\",\n \"filters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"columns\": [\n \"string\",\n \"string\"\n ],\n \"row_count\": 7016,\n \"download_url\": \"string\",\n \"expires_at\": \"1982-01-25T01:46:17.485Z\",\n \"requested_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d97d13c4-a98e-4f9e-9ec2-038a6b885ff9", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"dnc_entries\",\n \"format\": \"csv\",\n \"filters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ce25274-2794-444e-9d96-a4ccc1b90b70", "name": "Read an export job", "request": { "name": "Read an export job", "description": {}, "url": { "path": [ "v1", "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "export_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7112901d-e41e-4929-b4f2-f53d31b522f4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "export_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"resource\": \"usage_events\",\n \"status\": \"running\",\n \"created_at\": \"1954-02-01T11:48:24.005Z\",\n \"updated_at\": \"2015-12-08T18:05:40.027Z\",\n \"format\": \"csv\",\n \"filters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"columns\": [\n \"string\",\n \"string\"\n ],\n \"row_count\": 7016,\n \"download_url\": \"string\",\n \"expires_at\": \"1982-01-25T01:46:17.485Z\",\n \"requested_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08392d89-5200-4811-807e-b11930c7da08", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "export_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c90692cc-6fba-4226-8032-ff395ad6e019", "name": "integrations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7eba572f-c65c-498b-baaa-ec32cf3d2d8a", "name": "Read the tenant's webhook endpoint", "request": { "name": "Read the tenant's webhook endpoint", "description": {}, "url": { "path": [ "v1", "webhook-endpoint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d8a04787-b3a5-48bd-bd18-a1b9246e9562", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-endpoint" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"url\": \"string\",\n \"enabled_events\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"api_version_pin\": \"string\",\n \"previous_secret_expires_at\": \"2004-10-18T14:28:12.104Z\",\n \"created_at\": \"1956-11-07T08:45:59.719Z\",\n \"updated_at\": \"2020-08-12T20:20:55.956Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f60a4083-d46d-462a-ba45-3adbfc887bf1", "name": "Create or replace the tenant's webhook endpoint", "request": { "name": "Create or replace the tenant's webhook endpoint", "description": { "content": "Upsert the tenant's single endpoint.\n\nCreating mints a signing secret and returns it - the only time it is ever readable.\nReplacing keeps the stored secret (``secret: null``) and re-activates an endpoint\nthat was `disabled_by_failures`: fixing the URL and re-`PUT`ting is the documented\nway back after an auto-disable.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"http://YHsCFyBonveNiiYHbmmFpBemR.qbX9XyoRreKMHZuWXFEtto5W2HxJzIdYEj0K3aH.VcHj9t1zW6lvR3\",\n \"enabled_events\": [\n \"call.analyzed\",\n \"ticket.resolved\"\n ],\n \"api_version_pin\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "58aa0dc0-9e76-4388-9c68-80e5ada60336", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-endpoint" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://aSgDrEDndJikSKwqGScDwChIOqxZpveqE.otbisrWSMbRd9W\",\n \"enabled_events\": [\n \"optout.recorded\",\n \"conversation.action_recorded\"\n ],\n \"api_version_pin\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"url\": \"string\",\n \"enabled_events\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"api_version_pin\": \"string\",\n \"previous_secret_expires_at\": \"1960-06-30T05:41:50.639Z\",\n \"created_at\": \"2002-10-02T15:53:32.612Z\",\n \"updated_at\": \"1976-09-14T07:33:55.489Z\",\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef0e9d6-7f5f-4969-98ef-c7bf5026dac2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-endpoint" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://aSgDrEDndJikSKwqGScDwChIOqxZpveqE.otbisrWSMbRd9W\",\n \"enabled_events\": [\n \"optout.recorded\",\n \"conversation.action_recorded\"\n ],\n \"api_version_pin\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53873759-68d9-4ac3-97f2-dd75a15cb9b6", "name": "Rotate the endpoint's signing secret", "request": { "name": "Rotate the endpoint's signing secret", "description": { "content": "Mint a new signing secret, keeping the superseded one valid for 24 hours.\n\nDuring the overlap every delivery carries two `v1=` signatures - one per secret - so\na receiver can be redeployed with the new key at any point inside the window\n(docs/04-api.md §5 signing). `previous_secret_expires_at` on the response is when\nthe old key stops verifying.\n\nAn `Idempotency-Key` is honored so a retried rotate replays the first rotation's minted\nsecret rather than rotating a second time - a double rotate would collapse the previous\nsecret's 24-hour overlap before a receiver could pick up the new one. The claim shares\nthis request's transaction with the rotation, so a failure frees the key.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoint", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a4f0dee0-7501-4a46-9441-289d126361ee", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-endpoint", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"url\": \"string\",\n \"enabled_events\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"api_version_pin\": \"string\",\n \"previous_secret_expires_at\": \"1960-06-30T05:41:50.639Z\",\n \"created_at\": \"2002-10-02T15:53:32.612Z\",\n \"updated_at\": \"1976-09-14T07:33:55.489Z\",\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37773193-0f84-4230-997c-8a0bc073d4ae", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-endpoint", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecefc434-dac0-41f8-a533-0a4b05f0bc9f", "name": "List webhook deliveries", "request": { "name": "List webhook deliveries", "description": { "content": "The inspectable delivery ledger, newest first.\n\nFilterable on `event_id`, `endpoint_id`, `status`, and `created_at` ranges - the\ndocumented recovery path is `?event_id=…` plus re-fetching the underlying resource.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "endpoint_id", "value": "string", "description": "Filter on `endpoint_id`. Comma-separated values are OR." }, { "disabled": true, "key": "endpoint_id.gte", "value": "string", "description": "Filter on `endpoint_id` with the `gte` operator." }, { "disabled": true, "key": "endpoint_id.lte", "value": "string", "description": "Filter on `endpoint_id` with the `lte` operator." }, { "disabled": true, "key": "endpoint_id.gt", "value": "string", "description": "Filter on `endpoint_id` with the `gt` operator." }, { "disabled": true, "key": "endpoint_id.lt", "value": "string", "description": "Filter on `endpoint_id` with the `lt` operator." }, { "disabled": true, "key": "endpoint_id.in", "value": "string", "description": "Filter on `endpoint_id` with the `in` operator." }, { "disabled": true, "key": "event_id", "value": "string", "description": "Filter on `event_id`. Comma-separated values are OR." }, { "disabled": true, "key": "event_id.gte", "value": "string", "description": "Filter on `event_id` with the `gte` operator." }, { "disabled": true, "key": "event_id.lte", "value": "string", "description": "Filter on `event_id` with the `lte` operator." }, { "disabled": true, "key": "event_id.gt", "value": "string", "description": "Filter on `event_id` with the `gt` operator." }, { "disabled": true, "key": "event_id.lt", "value": "string", "description": "Filter on `event_id` with the `lt` operator." }, { "disabled": true, "key": "event_id.in", "value": "string", "description": "Filter on `event_id` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cac136ee-df67-4b4c-879a-620374af2cfc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "endpoint_id", "value": "string" }, { "key": "endpoint_id.gte", "value": "string" }, { "key": "endpoint_id.lte", "value": "string" }, { "key": "endpoint_id.gt", "value": "string" }, { "key": "endpoint_id.lt", "value": "string" }, { "key": "endpoint_id.in", "value": "string" }, { "key": "event_id", "value": "string" }, { "key": "event_id.gte", "value": "string" }, { "key": "event_id.lte", "value": "string" }, { "key": "event_id.gt", "value": "string" }, { "key": "event_id.lt", "value": "string" }, { "key": "event_id.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"endpoint_id\": \"string\",\n \"event_id\": \"string\",\n \"attempt\": 9919,\n \"status\": \"string\",\n \"response_code\": 1105,\n \"next_retry_at\": \"1951-03-18T01:46:59.133Z\",\n \"delivered_at\": \"1973-10-10T17:22:09.170Z\",\n \"created_at\": \"1982-05-10T13:11:02.301Z\",\n \"updated_at\": \"2022-07-30T18:35:56.755Z\"\n },\n {\n \"id\": \"string\",\n \"endpoint_id\": \"string\",\n \"event_id\": \"string\",\n \"attempt\": 2118,\n \"status\": \"string\",\n \"response_code\": 4226,\n \"next_retry_at\": \"2020-08-09T15:50:30.694Z\",\n \"delivered_at\": \"1992-05-14T05:55:04.941Z\",\n \"created_at\": \"2022-01-16T19:36:47.056Z\",\n \"updated_at\": \"1950-06-21T07:29:11.399Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e62a8a2-62aa-4358-b7ea-78ff900ebce4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "endpoint_id", "value": "string" }, { "key": "endpoint_id.gte", "value": "string" }, { "key": "endpoint_id.lte", "value": "string" }, { "key": "endpoint_id.gt", "value": "string" }, { "key": "endpoint_id.lt", "value": "string" }, { "key": "endpoint_id.in", "value": "string" }, { "key": "event_id", "value": "string" }, { "key": "event_id.gte", "value": "string" }, { "key": "event_id.lte", "value": "string" }, { "key": "event_id.gt", "value": "string" }, { "key": "event_id.lt", "value": "string" }, { "key": "event_id.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5176c15d-819d-49ce-80a7-26f2c3c99591", "name": "Send one signed sample event to the endpoint, synchronously", "request": { "name": "Send one signed sample event to the endpoint, synchronously", "description": { "content": "Prove the receiver end to end before any real call depends on it.\n\nThe sample rides the exact production mechanics - same envelope keys, same compact\nkey-ordered serialization, same `Vocapable-Signature` scheme signed with the same\nsecrets (both, during a rotation overlap), same 10-second success rule - so a\nreceiver that verifies this ping verifies real traffic. `data.test: true` is the\nmarker; nothing durable is written and no outbox row is minted.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoint", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b6f49e56-d230-44f7-99de-ab653d30c37f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-endpoint", "test" ], "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"delivered\": false,\n \"status_code\": 5396,\n \"event_type\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c8605dc-32f3-4871-b193-b95ea7ada886", "name": "Put one exhausted delivery back on the retry ladder", "request": { "name": "Put one exhausted delivery back on the retry ladder", "description": { "content": "Self-service recovery after an outage outlasted the 24-hour retry window.\n\nOnly an `exhausted` delivery moves: `pending`/`failed` are already on the ladder,\nand a `delivered` one was received - re-sending it would deliver the same event\ntwice on a human's timescale. The requeued delivery gets exactly one more POST\n(the enqueue window is never reopened); a receiver that is still down returns it\nto `exhausted`, one press at a time.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-deliveries", ":delivery_id", "redrive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "delivery_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cbb86992-1112-4069-bef7-a0ba3e1e2131", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-deliveries", ":delivery_id", "redrive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "delivery_id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"endpoint_id\": \"string\",\n \"event_id\": \"string\",\n \"attempt\": 7208,\n \"status\": \"string\",\n \"response_code\": 5843,\n \"next_retry_at\": \"2014-08-30T00:00:35.352Z\",\n \"delivered_at\": \"1960-06-07T12:29:52.364Z\",\n \"created_at\": \"1994-11-20T12:23:52.677Z\",\n \"updated_at\": \"1959-03-19T03:31:49.602Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a068753f-b9d6-4f34-a786-53ce23251547", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-deliveries", ":delivery_id", "redrive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "delivery_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad0e6118-5e84-4d7b-b6b5-cb5589efa643", "name": "List bounded receptionist outcome delivery targets", "request": { "name": "List bounded receptionist outcome delivery targets", "description": { "content": "The control-center view of native outcome routing and its latest evidence.\n\nThe catalog is fixed in ``ReceptionistActionOutcome``; this route never renders a\ntenant-defined executable tool, schema, command, or signing secret. Delivery counts\nare an observation of the durable ledger, not a promise that an external receiver\ncompleted business work.", "type": "text/plain" }, "url": { "path": [ "v1", "receptionist-action-targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "73e53028-49d9-4dc3-a175-7f3812661b1f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"outcome_type\": \"string\",\n \"event_type\": \"string\",\n \"endpoint_id\": \"string\",\n \"endpoint_url\": \"string\",\n \"endpoint_status\": \"string\",\n \"delivery_count\": 5970,\n \"latest_delivery_status\": \"string\",\n \"latest_delivery_at\": \"1992-11-02T15:32:13.411Z\",\n \"last_tested_at\": \"1976-10-04T10:39:07.675Z\",\n \"last_test_status\": \"string\",\n \"last_test_response_code\": 9669,\n \"created_at\": \"2009-12-26T08:40:49.751Z\",\n \"updated_at\": \"2010-07-15T15:53:37.096Z\",\n \"signing_secret_source\": \"webhook_endpoint_create_or_rotate\"\n },\n {\n \"id\": \"string\",\n \"outcome_type\": \"string\",\n \"event_type\": \"string\",\n \"endpoint_id\": \"string\",\n \"endpoint_url\": \"string\",\n \"endpoint_status\": \"string\",\n \"delivery_count\": 5524,\n \"latest_delivery_status\": \"string\",\n \"latest_delivery_at\": \"2002-01-21T21:06:24.896Z\",\n \"last_tested_at\": \"2009-12-16T11:49:10.786Z\",\n \"last_test_status\": \"string\",\n \"last_test_response_code\": 6463,\n \"created_at\": \"1969-09-27T04:19:25.318Z\",\n \"updated_at\": \"1980-04-14T19:07:36.464Z\",\n \"signing_secret_source\": \"webhook_endpoint_create_or_rotate\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d495dec7-7b16-4d8d-bb21-fbb20c9f0897", "name": "Bind one predefined receptionist outcome to the signed endpoint", "request": { "name": "Bind one predefined receptionist outcome to the signed endpoint", "description": { "content": "Upsert one closed-catalog action binding.\n\nThe endpoint must already exist through ``PUT /webhook-endpoint``. That endpoint owns\nthe one-time HMAC secret and the durable retry worker; this resource only decides which\nnative outcome it may receive after its Inbox/resource transaction has committed.", "type": "text/plain" }, "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"endpoint_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e16f9f8-0925-41f5-b40a-ddf6a2f600c8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"endpoint_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"outcome_type\": \"string\",\n \"event_type\": \"string\",\n \"endpoint_id\": \"string\",\n \"endpoint_url\": \"string\",\n \"endpoint_status\": \"string\",\n \"delivery_count\": 8400,\n \"latest_delivery_status\": \"string\",\n \"latest_delivery_at\": \"1988-07-18T12:26:28.521Z\",\n \"last_tested_at\": \"2008-02-14T07:48:07.008Z\",\n \"last_test_status\": \"string\",\n \"last_test_response_code\": 1473,\n \"created_at\": \"1975-07-12T22:30:10.741Z\",\n \"updated_at\": \"1958-11-28T05:15:21.037Z\",\n \"signing_secret_source\": \"webhook_endpoint_create_or_rotate\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "767f17db-1003-42d4-912a-def4da2335e4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"endpoint_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "330831ce-15f3-40cf-bfab-8d43226ed63d", "name": "Remove one receptionist outcome delivery binding", "request": { "name": "Remove one receptionist outcome delivery binding", "description": { "content": "Idempotently stop future external delivery for one outcome.\n\nExisting Inbox/resource rows and any already-enqueued delivery ledger rows remain\ndurable/auditable. Removing a binding cannot erase a caller's request or falsely turn a\ndelivered/failed historical outcome into a different state.", "type": "text/plain" }, "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2af1f0ed-c845-4d4e-a8f2-8bff1ec8d764", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50be53ef-220f-44df-8ccc-a85810da2e75", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb04bb2a-fbc0-45bf-9cc4-f99ae06615ae", "name": "List durable deliveries for one receptionist outcome", "request": { "name": "List durable deliveries for one receptionist outcome", "description": { "content": "The exact retry/delivery history behind one bound native outcome.", "type": "text/plain" }, "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "04958f8e-4354-4011-80f4-c6553148dc96", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"endpoint_id\": \"string\",\n \"event_id\": \"string\",\n \"attempt\": 9919,\n \"status\": \"string\",\n \"response_code\": 1105,\n \"next_retry_at\": \"1951-03-18T01:46:59.133Z\",\n \"delivered_at\": \"1973-10-10T17:22:09.170Z\",\n \"created_at\": \"1982-05-10T13:11:02.301Z\",\n \"updated_at\": \"2022-07-30T18:35:56.755Z\"\n },\n {\n \"id\": \"string\",\n \"endpoint_id\": \"string\",\n \"event_id\": \"string\",\n \"attempt\": 2118,\n \"status\": \"string\",\n \"response_code\": 4226,\n \"next_retry_at\": \"2020-08-09T15:50:30.694Z\",\n \"delivered_at\": \"1992-05-14T05:55:04.941Z\",\n \"created_at\": \"2022-01-16T19:36:47.056Z\",\n \"updated_at\": \"1950-06-21T07:29:11.399Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c229fed6-c76b-467a-8960-cf63f5f2d89a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d156223-0f98-419f-9ae9-d888736cc2cf", "name": "Send a signed setup-check for one receptionist outcome target", "request": { "name": "Send a signed setup-check for one receptionist outcome target", "description": { "content": "Prove the exact action envelope/signature without creating a caller outcome.\n\nThis carries the real outcome event type but ``data.test: true`` and writes no Inbox,\nresource, event, or delivery ledger row. Its result is persisted on the binding so the\nportal can show the last setup check separately from the durable delivery ledger.", "type": "text/plain" }, "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a774d917-32ed-4eed-8fe0-e984ed077cb7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"delivered\": false,\n \"status_code\": 5396,\n \"event_type\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7d66676-6c89-41c1-a21c-e995ce16bd01", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "receptionist-action-targets", ":outcome_type", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "lead", "key": "outcome_type", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aa2e69b-5a26-4aae-b457-ea4eeab3bc1e", "name": "Register a custom_webhook tool target", "request": { "name": "Register a custom_webhook tool target", "description": { "content": "Register one target, minting its signing secret - the only time it is readable.\n\nEverything bind time would refuse is refused here, where it costs one API request\ninstead of one tool on a live call: a reserved name, a schema the runtime's validator\ncannot enforce, one over the prompt budget, and a URL outside the delivery policy.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-targets" ], "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 \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 7503.203554950222,\n \"key_1\": 8805.761452443654\n },\n \"side_effect\": \"read_only\",\n \"url\": \"string\",\n \"timeout_seconds\": 5,\n \"max_invocations_per_call\": 3\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5c2c1d44-f43c-4992-a22c-3cc273a1f432", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-targets" ], "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 \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 7503.203554950222,\n \"key_1\": 8805.761452443654\n },\n \"side_effect\": \"read_only\",\n \"url\": \"string\",\n \"timeout_seconds\": 5,\n \"max_invocations_per_call\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": \"string\",\n \"key_1\": 6552.7979712653805\n },\n \"side_effect\": \"string\",\n \"timeout_seconds\": 9531.093585049513,\n \"max_invocations_per_call\": 7835,\n \"url\": \"string\",\n \"status\": \"string\",\n \"previous_secret_expires_at\": \"2000-02-15T03:43:07.391Z\",\n \"created_at\": \"2024-12-25T05:47:13.500Z\",\n \"updated_at\": \"1953-03-22T08:03:07.492Z\",\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87236b5-9ce7-451f-be43-cf851a26c3b7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-targets" ], "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 \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 7503.203554950222,\n \"key_1\": 8805.761452443654\n },\n \"side_effect\": \"read_only\",\n \"url\": \"string\",\n \"timeout_seconds\": 5,\n \"max_invocations_per_call\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c18cdb1f-8b1e-40a3-a558-a721a9775e0b", "name": "List every webhook target, active and disabled", "request": { "name": "List every webhook target, active and disabled", "description": {}, "url": { "path": [ "v1", "webhook-targets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4b6c9248-20c3-4e99-9478-1d75f28be6bf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-targets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 3770.2776480012835\n },\n \"side_effect\": \"string\",\n \"timeout_seconds\": 4665.123816330647,\n \"max_invocations_per_call\": 5194,\n \"url\": \"string\",\n \"status\": \"string\",\n \"previous_secret_expires_at\": \"1976-06-09T06:24:42.177Z\",\n \"created_at\": \"1976-05-13T23:13:02.454Z\",\n \"updated_at\": \"1987-12-06T03:03:48.965Z\"\n },\n {\n \"id\": \"string\",\n \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 798.7708509535496\n },\n \"side_effect\": \"string\",\n \"timeout_seconds\": 1439.0035472029151,\n \"max_invocations_per_call\": 6835,\n \"url\": \"string\",\n \"status\": \"string\",\n \"previous_secret_expires_at\": \"1994-06-20T01:15:24.941Z\",\n \"created_at\": \"1952-09-15T15:56:33.664Z\",\n \"updated_at\": \"1987-05-10T03:30:05.581Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36cc9836-9a8f-4329-a9d0-fa31f1a18f3b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-targets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1a22b7d-8791-4b27-89ec-7fc890dae134", "name": "Read one webhook target", "request": { "name": "Read one webhook target", "description": {}, "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "08585407-a62d-497f-8437-487313eed044", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 4130,\n \"key_1\": 4418,\n \"key_2\": 2553\n },\n \"side_effect\": \"string\",\n \"timeout_seconds\": 6663.478651442485,\n \"max_invocations_per_call\": 3752,\n \"url\": \"string\",\n \"status\": \"string\",\n \"previous_secret_expires_at\": \"1955-03-20T02:36:31.472Z\",\n \"created_at\": \"1961-03-01T17:03:09.932Z\",\n \"updated_at\": \"2001-03-24T04:33:44.569Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd857b56-c76b-4922-a82b-31eca116af40", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0d1b5ef-bb89-4537-a96c-1ecc1b89cc08", "name": "Update a webhook target", "request": { "name": "Update a webhook target", "description": { "content": "Apply the supplied fields, under the same boundary checks as registration.\n\nAn edit takes effect for calls redeemed after it commits; a call already running keeps\nthe configuration its session was bound with.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "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\": \"string\",\n \"parameters\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"side_effect\": \"read_only\",\n \"url\": \"string\",\n \"timeout_seconds\": 28.55671207007491,\n \"max_invocations_per_call\": 11,\n \"status\": \"disabled\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a482ba4c-7570-4070-b267-7a2ca6c234a9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "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\": \"string\",\n \"parameters\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"side_effect\": \"read_only\",\n \"url\": \"string\",\n \"timeout_seconds\": 28.55671207007491,\n \"max_invocations_per_call\": 11,\n \"status\": \"disabled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": 4130,\n \"key_1\": 4418,\n \"key_2\": 2553\n },\n \"side_effect\": \"string\",\n \"timeout_seconds\": 6663.478651442485,\n \"max_invocations_per_call\": 3752,\n \"url\": \"string\",\n \"status\": \"string\",\n \"previous_secret_expires_at\": \"1955-03-20T02:36:31.472Z\",\n \"created_at\": \"1961-03-01T17:03:09.932Z\",\n \"updated_at\": \"2001-03-24T04:33:44.569Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb7c5ad-9c72-4aab-971e-89cd85bdc398", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "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\": \"string\",\n \"parameters\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"side_effect\": \"read_only\",\n \"url\": \"string\",\n \"timeout_seconds\": 28.55671207007491,\n \"max_invocations_per_call\": 11,\n \"status\": \"disabled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de06f7ca-4481-4d9b-935b-bd87a03b9566", "name": "Disable a webhook target", "request": { "name": "Disable a webhook target", "description": { "content": "Disable-not-delete: the id stays attributable in transcripts and eval history.\n\nIdempotent - deleting an already-disabled target changes nothing and answers 204,\nso a retried DELETE cannot fail its caller. Re-enabling is `PATCH {status: active}`.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "79ec446c-e349-4dbd-977a-71bbbe4cae79", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec04d222-d1a1-489c-807e-5c2d2c4bd0fa", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1929c1de-646f-4933-b83a-92160dd75331", "name": "Rotate the target's signing secret", "request": { "name": "Rotate the target's signing secret", "description": { "content": "Mint a new signing secret, keeping the superseded one valid for 24 hours.\n\nDuring the overlap every dispatch carries two `v1=` signatures - one per secret - so\nthe receiver can be redeployed with the new key at any point inside the window,\nexactly like the endpoint rotation above (docs/04-api.md §5 signing).\n\nAn `Idempotency-Key` is honored so a retried rotate replays the first rotation's minted\nsecret rather than rotating twice and collapsing the previous secret's overlap. The\nclaim shares this request's transaction with the rotation.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-targets", ":target_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ddbd6ead-c2f1-4278-94c8-5d2ca2b2c384", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"webhook_id\": \"string\",\n \"description\": \"string\",\n \"parameters\": {\n \"key_0\": \"string\",\n \"key_1\": 6552.7979712653805\n },\n \"side_effect\": \"string\",\n \"timeout_seconds\": 9531.093585049513,\n \"max_invocations_per_call\": 7835,\n \"url\": \"string\",\n \"status\": \"string\",\n \"previous_secret_expires_at\": \"2000-02-15T03:43:07.391Z\",\n \"created_at\": \"2024-12-25T05:47:13.500Z\",\n \"updated_at\": \"1953-03-22T08:03:07.492Z\",\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b85974cb-07a0-441e-860d-dc4a519d8af7", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "webhook-targets", ":target_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "target_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "00bb3bc2-d1cb-4ece-83d6-50ca59627a8d", "name": "messages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2fabe9bc-38b9-4b44-968c-7a229fee9f39", "name": "List this tenant's messages", "request": { "name": "List this tenant's messages", "description": {}, "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "contact_id", "value": "string", "description": "Filter on `contact_id`. Comma-separated values are OR." }, { "disabled": true, "key": "contact_id.gte", "value": "string", "description": "Filter on `contact_id` with the `gte` operator." }, { "disabled": true, "key": "contact_id.lte", "value": "string", "description": "Filter on `contact_id` with the `lte` operator." }, { "disabled": true, "key": "contact_id.gt", "value": "string", "description": "Filter on `contact_id` with the `gt` operator." }, { "disabled": true, "key": "contact_id.lt", "value": "string", "description": "Filter on `contact_id` with the `lt` operator." }, { "disabled": true, "key": "contact_id.in", "value": "string", "description": "Filter on `contact_id` with the `in` operator." }, { "disabled": true, "key": "created_at", "value": "string", "description": "Filter on `created_at`. Comma-separated values are OR." }, { "disabled": true, "key": "created_at.gte", "value": "string", "description": "Filter on `created_at` with the `gte` operator." }, { "disabled": true, "key": "created_at.lte", "value": "string", "description": "Filter on `created_at` with the `lte` operator." }, { "disabled": true, "key": "created_at.gt", "value": "string", "description": "Filter on `created_at` with the `gt` operator." }, { "disabled": true, "key": "created_at.lt", "value": "string", "description": "Filter on `created_at` with the `lt` operator." }, { "disabled": true, "key": "created_at.in", "value": "string", "description": "Filter on `created_at` with the `in` operator." }, { "disabled": true, "key": "direction", "value": "string", "description": "Filter on `direction`. Comma-separated values are OR." }, { "disabled": true, "key": "direction.gte", "value": "string", "description": "Filter on `direction` with the `gte` operator." }, { "disabled": true, "key": "direction.lte", "value": "string", "description": "Filter on `direction` with the `lte` operator." }, { "disabled": true, "key": "direction.gt", "value": "string", "description": "Filter on `direction` with the `gt` operator." }, { "disabled": true, "key": "direction.lt", "value": "string", "description": "Filter on `direction` with the `lt` operator." }, { "disabled": true, "key": "direction.in", "value": "string", "description": "Filter on `direction` with the `in` operator." }, { "disabled": true, "key": "inbound_intent", "value": "string", "description": "Filter on `inbound_intent`. Comma-separated values are OR." }, { "disabled": true, "key": "inbound_intent.gte", "value": "string", "description": "Filter on `inbound_intent` with the `gte` operator." }, { "disabled": true, "key": "inbound_intent.lte", "value": "string", "description": "Filter on `inbound_intent` with the `lte` operator." }, { "disabled": true, "key": "inbound_intent.gt", "value": "string", "description": "Filter on `inbound_intent` with the `gt` operator." }, { "disabled": true, "key": "inbound_intent.lt", "value": "string", "description": "Filter on `inbound_intent` with the `lt` operator." }, { "disabled": true, "key": "inbound_intent.in", "value": "string", "description": "Filter on `inbound_intent` with the `in` operator." }, { "disabled": true, "key": "origin_call_id", "value": "string", "description": "Filter on `origin_call_id`. Comma-separated values are OR." }, { "disabled": true, "key": "origin_call_id.gte", "value": "string", "description": "Filter on `origin_call_id` with the `gte` operator." }, { "disabled": true, "key": "origin_call_id.lte", "value": "string", "description": "Filter on `origin_call_id` with the `lte` operator." }, { "disabled": true, "key": "origin_call_id.gt", "value": "string", "description": "Filter on `origin_call_id` with the `gt` operator." }, { "disabled": true, "key": "origin_call_id.lt", "value": "string", "description": "Filter on `origin_call_id` with the `lt` operator." }, { "disabled": true, "key": "origin_call_id.in", "value": "string", "description": "Filter on `origin_call_id` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "27f5c23a-8872-4b80-a7ec-da5bbe554d02", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "direction.gte", "value": "string" }, { "key": "direction.lte", "value": "string" }, { "key": "direction.gt", "value": "string" }, { "key": "direction.lt", "value": "string" }, { "key": "direction.in", "value": "string" }, { "key": "inbound_intent", "value": "string" }, { "key": "inbound_intent.gte", "value": "string" }, { "key": "inbound_intent.lte", "value": "string" }, { "key": "inbound_intent.gt", "value": "string" }, { "key": "inbound_intent.lt", "value": "string" }, { "key": "inbound_intent.in", "value": "string" }, { "key": "origin_call_id", "value": "string" }, { "key": "origin_call_id.gte", "value": "string" }, { "key": "origin_call_id.lte", "value": "string" }, { "key": "origin_call_id.gt", "value": "string" }, { "key": "origin_call_id.lt", "value": "string" }, { "key": "origin_call_id.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"direction\": \"outbound\",\n \"phone_number_id\": \"string\",\n \"contact_id\": \"string\",\n \"to_e164\": \"string\",\n \"from_e164\": \"string\",\n \"template_id\": \"string\",\n \"body_rendered\": \"string\",\n \"status\": \"sent\",\n \"provider_sid\": \"string\",\n \"origin_call_id\": \"string\",\n \"inbound_intent\": {\n \"value\": \"\"\n },\n \"segments\": 2495,\n \"created_at\": \"1971-01-25T23:03:21.255Z\",\n \"updated_at\": \"2022-01-03T07:40:15.383Z\"\n },\n {\n \"id\": \"string\",\n \"direction\": \"inbound\",\n \"phone_number_id\": \"string\",\n \"contact_id\": \"string\",\n \"to_e164\": \"string\",\n \"from_e164\": \"string\",\n \"template_id\": \"string\",\n \"body_rendered\": \"string\",\n \"status\": \"received\",\n \"provider_sid\": \"string\",\n \"origin_call_id\": \"string\",\n \"inbound_intent\": {\n \"value\": \"\"\n },\n \"segments\": 2640,\n \"created_at\": \"1973-08-05T19:51:12.235Z\",\n \"updated_at\": \"2003-01-12T00:59:31.381Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aa0efa1-8a90-42db-8ff4-75b1e6fe0b72", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "contact_id", "value": "string" }, { "key": "contact_id.gte", "value": "string" }, { "key": "contact_id.lte", "value": "string" }, { "key": "contact_id.gt", "value": "string" }, { "key": "contact_id.lt", "value": "string" }, { "key": "contact_id.in", "value": "string" }, { "key": "created_at", "value": "string" }, { "key": "created_at.gte", "value": "string" }, { "key": "created_at.lte", "value": "string" }, { "key": "created_at.gt", "value": "string" }, { "key": "created_at.lt", "value": "string" }, { "key": "created_at.in", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "direction.gte", "value": "string" }, { "key": "direction.lte", "value": "string" }, { "key": "direction.gt", "value": "string" }, { "key": "direction.lt", "value": "string" }, { "key": "direction.in", "value": "string" }, { "key": "inbound_intent", "value": "string" }, { "key": "inbound_intent.gte", "value": "string" }, { "key": "inbound_intent.lte", "value": "string" }, { "key": "inbound_intent.gt", "value": "string" }, { "key": "inbound_intent.lt", "value": "string" }, { "key": "inbound_intent.in", "value": "string" }, { "key": "origin_call_id", "value": "string" }, { "key": "origin_call_id.gte", "value": "string" }, { "key": "origin_call_id.lte", "value": "string" }, { "key": "origin_call_id.gt", "value": "string" }, { "key": "origin_call_id.lt", "value": "string" }, { "key": "origin_call_id.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d162231e-a7f4-4bab-84a7-39245aa4169e", "name": "Send an SMS from a number this tenant holds", "request": { "name": "Send an SMS from a number this tenant holds", "description": {}, "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "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 \"from_phone_number_id\": \"string\",\n \"to_e164\": \"+55027803402374\",\n \"template_id\": \"string\",\n \"body\": \"string\",\n \"variables\": {\n \"key_0\": \"string\"\n },\n \"origin_call_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20ac6286-5678-4980-b31c-6fe23a1c362c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from_phone_number_id\": \"string\",\n \"to_e164\": \"+55027803402374\",\n \"template_id\": \"string\",\n \"body\": \"string\",\n \"variables\": {\n \"key_0\": \"string\"\n },\n \"origin_call_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"direction\": \"inbound\",\n \"phone_number_id\": \"string\",\n \"contact_id\": \"string\",\n \"to_e164\": \"string\",\n \"from_e164\": \"string\",\n \"template_id\": \"string\",\n \"body_rendered\": \"string\",\n \"status\": \"received\",\n \"provider_sid\": \"string\",\n \"origin_call_id\": \"string\",\n \"inbound_intent\": \"other\",\n \"segments\": 3776,\n \"created_at\": \"1979-04-06T04:45:10.260Z\",\n \"updated_at\": \"1964-10-29T11:36:33.793Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e501d1a5-8910-4205-8c03-acfcb2daad85", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": true, "description": "Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries `Idempotent-Replay: true`. A UUID is the documented shape.", "key": "Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from_phone_number_id\": \"string\",\n \"to_e164\": \"+55027803402374\",\n \"template_id\": \"string\",\n \"body\": \"string\",\n \"variables\": {\n \"key_0\": \"string\"\n },\n \"origin_call_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59e0f968-31c8-430d-a4f6-2a229f7d6915", "name": "List this tenant's message templates", "request": { "name": "List this tenant's message templates", "description": {}, "url": { "path": [ "v1", "message-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "50" }, { "disabled": true, "key": "cursor", "value": "string" }, { "disabled": true, "key": "locale", "value": "string", "description": "Filter on `locale`. Comma-separated values are OR." }, { "disabled": true, "key": "locale.gte", "value": "string", "description": "Filter on `locale` with the `gte` operator." }, { "disabled": true, "key": "locale.lte", "value": "string", "description": "Filter on `locale` with the `lte` operator." }, { "disabled": true, "key": "locale.gt", "value": "string", "description": "Filter on `locale` with the `gt` operator." }, { "disabled": true, "key": "locale.lt", "value": "string", "description": "Filter on `locale` with the `lt` operator." }, { "disabled": true, "key": "locale.in", "value": "string", "description": "Filter on `locale` with the `in` operator." }, { "disabled": true, "key": "status", "value": "string", "description": "Filter on `status`. Comma-separated values are OR." }, { "disabled": true, "key": "status.gte", "value": "string", "description": "Filter on `status` with the `gte` operator." }, { "disabled": true, "key": "status.lte", "value": "string", "description": "Filter on `status` with the `lte` operator." }, { "disabled": true, "key": "status.gt", "value": "string", "description": "Filter on `status` with the `gt` operator." }, { "disabled": true, "key": "status.lt", "value": "string", "description": "Filter on `status` with the `lt` operator." }, { "disabled": true, "key": "status.in", "value": "string", "description": "Filter on `status` with the `in` operator." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b336e823-4924-4ddb-9263-9b00bb798e36", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "message-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "locale", "value": "string" }, { "key": "locale.gte", "value": "string" }, { "key": "locale.lte", "value": "string" }, { "key": "locale.gt", "value": "string" }, { "key": "locale.lt", "value": "string" }, { "key": "locale.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"locale\": \"string\",\n \"body\": \"string\",\n \"status\": \"string\",\n \"variables\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1956-08-08T16:35:56.136Z\",\n \"updated_at\": \"1958-02-23T11:16:52.663Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"locale\": \"string\",\n \"body\": \"string\",\n \"status\": \"string\",\n \"variables\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1949-10-28T23:21:33.795Z\",\n \"updated_at\": \"1963-03-08T17:42:31.659Z\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a63e30e-904a-4666-9078-8173feee0694", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "message-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "cursor", "value": "string" }, { "key": "locale", "value": "string" }, { "key": "locale.gte", "value": "string" }, { "key": "locale.lte", "value": "string" }, { "key": "locale.gt", "value": "string" }, { "key": "locale.lt", "value": "string" }, { "key": "locale.in", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status.gte", "value": "string" }, { "key": "status.lte", "value": "string" }, { "key": "status.gt", "value": "string" }, { "key": "status.lt", "value": "string" }, { "key": "status.in", "value": "string" } ], "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 \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5648a006-5300-4157-8e66-cc39fdbde263", "name": "Create a message template", "request": { "name": "Create a message template", "description": {}, "url": { "path": [ "v1", "message-templates" ], "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\": \"string\",\n \"body\": \"string\",\n \"locale\": \"en\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "83fab081-5e7a-4edd-ba8d-f965138b5774", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "message-templates" ], "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 \"name\": \"string\",\n \"body\": \"string\",\n \"locale\": \"en\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"locale\": \"string\",\n \"body\": \"string\",\n \"status\": \"string\",\n \"variables\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1973-02-18T05:42:38.100Z\",\n \"updated_at\": \"2008-04-27T20:18:57.692Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d515ee-0c52-4aac-98c1-bea2386efb94", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "message-templates" ], "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 \"name\": \"string\",\n \"body\": \"string\",\n \"locale\": \"en\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25185041-3e02-4be6-afd8-e1e26b0bd26c", "name": "Archive or reactivate a message template", "request": { "name": "Archive or reactivate a message template", "description": { "content": "The one legal template mutation: the status flip (see the request model).", "type": "text/plain" }, "url": { "path": [ "v1", "message-templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "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 \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a2c16ded-104c-4b14-800d-e16ef25699b6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "message-templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "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 \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"locale\": \"string\",\n \"body\": \"string\",\n \"status\": \"string\",\n \"variables\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1973-02-18T05:42:38.100Z\",\n \"updated_at\": \"2008-04-27T20:18:57.692Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0543ee73-2ac7-45c2-ac29-c9f9c23e9b06", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "message-templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) " } ] }, "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 \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "205391bc-f2d2-4bf1-a73b-e5c2227d500e", "name": "Record an inbound SMS delivered by the provider", "request": { "name": "Record an inbound SMS delivered by the provider", "description": {}, "url": { "path": [ "v1", "messages", "inbound" ], "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 \"from_e164\": \"+327\",\n \"to_e164\": \"+23519712\",\n \"body\": \"string\",\n \"provider_sid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "63867d1c-90f0-4d86-9441-fcafc6cb9c96", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "messages", "inbound" ], "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 \"from_e164\": \"+327\",\n \"to_e164\": \"+23519712\",\n \"body\": \"string\",\n \"provider_sid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message_id\": \"string\",\n \"intent\": \"other\",\n \"dnc_entry_id\": \"string\",\n \"dnc_entry_created\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e38ab65-86cb-46e7-9dab-ad28c5a2e988", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "messages", "inbound" ], "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 \"from_e164\": \"+327\",\n \"to_e164\": \"+23519712\",\n \"body\": \"string\",\n \"provider_sid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2e15d67c-13ac-4edf-84e3-db08b88b3e6e", "name": "workspace", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "84190afa-3408-4cc3-8a67-e6656a450319", "name": "Read the deployment and tenant capability map for this workspace", "request": { "name": "Read the deployment and tenant capability map for this workspace", "description": { "content": "Return one fresh readiness map without mutating a workspace or reserving capacity.", "type": "text/plain" }, "url": { "path": [ "v1", "workspace-capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c4635471-d741-496f-9986-d5b00cae2e55", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workspace-capabilities" ], "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"generated_at\": \"2019-08-21T06:32:05.309Z\",\n \"capabilities\": [\n {\n \"key\": \"phone_test_call\",\n \"state\": \"needs_setup\",\n \"blockers\": [\n \"runtime_not_configured\",\n \"test_call_daily_cap_reached\"\n ]\n },\n {\n \"key\": \"calendar_booking\",\n \"state\": \"needs_setup\",\n \"blockers\": [\n \"calls_write_scope_required\",\n \"agents_write_scope_required\"\n ]\n },\n {\n \"key\": \"text_chat_test\",\n \"state\": \"ready\",\n \"blockers\": [\n \"runtime_not_configured\",\n \"voice_catalog_empty\"\n ]\n },\n {\n \"key\": \"guided_setup\",\n \"state\": \"needs_setup\",\n \"blockers\": [\n \"agent_chat_not_configured\",\n \"agent_chat_not_configured\"\n ]\n },\n {\n \"key\": \"guided_setup\",\n \"state\": \"needs_setup\",\n \"blockers\": [\n \"runtime_not_configured\",\n \"browser_runtime_not_configured\"\n ]\n },\n {\n \"key\": \"voice_preview\",\n \"state\": \"unavailable\",\n \"blockers\": [\n \"fleet_placement_not_configured\",\n \"calls_write_scope_required\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4193f82b-64d4-4da6-b491-e7ed787c8de6", "name": "Record one privacy-safe customer portal funnel event", "request": { "name": "Record one privacy-safe customer portal funnel event", "description": { "content": "Write only finite, non-identifying portal dimensions to structured monitoring.\n\nThis endpoint deliberately owns no database model, progression record, counter, or\nresource join. It is a best-effort operational signal; the browser never waits for\nit to decide whether a customer can keep setting up their workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "workspace-telemetry" ], "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 \"event\": \"developer_handoff_opened\",\n \"workflow\": \"not_applicable\",\n \"workforce_track\": \"not_applicable\",\n \"surface\": \"unknown\",\n \"test_channel\": \"not_applicable\",\n \"blocker\": \"test_call_daily_cap_reached\",\n \"duration_bucket\": \"not_applicable\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d83f3943-afb6-4cc6-808c-e14b94facaf1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "workspace-telemetry" ], "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 \"event\": \"developer_handoff_opened\",\n \"workflow\": \"not_applicable\",\n \"workforce_track\": \"not_applicable\",\n \"surface\": \"unknown\",\n \"test_channel\": \"not_applicable\",\n \"blocker\": \"test_call_daily_cap_reached\",\n \"duration_bucket\": \"not_applicable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recorded\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6526ef9-75d6-489f-8cb3-6b312b448d24", "name": "Validation Error", "originalRequest": { "url": { "path": [ "v1", "workspace-telemetry" ], "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 \"event\": \"developer_handoff_opened\",\n \"workflow\": \"not_applicable\",\n \"workforce_track\": \"not_applicable\",\n \"surface\": \"unknown\",\n \"test_channel\": \"not_applicable\",\n \"blocker\": \"test_call_daily_cap_reached\",\n \"duration_bucket\": \"not_applicable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n },\n {\n \"loc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"msg\": \"string\",\n \"type\": \"string\",\n \"input\": {},\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.vocapable.com" }, { "key": "apiKey", "value": "vcp_test_..." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "info": { "_postman_id": "ed7ea8b3-8637-41a6-a585-e900b1fce0bd", "name": "Vocapable API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from the committed OpenAPI 3.1 snapshot (spec version 0.1.0, sha256 239a31550856f2b3d4ac474fc0f589f6b98622c1f5596694393f4e0734901826). Set {{apiKey}} to your key; vcp_test_ keys are free and route all telephony to a simulated provider. Docs: https://docs.vocapable.com" } }