{"item":[{"id":"5aeeaa8c-ad1c-431a-b28e-d7994394a33e","name":"Agent Suggestions","description":{"content":"Get AI-powered reply suggestions for conversations based on context and message history.","type":"text/plain"},"item":[{"id":"ee7238a3-37c9-42bd-add8-bada49a4cb9f","name":"Get Agent Suggestions","request":{"name":"Get Agent Suggestions","description":{"content":"Get AI-powered suggestions for agent based on conversation context.\n\nSearches the knowledge base using recent messages as context and returns\nrelevant suggestions from FAQs, manuals, and past tickets.\n\nArgs:\n conversation_id: Conversation ID to get suggestions for\n\nReturns:\n Dict with:\n - suggestion_id: ID for tracking acceptance\n - answer: AI-generated response\n - sources: List of relevant documents/tickets\n - query: Query used for search\n\n**🔐 Required Scopes:** `conversations:read`\n","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","suggest"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"kb_only\": {\n \"value\": \"\"\n },\n \"detailed_response\": {\n \"value\": \"\"\n },\n \"use_full_conversation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"86587f96-bd8d-4b1f-9944-b2bf8b0f5410","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","suggest"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"kb_only\": {\n \"value\": \"\"\n },\n \"detailed_response\": {\n \"value\": \"\"\n },\n \"use_full_conversation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"answer\": \"Based on our documentation, you can reset your password by...\",\n \"citations\": [],\n \"confidence\": 0.85,\n \"query\": \"how do I reset my password\",\n \"sources\": [\n {\n \"relevance_score\": 0.95,\n \"title\": \"Password Reset\",\n \"type\": \"faq\"\n }\n ],\n \"suggestion_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"59274623-5794-4d4e-b78a-2a2895bcc25f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","suggest"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"kb_only\": {\n \"value\": \"\"\n },\n \"detailed_response\": {\n \"value\": \"\"\n },\n \"use_full_conversation\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9d4c9aca-9912-431f-b8a9-b7511cab5d8e","name":"Accept Suggestion","request":{"name":"Accept Suggestion","description":{"content":"Mark a suggestion as accepted by the agent.\n\nThis tracks which suggestions are helpful for improving the knowledge base.\n\nArgs:\n suggestion_id: Suggestion ID to mark as accepted\n accepted_source_id: Optional ID of the specific source that was used\n ai_answer_event_id: The event id returned by /suggest. Pass it so the\n acceptance lands on the right event and the FAQ entries behind the\n answer get credited (times_in_sent_reply). Omitted, the event is\n matched back from the suggestion's conversation + query.\n\nReturns:\n Success message\n\n**🔐 Required Scopes:** `conversations:update`\n","type":"text/plain"},"url":{"path":["api","v1","suggestions",":suggestion_id","accept"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"accepted_source_id","value":"string"},{"disabled":false,"key":"ai_answer_event_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"7d7922d2-d66b-4427-94ec-fb28a660326d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","suggestions",":suggestion_id","accept"],"host":["{{baseUrl}}"],"query":[{"key":"accepted_source_id","value":"string"},{"key":"ai_answer_event_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"suggestion_id\": \"string\",\n \"ai_answer_event_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5708f21c-2cfe-4f85-bf0d-06164add41a3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","suggestions",":suggestion_id","accept"],"host":["{{baseUrl}}"],"query":[{"key":"accepted_source_id","value":"string"},{"key":"ai_answer_event_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2d02ad92-9879-42c2-a094-74f897ad36a4","name":"Get Suggestion History","request":{"name":"Get Suggestion History","description":{"content":"Get suggestion history for a conversation.\n\nReturns list of previous suggestions made for this conversation.\n\nArgs:\n conversation_id: Conversation ID\n\nReturns:\n List of suggestion records\n\n**🔐 Required Scopes:** `conversations:read`\n","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","suggestions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"6b93b8a2-0beb-4d60-a2d0-abfd0533c195","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","suggestions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"key_0\": 9017.51718126155,\n \"key_1\": 9929.16667383195\n },\n {\n \"key_0\": false\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"cbc36e13-d48d-400c-8e92-805c0ddecf0b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","suggestions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5b4ef1d0-6235-4b4e-b100-a6d4e849e658","name":"Search Similar Tickets For Conversation","request":{"name":"Search Similar Tickets For Conversation","description":{"content":"**Retired.** Always returns `410 Gone`.\n\nSimilar ticket search was retired in October 2026 (conversation summaries\nare no longer indexed for search). Summaries are still stored on each\nconversation; list them with `GET /api/v1/knowledge-base/tickets`.\n\n**Required Scopes:** `conversations:read`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","search-similar-tickets"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"4e88dbc4-9270-477d-b4a4-89c9dc5e8677","name":"AI Agents","description":{"content":"Beta. Create and manage Conversational Agents: persona, instructions, skills, knowledge sources, handoff rules, test console and turn audit log.","type":"text/plain"},"item":[{"id":"3a901e06-9367-4eeb-800c-b982dc750f6a","name":"List Agents","request":{"name":"List Agents","description":{"content":"List Conversational Agents.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"50"},{"disabled":false,"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"6765516a-3dc1-4ce7-8d86-091ca395eed3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d04f0bb5-f34a-41d0-89e1-5f5794124c34","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"search","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d9487371-70c4-48ba-bb27-8696fed82630","name":"Create Agent","request":{"name":"Create Agent","description":{"content":"Create a Conversational Agent (backing bot row + agent config, optional\ninline skills and knowledge sources) in one transaction.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","agents"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": 3297,\n \"turn_timeout_ms\": 3592,\n \"settings\": {\n \"key_0\": 2242,\n \"key_1\": true\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": false,\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 1070.9185428694368,\n \"key_1\": true,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"is_active\": true,\n \"publish\": true,\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c17d953d-1513-494f-aff0-5a096ba1bbb8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": 3297,\n \"turn_timeout_ms\": 3592,\n \"settings\": {\n \"key_0\": 2242,\n \"key_1\": true\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": false,\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 1070.9185428694368,\n \"key_1\": true,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"is_active\": true,\n \"publish\": true,\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"language_settings\": {\n \"response_language\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"auto_translate_messages\": {\n \"value\": \"\"\n },\n \"language_detection_strategy\": {\n \"value\": \"\"\n }\n },\n \"escalation\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"offers_escalation\": {\n \"value\": \"\"\n },\n \"handoff_message\": {\n \"value\": \"\"\n },\n \"escalation_keywords\": {\n \"value\": \"\"\n },\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": {\n \"value\": \"\"\n },\n \"outside_hours_message\": {\n \"value\": \"\"\n },\n \"is_escalation_schedule_enabled\": {\n \"value\": \"\"\n },\n \"escalation_timezone\": {\n \"value\": \"\"\n },\n \"escalation_schedule\": {\n \"value\": \"\"\n },\n \"escalation_schedule_mode\": {\n \"value\": \"\"\n }\n },\n \"max_tool_calls\": 6080,\n \"turn_timeout_ms\": 3915,\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": 2390\n },\n \"tools_config\": {\n \"key_0\": 2396,\n \"key_1\": 2440.579250522724\n },\n \"handoff_config\": {\n \"key_0\": \"string\"\n },\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"channel_actions\": {\n \"mark_as_read\": {\n \"value\": \"\"\n },\n \"typing_indicator\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": \"string\"\n },\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2020-08-08T03:56:13.794Z\",\n \"updated_at\": \"1963-06-07T11:23:18.234Z\",\n \"publish_state\": \"published\",\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-01-28T00:03:41.306Z\",\n \"published_at\": \"1998-09-27T05:41:50.074Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3b7ea165-e469-48ee-a746-49f71ecd5912","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": 3297,\n \"turn_timeout_ms\": 3592,\n \"settings\": {\n \"key_0\": 2242,\n \"key_1\": true\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": false,\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 1070.9185428694368,\n \"key_1\": true,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"is_active\": true,\n \"publish\": true,\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"09e6a792-fe7e-4c21-8616-30697ce7bbb4","name":"Get Agent","request":{"name":"Get Agent","description":{"content":"Get one Conversational Agent.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","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"},"response":[{"id":"5522feaf-618e-4846-8650-4aa45a63d9e1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"language_settings\": {\n \"response_language\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"auto_translate_messages\": {\n \"value\": \"\"\n },\n \"language_detection_strategy\": {\n \"value\": \"\"\n }\n },\n \"escalation\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"offers_escalation\": {\n \"value\": \"\"\n },\n \"handoff_message\": {\n \"value\": \"\"\n },\n \"escalation_keywords\": {\n \"value\": \"\"\n },\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": {\n \"value\": \"\"\n },\n \"outside_hours_message\": {\n \"value\": \"\"\n },\n \"is_escalation_schedule_enabled\": {\n \"value\": \"\"\n },\n \"escalation_timezone\": {\n \"value\": \"\"\n },\n \"escalation_schedule\": {\n \"value\": \"\"\n },\n \"escalation_schedule_mode\": {\n \"value\": \"\"\n }\n },\n \"max_tool_calls\": 6080,\n \"turn_timeout_ms\": 3915,\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": 2390\n },\n \"tools_config\": {\n \"key_0\": 2396,\n \"key_1\": 2440.579250522724\n },\n \"handoff_config\": {\n \"key_0\": \"string\"\n },\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"channel_actions\": {\n \"mark_as_read\": {\n \"value\": \"\"\n },\n \"typing_indicator\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": \"string\"\n },\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2020-08-08T03:56:13.794Z\",\n \"updated_at\": \"1963-06-07T11:23:18.234Z\",\n \"publish_state\": \"published\",\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-01-28T00:03:41.306Z\",\n \"published_at\": \"1998-09-27T05:41:50.074Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d6be0260-477e-4f7b-8796-fb3747a0fd2e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f47ea1f0-52ad-4df9-8683-b308166728f7","name":"Update Agent","request":{"name":"Update Agent","description":{"content":"Update a Conversational Agent (persona, instructions, tools, handoff,\nlanguage and escalation settings).\n\n``tools_config`` is merged: keys omitted in the request keep their stored\nvalue. The response always carries concrete values for ``read_images``,\n``read_documents``, ``max_images_per_message`` (1-3) and\n``max_attachments_per_conversation`` (1-50). Writing ``read_images`` also\nsets the backing bot's ``vision_enabled``.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","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","body":{"mode":"raw","raw":"{\n \"instructions\": \"string\",\n \"model_tier\": \"advanced\",\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": 5388,\n \"turn_timeout_ms\": 9822,\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": true,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 8615,\n \"key_1\": true\n },\n \"name\": \"string\",\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9e7633d5-af87-484f-a947-bc7c1379fede","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","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":"PATCH","body":{"mode":"raw","raw":"{\n \"instructions\": \"string\",\n \"model_tier\": \"advanced\",\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": 5388,\n \"turn_timeout_ms\": 9822,\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": true,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 8615,\n \"key_1\": true\n },\n \"name\": \"string\",\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"language_settings\": {\n \"response_language\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"auto_translate_messages\": {\n \"value\": \"\"\n },\n \"language_detection_strategy\": {\n \"value\": \"\"\n }\n },\n \"escalation\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"offers_escalation\": {\n \"value\": \"\"\n },\n \"handoff_message\": {\n \"value\": \"\"\n },\n \"escalation_keywords\": {\n \"value\": \"\"\n },\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": {\n \"value\": \"\"\n },\n \"outside_hours_message\": {\n \"value\": \"\"\n },\n \"is_escalation_schedule_enabled\": {\n \"value\": \"\"\n },\n \"escalation_timezone\": {\n \"value\": \"\"\n },\n \"escalation_schedule\": {\n \"value\": \"\"\n },\n \"escalation_schedule_mode\": {\n \"value\": \"\"\n }\n },\n \"max_tool_calls\": 6080,\n \"turn_timeout_ms\": 3915,\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": 2390\n },\n \"tools_config\": {\n \"key_0\": 2396,\n \"key_1\": 2440.579250522724\n },\n \"handoff_config\": {\n \"key_0\": \"string\"\n },\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"channel_actions\": {\n \"mark_as_read\": {\n \"value\": \"\"\n },\n \"typing_indicator\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": \"string\"\n },\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2020-08-08T03:56:13.794Z\",\n \"updated_at\": \"1963-06-07T11:23:18.234Z\",\n \"publish_state\": \"published\",\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-01-28T00:03:41.306Z\",\n \"published_at\": \"1998-09-27T05:41:50.074Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ede9ee20-ac76-464c-a5f0-44387989fad7","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","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":"PATCH","body":{"mode":"raw","raw":"{\n \"instructions\": \"string\",\n \"model_tier\": \"advanced\",\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": 5388,\n \"turn_timeout_ms\": 9822,\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": true,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 8615,\n \"key_1\": true\n },\n \"name\": \"string\",\n \"is_active\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b8756eb4-a1a0-4291-8a87-bf2582ef190e","name":"Delete Agent","request":{"name":"Delete Agent","description":{"content":"Delete a Conversational Agent and its backing bot (rules, sessions, skill\nlinks and knowledge sources go with it). Returns 409 ``agent_in_use`` with\nthe flows while a published or paused flow's run_assistant node targets it.\n\n**Required Scopes:** `automation:delete`","type":"text/plain"},"url":{"path":["api","v1","automation","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":"DELETE"},"response":[{"id":"b623bc54-50f6-4ce4-8936-3ef5deabfe4d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","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":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"969f983f-0443-43c5-b56a-b0771742b833","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","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":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0c5ab81c-75d7-46fb-9863-c7acbccfb23f","name":"Get Agent Draft","request":{"name":"Get Agent Draft","description":{"content":"The editor document: the saved draft (rebased onto the current live\nconfig) or, without a draft, the live config. ``has_unpublished_changes``,\na per-section ``changes`` summary and the publish ``validation`` are\nincluded. Reading never modifies anything.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"b94dcda7-8f3a-4c2e-a828-ea7dd9f58c5c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"bot_id\": \"string\",\n \"document\": {\n \"key_0\": 9455.848371211667\n },\n \"live_document\": {\n \"key_0\": 6903.07888439473\n },\n \"publish_state\": \"published\",\n \"status\": \"draft\",\n \"flow_targeted\": true,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-11-14T03:23:55.056Z\",\n \"draft_updated_by_name\": \"string\",\n \"published_at\": \"1962-10-26T22:41:09.160Z\",\n \"published_by_name\": \"string\",\n \"changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"validation\": {\n \"errors\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"avatar_display_url\": \"string\",\n \"widget_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e086ef8c-dea3-4e8d-9fc9-fe7c3eaaf70d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"880a4031-40d5-4396-8680-94036892f48e","name":"Save Agent Draft","request":{"name":"Save Agent Draft","description":{"content":"Save (autosave) the agent draft. Fields left out keep their previous\ndraft value. Validated like the live endpoints (same 422 codes); new\nknowledge sources / channel rules get server ids. The live agent is not\nchanged until ``POST /agents/{id}/publish``. A draft identical to the\nlive config is cleared.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"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","body":{"mode":"raw","raw":"{\n \"document\": {\n \"instructions\": {\n \"value\": \"\"\n },\n \"model_tier\": {\n \"value\": \"\"\n },\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": {\n \"value\": \"\"\n },\n \"turn_timeout_ms\": {\n \"value\": \"\"\n },\n \"settings\": {\n \"value\": \"\"\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"greeting_message\": {\n \"value\": \"\"\n },\n \"ai_disclosure_message\": {\n \"value\": \"\"\n },\n \"ai_disclosure_include_escalation\": {\n \"value\": \"\"\n },\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": {\n \"value\": \"\"\n },\n \"source_footer_mode\": {\n \"value\": \"\"\n },\n \"source_link_params\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"greeting_buttons_enabled\": {\n \"value\": \"\"\n },\n \"greeting_human_button_caption\": {\n \"value\": \"\"\n },\n \"greeting_continue_button_caption\": {\n \"value\": \"\"\n },\n \"greeting_continue_ack_message\": {\n \"value\": \"\"\n },\n \"max_credits_per_conversation\": {\n \"value\": \"\"\n },\n \"skills\": {\n \"value\": \"\"\n },\n \"knowledge_sources\": {\n \"value\": \"\"\n },\n \"activation_rules\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dc90a19c-9804-471d-a2ed-9998b0f3665b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"document\": {\n \"instructions\": {\n \"value\": \"\"\n },\n \"model_tier\": {\n \"value\": \"\"\n },\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": {\n \"value\": \"\"\n },\n \"turn_timeout_ms\": {\n \"value\": \"\"\n },\n \"settings\": {\n \"value\": \"\"\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"greeting_message\": {\n \"value\": \"\"\n },\n \"ai_disclosure_message\": {\n \"value\": \"\"\n },\n \"ai_disclosure_include_escalation\": {\n \"value\": \"\"\n },\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": {\n \"value\": \"\"\n },\n \"source_footer_mode\": {\n \"value\": \"\"\n },\n \"source_link_params\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"greeting_buttons_enabled\": {\n \"value\": \"\"\n },\n \"greeting_human_button_caption\": {\n \"value\": \"\"\n },\n \"greeting_continue_button_caption\": {\n \"value\": \"\"\n },\n \"greeting_continue_ack_message\": {\n \"value\": \"\"\n },\n \"max_credits_per_conversation\": {\n \"value\": \"\"\n },\n \"skills\": {\n \"value\": \"\"\n },\n \"knowledge_sources\": {\n \"value\": \"\"\n },\n \"activation_rules\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"bot_id\": \"string\",\n \"document\": {\n \"key_0\": 9455.848371211667\n },\n \"live_document\": {\n \"key_0\": 6903.07888439473\n },\n \"publish_state\": \"published\",\n \"status\": \"draft\",\n \"flow_targeted\": true,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-11-14T03:23:55.056Z\",\n \"draft_updated_by_name\": \"string\",\n \"published_at\": \"1962-10-26T22:41:09.160Z\",\n \"published_by_name\": \"string\",\n \"changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"validation\": {\n \"errors\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"avatar_display_url\": \"string\",\n \"widget_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8000f33-6541-4273-b08f-3d127422c122","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"document\": {\n \"instructions\": {\n \"value\": \"\"\n },\n \"model_tier\": {\n \"value\": \"\"\n },\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"max_tool_calls\": {\n \"value\": \"\"\n },\n \"turn_timeout_ms\": {\n \"value\": \"\"\n },\n \"settings\": {\n \"value\": \"\"\n },\n \"channel_actions\": {\n \"value\": \"\"\n },\n \"persona\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"greeting_message\": {\n \"value\": \"\"\n },\n \"ai_disclosure_message\": {\n \"value\": \"\"\n },\n \"ai_disclosure_include_escalation\": {\n \"value\": \"\"\n },\n \"language_settings\": {\n \"value\": \"\"\n },\n \"escalation\": {\n \"value\": \"\"\n },\n \"source_footer_enabled\": {\n \"value\": \"\"\n },\n \"source_footer_mode\": {\n \"value\": \"\"\n },\n \"source_link_params\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"greeting_buttons_enabled\": {\n \"value\": \"\"\n },\n \"greeting_human_button_caption\": {\n \"value\": \"\"\n },\n \"greeting_continue_button_caption\": {\n \"value\": \"\"\n },\n \"greeting_continue_ack_message\": {\n \"value\": \"\"\n },\n \"max_credits_per_conversation\": {\n \"value\": \"\"\n },\n \"skills\": {\n \"value\": \"\"\n },\n \"knowledge_sources\": {\n \"value\": \"\"\n },\n \"activation_rules\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b184d0bd-6d8b-4fdf-a3ce-1efb03d9c165","name":"Discard Agent Draft","request":{"name":"Discard Agent Draft","description":{"content":"Discard the draft; returns the live config as the editor document.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"0de19d08-81bb-4a1d-9b04-5c4d6660b061","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"bot_id\": \"string\",\n \"document\": {\n \"key_0\": 9455.848371211667\n },\n \"live_document\": {\n \"key_0\": 6903.07888439473\n },\n \"publish_state\": \"published\",\n \"status\": \"draft\",\n \"flow_targeted\": true,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-11-14T03:23:55.056Z\",\n \"draft_updated_by_name\": \"string\",\n \"published_at\": \"1962-10-26T22:41:09.160Z\",\n \"published_by_name\": \"string\",\n \"changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"validation\": {\n \"errors\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"avatar_display_url\": \"string\",\n \"widget_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"360ad88f-a15e-41b8-a30f-0f2a82329b90","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ae5b5f2b-5cbe-4ca5-9de0-480fc844bad8","name":"Publish Agent","request":{"name":"Publish Agent","description":{"content":"Publish the draft in one transaction. Changes made to the live agent since\nthe draft was started are kept (three-way merge). Without a draft, a\nnever-published agent is simply made live. 422 ``publish_blocked`` lists\nthe blocking issues (``name_missing``, ``ai_disclosure_missing``,\n``goal_invalid``, ``live_source_invalid``, ``skill_missing``).\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","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"},"response":[{"id":"9f0feb90-dad9-4b32-bf7b-affa3d842ca6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"bot_id\": \"string\",\n \"document\": {\n \"key_0\": 9455.848371211667\n },\n \"live_document\": {\n \"key_0\": 6903.07888439473\n },\n \"publish_state\": \"published\",\n \"status\": \"draft\",\n \"flow_targeted\": true,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-11-14T03:23:55.056Z\",\n \"draft_updated_by_name\": \"string\",\n \"published_at\": \"1962-10-26T22:41:09.160Z\",\n \"published_by_name\": \"string\",\n \"changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"validation\": {\n \"errors\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"avatar_display_url\": \"string\",\n \"widget_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"545d7c68-cf17-4d2d-b309-1f8608aad4c2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"972eeaca-0a60-41f5-b0e9-fb20e6142404","name":"Upload Agent Avatar","request":{"name":"Upload Agent Avatar","description":{"content":"Upload an avatar into the agent DRAFT (live after publish). PNG, JPEG or\nWebP, max 2 MB; the content is checked (SVG is rejected). 422\n``invalid_avatar`` otherwise.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) "}]}},"response":[{"id":"2173570e-366a-4e18-a801-08ec58bd1981","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"bot_id\": \"string\",\n \"document\": {\n \"key_0\": 9455.848371211667\n },\n \"live_document\": {\n \"key_0\": 6903.07888439473\n },\n \"publish_state\": \"published\",\n \"status\": \"draft\",\n \"flow_targeted\": true,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-11-14T03:23:55.056Z\",\n \"draft_updated_by_name\": \"string\",\n \"published_at\": \"1962-10-26T22:41:09.160Z\",\n \"published_by_name\": \"string\",\n \"changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"validation\": {\n \"errors\": {\n \"value\": \"\"\n },\n \"warnings\": {\n \"value\": \"\"\n }\n },\n \"avatar_display_url\": \"string\",\n \"widget_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f8d6cfe2-ccdd-47fa-8159-46df626b63e8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f777d377-6963-4ee9-8ec9-7db4225e6dd4","name":"Replace Agent Skills","request":{"name":"Replace Agent Skills","description":{"content":"Replace the agent's skill links (mode / pinned version / order).\n\nEach link may carry ``sources`` = ``{web_search_mode, live_source_ids,\nlive_mode}`` (per-skill source override, stored in\n``settings.skill_sources``): omitted => keep the stored override, ``null``\n=> remove it. ``live_source_ids`` must be ``live_source`` sources of this\nagent (max 5). Overrides of skills no longer attached are dropped.\n422 ``invalid_skill_sources`` on a bad override.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","skills"],"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","body":{"mode":"raw","raw":"{\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"423a8eca-afc0-4956-acdd-8c3ce89b72d9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skills"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"language_settings\": {\n \"response_language\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"auto_translate_messages\": {\n \"value\": \"\"\n },\n \"language_detection_strategy\": {\n \"value\": \"\"\n }\n },\n \"escalation\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"offers_escalation\": {\n \"value\": \"\"\n },\n \"handoff_message\": {\n \"value\": \"\"\n },\n \"escalation_keywords\": {\n \"value\": \"\"\n },\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": {\n \"value\": \"\"\n },\n \"outside_hours_message\": {\n \"value\": \"\"\n },\n \"is_escalation_schedule_enabled\": {\n \"value\": \"\"\n },\n \"escalation_timezone\": {\n \"value\": \"\"\n },\n \"escalation_schedule\": {\n \"value\": \"\"\n },\n \"escalation_schedule_mode\": {\n \"value\": \"\"\n }\n },\n \"max_tool_calls\": 6080,\n \"turn_timeout_ms\": 3915,\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": 2390\n },\n \"tools_config\": {\n \"key_0\": 2396,\n \"key_1\": 2440.579250522724\n },\n \"handoff_config\": {\n \"key_0\": \"string\"\n },\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"channel_actions\": {\n \"mark_as_read\": {\n \"value\": \"\"\n },\n \"typing_indicator\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": \"string\"\n },\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2020-08-08T03:56:13.794Z\",\n \"updated_at\": \"1963-06-07T11:23:18.234Z\",\n \"publish_state\": \"published\",\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-01-28T00:03:41.306Z\",\n \"published_at\": \"1998-09-27T05:41:50.074Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"00dc1097-8199-4647-a85c-d0a21e5dd19e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skills"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"350e537c-07db-46f2-8f75-9f5df5075d41","name":"List Knowledge Sources","request":{"name":"List Knowledge Sources","description":{"content":"List the agent's knowledge sources (bounded, single page).\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"679c9bee-2e3c-43d2-b14e-5b89ab6218c4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c5980c7f-b8d6-4c4a-89b6-8824e4069660","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2d18994e-ae92-4aa5-9a9f-00c6032bc4a7","name":"Create Knowledge Source","request":{"name":"Create Knowledge Source","description":{"content":"Add a knowledge source (KB folder, whole KB, FAQ, web search with a\ndomain allowlist, or ``live_source``: one URL fetched live at answer time,\n``config = {url, match, label, description, ttl_minutes, fetcher, scope}``).\n\nLive sources: at most ``AGENT_LIVE_SOURCES_MAX_PER_AGENT`` (default 10) per\nagent (422 ``live_source_limit``), label unique per agent case-insensitively\n(422 ``live_source_label_taken``), URL must be public http(s) (422\n``invalid_live_source_url`` with ``error_code``).\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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","body":{"mode":"raw","raw":"{\n \"source_type\": \"live_source\",\n \"kb_folder_id\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": true,\n \"config\": {\n \"key_0\": false,\n \"key_1\": 3298,\n \"key_2\": true,\n \"key_3\": \"string\"\n },\n \"sort_order\": 1683\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"cfa01bda-3848-4cd2-aa5d-69d446a2b4f3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"source_type\": \"live_source\",\n \"kb_folder_id\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": true,\n \"config\": {\n \"key_0\": true\n },\n \"sort_order\": 7438\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"source_type\": \"string\",\n \"kb_folder_id\": \"string\",\n \"kb_folder_name\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": true,\n \"config\": {\n \"key_0\": 7403\n },\n \"sort_order\": 0,\n \"created_at\": \"1975-09-09T00:28:27.576Z\",\n \"updated_at\": \"2003-06-12T12:14:50.898Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"13d50944-db4c-49af-8346-fce92aea05c2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"source_type\": \"live_source\",\n \"kb_folder_id\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": true,\n \"config\": {\n \"key_0\": true\n },\n \"sort_order\": 7438\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a886cd70-4ebb-4c19-a495-ed7ad3604fd0","name":"Update Knowledge Source","request":{"name":"Update Knowledge Source","description":{"content":"Update a knowledge source. For a ``live_source`` the ``config`` patch is\nmerged over the stored config and re-validated (422 ``invalid_live_source``).\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"kb_folder_id\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": true,\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 2027\n },\n \"sort_order\": 1735\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1d92aea1-ca41-4721-866f-7cc8eced9245","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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":"PATCH","body":{"mode":"raw","raw":"{\n \"kb_folder_id\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": false,\n \"config\": {\n \"key_0\": 9023.806390672504\n },\n \"sort_order\": 2458\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"source_type\": \"string\",\n \"kb_folder_id\": \"string\",\n \"kb_folder_name\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": true,\n \"config\": {\n \"key_0\": 7403\n },\n \"sort_order\": 0,\n \"created_at\": \"1975-09-09T00:28:27.576Z\",\n \"updated_at\": \"2003-06-12T12:14:50.898Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cc87ebe8-1ee6-4b66-86ff-4a9b1c751463","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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":"PATCH","body":{"mode":"raw","raw":"{\n \"kb_folder_id\": \"string\",\n \"allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_enabled\": false,\n \"config\": {\n \"key_0\": 9023.806390672504\n },\n \"sort_order\": 2458\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"08497450-0f8a-490b-89a0-c6c06d68ea4a","name":"Delete Knowledge Source","request":{"name":"Delete Knowledge Source","description":{"content":"Remove a knowledge source from the agent. Removing a ``live_source``\nalso removes its id from every per-skill override.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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":"DELETE"},"response":[{"id":"0cd5f9c0-83d0-4ddc-a057-79e67daf47f4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1c87c4d-d914-4e51-9187-95463f7bd342","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","knowledge-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":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2e6d3eee-3450-4c59-b236-42b946d9b8ba","name":"Test Agent","request":{"name":"Test Agent","description":{"content":"Run one test-console turn. Nothing is sent to a customer and nothing is\nbilled (``credits`` reports what a live turn would bill). The turn is\nrecorded in the audit log with surface ``test``. Rate limited to 20\nturns per minute and 200 per hour per workspace (429 + Retry-After).\n\n``attachment_ids`` (max 5): files uploaded with ``POST /attachments/upload``\nthat the test customer \"sends\" with the message (``message`` may then be\nempty). Unknown or foreign ids return 422 ``attachment_not_found``. The\n``attachments`` trace lists each file as read or skipped (with the reason)\nand the AI credits it would cost in a live conversation.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","test"],"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","body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"history\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"state\": {\n \"key_0\": 7032,\n \"key_1\": 3193.1387228312615\n },\n \"skill_slug\": \"string\",\n \"channel_type\": \"string\",\n \"task\": {\n \"key_0\": 7086,\n \"key_1\": 5046.230287339007,\n \"key_2\": 5482.80284759427\n },\n \"attachment_ids\": [\n \"string\",\n \"string\"\n ],\n \"config\": \"live\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f175cdad-6d39-4779-a82b-21a936087f0c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"history\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"state\": {\n \"key_0\": 7032,\n \"key_1\": 3193.1387228312615\n },\n \"skill_slug\": \"string\",\n \"channel_type\": \"string\",\n \"task\": {\n \"key_0\": 7086,\n \"key_1\": 5046.230287339007,\n \"key_2\": 5482.80284759427\n },\n \"attachment_ids\": [\n \"string\",\n \"string\"\n ],\n \"config\": \"live\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"outcome\": \"string\",\n \"replies\": [\n {\n \"key_0\": 1016.92718874263\n },\n {\n \"key_0\": 8443.88026214925\n }\n ],\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 3121.4921256282046\n },\n \"handoff\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"engine_trace\": [\n {\n \"key_0\": 54.678745127234585,\n \"key_1\": 7118.348568495324\n },\n {\n \"key_0\": 2348.960144710055,\n \"key_1\": 2617\n }\n ],\n \"credits\": {\n \"key_0\": true\n },\n \"state\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"turn_id\": \"string\",\n \"model\": \"string\",\n \"router\": {\n \"value\": \"\"\n },\n \"skills_loaded\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tool_calls\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"link_fixes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"checks\": {\n \"key_0\": 4785\n },\n \"sources\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n {\n \"key_0\": 6314.614921857379,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"duration_ms\": 9740,\n \"goal_progress\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"config\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"676dd7a6-5e7f-4a3f-a1d4-baa1aba83b72","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"history\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"state\": {\n \"key_0\": 7032,\n \"key_1\": 3193.1387228312615\n },\n \"skill_slug\": \"string\",\n \"channel_type\": \"string\",\n \"task\": {\n \"key_0\": 7086,\n \"key_1\": 5046.230287339007,\n \"key_2\": 5482.80284759427\n },\n \"attachment_ids\": [\n \"string\",\n \"string\"\n ],\n \"config\": \"live\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"70c90f53-6ff6-44c9-aa9c-38d968514d0b","name":"List Agent Turns","request":{"name":"List Agent Turns","description":{"content":"Audit log of the agent's turns (newest first). Raw model contents are not\nreturned. ``contact_name`` and the conversation / message ids are only\nreturned for conversations the caller can open in the inbox; otherwise\nthey are null and ``contact_hidden`` is true (``conversation_key`` still\ngroups the turns of one conversation).\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","turns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"50"},{"disabled":false,"key":"conversation_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7f2b3642-f2dc-483a-ab16-1d43fe917bc7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","turns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"conversation_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"821e0927-1c9f-43a4-80df-665fb6927556","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","turns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"conversation_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac81f486-5efd-4dc2-a2ec-1710c8a4b6e8","name":"Get Agent Feedback","request":{"name":"Get Agent Feedback","description":{"content":"Answer feedback for an agent: 👍 / 👎 / wrong counts (total, per skill and\nper day) and the newest 👎 / wrong ratings with the customer question, the\nagent's answer, the correction, the skill(s) used and the KB correction it\nopened. Without inbox access to a rating's conversation, its\n``conversation_id``, ``message_id``, ``question`` and ``answer`` are null\nand ``contact_hidden`` is true. Ratings themselves are submitted with\n``POST /ai-answers/{event_id}/rate``, the same endpoint as FAQ bot replies.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","feedback"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Window in days (answer events are kept 90 days)"},{"disabled":false,"key":"skill","value":"string","description":"Limit series + recent to one skill slug (\"__none__\" = no skill)"},{"disabled":false,"key":"recent_limit","value":"20"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"372f6933-e921-4403-959d-07dd0154a426","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","feedback"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"},{"key":"skill","value":"string"},{"key":"recent_limit","value":"20"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"days\": 6032,\n \"totals\": {\n \"up\": {\n \"value\": \"\"\n },\n \"down\": {\n \"value\": \"\"\n },\n \"wrong\": {\n \"value\": \"\"\n },\n \"rated\": {\n \"value\": \"\"\n },\n \"answers\": {\n \"value\": \"\"\n }\n },\n \"skill\": \"string\",\n \"by_skill\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"series\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recent\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"truncated\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f74cfb54-d643-41da-b86b-546b0ae0e6cf","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","feedback"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"},{"key":"skill","value":"string"},{"key":"recent_limit","value":"20"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8dd6f840-b05f-41f0-b0b3-eaedc9676324","name":"List Skill Suggestions","request":{"name":"List Skill Suggestions","description":{"content":"\n\n**🔐 Required Scopes:** `automation:read`\n","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"status","value":"string"},{"disabled":false,"key":"skill_id","value":"string"},{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"947ca6cf-0cd1-4f45-a9a4-ce512c366ebe","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"string"},{"key":"skill_id","value":"string"},{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": 4644.057761135885,\n \"key_1\": \"string\",\n \"key_2\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1bf240de-c506-4634-a3c8-68caf0a4af73","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"string"},{"key":"skill_id","value":"string"},{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"aaa36062-ba0f-46e0-afbb-dc24faca9fc7","name":"Generate Skill Suggestion","request":{"name":"Generate Skill Suggestion","description":{"content":"\n\n**🔐 Required Scopes:** `automation:update`\n","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions","generate"],"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","body":{"mode":"raw","raw":"{\n \"skill_id\": \"string\",\n \"days\": 30\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8f3c07f7-a39e-4704-9e35-8959871eb9a3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"skill_id\": \"string\",\n \"days\": 30\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": true,\n \"key_1\": 2295\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9bcf6f90-1420-412a-8f29-944d99e52dbf","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"skill_id\": \"string\",\n \"days\": 30\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2b9a2652-73f5-4dec-9c19-cf8c52bc72ab","name":"Approve Skill Suggestion","request":{"name":"Approve Skill Suggestion","description":{"content":"\n\n**🔐 Required Scopes:** `automation:update`\n","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions",":suggestion_id","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"instructions\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2c499ce5-38c5-4a24-9830-46b0c9af5970","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions",":suggestion_id","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"instructions\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e42a880-0b41-4df9-a087-b1995e0ac13d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions",":suggestion_id","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"instructions\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"732d6e85-539b-4637-869f-f9b2fd773344","name":"Dismiss Skill Suggestion","request":{"name":"Dismiss Skill Suggestion","description":{"content":"\n\n**🔐 Required Scopes:** `automation:update`\n","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions",":suggestion_id","dismiss"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"note\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dd2745bc-bc2e-4842-981c-2a19e6a3adcb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions",":suggestion_id","dismiss"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"note\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ddea683-d912-4e2b-b5ca-ca8b3e1871c1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","skill-suggestions",":suggestion_id","dismiss"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"note\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b2ecf07e-1d8d-4812-8242-374dd625cd5e","name":"Get Agents Insights Overview","request":{"name":"Get Agents Insights Overview","description":{"content":"Workspace-wide agent insights for the last ``days`` days: goal funnel per\nskill (activations started / completed), skills by usage (turns that\nloaded the skill, number of agents) and the number of knowledge-gap FAQ\ndrafts waiting for review. Test-console turns are excluded.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents","insights","overview"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Window in days: 7, 30 or 90"},{"disabled":false,"key":"agent_id","value":"string","description":"Only this agent's turns and knowledge-gap drafts"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"654bc76e-f80a-4d8f-b79d-e072d5bf1d67","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents","insights","overview"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"},{"key":"agent_id","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"range_days\": 7512,\n \"goals\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"skills_by_usage\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"kb_gaps\": {\n \"pending_count\": {\n \"value\": \"\"\n }\n },\n \"truncated\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"56dc5d8f-ff31-47dc-9983-090636bbfaad","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents","insights","overview"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"},{"key":"agent_id","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c414d559-76b1-49e0-8c4f-4690cd0fa6cd","name":"Get Agent Analytics","request":{"name":"Get Agent Analytics","description":{"content":"Agent analytics over the last ``days`` calendar days (workspace timezone,\ntoday included): turn outcomes, KB / web / live-source usage, enforced\nlookups, answer-check (grounding) results, credits, and a zero-filled\ndaily series. Test-console turns and plan-gated turns are excluded. At\nmost 20,000 turns are aggregated (``truncated: true`` beyond).\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","analytics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Window in days: 7, 30 or 90"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3392f59d-8fbb-40b9-a75b-26a0f20568c7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","analytics"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"days\": 6961,\n \"from\": \"string\",\n \"to\": \"string\",\n \"totals\": {\n \"turns\": {\n \"value\": \"\"\n },\n \"conversations\": {\n \"value\": \"\"\n },\n \"answered\": {\n \"value\": \"\"\n },\n \"handoffs\": {\n \"value\": \"\"\n },\n \"fallbacks\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"kb_searches\": {\n \"value\": \"\"\n },\n \"kb_zero_hit_turns\": {\n \"value\": \"\"\n },\n \"kb_search_turns\": {\n \"value\": \"\"\n },\n \"web_searches\": {\n \"value\": \"\"\n },\n \"web_turns\": {\n \"value\": \"\"\n },\n \"web_cache_hits\": {\n \"value\": \"\"\n },\n \"live_reads\": {\n \"value\": \"\"\n },\n \"live_turns\": {\n \"value\": \"\"\n },\n \"enforced_lookups\": {\n \"value\": \"\"\n },\n \"grounding_checked\": {\n \"value\": \"\"\n },\n \"grounding_rewrites\": {\n \"value\": \"\"\n },\n \"grounding_handoffs\": {\n \"value\": \"\"\n },\n \"credits_billed\": {\n \"value\": \"\"\n },\n \"resolved_conversations\": {\n \"value\": \"\"\n },\n \"handoff_conversations\": {\n \"value\": \"\"\n }\n },\n \"rates\": {\n \"web_fallback_rate\": {\n \"value\": \"\"\n },\n \"kb_zero_hit_rate\": {\n \"value\": \"\"\n },\n \"handoff_rate\": {\n \"value\": \"\"\n },\n \"grounding_rewrite_rate\": {\n \"value\": \"\"\n },\n \"resolved_pct\": {\n \"value\": \"\"\n },\n \"handoff_pct\": {\n \"value\": \"\"\n }\n },\n \"timezone\": \"UTC\",\n \"truncated\": false,\n \"min_sample\": 20,\n \"insufficient_data\": false,\n \"credits_per_conversation\": 8219.477417622187,\n \"daily\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2e54c978-2252-487c-9916-84cbf162bcf7","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","analytics"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"27b2c4ea-c2b4-4cb6-a57b-4922efa9c8a0","name":"Run Kb Gap Suggestions","request":{"name":"Run Kb Gap Suggestions","description":{"content":"Draft FAQ entries for questions this agent recently answered from web\nsearch while the knowledge base had nothing. Drafts land in the FAQ review\nlist (status ``draft``) and are never published automatically. One run per\nagent at a time (409 ``gap_run_in_progress``).\n\n**Required Scopes:** `automation:update` AND `knowledge_base:create` (it writes FAQ drafts)","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","kb-gap-suggestions"],"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","body":{"mode":"raw","raw":"{\n \"days\": 30\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0593a61d-7711-4770-b427-c40a3c8fdb50","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","kb-gap-suggestions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"days\": 30\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created\": 0,\n \"skipped_existing\": 0,\n \"skipped_volatile\": 0,\n \"candidates\": 0,\n \"draft_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bfe33200-01df-4702-85d5-f4f1c1bf8e70","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","kb-gap-suggestions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"days\": 30\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"72c4e7c8-e1cb-46be-b711-bf93b4419e3b","name":"List Kb Gap Suggestions","request":{"name":"List Kb Gap Suggestions","description":{"content":"FAQ drafts created from this agent's knowledge gaps (not archived), newest\nfirst.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","agents",":agent_id","kb-gap-suggestions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"20"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"67efa45e-d7c0-4e7d-b6c9-ec7afe37d412","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","kb-gap-suggestions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e04341a1-2973-4bb8-949f-18b29c26fdd3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agents",":agent_id","kb-gap-suggestions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"agent_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"498f77bd-f951-46f1-a364-7ca5719bdb36","name":"Estimate Agent Build","request":{"name":"Estimate Agent Build","description":{"content":"AI credits one successful AI agent build costs — shown before the user starts.\n\nPrice = credits x the plan's AI-credit rate. Failed builds and creating the\nagent are never charged.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","agent-builder","estimate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"81f05c48-1b9e-4089-8a81-85e6d395605c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","estimate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"credits\": 647,\n \"price_euros\": \"string\",\n \"ai_credit_rate_euros\": \"string\",\n \"billable\": false,\n \"charged_on\": \"successful_build\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7cc91249-da42-4f23-9a11-0792657e747e","name":"Generate Agent Draft","request":{"name":"Generate Agent Draft","description":{"content":"Queue an AI agent build: research the company website (domain-restricted web\nsearch; up to 3 of its pages are read to propose live sources) and draft a\nfoundation skill plus 3-6 tailored skills. Poll ``/jobs/{job_id}``. Nothing is saved.\n\nLimits per workspace: 5 builds/hour, 20/day, one active build at a time.\nRepeating a request with the same ``request_id`` returns the same job and is\nnever charged twice.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","agent-builder","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"company_name\": \"string\",\n \"goals\": [\n \"human_handoff\"\n ],\n \"tone\": \"enthusiastic\",\n \"website_url\": \"string\",\n \"base_language\": \"string\",\n \"language_mode\": \"auto\",\n \"languages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"notes\": \"string\",\n \"ui_language\": \"string\",\n \"request_id\": \"MtZrpCMtZrpC\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d40aceb6-88bc-4b09-b529-26ae34a3ebab","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"company_name\": \"string\",\n \"goals\": [\n \"human_handoff\"\n ],\n \"tone\": \"enthusiastic\",\n \"website_url\": \"string\",\n \"base_language\": \"string\",\n \"language_mode\": \"auto\",\n \"languages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"notes\": \"string\",\n \"ui_language\": \"string\",\n \"request_id\": \"MtZrpCMtZrpC\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"job_id\": \"string\",\n \"status\": \"string\",\n \"stage\": \"string\",\n \"result\": {\n \"key_0\": false\n },\n \"error\": {\n \"value\": \"\"\n },\n \"request_id\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f325e5e9-9684-4705-8d62-95a685b0ee8f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"company_name\": \"string\",\n \"goals\": [\n \"human_handoff\"\n ],\n \"tone\": \"enthusiastic\",\n \"website_url\": \"string\",\n \"base_language\": \"string\",\n \"language_mode\": \"auto\",\n \"languages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"notes\": \"string\",\n \"ui_language\": \"string\",\n \"request_id\": \"MtZrpCMtZrpC\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"97b770cb-335d-4c3b-845a-181006364f24","name":"Get Agent Build Job","request":{"name":"Get Agent Build Job","description":{"content":"Poll an AI agent build (kept 24h). Another workspace's job is a 404.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","agent-builder","jobs",":job_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1783cbe7-06be-4135-897c-0a7dea0d3692","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","jobs",":job_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"job_id\": \"string\",\n \"status\": \"string\",\n \"stage\": \"string\",\n \"result\": {\n \"key_0\": false\n },\n \"error\": {\n \"value\": \"\"\n },\n \"request_id\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4cb76675-fabb-4f46-929a-80860ddecf8f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","jobs",":job_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"448993a2-96c0-43ab-910f-4ae5bcce087e","name":"Create Agent From Build","request":{"name":"Create Agent From Build","description":{"content":"Create the reviewed agent from a successful build: its skills (version 1),\nthe agent (INACTIVE — test it, then activate), knowledge sources and the\nchannel activation rule, in one transaction. Idempotent per ``build_id``:\ncalling it again returns the same agent. Not charged.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","agent-builder","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"build_id\": \"stringstringstringstringstringstring\",\n \"agent\": {\n \"name\": {\n \"value\": \"\"\n },\n \"persona\": {\n \"value\": \"\"\n },\n \"instructions\": {\n \"value\": \"\"\n },\n \"model_tier\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"language_mode\": {\n \"value\": \"\"\n },\n \"default_language\": {\n \"value\": \"\"\n },\n \"supported_languages\": {\n \"value\": \"\"\n },\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"escalation_enabled\": {\n \"value\": \"\"\n }\n },\n \"skills\": [\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_ids\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9e82d6b3-ba70-4ab5-94fb-78e486184d1d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"build_id\": \"stringstringstringstringstringstring\",\n \"agent\": {\n \"name\": {\n \"value\": \"\"\n },\n \"persona\": {\n \"value\": \"\"\n },\n \"instructions\": {\n \"value\": \"\"\n },\n \"model_tier\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"language_mode\": {\n \"value\": \"\"\n },\n \"default_language\": {\n \"value\": \"\"\n },\n \"supported_languages\": {\n \"value\": \"\"\n },\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"escalation_enabled\": {\n \"value\": \"\"\n }\n },\n \"skills\": [\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_ids\": [\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 \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"language_settings\": {\n \"response_language\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"auto_translate_messages\": {\n \"value\": \"\"\n },\n \"language_detection_strategy\": {\n \"value\": \"\"\n }\n },\n \"escalation\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"offers_escalation\": {\n \"value\": \"\"\n },\n \"handoff_message\": {\n \"value\": \"\"\n },\n \"escalation_keywords\": {\n \"value\": \"\"\n },\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": {\n \"value\": \"\"\n },\n \"outside_hours_message\": {\n \"value\": \"\"\n },\n \"is_escalation_schedule_enabled\": {\n \"value\": \"\"\n },\n \"escalation_timezone\": {\n \"value\": \"\"\n },\n \"escalation_schedule\": {\n \"value\": \"\"\n },\n \"escalation_schedule_mode\": {\n \"value\": \"\"\n }\n },\n \"max_tool_calls\": 6080,\n \"turn_timeout_ms\": 3915,\n \"persona\": \"string\",\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"greeting_message\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"instructions\": \"string\",\n \"model_tier\": \"standard\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": 2390\n },\n \"tools_config\": {\n \"key_0\": 2396,\n \"key_1\": 2440.579250522724\n },\n \"handoff_config\": {\n \"key_0\": \"string\"\n },\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"channel_actions\": {\n \"mark_as_read\": {\n \"value\": \"\"\n },\n \"typing_indicator\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": \"string\"\n },\n \"skills\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2020-08-08T03:56:13.794Z\",\n \"updated_at\": \"1963-06-07T11:23:18.234Z\",\n \"publish_state\": \"published\",\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": \"2021-01-28T00:03:41.306Z\",\n \"published_at\": \"1998-09-27T05:41:50.074Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"328df4c2-2010-4b2e-ba89-5cd16e04e434","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","agent-builder","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"build_id\": \"stringstringstringstringstringstring\",\n \"agent\": {\n \"name\": {\n \"value\": \"\"\n },\n \"persona\": {\n \"value\": \"\"\n },\n \"instructions\": {\n \"value\": \"\"\n },\n \"model_tier\": {\n \"value\": \"\"\n },\n \"base_language\": {\n \"value\": \"\"\n },\n \"language_mode\": {\n \"value\": \"\"\n },\n \"default_language\": {\n \"value\": \"\"\n },\n \"supported_languages\": {\n \"value\": \"\"\n },\n \"tools_config\": {\n \"value\": \"\"\n },\n \"handoff_config\": {\n \"value\": \"\"\n },\n \"escalation_enabled\": {\n \"value\": \"\"\n }\n },\n \"skills\": [\n {\n \"value\": \"\"\n }\n ],\n \"knowledge_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_ids\": [\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"a79bf92c-21e7-41dc-bbb0-bdd3f2f4aa23","name":"AI Skills","description":{"content":"Beta. Manage the skills library for Conversational Agents. Every content change creates an immutable version; import skills in bulk.","type":"text/plain"},"item":[{"id":"792be8d1-cf70-4d3b-b9d1-64d8ba866956","name":"List Skills","request":{"name":"List Skills","description":{"content":"List the tenant's skills library.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","skills"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"search","value":"string"},{"disabled":false,"key":"include_archived","value":"false"},{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"50"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"5c0d22f7-6f36-4c73-be3c-107d4dbe1276","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills"],"host":["{{baseUrl}}"],"query":[{"key":"search","value":"string"},{"key":"include_archived","value":"false"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c47d22b2-7447-4196-bed2-d351ec34ce6a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills"],"host":["{{baseUrl}}"],"query":[{"key":"search","value":"string"},{"key":"include_archived","value":"false"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fb5c6528-e296-4a4d-8472-db745b54290d","name":"Create Skill","request":{"name":"Create Skill","description":{"content":"Create a skill (and its version 1). ``slug`` is derived from the title\nwhen omitted; an explicit slug that already exists returns 409.\n\n``goal`` (Beta, optional): structured goal stored on the version. An invalid\ngoal returns 422 ``{\"detail\": {\"code\": \"invalid_goal\", \"errors\": [{path, code,\nmessage}]}}``; 409 ``goal_unavailable`` while goals are not yet available.\n\n``attachment_instruction`` (Beta, optional): what the agent does with a\ncustomer's image or PDF when this skill is loaded --\n``{\"preset\": \"read_text\" | \"describe\" | \"context\" | \"custom\", \"custom_text\"}``\n(``custom_text`` 1-1000 chars, only for ``custom``). Omitted / null = ``context``.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","skills"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"description\": \"string\",\n \"body\": \"string\",\n \"slug\": \"string\",\n \"default_mode\": \"model_selected\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": true\n },\n \"attachment_instruction\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a997ddcc-6c26-4505-947d-0537fd1d865e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"description\": \"string\",\n \"body\": \"string\",\n \"slug\": \"string\",\n \"default_mode\": \"model_selected\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": 6079\n },\n \"attachment_instruction\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"string\",\n \"current_version\": 5887,\n \"current_version_id\": \"string\",\n \"is_archived\": false,\n \"used_by_count\": 0,\n \"used_by\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_goal\": false,\n \"goal_label\": \"string\",\n \"created_at\": \"2011-08-30T20:42:34.874Z\",\n \"updated_at\": \"1989-10-19T08:00:55.602Z\",\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"attachment_instruction\": {\n \"key_0\": \"string\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4d380792-c7af-40c4-b5e5-13fbd4bcb755","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"description\": \"string\",\n \"body\": \"string\",\n \"slug\": \"string\",\n \"default_mode\": \"model_selected\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": 6079\n },\n \"attachment_instruction\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8bdec07a-3134-48bd-a40b-a1fbc7b44e80","name":"Import Skills","request":{"name":"Import Skills","description":{"content":"Import skills in the seed format ``{slug?, title, description, mode?, skill,\ntool_allowlist?, goal?, attachment_instruction?}`` (an omitted ``goal`` /\n``attachment_instruction`` keeps the existing value on update).\nAn existing slug gets a new version when its content changed (``updated``),\notherwise it is reported as ``unchanged``. Invalid items are reported in\n``errors`` without stopping the others.\n\n**Required Scopes:** `automation:create`, `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","skills","import"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0c3ee491-1b03-4c06-aed6-102bb6814340","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills","import"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"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 \"created\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"unchanged\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a8f9e5db-8967-400a-b02a-a18a4cbf1d9f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills","import"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e70ac04-f9ce-4cd4-a6bb-abae1b9fa4ec","name":"Get Skill","request":{"name":"Get Skill","description":{"content":"Get a skill including the body of its current version.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"52f456f3-e4d2-459b-9091-560a5d11ba93","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"string\",\n \"current_version\": 5887,\n \"current_version_id\": \"string\",\n \"is_archived\": false,\n \"used_by_count\": 0,\n \"used_by\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_goal\": false,\n \"goal_label\": \"string\",\n \"created_at\": \"2011-08-30T20:42:34.874Z\",\n \"updated_at\": \"1989-10-19T08:00:55.602Z\",\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"attachment_instruction\": {\n \"key_0\": \"string\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f1db448-672c-4636-b818-82044cad0b39","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f27eb916-d29e-4c44-9d6e-4213cd5bb817","name":"Update Skill","request":{"name":"Update Skill","description":{"content":"Update a skill. A title, description, body, tool_allowlist, ``goal`` or\n``attachment_instruction`` change (``null`` clears either) creates a new\nimmutable version; an omitted ``goal`` / ``attachment_instruction`` is\ncarried forward. default_mode / is_archived only change the skill.\nInvalid goal → 422 ``invalid_goal`` (see create).\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"flow_only\",\n \"is_archived\": true,\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"attachment_instruction\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ff7edc45-f191-4280-beb3-4e5fd2a4961b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"model_selected\",\n \"is_archived\": true,\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": 9352.097683632983,\n \"key_1\": 8393,\n \"key_2\": 4393,\n \"key_3\": 5495\n },\n \"attachment_instruction\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"string\",\n \"current_version\": 5887,\n \"current_version_id\": \"string\",\n \"is_archived\": false,\n \"used_by_count\": 0,\n \"used_by\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_goal\": false,\n \"goal_label\": \"string\",\n \"created_at\": \"2011-08-30T20:42:34.874Z\",\n \"updated_at\": \"1989-10-19T08:00:55.602Z\",\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"attachment_instruction\": {\n \"key_0\": \"string\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53ee9c7a-a3cb-45a2-9bf9-fe43798009c4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"model_selected\",\n \"is_archived\": true,\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": 9352.097683632983,\n \"key_1\": 8393,\n \"key_2\": 4393,\n \"key_3\": 5495\n },\n \"attachment_instruction\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b7703c4d-9619-4007-be73-3c606d558fa6","name":"Delete Skill","request":{"name":"Delete Skill","description":{"content":"Delete a skill. A skill still linked to an agent or referenced by a flow\nis archived instead (``action: \"archived\"``); otherwise it is deleted with\nall its versions (``action: \"deleted\"``).\n\n**Required Scopes:** `automation:delete`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"b429c648-df7f-4c87-bd70-eda4f9b1d514","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"action\": \"archived\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4608422c-6987-40d7-8dac-484f62b31a92","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2237d68c-53b4-46ea-aecf-ff5274532003","name":"List Skill Versions","request":{"name":"List Skill Versions","description":{"content":"List a skill's versions (newest first; bodies omitted, see ``body_chars``).\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id","versions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"05d85a74-3135-480d-a471-378effb2b45c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","versions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"162823df-e8a5-4303-816e-1fe7ae6cdcb5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","versions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"62270127-66e5-4af8-b1f6-b9e14a4c1ff2","name":"Get Skill Version","request":{"name":"Get Skill Version","description":{"content":"Get one skill version including its body.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id","versions",":version_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"version_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"83b7e1d8-43df-4681-9243-64db98190309","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","versions",":version_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"version_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"skill_id\": \"string\",\n \"version\": 5432,\n \"body\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"body_chars\": 0,\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": 534\n },\n \"attachment_instruction\": {\n \"key_0\": 2620.5335432395827,\n \"key_1\": \"string\"\n },\n \"is_current\": false,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"1990-01-30T12:49:18.578Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1ac2250b-6872-4f28-b373-1f901f692cc5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","versions",":version_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"version_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a5359994-5f63-48e4-875f-fb99025087fe","name":"Restore Skill Version","request":{"name":"Restore Skill Version","description":{"content":"Restore an old version by copying it into a NEW current version.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id","versions",":version_id","restore"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"version_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"e8e5efd6-b7f8-4744-9123-4df51ae1b477","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","versions",":version_id","restore"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"version_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"default_mode\": \"string\",\n \"current_version\": 5887,\n \"current_version_id\": \"string\",\n \"is_archived\": false,\n \"used_by_count\": 0,\n \"used_by\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_goal\": false,\n \"goal_label\": \"string\",\n \"created_at\": \"2011-08-30T20:42:34.874Z\",\n \"updated_at\": \"1989-10-19T08:00:55.602Z\",\n \"body\": \"string\",\n \"tool_allowlist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"goal\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"attachment_instruction\": {\n \"key_0\": \"string\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"89023e7c-46c8-46fa-ba21-505e998419be","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","versions",":version_id","restore"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"version_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5fc5b184-84ad-48b5-93ac-b809d9eaae8f","name":"Get Skill Usage","request":{"name":"Get Skill Usage","description":{"content":"Where a skill is used: linked agents and non-archived flows whose\nrun_assistant node sets this ``skill_slug``.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id","usage"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"58d5fdd6-f083-426e-95bc-5c5ee15918f3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","usage"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"flows\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"233715b8-5373-432f-981e-9427d09c6a8a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","usage"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"66a857e4-0ad9-4d8b-a819-75aeaee2cdae","name":"Get Skill Goal Stats","request":{"name":"Get Skill Goal Stats","description":{"content":"Goal funnel (Beta) for a skill over the last ``days`` (max 90): distinct goal\nactivations started / completed / handed off, overall and per skill version.\nTest-console turns are excluded.\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","skills",":skill_id","goal-stats"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"355bb6e4-4ae3-4a29-8306-c4510a289bde","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","goal-stats"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"days\": 4243,\n \"started\": 0,\n \"completed\": 0,\n \"handed_off\": 0,\n \"completion_rate\": 4694.650004616442,\n \"by_version\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"truncated\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f30e8fe6-6d7b-417c-8e3d-cd0923c9b18a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","skills",":skill_id","goal-stats"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"skill_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"dff38896-6e8f-4266-a838-4d5a43754cfb","name":"Alerts","description":{"content":"Configure channel-health and delivery alerts and manage alert notification settings and history.","type":"text/plain"},"item":[{"id":"af6ed9f8-956a-40c7-b46b-0edcda8a76f0","name":"Get Alert Settings","request":{"name":"Get Alert Settings","description":{"content":"All three config layers + every destination visible to this tenant.\n\n**🔐 Required Scopes:** `alerts:read`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"d360802b-7e7a-429f-80c1-0664a89dc983","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"effective_scope\": \"implicit\",\n \"effective\": {\n \"value\": \"\"\n },\n \"account\": {\n \"value\": \"\"\n },\n \"tenant\": {\n \"value\": \"\"\n },\n \"paid_channels_available\": true,\n \"paid_channels_reason\": \"ok\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c0018163-2551-46cf-8065-c2656da9f872","name":"Put Alert Settings","request":{"name":"Put Alert Settings","description":{"content":"Upsert the settings row at ``scope``.\n\n``account`` writes the BA-default (applies to every tenant of the billing\naccount); ``tenant`` creates/updates this tenant's all-or-nothing\noverride. Single-row-per-scope is enforced HERE (MySQL treats NULLs as\ndistinct inside the unique constraint).\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"scope","value":"account"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"mode\": \"all\",\n \"severity_matrix\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"type_overrides\": {\n \"key_0\": \"string\"\n },\n \"email_always_on\": true,\n \"monthly_paid_cap_euros\": 1900.5564058097934\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a3df8ea6-fa65-43a1-9b01-012071db544f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings"],"host":["{{baseUrl}}"],"query":[{"key":"scope","value":"account"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"mode\": \"all\",\n \"severity_matrix\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"type_overrides\": {\n \"key_0\": \"string\"\n },\n \"email_always_on\": true,\n \"monthly_paid_cap_euros\": 1900.5564058097934\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"billing_account_id\": \"string\",\n \"scope\": \"tenant\",\n \"mode\": \"all\",\n \"severity_matrix\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"type_overrides\": {\n \"key_0\": 295.22515632143586,\n \"key_1\": 2804\n },\n \"email_always_on\": true,\n \"monthly_paid_cap_euros\": 4710.7751554847255,\n \"tenant_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5369cf44-b6cc-42aa-bcfd-37291a0c35b4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings"],"host":["{{baseUrl}}"],"query":[{"key":"scope","value":"account"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"mode\": \"all\",\n \"severity_matrix\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"type_overrides\": {\n \"key_0\": \"string\"\n },\n \"email_always_on\": true,\n \"monthly_paid_cap_euros\": 1900.5564058097934\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d8ab7f9a-f305-4d8f-bf6e-64e28ed2bece","name":"Delete Alert Settings Override","request":{"name":"Delete Alert Settings Override","description":{"content":"Remove this tenant's override — it reverts to the BA default.\n\nTenant-scoped destination rows are kept (inert while no override exists)\nso re-enabling the override restores them.\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","override"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"727c4df2-f001-4da6-9c3f-79c1f672b50a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","override"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bd314ace-a138-49cc-a44b-76463bd8b8bb","name":"Create Alert Destination","request":{"name":"Create Alert Destination","description":{"content":"\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"in_app\",\n \"scope\": \"account\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"is_enabled\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"137b7c98-572a-4ddd-a70b-641756024280","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"in_app\",\n \"scope\": \"account\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"is_enabled\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"billing_account_id\": \"string\",\n \"scope\": \"account\",\n \"channel\": \"string\",\n \"is_enabled\": true,\n \"tenant_id\": \"string\",\n \"config\": {\n \"key_0\": 3305.891257553033,\n \"key_1\": 334\n },\n \"verified_at\": \"2023-06-23T02:07:52.993Z\",\n \"needs_attention\": false,\n \"last_error\": \"string\",\n \"last_used_at\": \"1964-04-17T00:23:53.348Z\",\n \"created_at\": \"1981-08-30T13:04:14.747Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c276b062-bb50-4ca5-bf78-bedce1cffb24","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"in_app\",\n \"scope\": \"account\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"is_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1bf1b4e4-8767-4ab6-bb7d-4197a1b1aac9","name":"Update Alert Destination","request":{"name":"Update Alert Destination","description":{"content":"\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"config\": {\n \"key_0\": false\n },\n \"is_enabled\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"211beb7f-afac-44b2-b473-fa55ba5d2e32","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"config\": {\n \"key_0\": false\n },\n \"is_enabled\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"billing_account_id\": \"string\",\n \"scope\": \"account\",\n \"channel\": \"string\",\n \"is_enabled\": true,\n \"tenant_id\": \"string\",\n \"config\": {\n \"key_0\": 3305.891257553033,\n \"key_1\": 334\n },\n \"verified_at\": \"2023-06-23T02:07:52.993Z\",\n \"needs_attention\": false,\n \"last_error\": \"string\",\n \"last_used_at\": \"1964-04-17T00:23:53.348Z\",\n \"created_at\": \"1981-08-30T13:04:14.747Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"28ad4fdc-53b0-4e1e-a4bd-3b9579c81fd0","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"config\": {\n \"key_0\": false\n },\n \"is_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"aa9e56ab-fafe-4a4b-9be2-59ebdd2db4e8","name":"Delete Alert Destination","request":{"name":"Delete Alert Destination","description":{"content":"\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"c9756422-1b24-4288-ac21-c4a7e62f70d2","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"162e737e-af28-4ab7-bec2-63e8d1aaf353","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6b38a511-6c94-40c6-afbb-fbd34fad2d55","name":"Send Destination Verification","request":{"name":"Send Destination Verification","description":{"content":"Send a one-time code to the destination via ITS OWN channel\n(SMS / WhatsApp / email). Verifying through the same channel doubles as\nthe consent record for utility messages (plan §6.3) — ``verified_at`` is\nonly stamped after the code round-trips against the SAME target value\n(security review #1: the code is bound to the phone/email, not the row).\n\nAbuse limits (#2): per-destination hourly + per-tenant daily send quotas.\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","destinations",":destination_id","send-verification"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"19cf05ca-3345-4407-bc99-818c89c20861","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id","send-verification"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f8af5646-cb1f-489c-bbdf-b30bbb9fb110","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id","send-verification"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"919e4f6a-6315-4d92-85c9-05cfeddeda6e","name":"Verify Destination","request":{"name":"Verify Destination","description":{"content":"\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","destinations",":destination_id","verify"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"stri\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b4b7cffb-d319-460c-b9a6-a1653651b9a7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id","verify"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"stri\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"180faea2-3294-4395-bbfc-a76a928af878","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings","destinations",":destination_id","verify"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"destination_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"stri\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c1fdc00e-c369-4e90-97fe-8304bec5560c","name":"List Alerts","request":{"name":"List Alerts","description":{"content":"Alert history for this tenant (SHARD), newest first.\n\n**🔐 Required Scopes:** `alerts:read`\n","type":"text/plain"},"url":{"path":["api","v1","alerts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"20"},{"disabled":false,"key":"severity","value":"severe"},{"disabled":false,"key":"alert_type","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"757c9c29-14d2-4250-83d1-1bc4b82ea76e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alerts"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"severity","value":"severe"},{"key":"alert_type","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f0af5bd3-1325-4553-adb7-801f77cabf91","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alerts"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"severity","value":"severe"},{"key":"alert_type","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"34a7aaae-4371-4403-9b03-5f8a44af01a1","name":"Send Test Alert","request":{"name":"Send Test Alert","description":{"content":"Send a test alert through the normal dispatch path.\n\nFounder decision #10: test alerts on paid channels are billed like real\nsends. Throttled (security review #3/#8) and the free-text message is\ndropped in favour of a fixed body (security review #12 — customer text\nmust not ride our WABA template / Slack markdown).\n\n**🔐 Required Scopes:** `alerts:update`\n","type":"text/plain"},"url":{"path":["api","v1","alert-settings","test"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6a2427c1-9d24-4956-88ec-378b3a092a68","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","alert-settings","test"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"alert_event_id\": \"string\",\n \"note\": \"Test alerts are delivered to your configured channels. Paid channels (SMS €0.10, WhatsApp €0.08 per message) are billed like real alerts.\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90ffd294-bc73-40ee-b009-d073887ddd4a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","alert-settings","test"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"message\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"916b068f-f2d9-4b8e-ace0-439a0db6eab1","name":"Analytics","description":{"content":"Access messaging analytics, conversation metrics, and channel performance data.","type":"text/plain"},"item":[{"id":"43755126-fc38-45ab-b2e2-0de6585b2d2b","name":"Get Dashboard Metrics","request":{"name":"Get Dashboard Metrics","description":{"content":"Get dashboard overview metrics\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Total messages (inbound/outbound)\n- Total conversations (open/closed)\n- Total contacts\n- Active channels\n- RCS monthly active recipients (`rcs_monthly_active_recipients`,\n `rcs_mau_period`): current Europe/Berlin month, for RCS agents billed\n per monthly active recipient. Their sends are not in the message\n counts. Null when the workspace has no such agent.","type":"text/plain"},"url":{"path":["api","v1","analytics","dashboard"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics (ISO format)"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics (ISO format)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7a1aefda-3909-424e-9e4d-016b6ec78e2f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","dashboard"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"active_channels\": 3,\n \"closed_conversations\": 105,\n \"inbound_messages\": 800,\n \"open_conversations\": 45,\n \"outbound_messages\": 700,\n \"period_end\": \"2026-01-18T00:00:00Z\",\n \"period_start\": \"2026-01-01T00:00:00Z\",\n \"total_contacts\": 500,\n \"total_conversations\": 150,\n \"total_messages\": 1500\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7fc7bb6a-4d35-493a-945c-170b32b91db6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","dashboard"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b510ac90-8d15-4722-ab2a-73954b49d1d7","name":"Get Messages By Channel","request":{"name":"Get Messages By Channel","description":{"content":"Get message counts grouped by channel type\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- List of {channel_type, message_count}","type":"text/plain"},"url":{"path":["api","v1","analytics","messages","by-channel"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"0bc56e27-f6ce-4006-939c-322d30bd1a73","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","messages","by-channel"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"channel_type\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n }\n },\n {\n \"channel_type\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"b71f1b41-af1b-4667-b4ea-3fee7edc68ff","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","messages","by-channel"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fc7d2883-8984-4c50-945b-973f0d2e5f6c","name":"Get Messages Over Time","request":{"name":"Get Messages Over Time","description":{"content":"Get message counts over time\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- List of {date, message_count}","type":"text/plain"},"url":{"path":["api","v1","analytics","messages","over-time"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"},{"disabled":false,"key":"interval","value":"day","description":"Grouping interval (day, hour)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ba0d286a-757d-4958-8d10-6a713c57e61c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","messages","over-time"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"},{"key":"interval","value":"day"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"date\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n },\n \"inbound\": {\n \"value\": \"\"\n },\n \"outbound\": {\n \"value\": \"\"\n }\n },\n {\n \"date\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n },\n \"inbound\": {\n \"value\": \"\"\n },\n \"outbound\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"5bd7bb21-1683-47d7-a299-e97ea2b5a895","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","messages","over-time"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"},{"key":"interval","value":"day"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d92b623-7b15-42b8-9d6c-71c19bceaf3e","name":"Get Response Time Metrics","request":{"name":"Get Response Time Metrics","description":{"content":"Get response time metrics\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Response rate percentage\n- Average response time\n- Conversations with/without response","type":"text/plain"},"url":{"path":["api","v1","analytics","response-time"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"cc976405-a8a4-4938-b031-8c425fe00014","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","response-time"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"average_response_time_minutes\": 5.5,\n \"by_channel\": [\n {\n \"avg_response_minutes\": 4.2,\n \"channel_type\": \"whatsapp\",\n \"conversation_count\": 80\n },\n {\n \"avg_response_minutes\": 7.1,\n \"channel_type\": \"telegram\",\n \"conversation_count\": 40\n }\n ],\n \"conversations_with_response\": 120,\n \"conversations_without_response\": 30,\n \"period_end\": \"2026-01-18T00:00:00Z\",\n \"period_start\": \"2026-01-01T00:00:00Z\",\n \"response_rate_percent\": 80,\n \"total_conversations\": 150\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"234289e8-5828-48a9-8e2a-71cd48b53171","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","response-time"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"26bb381f-7fb0-4966-80c3-a7e053e529fe","name":"Get Resolution Time Metrics","request":{"name":"Get Resolution Time Metrics","description":{"content":"Get resolution time metrics (time from conversation start to close)\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Average resolution time in hours\n- Total closed conversations\n- Per-channel breakdown","type":"text/plain"},"url":{"path":["api","v1","analytics","resolution-time"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"b44cad73-bf82-4ed0-ab94-fb60cc79149c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","resolution-time"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"average_resolution_hours\": 2.5,\n \"by_channel\": [\n {\n \"avg_hours\": 2.1,\n \"channel_type\": \"whatsapp\",\n \"count\": 60\n },\n {\n \"avg_hours\": 3.2,\n \"channel_type\": \"email\",\n \"count\": 45\n }\n ],\n \"period_end\": \"2026-01-18T00:00:00Z\",\n \"period_start\": \"2026-01-01T00:00:00Z\",\n \"total_closed_conversations\": 105\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6e0b460-e2f4-47da-9329-f4c254b57c3f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","resolution-time"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"29fff9b6-806e-43c4-a8fc-86b4144f6c45","name":"Get Time Metrics Over Time","request":{"name":"Get Time Metrics Over Time","description":{"content":"Get response time and resolution time metrics over time for charting\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Timeline with daily averages (response_minutes, resolution_hours)\n- Per-channel breakdown for tooltip display","type":"text/plain"},"url":{"path":["api","v1","analytics","time-metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a01da66a-efd6-45c1-bef6-bba43a46e9b1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","time-metrics"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"by_channel\": {\n \"whatsapp\": [\n {\n \"date\": \"2026-01-15\",\n \"resolution_hours\": 1.9,\n \"response_minutes\": 3.8\n }\n ]\n },\n \"period_end\": \"2026-01-18T00:00:00Z\",\n \"period_start\": \"2026-01-01T00:00:00Z\",\n \"timeline\": [\n {\n \"date\": \"2026-01-15\",\n \"resolution_hours\": 2.1,\n \"response_minutes\": 4.5\n },\n {\n \"date\": \"2026-01-16\",\n \"resolution_hours\": 2.8,\n \"response_minutes\": 5.2\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"abc4892c-a248-48db-9cdf-edbdc1ce4b28","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","time-metrics"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dc07a3b1-bd32-4995-883e-d858b201629d","name":"Get Agent Performance","request":{"name":"Get Agent Performance","description":{"content":"Get performance metrics by agent\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- List of {user_id, conversation_count, message_count}","type":"text/plain"},"url":{"path":["api","v1","analytics","agents","performance"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"8a3a01ad-944c-4dc9-93fc-505fe44f5c3f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","agents","performance"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"user_id\": {\n \"value\": \"\"\n },\n \"user_name\": {\n \"value\": \"\"\n },\n \"conversation_count\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n },\n \"user_email\": {\n \"value\": \"\"\n }\n },\n {\n \"user_id\": {\n \"value\": \"\"\n },\n \"user_name\": {\n \"value\": \"\"\n },\n \"conversation_count\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n },\n \"user_email\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"7a3fa884-0f77-4b93-8c49-df7540b54534","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","agents","performance"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"79cbb1a2-6238-4bce-88a5-1789f0ab2e52","name":"Get Conversation Stats","request":{"name":"Get Conversation Stats","description":{"content":"Get conversation statistics\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Conversations by status (open/assigned/resolved/closed)\n- Conversations by assignment (assigned/unassigned)\n- new_conversations: total created in the date range\n- resolved_conversations: count with RESOLVED status\n- closed_conversations: count with CLOSED status\n- avg_duration_hours: average conversation duration (creation to close)\n- avg_messages_per_conversation: average messages per conversation","type":"text/plain"},"url":{"path":["api","v1","analytics","conversations","stats"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"bd5130aa-1f84-4258-8837-4c62dd1ef9e0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","conversations","stats"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"avg_duration_hours\": 4.5,\n \"avg_messages_per_conversation\": 8.2,\n \"by_assignment\": {\n \"assigned\": 120,\n \"unassigned\": 30\n },\n \"by_status\": {\n \"closed\": 105,\n \"open\": 45\n },\n \"closed_conversations\": 105,\n \"new_conversations\": 150,\n \"period_end\": \"2026-01-18T00:00:00Z\",\n \"period_start\": \"2026-01-01T00:00:00Z\",\n \"resolved_conversations\": 35\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5541ecaa-cc41-4248-a96e-2b93d0836a43","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","conversations","stats"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3542b81b-cb83-49ee-849a-bb52da6def06","name":"Get Link Performance Summary","request":{"name":"Get Link Performance Summary","description":{"content":"Get link tracking performance summary for the dashboard widget.\n\n**Required Scopes:** `analytics:read`\n\n**Database:** SHARD (tracked_links, link_clicks tables)\n\n**Returns:**\n- total_links: Total number of tracked links\n- total_clicks: Total clicks across all links\n- clicks_today: Clicks in the last 24 hours\n- clicks_this_week: Clicks in the last 7 days\n- top_performing_links: Top 5 most clicked links\n- clicks_by_day: Click counts for the last 7 days\n- device_breakdown: Clicks by device type (desktop, mobile, tablet)\n- link_tracking_enabled: Whether link tracking is enabled for this tenant","type":"text/plain"},"url":{"path":["api","v1","analytics","links","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"9ee6193d-8baf-4725-b7f8-63a39c183868","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","links","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"active_links_this_week\": 8,\n \"clicks_by_day\": {},\n \"clicks_this_week\": 0,\n \"clicks_today\": 0,\n \"device_breakdown\": {},\n \"link_tracking_enabled\": true,\n \"recent_activity\": [],\n \"top_performing_links\": [\n {\n \"clicks\": 150,\n \"first_click_at\": \"2026-01-10T10:00:00Z\",\n \"label\": \"Holiday Promo\",\n \"last_click_at\": \"2026-01-18T14:30:00Z\",\n \"original_url\": \"https://example.com/promo\",\n \"short_code\": \"abc123\"\n }\n ],\n \"total_clicks\": 1500,\n \"total_links\": 25\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9cbaef5b-4ae3-42d6-8c32-127e0dd90210","name":"Get Ai Performance","request":{"name":"Get Ai Performance","description":{"content":"Get AI/Bot performance metrics for the dashboard.\n\n**Required Scopes:** `analytics:read`\n\n**Database:** SHARD (bot_interaction_logs, bot_conversation_sessions, messages tables)\n\n**Query Parameters:**\n- start_date: Start date for metrics (defaults to 30 days ago)\n- end_date: End date for metrics (defaults to now)\n\n**Returns:**\n- total_bot_messages: Count of messages sent by bots\n- total_manual_messages: Count of outbound messages NOT from bots\n- bot_sessions_count: Total bot conversation sessions\n- avg_confidence_score: Average confidence score (0.0-1.0, multiply by 100 for %)\n- escalation_rate: Percentage of sessions that escalated to human agent\n- period_start: Start of the reporting period (ISO format)\n- period_end: End of the reporting period (ISO format)","type":"text/plain"},"url":{"path":["api","v1","analytics","ai","performance"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2009-04-02","description":"Start date for metrics (YYYY-MM-DD)"},{"disabled":false,"key":"end_date","value":"2009-04-02","description":"End date for metrics (YYYY-MM-DD)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1e040085-0c78-4fa9-a4fa-1f2ffbf92fe8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","ai","performance"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2009-04-02"},{"key":"end_date","value":"2009-04-02"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"avg_confidence_score\": 0.85,\n \"bot_sessions_count\": 150,\n \"escalation_rate\": 15.5,\n \"period_end\": \"2026-01-18T00:00:00Z\",\n \"period_start\": \"2026-01-01T00:00:00Z\",\n \"total_bot_messages\": 500,\n \"total_manual_messages\": 200\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a8626093-6146-4d9a-a6b2-3e7c334d05de","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","ai","performance"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2009-04-02"},{"key":"end_date","value":"2009-04-02"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c9fb9166-d0a9-49e0-ae5d-8520fe1acff7","name":"Get Billing Summary","request":{"name":"Get Billing Summary","description":{"content":"Get billing-aligned analytics summary.\n\n**Required Scopes:** `analytics:read`\n\nUses the EXACT same query logic as the billing aggregation service to ensure\nanalytics numbers match billing 1:1. Breaks down outbound/inbound messages\nby platform, email campaigns by managed vs BYOK, push campaign messages,\nand knowledge base queries.\n\nIf no date range is provided, defaults to the current calendar month.","type":"text/plain"},"url":{"path":["api","v1","analytics","billing-summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start of period (ISO format). Defaults to start of current month."},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End of period (ISO format). Defaults to now."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"87474d21-9dcd-45ca-a483-39e1810e4e21","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","billing-summary"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"campaigns\": {\n \"email_byok\": 2000,\n \"email_managed\": 5000,\n \"push\": 1500\n },\n \"inbound_messages\": {\n \"by_platform\": {\n \"email\": 50,\n \"instagram\": 15,\n \"live_chat\": 5,\n \"messenger\": 20,\n \"sms\": 30,\n \"telegram\": 60,\n \"whatsapp\": 120\n },\n \"total\": 300\n },\n \"kb_queries\": 450,\n \"outbound_messages\": {\n \"by_platform\": {\n \"browser_push\": 5,\n \"email\": 40,\n \"instagram\": 10,\n \"live_chat\": 10,\n \"messenger\": 15,\n \"sms\": 20,\n \"telegram\": 50,\n \"whatsapp\": 100\n },\n \"total\": 250\n },\n \"period_end\": \"2026-03-08T12:00:00Z\",\n \"period_start\": \"2026-03-01T00:00:00Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b865bd0d-b037-49cc-b449-dd0735be5a37","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","billing-summary"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"29694e54-fb6a-4b5c-a896-89d0132f7386","name":"Get Ctwa Ad Breakdown","request":{"name":"Get Ctwa Ad Breakdown","description":{"content":"Get Click-to-WhatsApp (CTWA) \"Conversations from Ads\" breakdown.\n\n**Required Scopes:** `analytics:read`\n\n**Database:** SHARD (conversation_ad_attribution table)\n\nPurely informational counts — NO cost or ROI data. Aggregates CTWA\nconversations by their originating ad/post (`source_id`) over the date\nrange, ranked by conversation count descending.\n\n**Conditional rendering:** When the tenant has no CTWA conversations in the\nrange, this returns `total_conversations: 0`, `has_data: false`, and an\nempty `ads` list. The frontend hides the \"Conversations from Ads\" section\nwhen `has_data` is false (equivalently `total_conversations == 0`). There is\nno separate presence-check endpoint.\n\nReturns:\n- total_conversations: Total CTWA conversations in range (sum of ad counts)\n- has_data: Convenience flag, true when total_conversations > 0\n- ads: List of {source_id, headline, source_type, source_url, count} ranked desc\n- period_start / period_end: ISO range bounds (defaults filled server-side)","type":"text/plain"},"url":{"path":["api","v1","analytics","ctwa","ad-breakdown"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Start date for metrics (ISO format). Defaults to 30 days ago."},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"End date for metrics (ISO format). Defaults to now."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"67dc893f-6c2b-434c-ad50-06a81819124b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","ctwa","ad-breakdown"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"ads\": [\n {\n \"count\": 30,\n \"headline\": \"Summer Sale — Chat with us on WhatsApp\",\n \"source_id\": \"120210000000000000\",\n \"source_type\": \"ad\",\n \"source_url\": \"https://fb.me/ad/120210000000000000\"\n },\n {\n \"count\": 12,\n \"source_id\": \"120210000000000001\",\n \"source_type\": \"post\"\n }\n ],\n \"has_data\": true,\n \"period_end\": \"2026-06-11T23:59:59.999999Z\",\n \"period_start\": \"2026-05-12T00:00:00Z\",\n \"total_conversations\": 42\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5a42acb6-5405-4a2c-bdbb-31cda6cab4d3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","ctwa","ad-breakdown"],"host":["{{baseUrl}}"],"query":[{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"daeacec4-d9e8-4096-806a-f78a49dff6c2","name":"Get Subscriber Overview","request":{"name":"Get Subscriber Overview","description":{"content":"Get subscriber overview with counts by status, channel type, and list.\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Total subscription count\n- Breakdown by status (subscribed, pending, unsubscribed, bounced, complained)\n- Breakdown by channel type with per-status counts\n- Breakdown by list with per-status counts","type":"text/plain"},"url":{"path":["api","v1","analytics","subscribers","overview"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Number of days to look back"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"eb6a7196-5e99-4d7c-9f5c-c83ea08675ae","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","subscribers","overview"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"period_start\": \"string\",\n \"period_end\": \"string\",\n \"total_subscriptions\": 0,\n \"by_status\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"by_channel\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"by_list\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4c462103-fd99-4a65-93e5-8d98a998a58e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","subscribers","overview"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d75b4471-08ad-4ede-a13f-756a386e7955","name":"Get Subscriber Trends","request":{"name":"Get Subscriber Trends","description":{"content":"Get subscriber growth trends over time.\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Daily opt-in counts by channel type\n- Daily opt-out counts by channel type\n- Net growth, average daily opt-ins/opt-outs\n- Opt-in method breakdown","type":"text/plain"},"url":{"path":["api","v1","analytics","subscribers","trends"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Number of days to look back"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3d29fa22-b5a5-489e-a96c-a80a02804c62","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","subscribers","trends"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"period_start\": \"string\",\n \"period_end\": \"string\",\n \"daily_opt_ins\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"daily_opt_outs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total_opt_ins\": 0,\n \"total_opt_outs\": 0,\n \"net_growth\": 0,\n \"avg_daily_opt_ins\": 0,\n \"avg_daily_opt_outs\": 0,\n \"by_opt_in_method\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"51926ede-9703-4d12-98d2-2ccccc7275b9","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","subscribers","trends"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e1ee150d-0ffb-4ec9-b0cf-a70c592a67df","name":"Get Campaign Performance","request":{"name":"Get Campaign Performance","description":{"content":"Get campaign performance analytics.\n\n**Required Scopes:** `analytics:read`\n\nReturns:\n- Aggregate campaign stats (total/completed, sent/delivered/read/failed).\n Volume tiles are invoiced-aligned: non-email campaigns from\n campaign_messages + email campaigns from email_campaigns.\n- Delivery and read rates\n- Email breakdown (`email`): single/transactional (1:1, from email_messages)\n vs campaign/newsletter (from email_campaigns), each aligned to invoiced\n usage. Legacy flat `email_*` fields mirror `email.campaign.*`.\n- Channel-type breakdown from campaign messages\n- Last 5 completed campaigns","type":"text/plain"},"url":{"path":["api","v1","analytics","campaigns","performance"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Number of days to look back"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a981b984-5bcb-4a26-b64f-1b78596c8172","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","analytics","campaigns","performance"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"by_channel\": [\n {\n \"channel_type\": \"email\",\n \"delivered\": 1950,\n \"failed\": 50,\n \"sent\": 2000,\n \"total_messages\": 2000\n }\n ],\n \"completed_campaigns\": 10,\n \"delivery_rate\": 96,\n \"email_bounce_rate\": 2.5,\n \"email_bounced\": 50,\n \"email_click_rate\": 25,\n \"email_clicked\": 200,\n \"email_complained\": 5,\n \"email_open_rate\": 40,\n \"email_opened\": 800,\n \"email_sent\": 2000,\n \"period_end\": \"2026-03-08T00:00:00Z\",\n \"period_start\": \"2026-02-06T00:00:00Z\",\n \"read_rate\": 66.67,\n \"recent_campaigns\": [\n {\n \"completed_at\": \"2026-03-05T12:00:00Z\",\n \"delivered_count\": 1480,\n \"name\": \"March Newsletter\",\n \"sent_count\": 1500\n }\n ],\n \"total_campaigns\": 12,\n \"total_delivered\": 4800,\n \"total_failed\": 200,\n \"total_read\": 3200,\n \"total_sent\": 5000\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dd749a02-c953-4075-b98a-004ea1a90f8f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","analytics","campaigns","performance"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"de1b9681-6e18-4ace-9309-f65229c37b4e","name":"API Tokens","description":{"content":"Create and manage scoped API tokens for programmatic access to the SendSeven API.","type":"text/plain"},"item":[{"id":"1b6c35b4-bcfb-409a-83c5-a664a1f36f5a","name":"List Api Tokens","request":{"name":"List Api Tokens","description":{"content":"List all API tokens for current user in this tenant.\n\n**Required Scopes:** `api:read`\n\nBy default, only shows active (non-expired, non-revoked) tokens.\nSet include_inactive=true to see all tokens.","type":"text/plain"},"url":{"path":["api","v1","api-tokens"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"include_inactive","value":"false","description":"Include inactive/expired tokens"},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1eec1ceb-71fb-4da2-9b2f-4654ca5778a6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens"],"host":["{{baseUrl}}"],"query":[{"key":"include_inactive","value":"false"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0287efa0-10e9-46c8-ac0f-83d360baa3e7","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","api-tokens"],"host":["{{baseUrl}}"],"query":[{"key":"include_inactive","value":"false"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7abfa840-488c-498f-b51b-c6d5bc112d9e","name":"Create Api Token","request":{"name":"Create Api Token","description":{"content":"Create a new API token.\n\n**Required Scopes:** `api:create`\n\nIMPORTANT: The plaintext token is returned ONLY ONCE.\nSave it securely - you won't be able to retrieve it again.\n\nToken format: s7_api_<32_random_hex_chars>\n\nDefault expiration: 90 days\nMax expiration: 365 days","type":"text/plain"},"url":{"path":["api","v1","api-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"scopes\": [\n \"string\"\n ],\n \"expires_in_days\": 303\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"97329f5b-cc56-474b-8f84-5ddbd275fef1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"scopes\": [\n \"string\"\n ],\n \"expires_in_days\": 303\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"user_id\": \"string\",\n \"name\": \"string\",\n \"token\": \"string\",\n \"created_at\": \"1966-03-08T20:14:06.619Z\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"expires_at\": \"1990-12-17T20:49:18.089Z\",\n \"warning\": \"Save this token now - it will not be shown again\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2cbc5320-bd70-4d5f-b32c-5544bda3a848","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","api-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"scopes\": [\n \"string\"\n ],\n \"expires_in_days\": 303\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"94b18d4c-e41b-457c-ab76-26054c5f9d4e","name":"Get Available Scopes For Token","request":{"name":"Get Available Scopes For Token","description":{"content":"Get all scopes that the current user can grant to API tokens.\n\n**Required Scopes:** `api:read`\n\nThis endpoint expands wildcard scopes (*:*, resource:*, etc.) to show\nall granular scopes the user can select when creating tokens.\n\nExample:\n- User has ['*:*'] -> Returns all 78 scopes\n- User has ['campaigns:*'] -> Returns all campaigns:* scopes\n- User has ['contacts:read', 'messages:create'] -> Returns exactly those scopes","type":"text/plain"},"url":{"path":["api","v1","api-tokens","available-scopes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"6cdb3732-bbdd-47bb-8b22-fd697803cddf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens","available-scopes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"grouped\": {\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 \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"total\": 9054\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71867f7b-fe31-4e90-bbee-dbfed0ecf5e4","name":"Get Api Token","request":{"name":"Get Api Token","description":{"content":"Get details of a specific API token.\n\n**Required Scopes:** `api:read`\n\nNote: The plaintext token is NOT included - it was only shown at creation.","type":"text/plain"},"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"255559fa-102b-4cdb-91f3-d4a138875d38","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"user_id\": \"string\",\n \"name\": \"string\",\n \"created_at\": \"1948-04-13T05:46:57.047Z\",\n \"is_active\": false,\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"last_used_at\": \"2016-06-05T21:15:53.311Z\",\n \"expires_at\": \"1993-03-02T19:38:00.230Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c5d1b507-9e88-458e-b070-040134febee1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0bf3f066-edd1-4b3d-8a1f-664d8202d6ed","name":"Update Api Token","request":{"name":"Update Api Token","description":{"content":"Update API token metadata.\n\n**Required Scopes:** `api:create`\n\nCan update:\n- name: Change the human-readable name\n- is_active: Revoke (false) or reactivate (true) the token\n\nCannot update (create new token instead):\n- scopes\n- expires_at","type":"text/plain"},"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"name\": \"Updated CI/CD Token\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7e69d1ab-796a-4a17-b079-a58e64be2ceb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"name\": \"Updated CI/CD Token\"\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 \"user_id\": \"string\",\n \"name\": \"string\",\n \"created_at\": \"1948-04-13T05:46:57.047Z\",\n \"is_active\": false,\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"last_used_at\": \"2016-06-05T21:15:53.311Z\",\n \"expires_at\": \"1993-03-02T19:38:00.230Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5b6a27a8-044f-443a-b2bc-6c792d559833","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"name\": \"Updated CI/CD Token\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bccaea7a-c4f8-437e-b903-cb9ea5fc6a77","name":"Revoke Api Token","request":{"name":"Revoke Api Token","description":{"content":"Revoke (delete) an API token permanently.\n\n**Required Scopes:** `api:delete`\n\nThis permanently deletes the token.\nAlternatively, use PATCH to set is_active=false to soft-revoke.","type":"text/plain"},"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"e25b44b9-5cfd-40b3-940d-be600d6f948f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a4e2dab1-a545-4fa6-b694-6293c6becd8d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d1d63efc-c6ff-4c79-b2e2-62bd5ad117b8","name":"Regenerate Api Token","request":{"name":"Regenerate Api Token","description":{"content":"Regenerate an API token (new token string, same scopes).\n\n**Required Scopes:** `api:create`\n\nThis creates a new token string while keeping the same:\n- Name\n- Scopes\n- Expiration date\n\nThe old token is immediately revoked.\nIMPORTANT: Save the new token - it will only be shown once.","type":"text/plain"},"url":{"path":["api","v1","api-tokens",":token_id","regenerate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"6d6ed0ac-440b-46cc-8b99-8a05ea2776bf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id","regenerate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"user_id\": \"string\",\n \"name\": \"string\",\n \"token\": \"string\",\n \"created_at\": \"1966-03-08T20:14:06.619Z\",\n \"scopes\": [\n \"string\",\n \"string\"\n ],\n \"expires_at\": \"1990-12-17T20:49:18.089Z\",\n \"warning\": \"Save this token now - it will not be shown again\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8681aae5-6bdf-4863-8077-545407a5256d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","api-tokens",":token_id","regenerate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"721cbd38-7b08-4ab3-b7f5-58e940da9757","name":"Attachments","description":{"content":"Upload, retrieve, and manage file attachments (images, documents, videos, audio) for messages.","type":"text/plain"},"item":[{"id":"b096ea67-ceac-4073-a191-b956f2376d31","name":"Upload Attachment","request":{"name":"Upload Attachment","description":{"content":"Upload a file attachment\n\nArgs:\n file: The file to upload\n message_id: Optional message ID to associate with\n purpose: Optional. ``agent_test`` marks a Conversational-agent test\n console upload: deleted after 24 h unless it gets linked to a message.\n\nReturns:\n Attachment ID and metadata\n\nSecurity:\n - Validates file extension against blocklist\n - Validates file magic bytes match claimed MIME type\n - Enforces file size limits\n\n**🔐 Required Scopes:** `messages:create`\n","type":"text/plain"},"url":{"path":["api","v1","attachments","upload"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"message_id","value":"string"},{"disabled":false,"key":"purpose","value":"string"}],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) "}]}},"response":[{"id":"b7e6ab3b-5b41-432d-ab7e-016705724fe1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments","upload"],"host":["{{baseUrl}}"],"query":[{"key":"message_id","value":"string"},{"key":"purpose","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"filename\": \"string\",\n \"content_type\": \"string\",\n \"size\": 7570,\n \"storage_path\": \"string\",\n \"download_url\": \"string\",\n \"attachment_id\": \"string\",\n \"public_url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8e352209-9ec2-4f54-bbe1-93cf0798628e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments","upload"],"host":["{{baseUrl}}"],"query":[{"key":"message_id","value":"string"},{"key":"purpose","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"73073925-840e-49cf-937d-478c047b46ac","name":"Create Attachment From Url","request":{"name":"Create Attachment From Url","description":{"content":"Fetch a public URL server-side and store it as an attachment.\n\nReturns the same shape as ``POST /upload`` so the response is\ninterchangeable. Caller can then pass the returned ``id`` /\n``attachment_id`` in ``MessageCreate.attachments``.\n\nPer-tenant URL dedup: if this tenant already has an attachment\nwhose ``source_url`` matches the requested ``url`` exactly, that\nrow is returned without re-fetching or re-uploading. To force a\nre-fetch, vary the URL (e.g. add ``?t=12345``).\n\nSecurity:\n - ``http://`` / ``https://`` only — ``file://``, ``gopher://``,\n ``data://`` etc. rejected.\n - Hostname resolved up-front; rejected if any A/AAAA record\n falls into loopback, RFC1918, link-local (incl. cloud\n metadata 169.254.169.254), ULA, reserved, or multicast.\n - Bytes validated against the same magic-byte sniffer as\n ``/upload`` AND against a stricter MIME allowlist\n (``URL_FETCH_ALLOWED_MIME_TYPES``).\n - 50 MB hard cap; streaming cut-off enforced even if the\n server lies in ``Content-Length``.\n\n**Required Scopes:** ``messages:create``","type":"text/plain"},"url":{"path":["api","v1","attachments","from-url"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"url\": \"https://SVGZfQKltohMkTLaf.aqkboL3TGDFaFuGOQ6nP0,Y64kw5T8FbHAj1H6P7.\",\n \"filename\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fd8b156f-0f99-4d8c-bf04-a79ebf220687","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments","from-url"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"url\": \"https://SVGZfQKltohMkTLaf.aqkboL3TGDFaFuGOQ6nP0,Y64kw5T8FbHAj1H6P7.\",\n \"filename\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"filename\": \"string\",\n \"content_type\": \"string\",\n \"size\": 7570,\n \"storage_path\": \"string\",\n \"download_url\": \"string\",\n \"attachment_id\": \"string\",\n \"public_url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3770a472-c3d8-433f-b0ee-16493790ae38","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments","from-url"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"url\": \"https://SVGZfQKltohMkTLaf.aqkboL3TGDFaFuGOQ6nP0,Y64kw5T8FbHAj1H6P7.\",\n \"filename\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"70487613-ab58-4cd5-8b7e-ca339801c48b","name":"Get Attachment","request":{"name":"Get Attachment","description":{"content":"Get attachment metadata\n\nArgs:\n attachment_id: ID of the attachment\n\nReturns:\n Attachment metadata including download URL\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"260254d1-0db7-4152-a85c-9992574277f9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"filename\": \"string\",\n \"content_type\": \"string\",\n \"file_size\": 3219,\n \"url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"35cdd8b7-0b52-47b9-8a5b-638984328040","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b5bc5d48-1171-4f38-9691-aeb3a258d656","name":"Delete Attachment","request":{"name":"Delete Attachment","description":{"content":"Delete an attachment\n\nPermanently removes the ``attachments`` row **and** its stored blob. This\nis irreversible. Attachments are re-usable and carry no foreign key back\nto the messages that referenced them, so deleting one that a previously\nsent message still points at is allowed and expected — the message keeps\nits metadata, the media simply stops resolving.\n\nArgs:\n attachment_id: ID of the attachment\n\nReturns:\n ``204 No Content`` on success. ``404`` when the attachment does not\n exist or belongs to another tenant. ``500`` when the row exists but\n the delete itself failed (e.g. the storage backend errored) — in that\n case the row is left intact so the call can be retried.\n\n**Required Scopes:** `messages:delete`","type":"text/plain"},"url":{"path":["api","v1","attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"b4bda3ec-c92a-42a3-8930-dc9fc3e6ec92","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5a7df95e-100a-475b-b2f5-45c6d517faef","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"58391fb0-37f4-4071-8ebb-4376429b8854","name":"Download Attachment","request":{"name":"Download Attachment","description":{"content":"Download an attachment file\n\nArgs:\n attachment_id: ID of the attachment\n disposition: Content-Disposition mode - \"inline\" (default, for viewing in\n browser) or \"attachment\" (forces download dialog)\n\nReturns:\n File stream\n\n**Required Scopes:** `messages:read`","type":"text/plain"},"url":{"path":["api","v1","attachments",":attachment_id","download"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"disposition","value":"inline"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"2aee15fc-78a2-4b34-9164-8c03827acd1d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","download"],"host":["{{baseUrl}}"],"query":[{"key":"disposition","value":"inline"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"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":"ab300fa3-531a-4299-a20e-7fd7aadac8dc","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","download"],"host":["{{baseUrl}}"],"query":[{"key":"disposition","value":"inline"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4accf5d2-078c-4957-9e56-9f57aa4e80cd","name":"Get Attachment Url","request":{"name":"Get Attachment Url","description":{"content":"Get a signed URL for an attachment\n\nArgs:\n attachment_id: ID of the attachment\n expiration_minutes: URL expiration time in minutes\n\nReturns:\n Dict with signed URL\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","attachments",":attachment_id","url"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"expiration_minutes","value":"60"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"c3d72778-947e-4cea-a591-0fd337e4a9f2","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","url"],"host":["{{baseUrl}}"],"query":[{"key":"expiration_minutes","value":"60"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"expires_in_minutes\": 60,\n \"url\": \"https://storage.googleapis.com/bucket/path?signature=...\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47321d32-21d4-4dbc-85a0-9d7ca9bcae1b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","url"],"host":["{{baseUrl}}"],"query":[{"key":"expiration_minutes","value":"60"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e1c553d7-17c1-49fd-a624-7956661de7a1","name":"Get Attachment Summary","request":{"name":"Get Attachment Summary","description":{"content":"Get the AI summary of an image or PDF attachment.\n\nReturns the summary a Conversational Agent produced while reading the file,\nor one requested via `POST /attachments/{attachment_id}/summary`. Status\n`pending` means it is still being generated, `failed` means generation\nfailed (a new `POST` may retry). The text is derived from a\ncustomer-supplied file: treat it as untrusted plain text.\n\nErrors: `403 feature_disabled` when AI features are off for the workspace;\n`404` when the attachment is unknown, not visible to you, or has no summary.\n\n**Required Scopes:** `messages:read`","type":"text/plain"},"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"0c7b4c5b-398d-4099-af87-1f68a4d49ad7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"failed\",\n \"kind\": \"pdf\",\n \"source\": \"on_demand\",\n \"created_at\": \"string\",\n \"text\": \"string\",\n \"sections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pages_read\": 3995,\n \"pages_total\": 7977,\n \"truncated\": false,\n \"model\": \"string\",\n \"updated_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a50c5c6c-2782-45af-8666-3441d2c1403b","name":"AI features are not enabled for this workspace (`feature_disabled`)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"79583b1b-40f4-4024-b509-fd13f410c9e1","name":"Unknown / inaccessible attachment, or no summary yet (`summary_not_found`)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c6502d5f-98f4-4db4-b9c3-c0fd8b0bcb37","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dccc340d-4d80-4f1c-bbc3-70d8617b5feb","name":"Summarize Attachment","request":{"name":"Summarize Attachment","description":{"content":"Generate an AI summary of an inbound image or PDF attachment on demand.\n\nOnly for files a customer sent (inbound message), images up to 10 MB and\nPDFs up to 20 MB (the first 10 pages are read). Idempotent: if a summary\nalready exists it is returned with `200` and nothing is charged; if one is\nbeing generated you get `202` (poll `GET /attachments/{attachment_id}/summary`).\nA new summary returns `201` and charges AI credits from the workspace pool\n(image 2, PDF 3, see `credits_charged`). A failed generation returns `502`\n`summary_failed`, charges nothing and may be retried. Request body: none.\n\nErrors: `403 feature_disabled`, `404` unknown/inaccessible attachment,\n`422 attachment_not_summarizable`, `429` rate limit (30/min per principal,\n60/min per workspace), `503 rate_limit_unavailable`.\n\n**Required Scopes:** `conversations:update`","type":"text/plain"},"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"12dbdf3e-50de-4ab1-b258-2d79a3883657","name":"A summary already existed (no credits charged)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attachment_id\": \"string\",\n \"summary\": {\n \"value\": \"\"\n },\n \"credits_charged\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"248108c9-caf8-4a33-a249-99b18a5c73da","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attachment_id\": \"string\",\n \"summary\": {\n \"value\": \"\"\n },\n \"credits_charged\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f24b678-40cb-41e8-87e8-07a2fc3d31e5","name":"A summary is already being generated (poll GET)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attachment_id\": \"string\",\n \"summary\": {\n \"value\": \"\"\n },\n \"credits_charged\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c219bbf4-690d-4bb8-b375-0223baa758c3","name":"AI features are not enabled for this workspace (`feature_disabled`)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4318f038-c3cd-4002-9a12-d01d8b362d91","name":"Unknown or inaccessible attachment","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"aab41cfb-b03b-4d0b-8625-9a82dd87b687","name":"Attachment type/size/direction not supported (`attachment_not_summarizable`)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"POST","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1e50c006-d44b-4bee-803e-8cd7d241c21e","name":"Rate limit exceeded (30/min per user or API key, 60/min per workspace)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"POST","body":{}},"status":"Too Many Requests","code":429,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7d543693-865e-4752-9ea1-35515dfb586b","name":"Summary generation failed (`summary_failed`, no credits charged, retry allowed)","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"POST","body":{}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"eef107a8-8739-4f22-aa67-5096ecc4814e","name":"Rate limiter unavailable (`rate_limit_unavailable`), retry shortly","originalRequest":{"url":{"path":["api","v1","attachments",":attachment_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"attachment_id","description":"(Required) "}]},"method":"POST","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8913506b-96e6-46fc-aa84-89f926fa3c65","name":"Audit Log","description":{"content":"Retrieve audit and activity events for API requests and user actions.","type":"text/plain"},"item":[{"id":"8e2ec176-fa9c-4c52-9a10-80599a7780b5","name":"List Audit Log","request":{"name":"List Audit Log","description":{"content":"List API audit log entries for the current tenant.\n\nReturns paginated, sanitized records of API calls made against this tenant.\nSorted by most recent first.\n\n**Required Scopes:** `settings:admin`","type":"text/plain"},"url":{"path":["api","v1","audit-log"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"method","value":"string","description":"Filter by HTTP method (GET, POST, etc.)"},{"disabled":false,"key":"status_code","value":"4595","description":"Filter by status code"},{"disabled":false,"key":"path","value":"string","description":"Filter by path (partial match)"},{"disabled":false,"key":"start_date","value":"2025-01-08T09:00:57.148Z","description":"Filter from date (ISO 8601)"},{"disabled":false,"key":"end_date","value":"2025-01-08T09:00:57.148Z","description":"Filter to date (ISO 8601)"},{"disabled":false,"key":"page","value":"1","description":"Page number"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"01e75edd-c59e-4ca6-9af7-90dbf8b5205c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","audit-log"],"host":["{{baseUrl}}"],"query":[{"key":"method","value":"string"},{"key":"status_code","value":"4595"},{"key":"path","value":"string"},{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"header":[{"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":"08225855-772e-4fd9-aa0c-2f1a119dc3cd","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","audit-log"],"host":["{{baseUrl}}"],"query":[{"key":"method","value":"string"},{"key":"status_code","value":"4595"},{"key":"path","value":"string"},{"key":"start_date","value":"2025-01-08T09:00:57.148Z"},{"key":"end_date","value":"2025-01-08T09:00:57.148Z"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"1d5d3e76-d990-42cf-a24d-cbd8defbe3c8","name":"Automation","description":{"content":"Configure automated workflows and message routing rules triggered by events.","type":"text/plain"},"item":[{"id":"52784a60-4bc1-485d-bcbb-52c684eb317d","name":"Get Bot Templates","request":{"name":"Get Bot Templates","description":{"content":"Get available bot templates.\n\nTwo response shapes:\n\n* **No ``language`` param (legacy)** — returns one template per bot_type\n (Support, Sales, FAQ, …). Used by older UI flows.\n* **With ``language`` param (Phase 2)** — returns the unified assistant\n preset gallery: 5 presets (support / sales / faq / email / custom),\n each with a localised personality_prompt + greeting and\n ``bot_type='assistant'``. Used by the new bot creator (Step 2).\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"language","value":"string","description":"Optional ISO-639-1 language code (e.g. 'en', 'de'). When provided, returns the Phase-2 assistant preset gallery filtered by language. When omitted, returns the legacy per-bot-type template list."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"140544ed-9c07-4304-ba63-db51fec3d5ad","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","templates"],"host":["{{baseUrl}}"],"query":[{"key":"language","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"key_0\": 6361.683017099826,\n \"key_1\": 2955,\n \"key_2\": 3697.767325759401\n },\n {\n \"key_0\": 6058.094920764513,\n \"key_1\": true\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"7cf72141-b0dd-4377-b8c4-d5cce80ebb5b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","templates"],"host":["{{baseUrl}}"],"query":[{"key":"language","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"45a600be-43d6-49ea-9a55-139f894d269d","name":"Get Bot Template","request":{"name":"Get Bot Template","description":{"content":"Get a specific bot template by type.\n\n**Required Scopes:** `automation:read`\n\nArgs:\n bot_type: One of 'support', 'sales', 'custom'","type":"text/plain"},"url":{"path":["api","v1","automation","templates",":bot_type"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_type","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4b31f54e-2542-4720-9ad9-f8e6e53d0817","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","templates",":bot_type"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_type","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": 7230,\n \"key_1\": 3129.232601540697,\n \"key_2\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb11040e-d73d-4da8-a6ca-6511a6b71f8c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","templates",":bot_type"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_type","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"03c9f343-1d24-4065-a33a-8438e04fc8d1","name":"Create Bot","request":{"name":"Create Bot","description":{"content":"Create a new automation bot.\n\n**Required Scopes:** `automation:create`\n\nCreate an AI-powered bot that can handle customer conversations\nusing the knowledge base. Configure personality, escalation rules,\nand field collection requirements.\n\nKeyword bots are retired: ``bot_type='keyword'`` returns 422 with\n``detail.code = \"keyword_bots_retired\"``. Use a Flow with a keyword\ntrigger instead. Existing keyword bots keep working.","type":"text/plain"},"url":{"path":["api","v1","automation","bots"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"bot_type\": \"support\",\n \"is_active\": true,\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"is_kb_only_mode\": true,\n \"response_language\": \"string\",\n \"confidence_threshold\": 0.7,\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": true,\n \"web_search_mode\": {\n \"value\": \"\"\n },\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 6311,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"cascade\",\n \"escalation_enabled\": true,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 2,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 0.3,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"value\": \"\"\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": 314,\n \"max_email_replies\": 8,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": 7279\n },\n \"greeting_buttons_enabled\": true,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": true\n },\n \"kb_live_refresh_mode\": \"always_live\",\n \"kb_live_refresh_ttl_seconds\": 310\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d92f0a23-6d17-4190-a373-2bcb39b9db3b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"bot_type\": \"support\",\n \"is_active\": true,\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"is_kb_only_mode\": true,\n \"response_language\": \"string\",\n \"confidence_threshold\": 0.7,\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": true,\n \"web_search_mode\": {\n \"value\": \"\"\n },\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 5637,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"cascade\",\n \"escalation_enabled\": true,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 2,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 0.3,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"value\": \"\"\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": 1080,\n \"max_email_replies\": 26,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": 7627.337854831928\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 1393.5175946542388\n },\n \"kb_live_refresh_mode\": \"off\",\n \"kb_live_refresh_ttl_seconds\": 1232\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2370def6-f3f7-4a6a-9569-bbdd1052fca3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"bot_type\": \"support\",\n \"is_active\": true,\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"is_kb_only_mode\": true,\n \"response_language\": \"string\",\n \"confidence_threshold\": 0.7,\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": true,\n \"web_search_mode\": {\n \"value\": \"\"\n },\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 5637,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"cascade\",\n \"escalation_enabled\": true,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 2,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 0.3,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"value\": \"\"\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": 1080,\n \"max_email_replies\": 26,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": 7627.337854831928\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"urls_and_kb\",\n \"source_link_params\": {\n \"key_0\": 1393.5175946542388\n },\n \"kb_live_refresh_mode\": \"off\",\n \"kb_live_refresh_ttl_seconds\": 1232\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0be210f9-4ea7-4f78-ba73-6d9c40ca4257","name":"List Bots","request":{"name":"List Bots","description":{"content":"List all automation bots.\n\n**Required Scopes:** `automation:read`\n\nReturns all bots for the tenant with basic information\nand activation rule counts.","type":"text/plain"},"url":{"path":["api","v1","automation","bots"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"active_only","value":"false","description":"Only return active bots"},{"disabled":false,"key":"skip","value":"0","description":"Pagination offset"},{"disabled":false,"key":"limit","value":"100","description":"Pagination limit"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1f59cd92-0fe5-4ec4-9726-17e35ca58974","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots"],"host":["{{baseUrl}}"],"query":[{"key":"active_only","value":"false"},{"key":"skip","value":"0"},{"key":"limit","value":"100"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"bot_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"total_conversations\": {\n \"value\": \"\"\n },\n \"total_escalations\": {\n \"value\": \"\"\n },\n \"activation_rules_count\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n },\n \"escalation_tag_id\": {\n \"value\": \"\"\n },\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"bot_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"total_conversations\": {\n \"value\": \"\"\n },\n \"total_escalations\": {\n \"value\": \"\"\n },\n \"activation_rules_count\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n },\n \"escalation_tag_id\": {\n \"value\": \"\"\n },\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"6887bd02-1420-4b02-8d57-da13c05bbc68","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots"],"host":["{{baseUrl}}"],"query":[{"key":"active_only","value":"false"},{"key":"skip","value":"0"},{"key":"limit","value":"100"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ae3ba532-bd11-4c51-81dc-65cb7d78f837","name":"Reorder Bots","request":{"name":"Reorder Bots","description":{"content":"Reorder automation bots by priority.\n\n**Required Scopes:** `automation:update`\n\nUpdates the priority of bots based on the order in the request.\nThe first bot in the list gets the highest priority, the last gets the lowest.\nHigher priority bots are evaluated first when matching context.\n\n**Request Body:**\n- `bot_ids`: List of bot IDs in desired priority order (first = highest priority)\n\n**Example:**\n```json\n{\"bot_ids\": [\"bot-uuid-1\", \"bot-uuid-2\", \"bot-uuid-3\"]}\n```\nAfter reordering:\n- bot-uuid-1: priority 2 (highest)\n- bot-uuid-2: priority 1\n- bot-uuid-3: priority 0 (lowest)","type":"text/plain"},"url":{"path":["api","v1","automation","bots","reorder"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"bot_ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"92bf9969-5d87-4bb2-8502-87ce04f4fe7c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots","reorder"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"bot_ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"updated_count\": 1780,\n \"bots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"50416333-23b5-4d38-9966-f3bd00c3dce1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots","reorder"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"bot_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"54514a42-3ae8-44c1-834e-2da702d18eac","name":"Get Bot","request":{"name":"Get Bot","description":{"content":"Get a specific automation bot.\n\n**Required Scopes:** `automation:read`\n\nReturns full bot configuration including personality settings,\nknowledge base configuration, and escalation rules.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3f097fad-40e2-47cc-986c-9be938eee7d9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a1654713-2064-44d6-ba1c-b4306d314924","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5bb7e89e-a0f9-4eb9-99b3-a5ced64774fb","name":"Update Bot","request":{"name":"Update Bot","description":{"content":"Update an automation bot.\n\n**Required Scopes:** `automation:update`\n\nUpdate bot configuration. Only provided fields will be updated.\nChanging a non-keyword bot's ``bot_type`` to ``keyword`` returns 422\n``keyword_bots_retired``; existing keyword bots stay fully editable.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"bot_type\": {\n \"value\": \"\"\n },\n \"is_active\": false,\n \"priority\": 1173,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"is_kb_only_mode\": false,\n \"response_language\": \"string\",\n \"confidence_threshold\": 0.7036604356150431,\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": true,\n \"vision_enabled\": true,\n \"web_search_mode\": {\n \"value\": \"\"\n },\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 1330,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"fixed\",\n \"escalation_enabled\": false,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 1,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 0.4861072879159076,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"value\": \"\"\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": true,\n \"escalation_timezone\": \"string\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": 608,\n \"max_email_replies\": 44,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"greeting_buttons_enabled\": true,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": true,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": true,\n \"key_1\": 354,\n \"key_2\": 4556\n },\n \"kb_live_refresh_mode\": \"off\",\n \"kb_live_refresh_ttl_seconds\": 9755\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2ac197f7-ef6c-4bb2-86d2-85f3187d5aed","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"bot_type\": {\n \"value\": \"\"\n },\n \"is_active\": true,\n \"priority\": 1107,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": false,\n \"is_kb_only_mode\": true,\n \"response_language\": \"string\",\n \"confidence_threshold\": 0.36303913941389765,\n \"is_detailed_response\": true,\n \"use_full_conversation_context\": true,\n \"vision_enabled\": false,\n \"web_search_mode\": {\n \"value\": \"\"\n },\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 9136,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": false,\n \"language_detection_strategy\": \"cascade\",\n \"escalation_enabled\": true,\n \"offers_escalation\": false,\n \"max_failed_attempts\": 3,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 0.37123051631790416,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"value\": \"\"\n },\n \"is_field_collection_mode\": true,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"string\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": 1394,\n \"max_email_replies\": 39,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 5036.827832849698\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": true,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": 2574.339205731683\n },\n \"kb_live_refresh_mode\": \"live_once\",\n \"kb_live_refresh_ttl_seconds\": 8837\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 \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8409cb7-8e18-4efd-b3d4-d6ee976337ae","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"bot_type\": {\n \"value\": \"\"\n },\n \"is_active\": true,\n \"priority\": 1107,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": false,\n \"is_kb_only_mode\": true,\n \"response_language\": \"string\",\n \"confidence_threshold\": 0.36303913941389765,\n \"is_detailed_response\": true,\n \"use_full_conversation_context\": true,\n \"vision_enabled\": false,\n \"web_search_mode\": {\n \"value\": \"\"\n },\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 9136,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": false,\n \"language_detection_strategy\": \"cascade\",\n \"escalation_enabled\": true,\n \"offers_escalation\": false,\n \"max_failed_attempts\": 3,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 0.37123051631790416,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"value\": \"\"\n },\n \"is_field_collection_mode\": true,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": {\n \"value\": \"\"\n },\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"string\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": {\n \"value\": \"\"\n },\n \"escalation_fallback_minutes\": 1394,\n \"max_email_replies\": 39,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 5036.827832849698\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": true,\n \"source_footer_mode\": \"urls_only\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": 2574.339205731683\n },\n \"kb_live_refresh_mode\": \"live_once\",\n \"kb_live_refresh_ttl_seconds\": 8837\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3aa94139-1800-4396-befa-1f9d9c83333a","name":"Delete Bot","request":{"name":"Delete Bot","description":{"content":"Delete an automation bot.\n\n**Required Scopes:** `automation:delete`\n\nPermanently deletes the bot and all associated activation rules,\nsessions, and interaction logs.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"e02a819c-42a9-4971-80a0-3b245aacf6bc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b0f95e1e-2034-43cf-a567-d3e3a4f07bb8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"39755fb8-7fa6-4cae-b6a7-2e549d105134","name":"Convert Bot To Flow Endpoint","request":{"name":"Convert Bot To Flow Endpoint","description":{"content":"Convert a deprecated bot into an equivalent Flow.\n\n**Required Scopes:** ``automation:update``\n\nOnly ``router``, ``lead_qualification`` and ``appointment`` bots are\nconvertible — calling this on any other bot type returns 400.\n\nOn success (commit) the source bot is left in the DB but set to\n``is_active=false`` so historical conversations and interaction logs\nremain intact. The new flow is created in ``draft`` status — the\noperator should review + publish it manually.\n\nIdempotent: if a flow named ``\" (migrated)\"`` already\nexists for the tenant the endpoint returns 409 with the existing\nflow id so the caller can navigate to it.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","convert-to-flow"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"dry_run","value":"false","description":"When true (default false) returns the generated flow JSON without writing anything to the database. Use this from the UI to preview the conversion before committing."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"73dc0b76-ea35-4184-b3b2-c7e034f2f39a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","convert-to-flow"],"host":["{{baseUrl}}"],"query":[{"key":"dry_run","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": 4997.801437549168\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"99307a51-4369-4312-b179-79baa8c32d0d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","convert-to-flow"],"host":["{{baseUrl}}"],"query":[{"key":"dry_run","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f925919f-e344-4bcf-88aa-119930bcd444","name":"Upload Bot Avatar","request":{"name":"Upload Bot Avatar","description":{"content":"Upload an avatar image for an automation bot.\n\nReplaces any existing bot avatar. The uploaded image is stored in GCP\nCloud Storage and a signed URL is saved to the bot's avatar_url field.\n\n**Required Scopes:** `automation:update`\n\n**Constraints:**\n- File type: PNG, JPG, JPEG\n- Max size: 2MB","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) Avatar image file (PNG/JPG, max 2MB)"}]}},"response":[{"id":"b86c8398-a858-4580-8a50-cf0c61d7bef7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) Avatar image file (PNG/JPG, max 2MB)","type":"text/plain"},"key":"file","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"597ed012-67df-46fe-b32d-30cbe6d80c07","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) Avatar image file (PNG/JPG, max 2MB)","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"692566d9-6161-4a17-b9ea-c1688e8d9c31","name":"Delete Bot Avatar","request":{"name":"Delete Bot Avatar","description":{"content":"Remove an automation bot's avatar.\n\nSets the bot's avatar_url to None.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"3e50819b-d988-4912-afab-22b428716655","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"08510a57-76a3-4e35-a962-a59cb011cd53","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"54fd28f8-0599-44b9-ade0-73bc426479d0","name":"Create Activation Rule","request":{"name":"Create Activation Rule","description":{"content":"Create an activation rule for a bot.\n\n**Required Scopes:** `automation:update`\n\nActivation rules determine when and where a bot should be activated.\nRules are evaluated in priority order (highest first).\n\nRule types:\n- Channel filter: Only activate for specific channel types\n- Widget filter: Only activate for specific widgets\n- Schedule: Only activate during specific time ranges\n- Agent status: Only activate when no agents are online","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_schedule_enabled\": false,\n \"timezone\": \"UTC\",\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requires_no_agents_online\": false,\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 0,\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2908af4e-13ee-474f-9b05-d6253ed088cc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_schedule_enabled\": false,\n \"timezone\": \"UTC\",\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requires_no_agents_online\": false,\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 0,\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"is_schedule_enabled\": false,\n \"timezone\": \"string\",\n \"requires_no_agents_online\": true,\n \"priority\": 1009,\n \"is_active\": true,\n \"created_at\": \"1982-08-28T22:50:28.594Z\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"2001-03-13T21:10:20.336Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b8a5e4f6-e5ce-4535-be60-23daf1fdc59c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_schedule_enabled\": false,\n \"timezone\": \"UTC\",\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requires_no_agents_online\": false,\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 0,\n \"is_active\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c3a004e2-40cb-4adc-bfef-2e991f3c05e9","name":"List Activation Rules","request":{"name":"List Activation Rules","description":{"content":"List activation rules for a bot.\n\n**Required Scopes:** `automation:read`\n\nReturns all activation rules sorted by priority (highest first).","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"316de2a0-165d-4f45-b46f-efeb203153ca","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"is_schedule_enabled\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"requires_no_agents_online\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"channel_ids\": {\n \"value\": \"\"\n },\n \"channel_types\": {\n \"value\": \"\"\n },\n \"widget_ids\": {\n \"value\": \"\"\n },\n \"time_ranges\": {\n \"value\": \"\"\n },\n \"recipient_email_addresses\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"is_schedule_enabled\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"requires_no_agents_online\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"channel_ids\": {\n \"value\": \"\"\n },\n \"channel_types\": {\n \"value\": \"\"\n },\n \"widget_ids\": {\n \"value\": \"\"\n },\n \"time_ranges\": {\n \"value\": \"\"\n },\n \"recipient_email_addresses\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"8dad23c6-9bee-445e-a22c-c12d3a6d932a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"690ebd90-288e-4007-93fd-b096f6c20dc2","name":"Update Activation Rule","request":{"name":"Update Activation Rule","description":{"content":"Update an activation rule.\n\n**Required Scopes:** `automation:update`\n\nUpdate rule configuration. Only provided fields will be updated.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_schedule_enabled\": false,\n \"timezone\": \"string\",\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requires_no_agents_online\": true,\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 1,\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7dd3f96f-55f7-402f-829f-d9b564a75248","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_schedule_enabled\": true,\n \"timezone\": \"string\",\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requires_no_agents_online\": true,\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 16,\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"is_schedule_enabled\": false,\n \"timezone\": \"string\",\n \"requires_no_agents_online\": true,\n \"priority\": 1009,\n \"is_active\": true,\n \"created_at\": \"1982-08-28T22:50:28.594Z\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"2001-03-13T21:10:20.336Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58920b64-5585-43ed-bc90-1abc4a6dc6c2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"widget_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_schedule_enabled\": true,\n \"timezone\": \"string\",\n \"time_ranges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requires_no_agents_online\": true,\n \"recipient_email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 16,\n \"is_active\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3f2bfc3f-08c2-4884-8be7-fe744189e7fe","name":"Delete Activation Rule","request":{"name":"Delete Activation Rule","description":{"content":"Delete an activation rule.\n\n**Required Scopes:** `automation:delete`\n\nPermanently deletes the activation rule.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"9c7a6a27-45cd-4a2e-8eef-bb815cd31a7c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8ce6a4d0-286c-43b4-8062-609f75a6d693","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"92825f64-6e3f-4921-9ae4-3d06d592cff9","name":"List Sessions","request":{"name":"List Sessions","description":{"content":"List bot conversation sessions.\n\n**Required Scopes:** `automation:read`\n\nReturns all bot sessions with optional filtering by bot or status.","type":"text/plain"},"url":{"path":["api","v1","automation","sessions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"bot_id","value":"string","description":"Filter by bot ID"},{"disabled":false,"key":"session_status","value":"string","description":"Filter by status: active, escalated, completed, abandoned"},{"disabled":false,"key":"skip","value":"0","description":"Pagination offset"},{"disabled":false,"key":"limit","value":"100","description":"Pagination limit"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"930153aa-7408-4efc-b46b-05694e6d5b2a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","sessions"],"host":["{{baseUrl}}"],"query":[{"key":"bot_id","value":"string"},{"key":"session_status","value":"string"},{"key":"skip","value":"0"},{"key":"limit","value":"100"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n },\n \"started_at\": {\n \"value\": \"\"\n },\n \"bot_name\": {\n \"value\": \"\"\n },\n \"escalation_reason\": {\n \"value\": \"\"\n },\n \"ended_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"message_count\": {\n \"value\": \"\"\n },\n \"started_at\": {\n \"value\": \"\"\n },\n \"bot_name\": {\n \"value\": \"\"\n },\n \"escalation_reason\": {\n \"value\": \"\"\n },\n \"ended_at\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"67ab599f-0440-4930-afc9-e9533eb47370","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","sessions"],"host":["{{baseUrl}}"],"query":[{"key":"bot_id","value":"string"},{"key":"session_status","value":"string"},{"key":"skip","value":"0"},{"key":"limit","value":"100"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"90e058ba-3dd8-409f-ad4c-67b942128272","name":"Get Session","request":{"name":"Get Session","description":{"content":"Get a specific bot session.\n\n**Required Scopes:** `automation:read`\n\nReturns full session details including collected fields and escalation info.","type":"text/plain"},"url":{"path":["api","v1","automation","sessions",":session_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"session_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"d6512ad4-9fe4-4c5b-ba27-5ae6c085c8ae","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","sessions",":session_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"session_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"conversation_id\": \"string\",\n \"bot_id\": \"string\",\n \"tenant_id\": \"string\",\n \"status\": \"active\",\n \"message_count\": 3266,\n \"low_confidence_count\": 4045,\n \"started_at\": \"2007-08-12T04:39:49.217Z\",\n \"last_interaction_at\": \"1956-02-11T12:54:17.168Z\",\n \"collected_fields\": {\n \"key_0\": 4160\n },\n \"pending_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_reason\": {\n \"value\": \"\"\n },\n \"escalated_to_user_id\": \"string\",\n \"ended_at\": \"2022-02-24T15:12:22.502Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0299bd6e-4deb-487a-b4eb-1a19ee3a603a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","sessions",":session_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"session_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8490ad53-1dc6-4828-8540-e4d5310cbafa","name":"List Session Logs","request":{"name":"List Session Logs","description":{"content":"List interaction logs for a session.\n\n**Required Scopes:** `automation:read`\n\nReturns all bot-user interactions for debugging and analysis.","type":"text/plain"},"url":{"path":["api","v1","automation","sessions",":session_id","logs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"skip","value":"0","description":"Pagination offset"},{"disabled":false,"key":"limit","value":"100","description":"Pagination limit"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"session_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"17e54fcb-57e2-4706-b7b7-dd90e945db4a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","sessions",":session_id","logs"],"host":["{{baseUrl}}"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"100"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"session_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"session_id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"user_input\": {\n \"value\": \"\"\n },\n \"bot_response\": {\n \"value\": \"\"\n },\n \"confidence_score\": {\n \"value\": \"\"\n },\n \"kb_sources_used\": {\n \"value\": \"\"\n },\n \"input_tokens\": {\n \"value\": \"\"\n },\n \"output_tokens\": {\n \"value\": \"\"\n },\n \"model_used\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"session_id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"user_input\": {\n \"value\": \"\"\n },\n \"bot_response\": {\n \"value\": \"\"\n },\n \"confidence_score\": {\n \"value\": \"\"\n },\n \"kb_sources_used\": {\n \"value\": \"\"\n },\n \"input_tokens\": {\n \"value\": \"\"\n },\n \"output_tokens\": {\n \"value\": \"\"\n },\n \"model_used\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"613fab5c-0d98-4aa0-821c-fbd9a6c094f8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","sessions",":session_id","logs"],"host":["{{baseUrl}}"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"100"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"session_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f84964ae-156b-49f2-b939-3641779a0c14","name":"Get Analytics Summary","request":{"name":"Get Analytics Summary","description":{"content":"Get analytics summary across all bots.\n\n**Required Scopes:** `automation:read` OR `analytics:read`\n\nReturns aggregate metrics and per-bot breakdown.","type":"text/plain"},"url":{"path":["api","v1","automation","analytics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"period_days","value":"30","description":"Analysis period in days"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"e8dea89b-4bf6-4014-be34-0d884df3cd14","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","analytics"],"host":["{{baseUrl}}"],"query":[{"key":"period_days","value":"30"}],"variable":[]},"header":[{"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 \"period_start\": \"1959-01-26T01:44:43.269Z\",\n \"period_end\": \"1970-01-07T16:18:12.519Z\",\n \"period_days\": 30,\n \"total_bots\": 0,\n \"active_bots\": 0,\n \"total_sessions\": 0,\n \"total_completions\": 0,\n \"total_escalations\": 0,\n \"total_abandonments\": 0,\n \"total_messages\": 0,\n \"overall_resolution_rate\": 0,\n \"overall_escalation_rate\": 0,\n \"avg_messages_per_session\": 0,\n \"total_conversations\": 0,\n \"total_resolved_conversations\": 0,\n \"total_handoff_conversations\": 0,\n \"resolved_pct\": 2592.7712818359905,\n \"handoff_pct\": 9978.905328047633,\n \"insufficient_data\": true,\n \"min_sample\": 20,\n \"bot_breakdown\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"957591f7-c4ed-4d2f-9ac2-1e85def6281f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","analytics"],"host":["{{baseUrl}}"],"query":[{"key":"period_days","value":"30"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e3d0a504-9fdb-4adc-83bb-1d9ec08262eb","name":"Get Bot Analytics","request":{"name":"Get Bot Analytics","description":{"content":"Get analytics for a specific bot.\n\n**Required Scopes:** `automation:read` OR `analytics:read`\n\nReturns detailed metrics including session stats, resolution rate,\nescalation reasons, and token usage.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","analytics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"period_days","value":"30","description":"Analysis period in days"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"c0c55b08-5524-4611-84f9-99670f9e7edb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","analytics"],"host":["{{baseUrl}}"],"query":[{"key":"period_days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"bot_id\": \"string\",\n \"bot_name\": \"string\",\n \"period_start\": \"2015-09-22T21:56:21.309Z\",\n \"period_end\": \"2010-10-10T00:31:07.922Z\",\n \"total_sessions\": 0,\n \"active_sessions\": 0,\n \"completed_sessions\": 0,\n \"escalated_sessions\": 0,\n \"abandoned_sessions\": 0,\n \"resolution_rate\": 0,\n \"escalation_rate\": 0,\n \"avg_messages_per_session\": 0,\n \"avg_confidence_score\": 5566.228318412495,\n \"conversations\": 0,\n \"resolved_conversations\": 0,\n \"handoff_conversations\": 0,\n \"resolved_pct\": 2997.0475679187293,\n \"handoff_pct\": 9414.52425190213,\n \"insufficient_data\": true,\n \"min_sample\": 20,\n \"total_input_tokens\": 0,\n \"total_output_tokens\": 0,\n \"escalation_reasons\": {\n \"key_0\": 2851,\n \"key_1\": 7299,\n \"key_2\": 2914,\n \"key_3\": 9359,\n \"key_4\": 6166\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"af1c84fc-d845-4e3f-87e9-284d8a14f9f4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","analytics"],"host":["{{baseUrl}}"],"query":[{"key":"period_days","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac2ba6d0-3e79-4df8-a260-398ce02c6c7b","name":"List Keyword Triggers","request":{"name":"List Keyword Triggers","description":{"content":"List keyword triggers for a bot, sorted by priority DESC.\n\n**Required Scopes:** `automation:read`\n\nReturns all keyword triggers with their response sequences.\nOnly applicable to bots of type KEYWORD.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7cfa427e-42b9-4941-bc06-e26a86e1e0f5","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"keyword\": {\n \"value\": \"\"\n },\n \"match_type\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"channel_ids\": {\n \"value\": \"\"\n },\n \"handoff_bot_id\": {\n \"value\": \"\"\n },\n \"handover_to_human\": {\n \"value\": \"\"\n },\n \"flow_id\": {\n \"value\": \"\"\n },\n \"responses\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"keyword\": {\n \"value\": \"\"\n },\n \"match_type\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"channel_ids\": {\n \"value\": \"\"\n },\n \"handoff_bot_id\": {\n \"value\": \"\"\n },\n \"handover_to_human\": {\n \"value\": \"\"\n },\n \"flow_id\": {\n \"value\": \"\"\n },\n \"responses\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2cf8b09-0020-4b80-a6ed-7b60ff65c807","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"37cacb6c-7127-41f8-a78b-a46b03eff8bb","name":"Create Keyword Trigger","request":{"name":"Create Keyword Trigger","description":{"content":"Create a keyword trigger for a bot.\n\n**Required Scopes:** `automation:update`\n\nCreates a new keyword trigger with its response sequence.\nOnly applicable to bots of type KEYWORD.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"keyword\": \"string\",\n \"match_type\": \"exact\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 0,\n \"is_active\": true,\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"24630267-6967-45fb-89d4-9c4879d1fe01","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"keyword\": \"string\",\n \"match_type\": \"exact\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 0,\n \"is_active\": true,\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"keyword\": \"string\",\n \"match_type\": \"string\",\n \"priority\": 1679,\n \"is_active\": true,\n \"created_at\": \"1959-10-15T21:10:50.597Z\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"1981-07-15T21:17:45.482Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f9877867-9d58-4fb1-a5fd-7ac19dfcda4e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"keyword\": \"string\",\n \"match_type\": \"exact\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 0,\n \"is_active\": true,\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3ba44936-f9b4-4e43-b584-f9e9665418aa","name":"Reorder Keyword Triggers","request":{"name":"Reorder Keyword Triggers","description":{"content":"Reorder keyword triggers by priority.\n\n**Required Scopes:** `automation:update`\n\nUpdates the priority of triggers based on the order in the request.\nThe first trigger in the list gets the highest priority.\nOnly applicable to bots of type KEYWORD.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers","reorder"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"trigger_ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9d191fff-01e0-422d-a8aa-02b14ef6fa02","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers","reorder"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"trigger_ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"keyword\": {\n \"value\": \"\"\n },\n \"match_type\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"channel_ids\": {\n \"value\": \"\"\n },\n \"handoff_bot_id\": {\n \"value\": \"\"\n },\n \"handover_to_human\": {\n \"value\": \"\"\n },\n \"flow_id\": {\n \"value\": \"\"\n },\n \"responses\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"bot_id\": {\n \"value\": \"\"\n },\n \"keyword\": {\n \"value\": \"\"\n },\n \"match_type\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"channel_ids\": {\n \"value\": \"\"\n },\n \"handoff_bot_id\": {\n \"value\": \"\"\n },\n \"handover_to_human\": {\n \"value\": \"\"\n },\n \"flow_id\": {\n \"value\": \"\"\n },\n \"responses\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"5cead7f0-38b6-400a-90b8-166733d6ba75","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers","reorder"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"trigger_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"74446330-f945-4746-9158-5c2382b773a5","name":"Get Keyword Trigger","request":{"name":"Get Keyword Trigger","description":{"content":"Get a specific keyword trigger with its responses.\n\n**Required Scopes:** `automation:read`\n\nReturns the keyword trigger with its full response sequence.\nOnly applicable to bots of type KEYWORD.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1a7425c4-7d95-4799-b14f-e35a58ac4524","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"keyword\": \"string\",\n \"match_type\": \"string\",\n \"priority\": 1679,\n \"is_active\": true,\n \"created_at\": \"1959-10-15T21:10:50.597Z\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"1981-07-15T21:17:45.482Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"307b94f5-0f0a-404a-952c-015c7d4cde07","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b6a9b316-db84-4d9a-95ad-2a49e4f5ea74","name":"Update Keyword Trigger","request":{"name":"Update Keyword Trigger","description":{"content":"Update a keyword trigger.\n\n**Required Scopes:** `automation:update`\n\nUpdates trigger configuration. If responses are provided,\nexisting responses are replaced with the new set.\nOnly applicable to bots of type KEYWORD.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"keyword\": \"string\",\n \"match_type\": \"string\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 7803,\n \"is_active\": false,\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"db2b4de3-01d0-4cfd-865d-36dec3d62110","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"keyword\": \"strin\",\n \"match_type\": \"string\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 539,\n \"is_active\": true,\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": true,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"bot_id\": \"string\",\n \"keyword\": \"string\",\n \"match_type\": \"string\",\n \"priority\": 1679,\n \"is_active\": true,\n \"created_at\": \"1959-10-15T21:10:50.597Z\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": false,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"1981-07-15T21:17:45.482Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"45c91f52-7dc8-4bc5-8de2-30c333ab842e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"keyword\": \"strin\",\n \"match_type\": \"string\",\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"priority\": 539,\n \"is_active\": true,\n \"handoff_bot_id\": \"string\",\n \"handover_to_human\": true,\n \"flow_id\": \"string\",\n \"responses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ce675bf6-aedf-43c1-8d5b-2558f67916f3","name":"Delete Keyword Trigger","request":{"name":"Delete Keyword Trigger","description":{"content":"Delete a keyword trigger.\n\n**Required Scopes:** `automation:delete`\n\nPermanently deletes the trigger and all its responses.\nOnly applicable to bots of type KEYWORD.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"b9e7d99d-ecc4-4117-9a4a-3030260a1d6d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3a9192cc-654f-4fb6-af47-cdeedf524e79","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers",":trigger_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"trigger_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4687e25d-dff7-4644-a874-c1c8d3965404","name":"Upload Keyword Trigger Media","request":{"name":"Upload Keyword Trigger Media","description":{"content":"Upload a media file for use in keyword trigger responses.\n\n**Required Scopes:** `automation:update`\n\nUploads a file to cloud storage and returns an attachment record\nthat can be referenced by `attachment_id` in keyword trigger responses.\n\nAccepts images, videos, audio, and documents. Max file size: 50MB.\n\nReturns:\n attachment_id, url, filename, and content_type for the uploaded file.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) "}]}},"response":[{"id":"9aec05d0-c95f-4de5-b9b1-609a566b856b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1fcbb38c-d168-408e-bc38-dd6a680f8382","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","keyword-triggers","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"61ac74bb-c94f-478e-b774-1eb500b83f4d","name":"Delete Bot Translation","request":{"name":"Delete Bot Translation","description":{"content":"Delete the cached translations for a single language from a bot.\n\nIdempotent: removing a language that is not present still returns 200 with the\n(unchanged) bot. Returns 404 only when the bot itself does not exist or is not\nowned by the tenant.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","translations",":lang_code"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"lang_code","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"f436235a-219e-4095-aac9-b4083338ecba","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","translations",":lang_code"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"lang_code","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a1d069b8-85f0-4477-8987-1d4e8921a9e4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","translations",":lang_code"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"lang_code","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"560103b7-b156-42b1-9465-64a2d13a513c","name":"Upsert Bot Translation","request":{"name":"Upsert Bot Translation","description":{"content":"Insert or replace the cached translations for a single language on a bot.\n\nThe request body is the per-language translations object (the value stored at\ntranslation_cache[lang_code]); it is free-form and may contain nested\nstructures such as routing_messages. Returns 404 only when the bot itself does\nnot exist or is not owned by the tenant.\n\n**Required Scopes:** `automation:update`","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","translations",":lang_code"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"lang_code","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"key_0\": 1675,\n \"key_1\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f8aee862-d98e-4bd5-b7e5-3d047da46943","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","translations",":lang_code"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"lang_code","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"key_0\": 1675,\n \"key_1\": true\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 \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"345fe0e6-e74a-4bbe-afea-4d5475bb266e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","translations",":lang_code"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"lang_code","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"key_0\": 1675,\n \"key_1\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"70f0b740-5570-444d-ac13-dffde41a3d25","name":"Get Hub Stats","request":{"name":"Get Hub Stats","description":{"content":"Agents overview: KPIs + one row per bot (agents and classic bots, incl.\npaused) in priority order.\n\n**Required Scopes:** `automation:read`\n\nA conversation counts once per bot; it is *handed off* when a human was\nbrought in, otherwise *resolved*. Percentages are null below\n``min_sample`` (20) conversations per bot.","type":"text/plain"},"url":{"path":["api","v1","automation","hub","stats"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"days","value":"30","description":"Range in days: 7, 30 or 90"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3273e666-ef00-41ef-972a-abb52700db33","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","hub","stats"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"range_days\": 8441,\n \"series_dates\": [\n \"string\",\n \"string\"\n ],\n \"min_sample\": 3315,\n \"totals\": {\n \"conversations\": {\n \"value\": \"\"\n },\n \"conversations_prev\": {\n \"value\": \"\"\n },\n \"conversations_delta_pct\": {\n \"value\": \"\"\n },\n \"resolved\": {\n \"value\": \"\"\n },\n \"resolved_pct\": {\n \"value\": \"\"\n },\n \"handoffs\": {\n \"value\": \"\"\n },\n \"handoff_pct\": {\n \"value\": \"\"\n },\n \"insufficient_data\": {\n \"value\": \"\"\n },\n \"credits\": {\n \"value\": \"\"\n },\n \"credits_eur\": {\n \"value\": \"\"\n }\n },\n \"agents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"period_start\": \"string\",\n \"period_end\": \"string\",\n \"truncated\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7b573d74-eed5-46fb-8ea6-3698bddab84f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","hub","stats"],"host":["{{baseUrl}}"],"query":[{"key":"days","value":"30"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c59b52c6-c2a1-462a-a1e3-1093e7773afc","name":"Duplicate Bot","request":{"name":"Duplicate Bot","description":{"content":"Duplicate a Conversational Agent inside the same workspace.\n\n**Required Scopes:** `automation:create`\n\nThe copy is an unpublished draft, paused, and placed last. It keeps settings, skills (incl.\npinned versions) and knowledge sources, but no activation rules,\nconversations, ratings or history. Classic bots return 422\n``duplicate_classic_not_supported``.","type":"text/plain"},"url":{"path":["api","v1","automation","bots",":bot_id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"289a5630-6ce2-45db-9cbd-15d45849c228","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"bot_type\": \"faq\",\n \"is_active\": false,\n \"is_kb_only_mode\": false,\n \"confidence_threshold\": 2168.270299782423,\n \"offers_escalation\": true,\n \"max_failed_attempts\": 7581,\n \"created_at\": \"1986-09-25T17:57:30.582Z\",\n \"priority\": 0,\n \"personality_prompt\": \"string\",\n \"greeting_message\": \"string\",\n \"escalation_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"display_name\": \"string\",\n \"avatar_url\": \"string\",\n \"ai_disclosure_message\": \"string\",\n \"ai_disclosure_include_escalation\": true,\n \"response_language\": \"string\",\n \"is_detailed_response\": false,\n \"use_full_conversation_context\": false,\n \"vision_enabled\": false,\n \"web_search_mode\": \"string\",\n \"web_search_allowed_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_required_keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"web_search_max_per_conversation\": 8055,\n \"deep_answers_enabled\": false,\n \"auto_translate_messages\": true,\n \"language_detection_strategy\": \"string\",\n \"escalation_enabled\": true,\n \"handoff_message\": \"string\",\n \"no_answer_message\": \"string\",\n \"escalation_offer_message\": \"string\",\n \"immediate_handoff_threshold\": 6357.536773368029,\n \"required_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"routing_config\": {\n \"key_0\": 4492.939762576574,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"is_field_collection_mode\": false,\n \"calendly_event_type_uri\": \"string\",\n \"offline_escalation_behavior\": \"leave_message\",\n \"offline_message\": \"string\",\n \"outside_hours_message\": \"string\",\n \"is_escalation_schedule_enabled\": false,\n \"escalation_timezone\": \"UTC\",\n \"escalation_schedule\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"escalation_tag_id\": \"string\",\n \"escalation_routing_strategy\": \"string\",\n \"escalation_fallback_minutes\": 6872,\n \"max_email_replies\": 1,\n \"is_email_reply_mode\": false,\n \"coexist_bot_id\": \"string\",\n \"coexist_mode\": \"string\",\n \"base_language\": \"string\",\n \"translation_cache\": {\n \"key_0\": true,\n \"key_1\": 1589\n },\n \"greeting_buttons_enabled\": false,\n \"greeting_human_button_caption\": \"string\",\n \"greeting_continue_button_caption\": \"string\",\n \"greeting_continue_ack_message\": \"string\",\n \"source_footer_enabled\": false,\n \"source_footer_mode\": \"string\",\n \"source_link_params\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 6036\n },\n \"kb_live_refresh_mode\": \"string\",\n \"kb_live_refresh_ttl_seconds\": 809,\n \"total_conversations\": 0,\n \"total_escalations\": 0,\n \"updated_at\": \"1978-05-13T12:19:07.105Z\",\n \"activation_rules_count\": 0,\n \"keyword_triggers_count\": 4215\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bd3c4a66-d84b-406f-a4d4-ee4aaad9541d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","bots",":bot_id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bot_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2b86219b-2e6d-4280-a68c-634f206516bc","name":"List Hub Templates","request":{"name":"List Hub Templates","description":{"content":"Agent templates for \"Aus Vorlage\" (keys only; display copy is client-side).\n\n**Required Scopes:** `automation:read`","type":"text/plain"},"url":{"path":["api","v1","automation","hub","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"78458414-b4da-4b95-bc82-1a15dfa8396e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","hub","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ca080c0a-83af-45fe-8648-08558e7285a3","name":"Create From Template","request":{"name":"Create From Template","description":{"content":"Create a paused, unpublished (draft) Conversational Agent from a template, in the workspace\nlanguage (German or English). No AI credits are used.\n\n**Required Scopes:** `automation:create`","type":"text/plain"},"url":{"path":["api","v1","automation","hub","templates",":key","create"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"key","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"879305de-2ebb-46d1-bbda-a713d26d68f4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","automation","hub","templates",":key","create"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"key","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"agent_id\": \"string\",\n \"bot_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"730bbcc4-fe21-4983-84e9-0b629eb7287d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","automation","hub","templates",":key","create"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"key","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"2d12d76a-04b1-44b2-bbb1-b909ae1460a9","name":"Bounce Handling","description":{"content":"Monitor and manage email bounces, complaints, and delivery failures.","type":"text/plain"},"item":[{"id":"96b3fcc9-f2b3-4274-8508-e78d7d5890ed","name":"Get Suppression List","request":{"name":"Get Suppression List","description":{"content":"Get bounce suppression list\n\nRetrieve all suppressed email addresses with optional filtering.\n\n- **bounce_type**: Filter by 'hard' or 'soft' (optional)\n- **limit**: Max results per page (1-1000)\n- **offset**: Pagination offset\n\n**🔐 Required Scopes:** `analytics:read`\n","type":"text/plain"},"url":{"path":["api","v1","bounce-suppressions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"bounce_type","value":"soft"},{"disabled":false,"key":"limit","value":"100"},{"disabled":false,"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"d3ae0559-d43e-433e-ab6f-c2d267ef4460","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","bounce-suppressions"],"host":["{{baseUrl}}"],"query":[{"key":"bounce_type","value":"soft"},{"key":"limit","value":"100"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total\": 6297,\n \"limit\": 2419,\n \"offset\": 5536\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d1ff2dfb-2720-477f-a339-5242d867bc83","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","bounce-suppressions"],"host":["{{baseUrl}}"],"query":[{"key":"bounce_type","value":"soft"},{"key":"limit","value":"100"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9550c0b7-d87a-4dc0-8b5d-43b67cf1d51a","name":"Bulk Suppress Emails","request":{"name":"Bulk Suppress Emails","description":{"content":"Manually add multiple emails to suppression list\n\nUse this endpoint to:\n- Import known bad emails from external sources\n- Bulk suppress problematic email addresses\n- Proactively block emails before sending\n\nMaximum 1000 emails per request.\n\n**🔐 Required Scopes:** `settings:update`\n","type":"text/plain"},"url":{"path":["api","v1","bounce-suppressions","bulk-add"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"emails\": [\n \"X00vxvgEBy@vxjezxxJNlI.fg\"\n ],\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7469ea10-0ac6-40ab-b138-2bc944c2e483","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","bounce-suppressions","bulk-add"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"emails\": [\n \"X00vxvgEBy@vxjezxxJNlI.fg\"\n ],\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"added\": 1901,\n \"skipped\": 3814,\n \"total\": 6799\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d12880bd-3e82-4d3e-886b-4c359afe4eb9","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","bounce-suppressions","bulk-add"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"emails\": [\n \"X00vxvgEBy@vxjezxxJNlI.fg\"\n ],\n \"reason\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"abf16210-238a-4927-a52e-68a1742c4168","name":"Remove From Suppression","request":{"name":"Remove From Suppression","description":{"content":"Remove email from suppression list\n\nUse when:\n- Email is confirmed valid again\n- Manual approval to re-enable email\n- Contact provided updated email address\n\nThis will reset the contact's email_status to 'valid' and\nallow future emails to be sent.\n\n**🔐 Required Scopes:** `settings:update`\n","type":"text/plain"},"url":{"path":["api","v1","bounce-suppressions",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"374f3e5c-1a97-4901-90d9-4fbe93371992","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","bounce-suppressions",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6135ad07-03d4-47f0-87dd-5870322bf7f3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","bounce-suppressions",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1062e192-e32a-4f86-81f1-0bfb257c9c1a","name":"Get Bounce Analytics","request":{"name":"Get Bounce Analytics","description":{"content":"Get bounce analytics\n\nReturns comprehensive bounce statistics:\n- Total bounces by type (hard/soft)\n- Bounce rates\n- Top bounce categories\n- Most problematic domains\n\nOptionally filter by specific campaign.\n\n- **campaign_id**: Filter by campaign (optional)\n- **days**: Time period (1-365 days)\n\n**🔐 Required Scopes:** `analytics:read`\n","type":"text/plain"},"url":{"path":["api","v1","bounce-analytics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"campaign_id","value":"string"},{"disabled":false,"key":"days","value":"30"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"38780414-3dc7-4f54-859a-7ed2d6c86f1e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","bounce-analytics"],"host":["{{baseUrl}}"],"query":[{"key":"campaign_id","value":"string"},{"key":"days","value":"30"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"total_bounces\": 2554,\n \"hard_bounces\": 4405,\n \"soft_bounces\": 3136,\n \"hard_bounce_rate\": 4669.37190831399,\n \"soft_bounce_rate\": 9739.485134047241,\n \"top_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"period_days\": 1748\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"992ff4ad-a337-4f6a-a3c9-8a89cca3f028","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","bounce-analytics"],"host":["{{baseUrl}}"],"query":[{"key":"campaign_id","value":"string"},{"key":"days","value":"30"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"5f52e380-b2d3-46e6-b7ed-b3b908d0fc8e","name":"Campaigns","description":{"content":"Create and manage messaging campaigns for WhatsApp, SMS, and other channels. Schedule sends and track delivery.","type":"text/plain"},"item":[{"id":"06eeeca7-96c8-4512-99a4-8acaf1421601","name":"Create Campaign","request":{"name":"Create Campaign","description":{"content":"Create a new campaign\n\nWith `scheduled_at` the campaign is created as `scheduled` and must pass\nthe same checks as `POST /campaigns/{id}/schedule`: a large WhatsApp\ncampaign on a number that is still warming up is refused with HTTP 409\n`warmup_acknowledgement_required` unless `acknowledge_warmup_warning` is\ntrue, and a split plan that runs too long is refused with HTTP 422\n`split_plan_too_long`. Nothing is created in either case.\n\n**Send speed and batches:** `send_rate_limit` (messages per minute,\n1-60000) and `send_batch_size` (recipients per batch, at least 1) are\noptional. Rejected values return HTTP 422 `{code, message}` with `code`\none of `send_rate_limit_out_of_range`, `send_batch_size_invalid`,\n`send_pacing_conflicts_with_split` (cannot be combined with\n`send_split_config`) or `send_pacing_unavailable` (batches are not\navailable for this account yet).\n\n**Required Scopes:** `campaigns:create`","type":"text/plain"},"url":{"path":["api","v1","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"channel_content\": {\n \"value\": \"\"\n },\n \"message_text\": \"string\",\n \"message_type\": \"text\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scheduled_at\": \"1966-10-25T16:27:33.286Z\",\n \"timezone\": \"string\",\n \"send_rate_limit\": 3427,\n \"send_batch_size\": 4396,\n \"should_skip_duplicates\": true,\n \"duplicate_window_hours\": 24,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sms_optout_link_enabled\": false,\n \"acknowledge_warmup_warning\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"04512477-9501-455a-879b-851125c5dbc5","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"channel_content\": {\n \"value\": \"\"\n },\n \"message_text\": \"string\",\n \"message_type\": \"text\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scheduled_at\": \"1980-11-30T10:23:07.553Z\",\n \"timezone\": \"string\",\n \"send_rate_limit\": 3241,\n \"send_batch_size\": 7785,\n \"should_skip_duplicates\": true,\n \"duplicate_window_hours\": 24,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 8637\n },\n \"sms_optout_link_enabled\": true,\n \"acknowledge_warmup_warning\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fe715534-c8a6-4481-800a-6756b16a3d75","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"channel_content\": {\n \"value\": \"\"\n },\n \"message_text\": \"string\",\n \"message_type\": \"text\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scheduled_at\": \"1980-11-30T10:23:07.553Z\",\n \"timezone\": \"string\",\n \"send_rate_limit\": 3241,\n \"send_batch_size\": 7785,\n \"should_skip_duplicates\": true,\n \"duplicate_window_hours\": 24,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 8637\n },\n \"sms_optout_link_enabled\": true,\n \"acknowledge_warmup_warning\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6cb381a5-07a6-4665-8bb8-edef4bfffd3e","name":"List Campaigns","request":{"name":"List Campaigns","description":{"content":"List all campaigns for the tenant\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"campaign_status","value":"string"},{"disabled":false,"key":"limit","value":"50"},{"disabled":false,"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"fbb50b77-e65e-4757-9925-98beb7093af3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"campaign_status","value":"string"},{"key":"limit","value":"50"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"message_text\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"attachment_id\": {\n \"value\": \"\"\n },\n \"target_url\": {\n \"value\": \"\"\n },\n \"browser_push_title\": {\n \"value\": \"\"\n },\n \"channel_filter\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"scheduled_at\": {\n \"value\": \"\"\n },\n \"started_at\": {\n \"value\": \"\"\n },\n \"completed_at\": {\n \"value\": \"\"\n },\n \"total_recipients\": {\n \"value\": \"\"\n },\n \"sent_count\": {\n \"value\": \"\"\n },\n \"delivered_count\": {\n \"value\": \"\"\n },\n \"read_count\": {\n \"value\": \"\"\n },\n \"failed_count\": {\n \"value\": \"\"\n },\n \"send_rate_limit\": {\n \"value\": \"\"\n },\n \"should_skip_duplicates\": {\n \"value\": \"\"\n },\n \"duplicate_window_hours\": {\n \"value\": \"\"\n },\n \"created_by_user_id\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"channel_content\": {\n \"value\": \"\"\n },\n \"list_ids\": {\n \"value\": \"\"\n },\n \"selected_channel_ids\": {\n \"value\": \"\"\n },\n \"throttle_reason\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"send_batch_size\": {\n \"value\": \"\"\n },\n \"current_batch_number\": {\n \"value\": \"\"\n },\n \"whatsapp_template_id\": {\n \"value\": \"\"\n },\n \"whatsapp_template_name\": {\n \"value\": \"\"\n },\n \"whatsapp_template_language\": {\n \"value\": \"\"\n },\n \"whatsapp_template_variable_mapping\": {\n \"value\": \"\"\n },\n \"send_split_config\": {\n \"value\": \"\"\n },\n \"send_split_state\": {\n \"value\": \"\"\n },\n \"warmup_acknowledged_at\": {\n \"value\": \"\"\n },\n \"warmup_acknowledged_by_user_id\": {\n \"value\": \"\"\n },\n \"warmup_assessment\": {\n \"value\": \"\"\n },\n \"sms_optout_link_enabled\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"message_text\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"attachment_id\": {\n \"value\": \"\"\n },\n \"target_url\": {\n \"value\": \"\"\n },\n \"browser_push_title\": {\n \"value\": \"\"\n },\n \"channel_filter\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"scheduled_at\": {\n \"value\": \"\"\n },\n \"started_at\": {\n \"value\": \"\"\n },\n \"completed_at\": {\n \"value\": \"\"\n },\n \"total_recipients\": {\n \"value\": \"\"\n },\n \"sent_count\": {\n \"value\": \"\"\n },\n \"delivered_count\": {\n \"value\": \"\"\n },\n \"read_count\": {\n \"value\": \"\"\n },\n \"failed_count\": {\n \"value\": \"\"\n },\n \"send_rate_limit\": {\n \"value\": \"\"\n },\n \"should_skip_duplicates\": {\n \"value\": \"\"\n },\n \"duplicate_window_hours\": {\n \"value\": \"\"\n },\n \"created_by_user_id\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"channel_content\": {\n \"value\": \"\"\n },\n \"list_ids\": {\n \"value\": \"\"\n },\n \"selected_channel_ids\": {\n \"value\": \"\"\n },\n \"throttle_reason\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"send_batch_size\": {\n \"value\": \"\"\n },\n \"current_batch_number\": {\n \"value\": \"\"\n },\n \"whatsapp_template_id\": {\n \"value\": \"\"\n },\n \"whatsapp_template_name\": {\n \"value\": \"\"\n },\n \"whatsapp_template_language\": {\n \"value\": \"\"\n },\n \"whatsapp_template_variable_mapping\": {\n \"value\": \"\"\n },\n \"send_split_config\": {\n \"value\": \"\"\n },\n \"send_split_state\": {\n \"value\": \"\"\n },\n \"warmup_acknowledged_at\": {\n \"value\": \"\"\n },\n \"warmup_acknowledged_by_user_id\": {\n \"value\": \"\"\n },\n \"warmup_assessment\": {\n \"value\": \"\"\n },\n \"sms_optout_link_enabled\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"0d61eb8f-346c-4b76-be79-be74f1195d12","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"campaign_status","value":"string"},{"key":"limit","value":"50"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9ab5716a-3066-4018-b31a-37ce7bc778fb","name":"Get Personalization Variables","request":{"name":"Get Personalization Variables","description":{"content":"Get available personalization variables for campaign messages.\n\nReturns a list of variable placeholders (e.g. ``{{contact.name}}``)\nthat can be used in campaign message text. At send time, these placeholders\nare automatically replaced with the recipient contact's data.\n\nIncludes the tenant's active custom field definitions as\n``{{contact.custom.}}`` variables.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns","variables"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"fedee095-d8be-46c1-8338-ebc3a566d801","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns","variables"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"21a04236-1fad-404f-aa72-152ed5888841","name":"Get Channel Media Specs","request":{"name":"Get Channel Media Specs","description":{"content":"Get per-channel media specifications for campaign attachments.\n\nReturns supported file types, size limits, and format constraints\nfor each messaging channel. Useful for the campaign wizard to show\nupload constraints before the user selects files.\n\n**🔐 Required Scopes:** `campaigns:read`\n","type":"text/plain"},"url":{"path":["api","v1","campaigns","channel-media-specs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"597e3187-b2b1-4a56-b55e-8b0db2cba28b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns","channel-media-specs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n },\n \"messenger\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"browser_push\": {\n \"value\": \"\"\n },\n \"rcs\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71f105f5-3842-43a7-8fda-fed4cb3471af","name":"Get Campaign Unsubscribe Counts","request":{"name":"Get Campaign Unsubscribe Counts","description":{"content":"Batch opt-out counts for the messenger campaigns INDEX page.\n\nONE grouped query over the ``contact_subscription_events`` ledger for the\ngiven campaign ids (tenant-scoped). Per campaign: ``total`` opt-outs,\n``exact`` (link/manual — definite attribution) and ``estimated`` (keyword\nheuristic). Campaigns with no opt-outs are OMITTED — treat a missing id as 0.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns","unsubscribe-counts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"ids","value":"string","description":"(Required) Comma-separated campaign ids (max 200)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"857bbb59-ad7a-4079-9c3d-d7426f741bb9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns","unsubscribe-counts"],"host":["{{baseUrl}}"],"query":[{"key":"ids","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"counts\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"67038a51-cd2f-4e93-8337-1fd3f9fd8ec3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns","unsubscribe-counts"],"host":["{{baseUrl}}"],"query":[{"key":"ids","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"88dca22a-344d-4f38-a8b6-e18d237addf2","name":"Get Campaign","request":{"name":"Get Campaign","description":{"content":"Get a specific campaign\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","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"},"response":[{"id":"a6dcc105-895b-4f30-a2f5-c9c9e2d3cffb","name":"Successful Response","originalRequest":{"url":{"path":["api","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2349dc9e-f4ea-4b47-9023-e9984b446cd3","name":"Validation Error","originalRequest":{"url":{"path":["api","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f9a6f414-cb08-41b2-bc60-8ee05d8bdf8b","name":"Update Campaign","request":{"name":"Update Campaign","description":{"content":"Update a campaign\n\n`send_split_config` (WhatsApp only) sets split sending; explicit `null`\nclears it. Rejected with 422 `{code, message}`: `invalid_split_config`,\n`split_sending_requires_whatsapp`, `split_config_not_editable`. An\n`approved` campaign may change ONLY `send_split_config`,\n`send_rate_limit` and `send_batch_size`.\n\n`send_rate_limit` / `send_batch_size`: explicit `null` clears the value,\nomitting the key leaves it unchanged. A campaign that is `sending`,\n`throttled`, `paused` or `failed` may change ONLY these two fields (the\nnext messages and the next batch use the new values); switching them on\nfor a campaign that is already sending moves its unsent recipients into\nbatch 1 at the new speed. Rejected with 422 `{code, message}`:\n`send_rate_limit_out_of_range`, `send_batch_size_invalid`,\n`send_pacing_conflicts_with_split`, `send_pacing_unavailable`,\n`send_pacing_not_editable`.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","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":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"channel_content\": {\n \"value\": \"\"\n },\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scheduled_at\": \"2017-11-16T17:28:57.673Z\",\n \"timezone\": \"string\",\n \"send_rate_limit\": 5772,\n \"send_batch_size\": 6702,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6680,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 1981.732023359255,\n \"key_1\": true\n },\n \"sms_optout_link_enabled\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1df8aeeb-b19e-4f11-b232-dc263052fa2b","name":"Successful Response","originalRequest":{"url":{"path":["api","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":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"channel_content\": {\n \"value\": \"\"\n },\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scheduled_at\": \"1960-04-05T03:11:36.835Z\",\n \"timezone\": \"string\",\n \"send_rate_limit\": 3641,\n \"send_batch_size\": 3099,\n \"should_skip_duplicates\": true,\n \"duplicate_window_hours\": 101,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9652.633188746395\n },\n \"sms_optout_link_enabled\": 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 \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3e56ba6d-8a73-45df-901a-9ad16bbe2267","name":"Validation Error","originalRequest":{"url":{"path":["api","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":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"channel_content\": {\n \"value\": \"\"\n },\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scheduled_at\": \"1960-04-05T03:11:36.835Z\",\n \"timezone\": \"string\",\n \"send_rate_limit\": 3641,\n \"send_batch_size\": 3099,\n \"should_skip_duplicates\": true,\n \"duplicate_window_hours\": 101,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9652.633188746395\n },\n \"sms_optout_link_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e18ffb03-b5e4-4175-b532-6eff4d853cc7","name":"Delete Campaign","request":{"name":"Delete Campaign","description":{"content":"Delete a campaign (draft or scheduled only).\n\nA campaign that has already sent messages (for example contacts enrolled\nfrom HubSpot) cannot be deleted: HTTP 400. Sent emails of an email\ncampaign are kept for billing before the delete.\n\n**Required Scopes:** `campaigns:delete`","type":"text/plain"},"url":{"path":["api","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":"DELETE"},"response":[{"id":"4bcce2d5-c371-4c53-9f4d-515744f6a079","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"cc3d0ac2-db49-4557-b6b5-b4d02863cd29","name":"Validation Error","originalRequest":{"url":{"path":["api","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":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f3ea4dc5-ffcd-420b-a41a-cc5e7cb8763c","name":"Add Segment","request":{"name":"Add Segment","description":{"content":"Add a segment filter to a campaign\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","segments"],"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":"POST","body":{"mode":"raw","raw":"{\n \"filter_type\": \"all_contacts\",\n \"filter_operator\": {\n \"value\": \"\"\n },\n \"filter_value\": {\n \"key_0\": \"string\",\n \"key_1\": 1893\n },\n \"logical_operator\": \"and\",\n \"filter_order\": 0\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6f580ffd-fd1f-46b3-a2d7-7c82194aec83","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","segments"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"filter_type\": \"all_contacts\",\n \"filter_operator\": {\n \"value\": \"\"\n },\n \"filter_value\": {\n \"key_0\": \"string\",\n \"key_1\": 1893\n },\n \"logical_operator\": \"and\",\n \"filter_order\": 0\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"campaign_id\": \"string\",\n \"filter_type\": \"dynamic_list\",\n \"filter_operator\": {\n \"value\": \"\"\n },\n \"filter_value\": {\n \"key_0\": 5530\n },\n \"logical_operator\": \"or\",\n \"filter_order\": 7701,\n \"created_at\": \"2018-03-18T06:14:20.292Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a976e721-896b-4c0e-98ca-1fb740a8b46b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","segments"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"filter_type\": \"all_contacts\",\n \"filter_operator\": {\n \"value\": \"\"\n },\n \"filter_value\": {\n \"key_0\": \"string\",\n \"key_1\": 1893\n },\n \"logical_operator\": \"and\",\n \"filter_order\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"913fc0e5-1916-404d-b718-382274c948aa","name":"Preview Segment","request":{"name":"Preview Segment","description":{"content":"Preview contacts that would be included in a segment (for UI testing)\n\n``limit`` (default 10) is capped at 100; a larger value is a 422.\nReturns contact names/phones/emails, so it needs `contacts:read` too.\n\n**Required Scopes:** `campaigns:read` AND `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns","preview-segment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"segments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"limit\": 10\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dd49744d-da95-46dc-9e3d-468a6df43795","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns","preview-segment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"segments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"limit\": 10\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"016621b8-5ad6-4f85-af5b-ba55aff62156","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns","preview-segment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"segments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"limit\": 10\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6542f5c8-6609-4fae-a0a1-7eb2323f4c5c","name":"Estimate Campaign Cost","request":{"name":"Estimate Campaign Cost","description":{"content":"Estimate campaign cost and check balance before sending\n\n**Required Scopes:** `campaigns:read`\n\nReturns:\n - total_cost_eur: RAW usage cost in EUR (before the included pool)\n - recipient_count: Number of recipients\n - breakdown: Cost breakdown by channel ({count, cost})\n - warnings: List of warnings about variable costs\n - can_send: Whether campaign can be sent based on balance\n - balance_error: Error message if insufficient balance\n - current_balance_eur: Current balance in EUR\n\nIncluded-pool fields (base_fee plans only; 0 / null on legacy\n`minimum_commit` plans or plans with no included pool -- the UI gates the\npool UI on `included_messages_total > 0` and otherwise headlines\n`total_cost_eur`):\n - included_messages_total: effective pooled allowance this month (int)\n - included_messages_used: pooled units already consumed this month (int)\n - included_messages_remaining: max(0, total - used) (int)\n - projected_sends: billable send units this campaign draws (int)\n - sends_covered_by_pool: min(projected_sends, remaining) (int)\n - sends_over_pool: max(0, projected_sends - remaining) (int)\n - payable_overage_eur: EUR actually payable for THIS campaign after the\n pool absorbs what it can (0.00 when fully covered; null when no pool\n applies -- use total_cost_eur). Excludes Meta/WhatsApp per-conversation\n template fees, which Meta bills separately.\n - fully_covered: bool, true when sends_over_pool == 0\n - pool_is_shared: bool, true when the pool is shared across the account\n (human wording is authored on the frontend for i18n)\n\nRCS Newsletter (MAU) agents (only present when the campaign sends via one):\n - rcs_newsletter: {recipient_count, sendseven_fee_eur: 0.0, billing: \"mau\"}.\n These recipients carry NO per-message fee and draw NO pool units, so\n they are excluded from total_cost_eur / breakdown / projected_sends\n (recipient_count still includes them). Their only cost is the monthly\n active user price from the RCS balance -- see `GET /rcs-estimate`.","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","estimate-cost"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"137da8ff-f219-422a-b7c3-15555595bec1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","estimate-cost"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": 5382.780010670516,\n \"key_1\": true,\n \"key_2\": 7618,\n \"key_3\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"33871904-b0ea-4935-af37-3828e99f4d63","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","estimate-cost"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e4ad8412-8a3a-4bd4-9b46-406670e8d598","name":"Send Campaign","request":{"name":"Send Campaign","description":{"content":"Send a campaign immediately\n\n**Required Scopes:** `campaigns:send`\n\nOptional body `{\"acknowledge_warmup_warning\": true}` (no body = false).\nA large WhatsApp campaign on a number that is still warming up is refused\nwith HTTP 409 `detail = {\"code\": \"warmup_acknowledgement_required\",\n\"message\": ..., \"warmup\": }` unless acknowledged or\nsplit over days (`send_split_config`). Nothing is prepared or sent on 409.\nA split plan that would run too long is refused with HTTP 422\n`{\"code\": \"split_plan_too_long\", \"message\": ...}`.\n\nWith `send_split_config`, only day 1's batch is sent now; later batches\ngo out automatically (the response `split` block has `days_total`,\n`next_batch_at`, `scheduled_count`).\n\n**Response (200):** `{success, campaign_id, recipient_count,\npublished_count, dispatch, split, trial_recipient_cap, message}`. Messages\nare sent in the background after the response. `published_count` is the\nnumber of recipients queued to be sent now (all of them, or day 1 of a\nsplit plan). `dispatch` is `\"queued\"` when that number is above 0, and\n`\"pending\"` when nothing is due yet or queuing is retried automatically.\n\n**Send speed and batches:** with `send_rate_limit` and/or\n`send_batch_size` saved on the campaign, messages go out at the chosen\nspeed and, with a batch size, only the first batch is sent now. The\nresponse then also has `pacing: {paced, batch_number, armed, remaining,\nsend_rate_limit, send_batch_size}` (`armed` = recipients in batch 1,\n`remaining` = recipients waiting for later batches; `published_count` is\n0 because the messages are released gradually). After each batch the\ncampaign is `paused` with `throttle_reason = \"batch_complete\"`; send the\nnext one with `POST /campaigns/{id}/send-next-batch`. Invalid saved\nvalues are refused with HTTP 422 `{code, message}` (see\n`PUT /campaigns/{id}`).\n\nOnly campaigns with status `draft`, `approved` or `scheduled` can be sent.\n\n**Note:** Campaigns with status `in_review` or `rejected` cannot be sent\n(HTTP 400). A campaign that is already sending, throttled, completed,\npaused, failed or cancelled is refused with HTTP 409 -- re-posting here\nwould re-prepare the whole recipient list and send the campaign a second\ntime. Use `POST /campaigns/{id}/resume` for a paused or failed campaign.","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","send"],"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":"POST","body":{"mode":"raw","raw":"{\n \"acknowledge_warmup_warning\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"211a56cc-84a2-47e1-88ef-70647fcbe6e7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","send"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"acknowledge_warmup_warning\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed65bd11-d17d-45a9-948e-71328066ccd4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","send"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"acknowledge_warmup_warning\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d63ee4a6-ba83-49ff-9f7b-c77d93889e89","name":"Pause Campaign","request":{"name":"Pause Campaign","description":{"content":"Pause a sending campaign\n\nAlso allowed while a split-sending campaign waits for its next daily batch\n(`throttled` with `throttle_reason = \"daily_batch_limit\"`). A paused\ncampaign never resumes on its own -- use resume.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","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"},"response":[{"id":"e192aa35-03a6-49f9-8a79-3a92e9b58a87","name":"Successful Response","originalRequest":{"url":{"path":["api","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d7355380-a094-4058-9210-f03f16bf2a34","name":"Validation Error","originalRequest":{"url":{"path":["api","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"889d1c34-448a-4df9-83f5-fdcb14d72549","name":"Resume Campaign","request":{"name":"Resume Campaign","description":{"content":"Resume a paused or failed campaign\n\nFor split-sending campaigns the remaining recipients are re-planned from\nnow: today's batch is sent, later batches continue on the following days.\n\nOptional body `{\"acknowledge_warmup_warning\": true}` (no body = false).\nA campaign the scheduler paused with `throttle_reason =\n\"warmup_acknowledgement_required\"` (its warm-up acknowledgement was\nmissing or cleared by an edit), and any campaign resumed before its\nrecipients were prepared, passes the same WhatsApp warm-up gate as\n`POST /send`: HTTP 409 `warmup_acknowledgement_required` unless\nacknowledged; nothing changes on 409. Such a campaign is then dispatched\nlike a fresh send (recipients prepared, day 1 of a split plan published).\nA campaign held because its audience grew since the acknowledgement\n(`warmup_assessment.hold.kind = \"audience_grew\"`) always needs\n`acknowledge_warmup_warning: true`. A successful resume clears\n`warmup_assessment.hold`.\n\nResume continues the recipients that are still pending. It does not\nre-send failed recipients; use `POST /campaigns/{id}/retry-failed` for\nthat. Sending continues in the background after the response.\n\nCampaigns sent in batches: a campaign paused after finishing a batch\n(`throttle_reason = \"batch_complete\"`) sends its next batch at the saved\nbatch size (the same as `POST /campaigns/{id}/send-next-batch` with an\nempty body). Any other pause continues the current batch at the saved\nsend speed. A campaign sent in batches that ended as `completed` or\n`failed` while recipients were still waiting is re-opened the same way.\nWhile sending at a set speed or in batches is briefly unavailable, a\ncampaign that uses it returns HTTP 422 `send_pacing_unavailable`.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","resume"],"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":"POST","body":{"mode":"raw","raw":"{\n \"acknowledge_warmup_warning\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"892eb9e3-90c5-4171-be78-ded41c8986ef","name":"Successful Response","originalRequest":{"url":{"path":["api","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","body":{"mode":"raw","raw":"{\n \"acknowledge_warmup_warning\": {\n \"value\": \"\"\n }\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 \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"290b9a6b-8f3b-46c5-ac9c-ad1b81201169","name":"Validation Error","originalRequest":{"url":{"path":["api","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","body":{"mode":"raw","raw":"{\n \"acknowledge_warmup_warning\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9b4426f8-28dd-479c-bf66-196067b7f526","name":"Send Next Batch","request":{"name":"Send Next Batch","description":{"content":"Send the next batch of a campaign sent in batches\n\nOnly for a campaign that finished a batch: `status = \"paused\"` with\n`throttle_reason = \"batch_complete\"`, or one that ended as `completed` /\n`failed` while recipients were still waiting (it continues its unfinished\nbatch first, if any). Anything else returns HTTP 409\n`{\"code\": \"campaign_not_awaiting_batch\", \"message\": ...}` (also when two\nrequests race: only the first one sends a batch). HTTP 422\n`send_pacing_unavailable` while batch sending is briefly unavailable.\n\nBody (optional): `{\"batch_size\": 500}` sends 500 recipients now and saves\n500 as the campaign's batch size (1-1,000,000; anything else is HTTP 422\n`{\"code\": \"send_batch_size_invalid\", \"message\": ...}`); `{\"all_remaining\": true}` sends\neveryone who is still waiting. An empty body sends the next batch at the\nsaved batch size. Recipients who opted out, unsubscribed or were blocked\nsince the campaign was prepared are skipped (`skipped_ineligible`).\n\n**Response (200):** `{batch_number, armed, skipped_ineligible, remaining,\ncampaign}`. The batch is sent in the background at the campaign's send\nspeed; the campaign pauses again when the batch is done (or completes\nwhen nobody is left).\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","send-next-batch"],"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":"POST","body":{"mode":"raw","raw":"{\n \"batch_size\": {\n \"value\": \"\"\n },\n \"all_remaining\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fa71c2c2-5064-4637-aba7-e54b427995a9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","send-next-batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"batch_size\": {\n \"value\": \"\"\n },\n \"all_remaining\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"batch_number\": 692,\n \"armed\": 5367,\n \"campaign\": {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"message_text\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"attachment_id\": {\n \"value\": \"\"\n },\n \"target_url\": {\n \"value\": \"\"\n },\n \"browser_push_title\": {\n \"value\": \"\"\n },\n \"channel_filter\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"scheduled_at\": {\n \"value\": \"\"\n },\n \"started_at\": {\n \"value\": \"\"\n },\n \"completed_at\": {\n \"value\": \"\"\n },\n \"total_recipients\": {\n \"value\": \"\"\n },\n \"sent_count\": {\n \"value\": \"\"\n },\n \"delivered_count\": {\n \"value\": \"\"\n },\n \"read_count\": {\n \"value\": \"\"\n },\n \"failed_count\": {\n \"value\": \"\"\n },\n \"send_rate_limit\": {\n \"value\": \"\"\n },\n \"should_skip_duplicates\": {\n \"value\": \"\"\n },\n \"duplicate_window_hours\": {\n \"value\": \"\"\n },\n \"created_by_user_id\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"channel_content\": {\n \"value\": \"\"\n },\n \"list_ids\": {\n \"value\": \"\"\n },\n \"selected_channel_ids\": {\n \"value\": \"\"\n },\n \"throttle_reason\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"send_batch_size\": {\n \"value\": \"\"\n },\n \"current_batch_number\": {\n \"value\": \"\"\n },\n \"whatsapp_template_id\": {\n \"value\": \"\"\n },\n \"whatsapp_template_name\": {\n \"value\": \"\"\n },\n \"whatsapp_template_language\": {\n \"value\": \"\"\n },\n \"whatsapp_template_variable_mapping\": {\n \"value\": \"\"\n },\n \"send_split_config\": {\n \"value\": \"\"\n },\n \"send_split_state\": {\n \"value\": \"\"\n },\n \"warmup_acknowledged_at\": {\n \"value\": \"\"\n },\n \"warmup_acknowledged_by_user_id\": {\n \"value\": \"\"\n },\n \"warmup_assessment\": {\n \"value\": \"\"\n },\n \"sms_optout_link_enabled\": {\n \"value\": \"\"\n }\n },\n \"skipped_ineligible\": 0,\n \"remaining\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a67951f-b086-4236-a6e4-c4031a5f589c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","send-next-batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"batch_size\": {\n \"value\": \"\"\n },\n \"all_remaining\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"363791f6-12ed-4e8e-8c69-d8014de511ab","name":"List Campaign Batches","request":{"name":"List Campaign Batches","description":{"content":"Per-batch delivery counts of a campaign sent in batches\n\nOne item per batch: `{batch_number, total, pending, sent, delivered,\nread, failed, skipped}`, oldest batch first. `remaining` is the number of\nrecipients waiting for a later batch, `current_batch_number` the batch\nthe campaign is on and `send_batch_size` the saved batch size. A campaign\nthat is not sent in batches returns an empty list.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","batches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Batches per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"d19e612a-4a71-48f7-8c7d-670501dfa43c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","batches"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n },\n \"remaining\": 0,\n \"current_batch_number\": 1092,\n \"send_batch_size\": 4483\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"de0bf8e3-3484-41b7-b165-6e64ffc61463","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","batches"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"91fc6246-5e93-4b3f-b9e8-7f8232b62f1c","name":"Get Campaign Send Plan","request":{"name":"Get Campaign Send Plan","description":{"content":"Send plan: speed, batches and estimated duration\n\nRead-only estimate for the campaign's audience at its saved send speed\nand batch size, or at the values given as query parameters (to preview a\nchange before saving it). `effective_rate_per_minute` is the requested\nspeed capped by what the campaign's channels can send, and\n`rate_limited_by` says which of the two decides (`\"campaign\"` or\n`\"channel\"`). `channels[]` lists each channel's recipients and maximum\nmessages per second. `eta_seconds` estimates the time to send everyone\nwho is left (time paused between batches not included);\n`eta_seconds_per_batch` the time per batch. `pacing_available = false`\nmeans send speed and batches are not available for this account yet.\n\nOut-of-range query values return HTTP 422 `{code, message}`\n(`send_rate_limit_out_of_range`, `send_batch_size_invalid`).\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","send-plan"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"send_rate_limit","value":"4595","description":"Preview this send speed (messages per minute, 1-60000) instead of the saved one"},{"disabled":false,"key":"send_batch_size","value":"4595","description":"Preview this batch size (>= 1) instead of the saved one"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4aeaed45-cf3b-4ab4-9d11-faadf6adc314","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","send-plan"],"host":["{{baseUrl}}"],"query":[{"key":"send_rate_limit","value":"4595"},{"key":"send_batch_size","value":"4595"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pacing_available\": true,\n \"pacing_unavailable_reason\": \"string\",\n \"total_recipients\": 0,\n \"remaining\": 0,\n \"channels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requested_rate_per_minute\": 1108,\n \"effective_rate_per_minute\": 4324.130843266144,\n \"batch_size\": 6974,\n \"batches\": 6853,\n \"eta_seconds\": 2231,\n \"eta_seconds_per_batch\": 3287,\n \"rate_limited_by\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea15154b-de98-4a1c-a205-92180b4daa75","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","send-plan"],"host":["{{baseUrl}}"],"query":[{"key":"send_rate_limit","value":"4595"},{"key":"send_batch_size","value":"4595"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cd6edea4-9c66-43c7-8589-e2084f8d7b58","name":"Retry Failed Recipients","request":{"name":"Retry Failed Recipients","description":{"content":"Retry failed recipients of a campaign\n\nResets FAILED recipients back to pending and re-queues them for sending.\nDesigned for \"top up, then retry\": an SMS campaign that was paused because\nthe prepaid SMS balance was used up can be re-driven with\n``{\"error_codes\": [\"insufficient_sms_balance\"]}`` once credit is available.\nSMS recipients the carrier rejected or did not deliver are re-driven with\n``{\"error_codes\": [\"sms_rejected_by_carrier\"]}`` / ``[\"sms_not_delivered\"]``\n(e.g. after the cause of an automatic pause was fixed).\nSMS recipients that failed because the SMS provider temporarily limited\nthe sending rate are re-driven with ``{\"error_codes\": [\"sms_rate_limited\"]}``\n-- lower the campaign's `send_rate_limit` or set a `send_batch_size`\nfirst (`PUT /campaigns/{id}`) so the retry does not hit the limit again.\nWith no body (or an empty list) every failed recipient is retried.\nUnknown codes return HTTP 422 listing the allowed codes.\n\nAllowed on campaigns in status `completed`, `failed` or `paused`. A\n`completed` or `failed` campaign returns to `sending` and any recipients\nstill pending are re-queued as well. A `paused` campaign STAYS paused: the\nfailed recipients are reset and go out together with the rest when the\ncampaign is resumed (`POST /campaigns/{id}/resume`). A retry never\nresumes a paused campaign.\n\n**Response:** `{\"success\": true, \"id\": \"\", \"requeued\": }`\nwhere `requeued` is the number of failed recipients reset. When the\ncampaign was paused and stays paused the body also carries\n`\"paused\": true` (the field is omitted otherwise).\n\n**Errors:**\n* HTTP 429 `{\"code\": \"retry_failed_cooldown\", \"message\", \"retry_after_seconds\"}`\n (plus a `Retry-After` header) when failed recipients of this campaign\n were retried less than 10 minutes ago.\n* HTTP 422 `{\"code\": \"retry_requires_send_speed\", \"message\"}` when the\n campaign was paused because the SMS provider limited the sending rate\n and has no send speed / batch size yet: set `send_rate_limit` or\n `send_batch_size` with `PUT /campaigns/{id}` first.\n\nFor a split-sending campaign the reset recipients join the remaining\nplan, re-planned from now like `POST /resume`: only today's batch is sent\nimmediately, the rest follows on the next days.\n\nFor a campaign sent in batches the reset recipients join the current\nbatch and are sent at the campaign's send speed.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","retry-failed"],"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":"POST","body":{"mode":"raw","raw":"{\n \"error_codes\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"880eef00-1336-40d0-872a-c5f2391187ab","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","retry-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"error_codes\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c25ad345-04f5-40ff-a073-76b39061a0ab","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","retry-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"error_codes\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49721c33-aa6f-4243-b4db-852095cd48f0","name":"Cancel Campaign","request":{"name":"Cancel Campaign","description":{"content":"Cancel a scheduled, sending or paused campaign\n\nRecipients that were not sent yet are not sent (for a campaign sent in\nbatches this includes everyone waiting for a later batch). Messages\nalready sent are not recalled.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","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"},"response":[{"id":"9cf28f48-2644-4fca-aa8c-f000c7f9404e","name":"Successful Response","originalRequest":{"url":{"path":["api","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"397ebaa4-4cdb-4f40-bc29-aa10d18b250a","name":"Validation Error","originalRequest":{"url":{"path":["api","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fb44e16c-02b5-4287-8a9d-a01f1826ff63","name":"Schedule Campaign","request":{"name":"Schedule Campaign","description":{"content":"Schedule a campaign for future sending.\n\nAccepts a local datetime and IANA timezone string. The backend converts to UTC\nfor storage. The original timezone is preserved for display purposes.\n\nThe scheduled time must be at least 5 minutes in the future.\n\n`acknowledge_warmup_warning` (default false): same WhatsApp warm-up rule as\n`POST /send` -- 409 `warmup_acknowledgement_required` when required and not\ngiven. The acknowledgement is stored; the scheduled dispatch does not\nre-ask -- unless the audience, content, channels, template or split config\nis edited afterwards: that clears the acknowledgement and the dispatch then\nholds the campaign `paused` with `throttle_reason =\n\"warmup_acknowledgement_required\"` until `POST /resume` acknowledges.\nA split plan that would run too long: 422 `split_plan_too_long`.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","schedule"],"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":"POST","body":{"mode":"raw","raw":"{\n \"scheduled_at\": \"1980-06-27T06:30:14.370Z\",\n \"timezone\": \"string\",\n \"acknowledge_warmup_warning\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ea238198-f64f-4f16-8773-04056e0615b6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduled_at\": \"1980-06-27T06:30:14.370Z\",\n \"timezone\": \"string\",\n \"acknowledge_warmup_warning\": 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 \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c17246d3-91d2-4e8a-837c-1a453e41cc69","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduled_at\": \"1980-06-27T06:30:14.370Z\",\n \"timezone\": \"string\",\n \"acknowledge_warmup_warning\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e801b372-ed41-4d47-a90c-338e6966c41c","name":"Cancel Schedule","request":{"name":"Cancel Schedule","description":{"content":"Cancel a scheduled campaign and move it back to draft.\n\nThis clears the scheduled_at time and reverts the status to draft,\nallowing the user to edit and reschedule.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","cancel-schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"df2f53d4-0af4-47d0-91bc-860c7b921dbf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","cancel-schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"message_text\": \"string\",\n \"message_type\": \"string\",\n \"attachment_id\": \"string\",\n \"target_url\": \"string\",\n \"browser_push_title\": \"string\",\n \"channel_filter\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"draft\",\n \"scheduled_at\": \"1996-09-16T02:33:30.960Z\",\n \"started_at\": \"1958-04-10T17:28:21.693Z\",\n \"completed_at\": \"1973-08-30T17:12:02.145Z\",\n \"total_recipients\": 3422,\n \"sent_count\": 1278,\n \"delivered_count\": 276,\n \"read_count\": 9237,\n \"failed_count\": 7000,\n \"send_rate_limit\": 6715,\n \"should_skip_duplicates\": false,\n \"duplicate_window_hours\": 6858,\n \"created_by_user_id\": \"string\",\n \"created_at\": \"2021-08-02T11:40:17.157Z\",\n \"updated_at\": \"1993-10-19T11:48:29.718Z\",\n \"channel_content\": {\n \"key_0\": 9528.35262453713,\n \"key_1\": 9518.510079632924\n },\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"selected_channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"throttle_reason\": \"string\",\n \"timezone\": \"string\",\n \"send_batch_size\": 7844,\n \"current_batch_number\": 7428,\n \"whatsapp_template_id\": \"string\",\n \"whatsapp_template_name\": \"string\",\n \"whatsapp_template_language\": \"string\",\n \"whatsapp_template_variable_mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"send_split_config\": {\n \"key_0\": 9078,\n \"key_1\": true,\n \"key_2\": false\n },\n \"send_split_state\": {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": 9492.330365264603\n },\n \"warmup_acknowledged_at\": \"2010-07-02T09:19:36.898Z\",\n \"warmup_acknowledged_by_user_id\": \"string\",\n \"warmup_assessment\": {\n \"key_0\": 4118.43954316504,\n \"key_1\": false\n },\n \"sms_optout_link_enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"74c3fe96-7ebe-4d24-bc52-b3f2e28c94e0","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","cancel-schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"80d7d121-5501-4031-bb98-15340a00df45","name":"Get Campaign Statistics","request":{"name":"Get Campaign Statistics","description":{"content":"Get campaign statistics (sent, delivered, failed, etc.)\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","statistics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1c35cfc4-d920-42ce-8efc-11015d3ca332","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","statistics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": 3370,\n \"key_1\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"065f9c85-fbff-487c-a5f0-a64ed57c1f10","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","statistics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8bc34ed4-232d-4c25-b90d-7aa6ac2df3b4","name":"Get Campaign Link Performance","request":{"name":"Get Campaign Link Performance","description":{"content":"Get aggregate link performance for a Reach (messenger) campaign.\n\nRolls per-recipient child rows up under their template via\n``COALESCE(parent_link_id, id)``. Each row shows total clicks, unique\nrecipients (per_recipient mode only), first/last click timestamps,\nand the template's short URL.\n\n**Required Scopes:** `campaigns:read`\n\nReturns:\n ``{\"items\": [...]}`` — list of links sorted by clicks DESC. Empty\n list if the campaign has no tracked links yet.","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","link-performance"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3086c723-07f0-4081-88d5-ce296b8a104b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","link-performance"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": 8584,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b2a92673-c62e-4d2f-9065-71fd0044c991","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","link-performance"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f25af0b9-cd20-4e4c-b048-5e2810acb2dd","name":"Get Campaign Unsubscribes","request":{"name":"Get Campaign Unsubscribes","description":{"content":"List recipients who opted out attributed to THIS messenger campaign.\n\nCampaign-attributed opt-outs from the ``contact_subscription_events`` SHARD\nledger, split by source and confidence:\n\n* LINK opt-outs (``method='link'``, ``attribution='exact'``) — recipient used\n this campaign's own unsubscribe surface; attribution is certain.\n* KEYWORD opt-outs (``method='keyword'``, ``attribution='heuristic'``) — a\n \"stop\"-style keyword opt-out attributed to the last campaign on that channel\n within ``window_hours``. Only keyword opt-outs the heuristic matched to THIS\n campaign appear here.\n\n``method_counts`` and ``attribution_counts`` cover the full result set;\n``items`` is the requested page ordered by opt-out time DESC\n(``page``/``page_size``, default 25). The UI labels link=exact vs\nkeyword=approximate off each item's ``attribution``.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a12f09d6-777e-485b-945d-86f2ec3c90bf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attribution_counts\": {\n \"exact\": 1,\n \"heuristic\": 3\n },\n \"items\": [\n {\n \"attribution\": \"heuristic\",\n \"channel_type\": \"whatsapp\",\n \"contact_id\": \"c1a2b3\",\n \"contact_name\": \"Jane Doe\",\n \"matched_sent_at\": \"2026-09-13T09:00:00Z\",\n \"method\": \"keyword\",\n \"unsubscribed_at\": \"2026-09-14T10:30:00Z\",\n \"window_hours\": 72\n },\n {\n \"attribution\": \"exact\",\n \"channel_type\": \"whatsapp\",\n \"contact_id\": \"d4e5f6\",\n \"contact_name\": \"John Roe\",\n \"method\": \"link\",\n \"unsubscribed_at\": \"2026-09-14T08:15:00Z\"\n }\n ],\n \"method_counts\": {\n \"keyword\": 3,\n \"link\": 1\n },\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 25,\n \"total\": 4\n },\n \"total_unsubscribes\": 4\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b5035b58-5ae4-4bf5-9fd1-3ddbe7c87282","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fde44266-d608-4059-823d-0c14f439a3b7","name":"List Campaign Recipients","request":{"name":"List Campaign Recipients","description":{"content":"List a campaign's recipients (messenger/newsletter) with delivery status.\n\nGroups: `successful` = sent/delivered/read, `failed` = failed (skipped\nexcluded), `all` = the union of both, `held` = waiting for a later batch\n(campaigns sent in batches; not part of `all`). Each item:\n`{id, contact_id, name, identifier, status, error_reason, sent_at,\ndelivered_at, failed_at}`.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","recipients"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"status","value":"all","description":"Recipient group: failed | successful | all | held"},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"},{"disabled":false,"key":"search","value":"string","description":"Search recipient handle, contact name or phone"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"df11dca9-5355-400b-9fad-95366cf2c8c3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"all"},{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"search","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9fba9679-c3b9-451b-b211-84a548c72a55","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"all"},{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"search","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1b64e317-e54d-4f79-b925-07e3a4ea8dcd","name":"Retry Campaign Recipient","request":{"name":"Retry Campaign Recipient","description":{"content":"Retry a single failed recipient of a messenger/newsletter campaign.\n\nCalls the retry execution in ``CampaignService.retry_single_recipient`` and\nreturns the updated recipient item so the UI can update the row inline.\n\n- Recipient not found -> 404\n- Recipient not retryable in its current state -> 409\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id","retry"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"d3970684-5022-4c1e-9f8a-582b3984a5dd","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id","retry"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"contact_id\": \"string\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"error_reason\": \"string\",\n \"last_error_code\": \"string\",\n \"sent_at\": \"string\",\n \"delivered_at\": \"string\",\n \"failed_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"904ffe80-43c3-4f29-8a84-0ed16ada7c33","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id","retry"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"19720cdc-e46e-4af8-9499-af3214a9bd40","name":"Delete Campaign Recipient","request":{"name":"Delete Campaign Recipient","description":{"content":"Remove a single recipient from a messenger/newsletter campaign.\n\nHard-deletes the per-recipient row (tenant + campaign ownership validated),\nthen recomputes the campaign's denormalized counters and drops\n`total_recipients` by 1. A recipient who was already sent the message\n(sent / delivered / read) cannot be removed: HTTP 409.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"471e674b-39e0-440d-9abb-3aaa0faf366c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"43567ad8-aeb1-4e6d-b518-1f3cfb29a75b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c137de43-2def-4230-b78b-5a7ea312ac81","name":"Remove Failed Campaign Recipients","request":{"name":"Remove Failed Campaign Recipients","description":{"content":"Bulk-remove all failed recipients from a messenger/newsletter campaign.\n\nHard-deletes every failed-group row for this campaign, recomputes the\ncampaign counters and drops `total_recipients` by the number removed. This\nis DISTINCT from `POST /{campaign_id}/retry-failed`, which re-queues failed\nrecipients instead of deleting them.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","recipients","remove-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"9079bb31-fc02-4398-8315-b92bf264b743","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients","remove-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"removed_count\": 8419,\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"10ac5f94-bd26-4064-8a9a-80cac90dc151","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients","remove-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3fb6f22f-5c2e-4861-8a51-22ed5dbdcfde","name":"Unsubscribe Campaign Recipient","request":{"name":"Unsubscribe Campaign Recipient","description":{"content":"Opt a messenger/newsletter recipient's contact out of this campaign's lists.\n\nThis is DISTINCT from `DELETE /{campaign_id}/recipients/{recipient_id}`\n(\"Remove\"), which only deletes the per-recipient row and does NOT change\nsubscription state. This endpoint resolves the recipient's contact, computes\nthe campaign's originating list(s) (`campaign_lists` ∩ the contact's\ncurrently-subscribed lists) and opts the contact out of all of them via the\nsubscription chokepoint, writing the opt-out ledger with campaign attribution\n(`method='manual'`).\n\n- Recipient (or its campaign) not found for this tenant -> 404\n- Recipient is an anonymous subscriber with no linked contact -> 422\n- Contact subscribed to none of the campaign's lists (or the campaign targets\n no lists) -> 200 with an empty `unsubscribed_lists`\n- Contact already opted out of all of the campaign's lists -> 200 with\n `already_unsubscribed: true`\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"00f6b45b-1410-4281-8148-c3f7243120b0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"unsubscribed_lists\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"already_unsubscribed\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8b8c2c41-2f2f-426c-84dd-048009607715","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","campaigns",":campaign_id","recipients",":recipient_id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"785844f4-5dde-423c-a4c2-6b457d6fa0b4","name":"Canned Responses","description":{"content":"Manage pre-saved quick reply templates for agents. Supports personal and shared responses with shortcut triggers.","type":"text/plain"},"item":[{"id":"88d0b0cf-aab2-499b-a9ab-078ce8760d95","name":"List Canned Responses","request":{"name":"List Canned Responses","description":{"content":"List canned responses visible to the current user.\n\nReturns the user's own responses and all shared responses. Users with\n`canned_responses:settings` scope see all responses in the tenant.\n\n**Required Scopes:** `canned_responses:read`","type":"text/plain"},"url":{"path":["api","v1","canned-responses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"},{"disabled":false,"key":"category","value":"string","description":"Filter by category"},{"disabled":false,"key":"search","value":"string","description":"Search in title, content, and shortcut"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"80423c5d-bea4-49f6-90bc-f5d0b2172fbf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"category","value":"string"},{"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0db89d2d-3372-4a8e-93da-c240d265c0b2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","canned-responses"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"category","value":"string"},{"key":"search","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"66758b8e-c031-4c61-a86d-6db52237006f","name":"Create Canned Response","request":{"name":"Create Canned Response","description":{"content":"Create a new canned response.\n\nBy default, responses are personal (visible only to you). Set `is_shared=true`\nto make it visible to all team members (requires `canned_responses:settings` scope).\n\n**Required Scopes:** `canned_responses:create`","type":"text/plain"},"url":{"path":["api","v1","canned-responses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"category\": \"Greetings\",\n \"content\": \"Hello! Thank you for contacting us. How can I help you today?\",\n \"is_shared\": true,\n \"shortcut\": \"greeting\",\n \"title\": \"Standard Greeting\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"99f148ee-c633-4663-bb67-6d87aeffe68b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"category\": \"Greetings\",\n \"content\": \"Hello! Thank you for contacting us. How can I help you today?\",\n \"is_shared\": true,\n \"shortcut\": \"greeting\",\n \"title\": \"Standard Greeting\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"is_shared\": true,\n \"updated_at\": \"string\",\n \"shortcut\": \"string\",\n \"category\": \"string\",\n \"created_by_user_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c8777c3-94d8-4531-acd3-591c9fc5809c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","canned-responses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"category\": \"Greetings\",\n \"content\": \"Hello! Thank you for contacting us. How can I help you today?\",\n \"is_shared\": true,\n \"shortcut\": \"greeting\",\n \"title\": \"Standard Greeting\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1fd4ea37-b8e1-4afc-aadb-ff5a7d88be0a","name":"List Categories","request":{"name":"List Categories","description":{"content":"Get unique categories for canned responses.\n\nReturns all categories from responses visible to the current user.\n\n**Required Scopes:** `canned_responses:read`","type":"text/plain"},"url":{"path":["api","v1","canned-responses","categories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1ac4c8a0-4eea-4a34-ae7b-b51ea93887e0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses","categories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"categories\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a068aa1d-dbf2-44b2-8a05-437330d37195","name":"Get By Shortcut","request":{"name":"Get By Shortcut","description":{"content":"Get a canned response by its shortcut.\n\nUsed for slash command lookups (e.g., /greeting). The shortcut is\ncase-insensitive and the leading slash is optional.\n\n**Required Scopes:** `canned_responses:read`","type":"text/plain"},"url":{"path":["api","v1","canned-responses","by-shortcut",":shortcut"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"shortcut","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a1382e1b-a80d-4760-bb79-0d8de4c077a8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses","by-shortcut",":shortcut"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"shortcut","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"is_shared\": true,\n \"updated_at\": \"string\",\n \"shortcut\": \"string\",\n \"category\": \"string\",\n \"created_by_user_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"675eb171-d342-45c4-aca8-66ff46069a64","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","canned-responses","by-shortcut",":shortcut"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"shortcut","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"606a2d3d-c931-4ec8-9726-2ddf8bb9ba49","name":"Get Canned Response","request":{"name":"Get Canned Response","description":{"content":"Get a specific canned response by ID.\n\n**Required Scopes:** `canned_responses:read`","type":"text/plain"},"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4c1f312b-65d2-4fdb-bb49-17ac6929446a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"is_shared\": true,\n \"updated_at\": \"string\",\n \"shortcut\": \"string\",\n \"category\": \"string\",\n \"created_by_user_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6ea1465f-ddd1-4be3-a517-72773fb1131b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1cd07095-c289-4c20-b040-828244cc4df0","name":"Update Canned Response","request":{"name":"Update Canned Response","description":{"content":"Update a canned response.\n\nUsers can only update their own responses. Users with `canned_responses:settings`\nscope can update any response.\n\n**Required Scopes:** `canned_responses:update`","type":"text/plain"},"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"content\": \"Hi there! Thanks for reaching out. How may I assist you?\",\n \"title\": \"Updated Greeting\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1957e5bb-488c-4da6-a1d7-fcec0ee5ee87","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"content\": \"Hi there! Thanks for reaching out. How may I assist you?\",\n \"title\": \"Updated Greeting\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"is_shared\": true,\n \"updated_at\": \"string\",\n \"shortcut\": \"string\",\n \"category\": \"string\",\n \"created_by_user_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"77ec937d-c0ad-453b-9340-c9aeacd91354","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"content\": \"Hi there! Thanks for reaching out. How may I assist you?\",\n \"title\": \"Updated Greeting\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c262c4d0-bff8-404f-8d49-19fbb8a008c8","name":"Delete Canned Response","request":{"name":"Delete Canned Response","description":{"content":"Delete a canned response.\n\nUsers can only delete their own responses. Users with `canned_responses:settings`\nscope can delete any response.\n\n**Required Scopes:** `canned_responses:delete`","type":"text/plain"},"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"e213531c-73a4-4550-9351-a04b5c80028d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Resource deleted successfully\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"55cbea9a-4c57-45d1-86f8-4cd48a2dec0e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","canned-responses",":canned_response_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"canned_response_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"069acd71-efb1-4c4f-b3cd-e95a44b729a0","name":"Channel Connect","description":{"content":"Connect new messaging channels (WhatsApp, Telegram, Instagram, etc.) via guided setup wizards with token-based authentication.","type":"text/plain"},"item":[{"id":"6a6c8fdc-60d0-4198-bd50-a8e39f7f325c","name":"Create Token","request":{"name":"Create Token","description":{"content":"Create a new channel connect token.\n\n**Required Scopes:** `channels:create`\n\nGenerates a secure, time-limited token that can be shared with partners\nor clients to allow them to connect messaging channels without full\nplatform access.\n\nIMPORTANT: The raw token is returned ONLY ONCE. Save it securely.\n\n**Example:**\n```json\n{\n \"name\": \"Acme Corp Setup\",\n \"allowed_channel_types\": [\"telegram\", \"whatsapp\"],\n \"expires_in_hours\": 48,\n \"max_uses\": 5,\n \"partner_name\": \"Acme Corporation\"\n}\n```","type":"text/plain"},"url":{"path":["api","v1","channel-connect-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"allowed_channel_types\": [\n \"string\"\n ],\n \"name\": \"string\",\n \"expires_in_hours\": 24,\n \"max_uses\": 10,\n \"use_window_minutes\": 30,\n \"allowed_channel_modes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"partner_name\": \"string\",\n \"partner_redirect_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fa7ba079-e93d-4813-b939-5d019eff333e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"allowed_channel_types\": [\n \"string\"\n ],\n \"name\": \"string\",\n \"expires_in_hours\": 24,\n \"max_uses\": 10,\n \"use_window_minutes\": 30,\n \"allowed_channel_modes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"partner_name\": \"string\",\n \"partner_redirect_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"token_prefix\": \"string\",\n \"connect_url\": \"string\",\n \"max_uses\": 7652,\n \"current_uses\": 8576,\n \"use_window_minutes\": 3270,\n \"expires_at\": \"string\",\n \"is_revoked\": true,\n \"is_locked\": false,\n \"is_valid\": true,\n \"remaining_uses\": 4942,\n \"created_at\": \"string\",\n \"token\": \"string\",\n \"name\": \"string\",\n \"allowed_channel_types\": [\n \"string\",\n \"string\"\n ],\n \"allowed_channel_modes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"partner_name\": \"string\",\n \"partner_redirect_url\": \"string\",\n \"first_used_at\": \"string\",\n \"revoked_at\": \"string\",\n \"created_by_user_id\": \"string\",\n \"warning\": \"Save this token now - it will not be shown again\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c63bbc7-0d53-4386-88ba-f795b35d2f67","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"allowed_channel_types\": [\n \"string\"\n ],\n \"name\": \"string\",\n \"expires_in_hours\": 24,\n \"max_uses\": 10,\n \"use_window_minutes\": 30,\n \"allowed_channel_modes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"partner_name\": \"string\",\n \"partner_redirect_url\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"44d7ca4a-6ff7-41b0-8af9-d10f80b262ec","name":"List Tokens","request":{"name":"List Tokens","description":{"content":"List channel connect tokens for this tenant.\n\n**Required Scopes:** `channels:read`\n\nBy default, only shows active (non-expired, non-revoked) tokens.\nUse query parameters to include inactive tokens.","type":"text/plain"},"url":{"path":["api","v1","channel-connect-tokens"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"include_expired","value":"false","description":"Include expired tokens"},{"disabled":false,"key":"include_revoked","value":"false","description":"Include revoked tokens"},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"6fc04d48-a8bc-45d5-abc0-fa9d64115d44","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens"],"host":["{{baseUrl}}"],"query":[{"key":"include_expired","value":"false"},{"key":"include_revoked","value":"false"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cfd54b2b-e0ff-4bff-b0f7-95471d68fbfe","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens"],"host":["{{baseUrl}}"],"query":[{"key":"include_expired","value":"false"},{"key":"include_revoked","value":"false"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ebd67843-f9a7-496c-baf8-1680e3f1bc39","name":"Delegate Connect","request":{"name":"Delegate Connect","description":{"content":"Hand a channel connect over to a colleague by email.\n\n**Required Scopes:** `channels:create`\n\nCreates a short-lived connect token scoped to the given channel types and\nmails the link to `email`. Intended for the channel setup wizard, where the\nperson doing the setup often lacks the third-party platform access the\nconnect needs (typically: they are not an admin of the Meta Business\nportfolio that owns the WhatsApp number or the Facebook Page).\n\nThe recipient needs no SendSeven account — the link is the credential — so it\nis deliberately restrictive compared to a partner token: two uses (one real\nattempt plus one retry), a 60-minute window after first use, and a single\nplatform.\n\nThe token is created BEFORE the email is attempted, and `connect_url` is\nalways returned. A failed send therefore degrades to \"copy the link and send\nit yourself\" rather than losing the token.","type":"text/plain"},"url":{"path":["api","v1","channel-connect-tokens","delegate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_types\": [\n \"whatsapp\"\n ],\n \"email\": \"it@example.com\",\n \"expires_in_hours\": 48,\n \"note\": \"You're the admin on our Meta Business account - could you connect this?\",\n \"recipient_name\": \"Sam\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6b51a978-41a1-4578-8341-f9b4c44aa456","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens","delegate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_types\": [\n \"whatsapp\"\n ],\n \"email\": \"it@example.com\",\n \"expires_in_hours\": 48,\n \"note\": \"You're the admin on our Meta Business account - could you connect this?\",\n \"recipient_name\": \"Sam\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token_id\": \"string\",\n \"connect_url\": \"string\",\n \"expires_at\": \"string\",\n \"email_sent\": false,\n \"sent_to\": \"string\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"37d8e8c7-c6f7-4629-987b-6a70b9ff7aab","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens","delegate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_types\": [\n \"whatsapp\"\n ],\n \"email\": \"it@example.com\",\n \"expires_in_hours\": 48,\n \"note\": \"You're the admin on our Meta Business account - could you connect this?\",\n \"recipient_name\": \"Sam\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9def7079-9406-44f2-a70d-c8e0a085f4ec","name":"Get Token","request":{"name":"Get Token","description":{"content":"Get details of a specific channel connect token.\n\n**Required Scopes:** `channels:read`\n\nNote: The raw token value is NOT included - it was only shown at creation.","type":"text/plain"},"url":{"path":["api","v1","channel-connect-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"479674f0-430b-494d-b8ca-452ba3da2332","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"token_prefix\": \"string\",\n \"max_uses\": 7134,\n \"current_uses\": 4725,\n \"use_window_minutes\": 6501,\n \"expires_at\": \"string\",\n \"is_revoked\": false,\n \"is_locked\": false,\n \"is_valid\": false,\n \"remaining_uses\": 4133,\n \"created_at\": \"string\",\n \"name\": \"string\",\n \"allowed_channel_types\": [\n \"string\",\n \"string\"\n ],\n \"allowed_channel_modes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"partner_name\": \"string\",\n \"partner_redirect_url\": \"string\",\n \"connect_url\": \"string\",\n \"first_used_at\": \"string\",\n \"revoked_at\": \"string\",\n \"created_by_user_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b3751602-196c-46dc-9391-518c98b81d87","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c0656ae2-8579-44fa-934e-83acbe237622","name":"Revoke Token","request":{"name":"Revoke Token","description":{"content":"Revoke a channel connect token.\n\n**Required Scopes:** `channels:delete`\n\nRevoking a token immediately prevents any further use.\nThis action cannot be undone - create a new token if needed.\n\nOptionally provide a reason for audit purposes.","type":"text/plain"},"url":{"path":["api","v1","channel-connect-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"28dd8c06-b4c9-478b-9163-002ca0ccfbd1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a9c39da3-a15a-4ca3-8fd3-80aee85e6e5a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens",":token_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"reason\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ec84a28f-768f-4675-8492-45e0ef402e9a","name":"Get Token Audit Logs","request":{"name":"Get Token Audit Logs","description":{"content":"Get audit logs for a specific channel connect token.\n\n**Required Scopes:** `channels:read`\n\nReturns all events related to this token including:\n- Token creation\n- Public page views\n- Connection attempts (success/failure)\n- Revocation","type":"text/plain"},"url":{"path":["api","v1","channel-connect-tokens",":token_id","audit-logs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"99f9f3f5-36da-4608-ae8f-dedaeea1cad6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens",":token_id","audit-logs"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"455b965d-a694-440d-a4af-6e52f30852ec","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channel-connect-tokens",":token_id","audit-logs"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"token_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"feb952ac-5949-451a-a827-fb4cd429ab6a","name":"Channels","description":{"content":"Manage connected messaging channels (WhatsApp, Telegram, Messenger, Instagram, SMS, Email). View capabilities, profiles, and configuration.","type":"text/plain"},"item":[{"id":"5147a6da-7a9d-4af8-ace7-e0ea48553356","name":"Check Rcs Capabilities","request":{"name":"Check Rcs Capabilities","description":{"content":"Check whether one number can receive RCS from this agent.\n\n**Required Scopes:** `channels:read`\n\nAlso requires the tenant's `rcs_enabled` feature flag (403 otherwise).\n\nReturns **200 with `reachable: false`** for every kind of unreachable —\nthis is an answer, not an error. Google answers 404 whether the device has\nno RCS, has RCS switched off, sits on a carrier the agent is not launched\non, or belongs to a tester who has not accepted the invite, and it cannot\ntell those apart, so neither can we.\n\nSide effect: a reachable probe promotes a `pending` tester on this channel\nto `accepted` and stamps `accepted_at`. It is the only acceptance signal\nGoogle provides.","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","rcs","capabilities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"msisdn","value":"string","description":"(Required) Number to probe"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) RCS channel id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4fc77f1d-81df-44db-9941-80f774ac6243","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","rcs","capabilities"],"host":["{{baseUrl}}"],"query":[{"key":"msisdn","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) RCS channel id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"msisdn\": \"string\",\n \"reachable\": false,\n \"checked_at\": \"string\",\n \"features\": [\n \"string\",\n \"string\"\n ],\n \"carrier\": \"string\",\n \"cached\": false,\n \"reason\": \"string\",\n \"tester_status\": \"accepted\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b49d57b7-34db-4554-9423-e64a7bb78de4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","rcs","capabilities"],"host":["{{baseUrl}}"],"query":[{"key":"msisdn","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) RCS channel id"}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cb2ff7f4-35a6-4be8-8ce2-3d372020afbd","name":"Get Channel Health","request":{"name":"Get Channel Health","description":{"content":"Get health status of all channel integrations.\n\nReturns the connection status of all active channel integrations,\nhighlighting any that have errors that need attention.\n\n**Required Scopes:** `channels:read`\n\nCurrently supports:\n- Email integrations (Gmail, SMTP/IMAP, etc.)\n- Messaging channels (Messenger / Instagram) whose access token was\n invalidated (Graph API code=190) and need reconnecting. These appear\n with `channel_type` = the messaging type (\"messenger\", \"instagram\", ...),\n `connection_status` = \"disconnected\", `last_error` = the\n disconnection_reason (\"token_invalidated\"), and `last_error_at` = when\n the channel was disconnected.\n\nFuture support planned for:\n- WhatsApp Business API connections\n- Telegram bot connections","type":"text/plain"},"url":{"path":["api","v1","channels","health"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"2ac72d7b-a24f-42eb-bd93-552f567a7832","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels","health"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"has_errors\": true,\n \"error_count\": 7604,\n \"integrations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ab505e67-9d94-437b-a835-c29419604e47","name":"Get Channel Types","request":{"name":"Get Channel Types","description":{"content":"Get available channel types.\n\nReturns a list of available (implemented) channel types,\ncoming soon channel types, and detailed info for all types.\n\nThis endpoint is public (no auth required) as it's used during\nchannel setup and onboarding flows.","type":"text/plain"},"url":{"path":["api","v1","channels","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"f622ded5-b5ed-4ffe-9090-aa21a95c7c41","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"available\": [\n \"string\",\n \"string\"\n ],\n \"coming_soon\": [\n \"string\",\n \"string\"\n ],\n \"all_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"af9f9b2c-0795-48b1-967d-34e2ec6faa65","name":"Create Channel","request":{"name":"Create Channel","description":{"content":"Connect a new messaging channel\n\n**Required Scopes:** `channels:create`\n\nRCS channels cannot be created here: SendSeven sets up and manages RCS\nagents (403 `rcs_managed_by_sendseven`).","type":"text/plain"},"url":{"path":["api","v1","channels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_type\": \"whatsapp\",\n \"config\": {\n \"phone_number_id\": \"123456789012345\",\n \"waba_id\": \"987654321098765\"\n },\n \"identifier\": \"491521558086\",\n \"name\": \"Main WhatsApp Business\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d075d8ed-2dad-4b54-8ad5-6d8b398ae66b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_type\": \"whatsapp\",\n \"config\": {\n \"phone_number_id\": \"123456789012345\",\n \"waba_id\": \"987654321098765\"\n },\n \"identifier\": \"491521558086\",\n \"name\": \"Main WhatsApp Business\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_type\": \"email\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"is_active\": true,\n \"created_at\": \"1989-06-23T15:02:47.600Z\",\n \"phone_number_formatted\": \"string\",\n \"is_verified\": false,\n \"is_coexistence\": false,\n \"activation_status\": \"string\",\n \"setup_pending_reason\": \"string\",\n \"avatar_url\": \"string\",\n \"rcs_agent_id\": \"string\",\n \"rcs_partner_id\": \"string\",\n \"rcs_launch_state\": {\n \"key_0\": \"string\"\n },\n \"rcs_message_traffic_type\": \"string\",\n \"rcs_pricing_mode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d25663c7-a5a4-4299-acbf-a360f11dd9e5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_type\": \"whatsapp\",\n \"config\": {\n \"phone_number_id\": \"123456789012345\",\n \"waba_id\": \"987654321098765\"\n },\n \"identifier\": \"491521558086\",\n \"name\": \"Main WhatsApp Business\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f4f59dae-d20d-4817-83fa-8ff3d9fb660e","name":"List Channels","request":{"name":"List Channels","description":{"content":"List all active (non-archived) channels for the tenant.\n\nAny authenticated team member can list channels (used for app initialization).\n\nSecurity model (inverted May 2026):\n Non-admin/non-owner callers ALWAYS see only the channels reachable\n through their accessible Custom Inboxes -- regardless of the\n ``for_compose`` query param. Previously this filter was opt-in via\n ``for_compose=true``, which meant a restricted user could drop the\n param and see every channel in the tenant (UX leak / info disclosure\n -- they still couldn't send, but channel names appeared in any\n listing/picker). The filter is now mandatory for non-admins.\n\n ``for_compose`` is still accepted (and ignored for the security path)\n for API back-compat. Admins/owners always see every channel.\n\n If ``accessible_channel_ids_for_user`` returns ``None`` (zero-inbox\n tenant fallback for the Custom Inboxes feature), no extra filter is\n applied -- preserving pre-feature behaviour for tenants that have\n never configured inboxes.\n\n**🔐 Required Scopes:** `channels:read`\n","type":"text/plain"},"url":{"path":["api","v1","channels"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"for_compose","value":"false"},{"disabled":false,"key":"channel_type","value":"string","description":"Optional: filter results to a single channel_type (e.g. 'whatsapp')"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"977e0363-1087-433a-ab3f-1cc1d989b8a6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels"],"host":["{{baseUrl}}"],"query":[{"key":"for_compose","value":"false"},{"key":"channel_type","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"channel_type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"phone_number_formatted\": {\n \"value\": \"\"\n },\n \"is_verified\": {\n \"value\": \"\"\n },\n \"is_coexistence\": {\n \"value\": \"\"\n },\n \"activation_status\": {\n \"value\": \"\"\n },\n \"setup_pending_reason\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"rcs_agent_id\": {\n \"value\": \"\"\n },\n \"rcs_partner_id\": {\n \"value\": \"\"\n },\n \"rcs_launch_state\": {\n \"value\": \"\"\n },\n \"rcs_message_traffic_type\": {\n \"value\": \"\"\n },\n \"rcs_pricing_mode\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"channel_type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"phone_number_formatted\": {\n \"value\": \"\"\n },\n \"is_verified\": {\n \"value\": \"\"\n },\n \"is_coexistence\": {\n \"value\": \"\"\n },\n \"activation_status\": {\n \"value\": \"\"\n },\n \"setup_pending_reason\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"rcs_agent_id\": {\n \"value\": \"\"\n },\n \"rcs_partner_id\": {\n \"value\": \"\"\n },\n \"rcs_launch_state\": {\n \"value\": \"\"\n },\n \"rcs_message_traffic_type\": {\n \"value\": \"\"\n },\n \"rcs_pricing_mode\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"0cb03c3c-9acd-456c-9a98-302f04aa7c40","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels"],"host":["{{baseUrl}}"],"query":[{"key":"for_compose","value":"false"},{"key":"channel_type","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2e5a7acc-544b-4df1-9448-5be6816bcd5b","name":"Get Comment Capabilities","request":{"name":"Get Comment Capabilities","description":{"content":"Can these channels receive comments? (\"Comments -> Private Reply\" beta)\n\n**Required Scopes:** `channels:read`\n\nReports, for every non-archived Instagram and Facebook Messenger channel,\nwhether comment webhooks would actually arrive today — so the UI can show a\n\"reconnect to enable comments\" prompt instead of offering a feature that\nwould silently never fire.\n\n- **Instagram** needs the `instagram_business_manage_comments` permission,\n which is fixed at connect time and can only be added by reconnecting.\n- **Facebook Messenger** needs the Page subscribed to the `feed` webhook\n field. This is read LIVE from Facebook on every call, because the\n subscription can change without any change to the channel.\n\n**Fail-closed:** `can_receive_comments` is `true` only when positively\nverified. A channel connected before we recorded granted permissions\nreports `false` / `scope_granted_unknown`, never an assumed `true`.\n\n`beta_enabled` reports the tenant's feature-flag enrolment separately, so\n\"not in the beta\" and \"in the beta but needs a reconnect\" are\ndistinguishable. Read-only — nothing is subscribed or changed.","type":"text/plain"},"url":{"path":["api","v1","channels","comment-capabilities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"db9f31c9-1a3f-4b27-8ad3-93f28f758783","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels","comment-capabilities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"beta_enabled\": false,\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dbcc8701-7683-4d20-b02f-1379523451d0","name":"List read-receipt and typing-indicator support per channel type","request":{"name":"List read-receipt and typing-indicator support per channel type","description":{"content":"Which channel types support read receipts and typing indicators.\n\nReturns one item for **every** channel type (unsupported ones report\n`false`), so you can decide before calling\n`POST /messages/{message_id}/read` or\n`POST /conversations/{conversation_id}/typing`.\n\n- `read`: the contact can be shown that their message was read.\n- `typing`: the contact can be shown a typing indicator.\n- `typing_off`: the indicator can be cleared explicitly (otherwise\n `state: \"off\"` is a no-op and the indicator ends on its own).\n- `typing_ttl_seconds`: how long one typing call is shown; `null` means\n until cleared or until you reply.\n- `typing_requires_message`: the platform ties typing to a received\n message (the latest inbound message is used when you pass none).\n\nFor a single connected channel, the same block is returned as\n`sender_actions` on `GET /channels/{channel_id}/capabilities`.\n\n**Required Scopes:** `channels:read`","type":"text/plain"},"url":{"path":["api","v1","channels","sender-actions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"914507ec-8c5a-4134-970b-640f22925f1c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels","sender-actions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ba0b2bab-252f-49f2-8ec6-64b19da347cf","name":"Get Channel","request":{"name":"Get Channel","description":{"content":"Get a specific channel\n\n**Required Scopes:** `channels:read`","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"f804f5c7-06d5-4db4-92e8-27429956481d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_type\": \"email\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"is_active\": true,\n \"created_at\": \"1989-06-23T15:02:47.600Z\",\n \"phone_number_formatted\": \"string\",\n \"is_verified\": false,\n \"is_coexistence\": false,\n \"activation_status\": \"string\",\n \"setup_pending_reason\": \"string\",\n \"avatar_url\": \"string\",\n \"rcs_agent_id\": \"string\",\n \"rcs_partner_id\": \"string\",\n \"rcs_launch_state\": {\n \"key_0\": \"string\"\n },\n \"rcs_message_traffic_type\": \"string\",\n \"rcs_pricing_mode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"575adb73-1eb8-4a7e-bd39-b4ab6d256772","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e30be246-b071-488a-b312-320c2b3a1489","name":"Update Channel","request":{"name":"Update Channel","description":{"content":"Update a channel configuration\n\n**Required Scopes:** `channels:update`\n\nOn an RCS channel only `name` and `is_active` may change here; an\n`identifier` or `config` change answers 403 `rcs_managed_by_sendseven`\n(SendSeven manages RCS agents and their credentials).","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"name\": \"Updated WhatsApp Business\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2e8d7cc4-9dae-4dba-81a5-d8c4d084a59e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"name\": \"Updated WhatsApp Business\"\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 \"channel_type\": \"email\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"is_active\": true,\n \"created_at\": \"1989-06-23T15:02:47.600Z\",\n \"phone_number_formatted\": \"string\",\n \"is_verified\": false,\n \"is_coexistence\": false,\n \"activation_status\": \"string\",\n \"setup_pending_reason\": \"string\",\n \"avatar_url\": \"string\",\n \"rcs_agent_id\": \"string\",\n \"rcs_partner_id\": \"string\",\n \"rcs_launch_state\": {\n \"key_0\": \"string\"\n },\n \"rcs_message_traffic_type\": \"string\",\n \"rcs_pricing_mode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3dc85442-a0f8-4281-ab08-ed9ef5ce6872","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"name\": \"Updated WhatsApp Business\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fdf35c0c-a88f-4040-bdcb-7ec46d440b83","name":"Delete Channel","request":{"name":"Delete Channel","description":{"content":"Archive (soft-delete) a channel.\n\nThis preserves the channel record for billing history and audit purposes while:\n- Marking it as archived (hidden from normal listings)\n- Clearing sensitive credentials from config\n- Recording who archived it and when\n\nFor WhatsApp channels, the phone number is also deregistered from Meta.\nFor Messenger/Instagram channels, the Facebook Page is unsubscribed from\nour app so the asset can be cleanly re-connected later.\n\n**Required Scopes:** `channels:delete`\n\n**Returns:**\n- `success`: Boolean indicating if archive succeeded\n- `message`: Status message\n- `channel_id`: The archived channel's ID","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"98177dfb-d049-47e1-aab3-8862d52a83e6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"message\": \"string\",\n \"channel_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"26077973-02c0-4cdc-8da2-f392b1929087","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dfcdfea1-72a0-4dc3-b19e-e4eb9c18680e","name":"Get Channel Capabilities","request":{"name":"Get Channel Capabilities","description":{"content":"Get the feature capabilities matrix for a specific channel.\n\nReturns what message types and interactive elements are supported\nby the channel's messaging platform.\n\n**Required Scopes:** `channels:read`\n\n**Feature Categories:**\n- **Basic message types:** text, images, videos, audio, voice (PTT), documents, stickers\n- **Rich content:** location, contacts\n- **Engagement:** reactions\n- **Interactive elements:** interactive_buttons, interactive_lists, carousels, quick_replies\n- **Other:** templates (pre-approved message templates), proxy (proxy/passthrough support)\n\n**Response format:**\n- Boolean fields indicate simple support (true/false)\n- Object fields (e.g., interactive_buttons) include limits like max_buttons","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","capabilities"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"281d44ab-302c-44cd-98fd-3ce0c585d84d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","capabilities"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"channel_id\": \"a1b2c3d4-5678-9abc-def0-1234567890ab\",\n \"channel_name\": \"Main WhatsApp Business\",\n \"channel_type\": \"whatsapp\",\n \"features\": {\n \"audio\": true,\n \"carousels\": {\n \"max_cards\": 10,\n \"requires_template\": true,\n \"supported\": true\n },\n \"contacts\": true,\n \"documents\": true,\n \"images\": true,\n \"interactive_buttons\": {\n \"max_buttons\": 3,\n \"supported\": true\n },\n \"interactive_lists\": {\n \"max_rows_per_section\": 10,\n \"max_sections\": 10,\n \"supported\": true\n },\n \"location\": true,\n \"proxy\": true,\n \"quick_replies\": false,\n \"reactions\": true,\n \"stickers\": true,\n \"templates\": true,\n \"text\": true,\n \"videos\": true\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"68a1d3d7-010c-4e34-a1b1-d0abb31c3b62","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","capabilities"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5a315bef-8810-42e3-937f-9d9e638bcb24","name":"Get Channel Comment Capability","request":{"name":"Get Channel Comment Capability","description":{"content":"Can THIS channel receive comments? (\"Comments -> Private Reply\" beta)\n\n**Required Scopes:** `channels:read`\n\nSingle-channel form of `GET /channels/comment-capabilities` — same\nfail-closed contract and the same `reason` codes. A channel of a type that\ncan never do comments returns `comments_supported: false` with reason\n`channel_type_not_supported` rather than an error.\n\nRead-only: nothing is subscribed, changed or repaired.","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","comment-capability"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a68c088b-4ea3-4765-a0ad-6c227941a081","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","comment-capability"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"channel_id\": \"string\",\n \"channel_type\": \"string\",\n \"channel_name\": \"string\",\n \"comments_supported\": true,\n \"can_receive_comments\": false,\n \"reconnect_required\": true,\n \"resubscribe_required\": false,\n \"reason\": \"string\",\n \"checked_at\": \"1966-10-27T01:46:52.116Z\",\n \"identifier\": \"string\",\n \"detail\": \"string\",\n \"missing_scopes\": [\n \"string\",\n \"string\"\n ],\n \"granted_scopes_known\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2f496a12-6cd9-4d72-8bdf-496109501c6a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","comment-capability"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2cdc4c67-c297-4951-b78b-9c1f9516ea86","name":"Get Channel File Support","request":{"name":"Get Channel File Support","description":{"content":"Get the supported file formats and size limits for a specific channel.\n\nReturns which file types (extensions) and categories (image, video, audio, document)\nare supported by the channel, along with maximum file size per category.\n\nUseful for client-side validation before uploading/sending attachments.\n\n**Required Scopes:** `channels:read`","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","file-support"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"d7920e85-02df-4060-9a5f-83c36e4a7d7c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","file-support"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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":"58029c60-8edb-4711-b157-ee2dbe4b00b6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","file-support"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a343d79b-e972-4589-8e51-5f1577c5bc95","name":"Refresh Channel Webhook","request":{"name":"Refresh Channel Webhook","description":{"content":"Re-register the webhook for a channel.\n\nThis is useful when:\n- Webhook URL needs to be updated\n- Webhook registration failed initially\n- You want to verify the webhook is correctly set\n\nWebhooks are always registered to point to production (api.sendseven.com)\nto ensure proper message delivery and staging forwarding.\n\n**Required Scopes:** `channels:update`\n\n**Supported channels:** Telegram (other channels have webhooks configured externally)","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","refresh-webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"9a86bcdb-0e57-4175-b5de-999e271937ef","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","refresh-webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"message\": \"string\",\n \"webhook_url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47ab9149-d675-4160-9150-b5043add96f2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","refresh-webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d04e44f5-5d56-418e-8de8-fec42856feab","name":"Get Channel Profile","request":{"name":"Get Channel Profile","description":{"content":"Fetch channel profile from platform API (WhatsApp or Telegram).\n\nThis endpoint fetches the current profile data directly from the\nmessaging platform's API. No data is stored locally.\n\n**Required Scopes:** `channels:read`\n\n**Supported Channels:**\n- **WhatsApp:** Returns business profile (about, address, description, email,\n profile picture, websites, vertical)\n- **Telegram:** Returns bot profile (name, username, description,\n short description, commands, permissions)\n\n**Response:**\n- `channel_id`: The channel's ID\n- `channel_type`: \"whatsapp\" or \"telegram\"\n- `channel_name`: The channel's display name\n- `whatsapp`: WhatsApp-specific profile data (if applicable)\n- `telegram`: Telegram-specific profile data (if applicable)","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"86cf36ca-4f65-4ea1-9d27-cfb8168783a9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"channel_id\": \"string\",\n \"channel_type\": \"string\",\n \"channel_name\": \"string\",\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21b56b3d-87ec-4ad5-9cab-2da12216ca01","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"da6bafac-517b-4cae-9cc9-14d93223c73b","name":"Update Channel Profile","request":{"name":"Update Channel Profile","description":{"content":"Update channel profile on platform API.\n\nThis endpoint updates the profile data directly on the messaging\nplatform's API. Only provided fields are updated.\n\n**Required Scopes:** `channels:update`\n\n**Supported Channels:**\n\n**WhatsApp Profile Fields:**\n- `about`: Short description (max 139 chars, shown in profile)\n- `address`: Business address (max 256 chars)\n- `description`: Full description (max 512 chars)\n- `email`: Business contact email\n- `websites`: List of website URLs (max 2)\n- `vertical`: Business category (UNDEFINED, OTHER, AUTO, BEAUTY, APPAREL,\n EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH,\n NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, RESTAURANT, NOT_A_BIZ)\n\n**Telegram Profile Fields:**\n- `name`: Bot display name (max 64 chars)\n- `description`: Full description shown on profile page (max 512 chars)\n- `short_description`: Short description shown in chat list (max 120 chars)\n- `commands`: List of bot commands, each with `command` and `description`\n\n**Returns:**\n- `success`: Boolean indicating if update succeeded\n- `message`: Success or error message\n- `updated_fields`: List of fields that were updated\n- `errors`: List of errors if some fields failed (partial success)","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"about\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\",\n \"websites\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"vertical\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"name\": \"string\",\n \"short_description\": \"string\",\n \"commands\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0d673f2a-1b54-4320-9b47-d857061d8c8a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"about\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\",\n \"websites\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"vertical\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"name\": \"string\",\n \"short_description\": \"string\",\n \"commands\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"15c25a75-c48a-4db9-9d43-7d47661a7389","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"about\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\",\n \"websites\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"vertical\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"name\": \"string\",\n \"short_description\": \"string\",\n \"commands\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"da4efbe9-4607-4fd6-b89b-4acfaa0849c7","name":"Upload Channel Profile Photo","request":{"name":"Upload Channel Profile Photo","description":{"content":"Upload a profile photo for a WhatsApp channel.\n\nThis endpoint uploads a new profile picture directly to the WhatsApp\nBusiness Account via Meta's API.\n\n**Required Scopes:** `channels:update`\n\n**Supported Channels:** WhatsApp only (Telegram uses @BotFather for profile photos)\n\n**Image Requirements:**\n- Format: JPEG or PNG\n- Aspect ratio: Square (1:1) recommended\n- Size: 192x192 to 640x640 pixels\n- Maximum file size: 5MB\n\n**Request:**\n- Content-Type: multipart/form-data\n- Field name: `file`\n\n**Returns:**\n- `success`: Boolean indicating if upload succeeded\n- `message`: Success or error message\n- `profile_picture_url`: New profile picture URL if successful","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","profile","photo"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) "}]}},"response":[{"id":"31dfccaf-2910-4111-84a5-3b28e41b481b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","profile","photo"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"message\": \"string\",\n \"profile_picture_url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"708474ae-baed-4ee8-adf8-ff8095f95c9b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","profile","photo"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"40270735-aba7-4a06-8d33-e63d5296892c","name":"Get Whatsapp Username","request":{"name":"Get Whatsapp Username","description":{"content":"Get the WhatsApp business username claimed by this channel's phone number.\n\nA username lets customers reach the business through `wa.me/`\nwithout knowing its phone number. It belongs to the PHONE NUMBER, so each\nWhatsApp channel has at most one.\n\n**Required Scopes:** `channels:read`\n\n**Response:**\n- `username`: the current handle, or `null` when none is claimed\n- `status`: `approved` (live) or `reserved` (accepted, still propagating)\n- `wa_me_url`: short link to share with customers\n- `suggestions`: available handles suggested by WhatsApp (best-effort — an\n empty list simply means WhatsApp returned none)","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7dd5c8b6-c90f-4ba8-b2dc-c3fae5c50019","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"channel_id\": \"string\",\n \"username\": \"string\",\n \"status\": \"string\",\n \"wa_me_url\": \"string\",\n \"suggestions\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5270ed15-1899-4b0d-ac36-2f7251e8429e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bd9c9d8b-8ef4-40e6-902f-1b7f7adc60b6","name":"Set Whatsapp Username","request":{"name":"Set Whatsapp Username","description":{"content":"Claim or change the WhatsApp business username for this channel's number.\n\n**Required Scopes:** `channels:write`\n\n**Format:** 3-35 characters of lowercase letters, numbers, periods and\nunderscores; at least one letter; no leading/trailing period, no `..`, no\n`www` prefix, no domain-like suffix. Periods and underscores are distinct.\n\n**Transfers:** if the handle is already held by another phone number in the\nsame Meta business portfolio, WhatsApp answers with error `147005`. Repeat\nthe request with `force_transfer: true` to move it to this number.\n\n**Status:** `approved` means the username is live immediately; `reserved`\nmeans WhatsApp accepted it and will confirm through the\n`business_username_updates` webhook shortly.","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"username\": \"string\",\n \"force_transfer\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"26e46479-9cf8-4fdd-a8f2-47f942544bef","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"username\": \"string\",\n \"force_transfer\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"channel_id\": \"string\",\n \"message\": \"string\",\n \"username\": \"string\",\n \"status\": \"string\",\n \"wa_me_url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f80da2c-e4a8-41f3-ba71-61cfff8b3b14","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"username\": \"string\",\n \"force_transfer\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d89a3599-6f23-4142-a391-61edc04a17fe","name":"Delete Whatsapp Username","request":{"name":"Delete Whatsapp Username","description":{"content":"Release the WhatsApp business username held by this channel's number.\n\n**Required Scopes:** `channels:write`\n\nWhatsApp does not return a released handle to the pool immediately, so\nsomeone else may not be able to claim it right away — and neither can you.\nTreat this as destructive.","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"c49839a3-33ff-42f6-a7a8-58948d711649","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"channel_id\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ace2671-59f5-42d4-a5a3-8407a13d46a2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","whatsapp","username"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2aba11d8-4f45-4c12-b3a9-634946a16bce","name":"List Instagram Media","request":{"name":"List Instagram Media","description":{"content":"List media (posts, reels, carousels) for an Instagram channel.\n\nUsed by the ``comment_received`` flow-trigger config UI to let the user\npick specific posts to monitor for comments.\n\n**Required Scopes:** ``channels:read``\n\n**Pagination:**\n- Cursor-based via Meta's ``after`` parameter.\n- ``limit`` defaults to 25, max 50 (Meta enforces an upper bound around this).\n- Response includes ``pagination.next_cursor`` (null on the last page).\n\n**Errors:**\n- 404 — channel not found in this tenant.\n- 400 — channel exists but is not Instagram, or config is missing required fields.\n- 401 — Meta access token is expired / revoked (``error_code: \"token_expired\"``).\n- 429 — Meta rate limit exceeded.\n- 502 — Meta returned an unexpected error (full payload logged server-side, not exposed).","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","instagram","media"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"after","value":"string","description":"Meta Graph API pagination cursor (opaque)."},{"disabled":false,"key":"limit","value":"25","description":"Number of items per page (1-50)."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"c8fba616-b93a-485e-a185-d02e36573ef0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","instagram","media"],"host":["{{baseUrl}}"],"query":[{"key":"after","value":"string"},{"key":"limit","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"next_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c35129ad-b571-4e96-b32e-6b34b1555923","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","instagram","media"],"host":["{{baseUrl}}"],"query":[{"key":"after","value":"string"},{"key":"limit","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"201aa261-b770-44d3-827d-38ebb5e3f020","name":"List Facebook Page Posts","request":{"name":"List Facebook Page Posts","description":{"content":"List published posts for a Facebook Page (Messenger) channel.\n\nUsed by the comment auto-reply rules UI and the ``comment_received``\nflow-trigger config to let the user pick specific posts to watch.\n\nReads ``/{page_id}/published_posts`` rather than ``/feed``: ``feed``\nalso returns posts made BY OTHERS on the Page and scheduled/unpublished\ndrafts, none of which a customer can meaningfully pick as \"a post of mine\nto auto-reply on\".\n\n**Required Scopes:** ``channels:read``\n\n**Pagination:**\n- Cursor-based via Meta's ``after`` parameter.\n- ``limit`` defaults to 25, max 50.\n- Response includes ``pagination.next_cursor`` (null on the last page).\n\n**Errors:**\n- 404 — channel not found in this tenant.\n- 400 — channel exists but is not a Messenger channel, or config is missing required fields.\n- 401 — Meta access token is expired / revoked (``error_code: \"token_expired\"``).\n- 429 — Meta rate limit exceeded.\n- 502 — Meta returned an unexpected error (full payload logged server-side, not exposed).","type":"text/plain"},"url":{"path":["api","v1","channels",":channel_id","facebook","posts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"after","value":"string","description":"Meta Graph API pagination cursor (opaque)."},{"disabled":false,"key":"limit","value":"25","description":"Number of items per page (1-50)."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"193ebc03-54e9-45cf-9df8-0f815915f79a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","facebook","posts"],"host":["{{baseUrl}}"],"query":[{"key":"after","value":"string"},{"key":"limit","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"next_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb66495c-2921-4ecf-9f65-a1807da4f8c2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","channels",":channel_id","facebook","posts"],"host":["{{baseUrl}}"],"query":[{"key":"after","value":"string"},{"key":"limit","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"channel_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c89b0e38-47d5-45d2-bd16-cde7ab40dcdf","name":"Comment Rules","description":{"content":"Configure automated rules that reply to or act on incoming social comments.","type":"text/plain"},"item":[{"id":"72955531-8f68-4d19-962f-b96b4bcab9b2","name":"List Social Comment Rules","request":{"name":"List Social Comment Rules","description":{"content":"List comment auto-reply rules, in evaluation order.\n\nRules are returned in the order they are EVALUATED (priority ascending —\nlower runs first), so the list reads top-to-bottom exactly as it behaves.\n\n**Required Scopes:** `flows:read`","type":"text/plain"},"url":{"path":["api","v1","social-comment-rules"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"channel_id","value":"string","description":"Filter by channel"},{"disabled":false,"key":"enabled","value":"true","description":"Filter by enabled state"},{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"20"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"6478f9ad-0f61-4866-bf9e-baade563e45d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","social-comment-rules"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"enabled","value":"true"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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":"6c943c19-e5d1-48ff-9593-8865b5ffa5dd","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","social-comment-rules"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"enabled","value":"true"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f24a0c9a-277c-45aa-81cd-5fbda5ae341a","name":"Create Social Comment Rule","request":{"name":"Create Social Comment Rule","description":{"content":"Create a comment auto-reply rule.\n\n**Required Scopes:** `flows:write`","type":"text/plain"},"url":{"path":["api","v1","social-comment-rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"channel_id\": \"string\",\n \"enabled\": true,\n \"priority\": 0,\n \"post_scope\": \"all_posts\",\n \"post_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"match_mode\": \"any_comment\",\n \"keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action\": \"send_private_reply\",\n \"reply_text\": \"string\",\n \"flow_id\": \"string\",\n \"post_message_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"reply_buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f51d1051-6796-4e34-abad-f0baa182f910","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","social-comment-rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"channel_id\": \"string\",\n \"enabled\": true,\n \"priority\": 0,\n \"post_scope\": \"all_posts\",\n \"post_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"match_mode\": \"any_comment\",\n \"keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action\": \"send_private_reply\",\n \"reply_text\": \"string\",\n \"flow_id\": \"string\",\n \"post_message_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"reply_buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce59ed0f-c959-49c2-8532-6e97b8055e39","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","social-comment-rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"channel_id\": \"string\",\n \"enabled\": true,\n \"priority\": 0,\n \"post_scope\": \"all_posts\",\n \"post_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"match_mode\": \"any_comment\",\n \"keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action\": \"send_private_reply\",\n \"reply_text\": \"string\",\n \"flow_id\": \"string\",\n \"post_message_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"reply_buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9f7fd016-bea2-4420-8687-57c46919f9b4","name":"Get Social Comment Rule","request":{"name":"Get Social Comment Rule","description":{"content":"Get one comment auto-reply rule.\n\n**Required Scopes:** `flows:read`","type":"text/plain"},"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"dc6155dd-9561-4378-8b45-7492d38c33b0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"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":"1d929523-2224-4bad-af57-3c01e09fbf34","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4cc3a21c-c7a6-4ec4-8200-f3e27bcabf0f","name":"Update Social Comment Rule","request":{"name":"Update Social Comment Rule","description":{"content":"Update a comment auto-reply rule.\n\nPartial: omitted fields are left untouched. ``channel_id`` cannot be\nchanged — moving a rule to another channel silently changes which posts it\ncan match, so that is a delete plus a create.\n\nThe MERGED rule is re-validated, not just the submitted fields: switching\n``action`` to ``start_flow`` without also sending a ``flow_id`` has to fail\neven though each field on its own looks fine.\n\n**Required Scopes:** `flows:write`","type":"text/plain"},"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"enabled\": true,\n \"priority\": 409,\n \"post_scope\": {\n \"value\": \"\"\n },\n \"post_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"match_mode\": {\n \"value\": \"\"\n },\n \"keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action\": {\n \"value\": \"\"\n },\n \"reply_text\": \"string\",\n \"flow_id\": \"string\",\n \"post_message_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"reply_buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d156bf1a-43d5-4fa3-b288-cbaae01f2719","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"enabled\": false,\n \"priority\": 336,\n \"post_scope\": {\n \"value\": \"\"\n },\n \"post_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"match_mode\": {\n \"value\": \"\"\n },\n \"keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action\": {\n \"value\": \"\"\n },\n \"reply_text\": \"string\",\n \"flow_id\": \"string\",\n \"post_message_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"reply_buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"01573cd3-295d-4903-9305-5851a8489799","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"enabled\": false,\n \"priority\": 336,\n \"post_scope\": {\n \"value\": \"\"\n },\n \"post_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"match_mode\": {\n \"value\": \"\"\n },\n \"keywords\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"action\": {\n \"value\": \"\"\n },\n \"reply_text\": \"string\",\n \"flow_id\": \"string\",\n \"post_message_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"reply_buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"33b21752-a742-49f7-8075-f80f8b9cac60","name":"Delete Social Comment Rule","request":{"name":"Delete Social Comment Rule","description":{"content":"Delete a comment auto-reply rule.\n\nA hard delete. Rules carry no history worth archiving — the comments they\nacted on keep their own ``auto_replied`` state and their reply messages\nindependently of the rule that produced them.\n\n**Required Scopes:** `flows:write`","type":"text/plain"},"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"e4c42808-1652-4fc0-9bc2-950c4b9e0b82","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"070bac31-eda5-4334-8f57-eed11e75636e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","social-comment-rules",":rule_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"rule_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"a14a2323-d165-40b9-b3ee-d48d03ad9b53","name":"Comments","description":{"content":"Manage inbound social comments (Facebook, Instagram) and send public or private replies.","type":"text/plain"},"item":[{"id":"4d0af4d9-ffa0-49ce-b28f-eeae5841bc3d","name":"Subscribe Facebook Messenger Page(s) to the comment webhook","request":{"name":"Subscribe Facebook Messenger Page(s) to the comment webhook","description":{"content":"Fix a **Facebook Messenger** Page that the capability probe reported as\n`resubscribe_required` — i.e. the connection is otherwise fine, the Page is just\nnot subscribed to the `feed` webhook field that delivers post comments.\n\nUnlike Instagram (which needs a real permission the customer can only add by\nreconnecting), no permission is missing here: the stored Page token already\ncarries everything Facebook private replies need. So instead of sending the\ncustomer to reconnect, we do it for them — this POSTs the Page's\n`subscribed_apps` with the complete Messenger field list **plus `feed`** (a full\nreplace, never a merge; a Page that also backs a legacy page-backed Instagram\nchannel keeps `comments` on the union).\n\nPass `channel_id` to fix one Messenger channel, or omit it to resubscribe every\nnon-archived Messenger channel in the workspace. Tenant-scoped and idempotent.\nAfter it returns, re-read `GET /channels/comment-capabilities` for the fresh\nverdict.\n\n**Required Scopes:** `channels:update`","type":"text/plain"},"url":{"path":["api","v1","comments","messenger","resubscribe"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"channel_id","value":"string","description":"Restrict to one Facebook Messenger channel. Omit to resubscribe every non-archived Messenger channel in the workspace."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"01014d38-1d2a-4db1-9d0c-6e9467515813","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","messenger","resubscribe"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"results\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f9c1a00-5ddc-420d-9be1-49a61ce3f4e5","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","messenger","resubscribe"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"}],"variable":[]},"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c249af58-9631-44da-8998-74e2df5cf03e","name":"A `channel_id` was given but no matching non-archived Facebook Messenger channel exists in this workspace (`error_code`: `channel_not_found`). Instagram channels are never valid here — they need a customer reconnect, not a resubscribe.","originalRequest":{"url":{"path":["api","v1","comments","messenger","resubscribe"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"}],"variable":[]},"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"cfda7428-b7b5-4450-ad75-b4f64b628483","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments","messenger","resubscribe"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e285ae32-434d-46c7-8af5-2874c4da4d3d","name":"Send a private reply to a comment","request":{"name":"Send a private reply to a comment","description":{"content":"Send a **private reply**: a direct message to the person who left a public\ncomment on your Instagram post or Facebook Page post.\n\nPass Meta's own comment id in the path — the value your `comment.received`\nwebhook delivers. The comment does not have to be stored in your workspace; if\nit is not, supply `channel_id` in the body.\n\n### What a private reply may contain\n\nThe two platforms differ, and this endpoint enforces the difference rather\nthan letting a field be silently dropped:\n\n| Content | Instagram | Facebook Messenger |\n|---|---|---|\n| `text` | yes | yes |\n| `buttons` | yes (up to 3, `url` or `postback`) | yes (up to 3, `url` or `postback`) |\n| `quick_replies` | yes (up to 13) | yes (up to 13) |\n| `image_url` | **no** — 400 | yes |\n\nButtons and quick replies are supported on **both** platforms — verified on\nlive accounts: they render for the recipient and taps arrive back as inbound\nmessages.\n\nImages on Instagram are not accepted at all. On either platform, content the\nprivate reply cannot carry belongs in a **follow-up** message: once the\nrecipient answers, the standard 24-hour messaging window opens and the normal\nsend API accepts buttons and media.\n\n### Buttons\n\nEach button is one of two kinds:\n\n* **URL button** — `{\"type\": \"url\", \"title\": \"Shop now\", \"url\": \"https://…\"}`.\n Opens the link. Absolute **https** only. Nothing comes back to you.\n* **Postback button** — `{\"type\": \"postback\", \"title\": \"Get the code\", …}`.\n Sends a value back to you when tapped, arriving as `meta.button_id` on the\n resulting inbound message. Either:\n * `\"action\": \"start_flow\", \"flow_id\": \"…\"` — the tap **starts that flow** for\n the person who tapped, or\n * `\"payload\": \"your-own-value\"` — an opaque value you match yourself.\n\nA `start_flow` button may target any published flow **except** one whose\ntrigger is \"Comment received\": that trigger is reserved for the first message,\nand this comment's single allowed private reply was already spent on the\nmessage carrying the button.\n\n### Rules Meta enforces\n\n* **One private reply per comment, ever.** A second attempt returns `409`.\n* **7-day window** from when the comment was created. After that, `410`.\n* **Not available on ad comments** (Facebook). This is invisible until you\n send, so it surfaces as `422`.\n\n### Billing\n\nA private reply is a real Instagram/Messenger direct message and is billed\nexactly like any other outbound message on that channel.\n\n**🔐 Required Scopes:** `messages:create`\n","type":"text/plain"},"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"30bcc50d-0306-4e4a-b833-8aefe56107bd","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"comment_id\": \"string\",\n \"channel_id\": \"string\",\n \"platform\": \"string\",\n \"status\": \"sent\",\n \"message_id\": \"string\",\n \"conversation_id\": \"string\",\n \"contact_id\": \"string\",\n \"external_id\": \"string\",\n \"recipient_id\": \"string\",\n \"social_comment_id\": \"string\",\n \"state\": \"string\",\n \"sent_at\": \"1983-05-14T13:04:01.692Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"44ea584c-adbc-4079-84cf-c16eaccf8f34","name":"The request is not valid for this platform — most commonly an image on an **Instagram** channel, which Meta does not document for private replies. `error_code` is `unsupported_content` or `channel_required`.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6ce076db-1627-487b-b339-e8c9c8a1c6b1","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a72b19b2-468a-400f-bbe4-c89593cc0272","name":"The channel does not exist, is inactive, or is not an Instagram / Facebook Messenger channel (`error_code`: `channel_not_found`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bab42f39-9bda-441c-926c-70856ae76784","name":"A private reply has **already** been sent for this comment. Meta allows exactly one per comment, forever — this is permanent, not retryable (`error_code`: `private_reply_already_sent`). Also returned when the commenter is a blocked contact (`detail.error`: `CONTACT_BLOCKED`); unblock the contact to reply privately.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7a7ce5e9-41ff-4598-bd88-39250754e321","name":"The **7-day** private-reply window measured from the comment's creation has closed. Permanent (`error_code`: `private_reply_window_expired`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Gone","code":410,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"72011419-f5ac-4ce9-a862-2f87e85a2385","name":"Two distinct causes, told apart by `error_code`:\n\n* `private_reply_not_eligible` — Meta refuses a private reply to this particular comment: it is on an **ad** (Facebook only), the comment or its post was deleted, or the author is another Page. Nothing in Meta's webhooks flags an ad comment, so this can only be discovered at send time.\n* `invalid_buttons` — one or more buttons are unusable. The body carries `errors`: a list of `{index, field, reason}` naming the offending button by position. Reasons include `must_be_absolute_https_url`, `too_long`, `unknown_flow` and `flow_trigger_not_startable_from_button`.\n\nBoth carry an `error_code`, which also distinguishes them from FastAPI's schema-validation 422.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4c09e74b-b1f9-4b90-8684-e49148b0b0ae","name":"Meta rejected or failed the send for another reason (`error_code`: `send_failed`). Safe to retry.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","private-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"37df4864-f4f3-4646-808b-d50f6f12d0f4","name":"Post a public reply under a comment","request":{"name":"Post a public reply under a comment","description":{"content":"Post a **public reply** visible under a comment on your Instagram post or\nFacebook Page post — the ordinary \"reply to this comment\" action.\n\nPass Meta's own comment id in the path. If the comment is not stored in your\nworkspace, supply `channel_id` in the body.\n\nUnlike a **private reply**, a public reply is comment-layer only: it does not\ncreate a conversation, a contact or a `messages` row, and it is **not billed**\nlike a direct message. It also does not consume the one-per-comment private-reply\nallowance — you can reply publicly and still send a private DM afterwards. There\nis no time window and no duplicate suppression (Meta permits several public\nreplies to one comment).\n\nText only in v1 — no buttons, quick replies or media.\n\n**Required Scopes:** `messages:create`","type":"text/plain"},"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"aad74a15-c0e0-44e1-894d-a41c0217d03c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"comment_id\": \"string\",\n \"channel_id\": \"string\",\n \"platform\": \"string\",\n \"status\": \"sent\",\n \"public_reply_id\": \"string\",\n \"social_comment_id\": \"string\",\n \"public_reply_text\": \"string\",\n \"public_replied_at\": \"1966-12-30T04:56:14.517Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4c7aff82-1763-4b0e-9d3d-9505851be11f","name":"`channel_id` is required because the comment is not stored in this workspace (`error_code`: `channel_required`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c64d24e8-d375-49fb-a599-d361d41d18dc","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"abedf52c-c6ac-4b99-8c9d-322dc526252e","name":"The channel does not exist, is inactive, or is not an Instagram / Facebook Messenger channel (`error_code`: `channel_not_found`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"58da80c0-76fb-44e8-913f-c8d382c3919c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f52db6c-fd2e-4dba-876b-3492d6a44422","name":"Meta rejected or failed the reply (`error_code`: `send_failed`). Safe to retry — public replies have no one-per-comment limit.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","public-reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"text\": \"string\",\n \"channel_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d203cfa8-cba6-438a-acb3-c073bfa02ee4","name":"Post a public reply and/or send a private DM in one call","request":{"name":"Post a public reply and/or send a private DM in one call","description":{"content":"Post a public reply **and/or** send a private DM to a comment in one call.\nSupply `public_text`, `private_text`, or both (at least one is required).\n\nThe private-DM fields (`buttons`, `quick_replies`, `image_url`) behave exactly\nas on `POST /{comment_id}/private-reply` and apply only to the DM.\n\n### Order and partial-failure contract\n\nThe public reply is posted **first**, then the private DM:\n\n* **Public reply fails** → `502`, and the private DM is *not* attempted\n (nothing was sent).\n* **Public reply succeeds, private DM fails** → `200` with\n `status: \"partial\"`: the public reply is already live and is returned in\n `public`, while `private` is `null` and `private_error` /\n `private_error_type` describe the DM failure. The public reply is never\n rolled back.\n* **Private-only request (no `public_text`)** → the private-reply errors map to\n their usual HTTP statuses (`409` already-sent, `410` window, `422`\n not-eligible / invalid buttons, …), exactly like the standalone endpoint.\n* **Everything sent** → `200` with `status: \"sent\"`.\n\nBilling: the private DM is billed like any outbound message; the public reply is\nnot billed.\n\n**Required Scopes:** `messages:create`","type":"text/plain"},"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3a10f844-4b24-4d1a-a948-552140fa64bd","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"public\": {\n \"value\": \"\"\n },\n \"private\": {\n \"value\": \"\"\n },\n \"private_error\": \"string\",\n \"private_error_type\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1e4aefa-355a-4521-af99-902abd8f684a","name":"`error_code` `channel_required` (comment not stored, no `channel_id`) or `unsupported_content` (e.g. an image on Instagram).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e1b25c43-1c5e-48ea-b329-7346129666b6","name":"The `social_comments_beta` feature is not enabled (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a35c27a4-5d9d-4ee4-94e3-1e6bdb2695a7","name":"Channel not found (`error_code`: `channel_not_found`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e7419ea9-6596-43a3-8ce1-716a4408a08c","name":"A private reply was already sent for this comment (`error_code`: `private_reply_already_sent`). Only raised for a **private-only** request — see the partial contract below.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8c0550cd-e491-447b-9833-7ce5ae79fc7d","name":"The 7-day private-reply window has closed (`error_code`: `private_reply_window_expired`). Private-only request only.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Gone","code":410,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0b51766c-0b18-4fb4-9a19-7b64e28abdeb","name":"`private_reply_not_eligible`, `invalid_buttons` or `invalid_quick_replies` on the private DM. Private-only request only, plus FastAPI schema-validation 422.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"07852fce-d269-4de9-add6-af98a986e535","name":"The **public** reply failed (`error_code`: `send_failed`); nothing was sent, safe to retry.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`) — exactly as delivered by the webhook."}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"public_text\": \"string\",\n \"private_text\": \"string\",\n \"channel_id\": \"string\",\n \"buttons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quick_replies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"image_url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2ed66dd2-1ba4-4ca7-8da2-c1530cd87657","name":"List posts that have comments","request":{"name":"List posts that have comments","description":{"content":"The left-hand column of the Comments view: your Instagram media and Facebook\nPage posts, newest published first, each with its comment count and — the number\nthat matters — how many of those comments are still **unanswered**.\n\nBoth counts are read from the post row itself rather than counted per request.\nThey are maintained as comments arrive and recomputed whenever a comment is\ntriaged or aged out, which is what keeps this list cheap on a post that went\nviral.\n\nPass `channel_id`: the Comments view is channel-scoped, and it is also the\nindexed path. Use `has_unanswered=true` for a \"needs attention\" list.\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","comments","posts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"channel_id","value":"string","description":"Only posts on this Instagram / Facebook Messenger channel. Omit for every channel in the workspace."},{"disabled":false,"key":"has_unanswered","value":"true","description":"`true` → only posts with at least one unanswered comment; `false` → only fully cleared posts; omit for all."},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"23d6b5f9-faff-49c1-a151-7dfa599b53f8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","posts"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"has_unanswered","value":"true"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f3ae30bc-c03f-4fd5-9394-0561edaa3e20","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","posts"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"has_unanswered","value":"true"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"85ffe8c4-cd87-46a7-acbe-19ea4f1d29bd","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments","posts"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"has_unanswered","value":"true"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69e17d78-d22b-461d-b947-b506bae46ff2","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments","posts"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"has_unanswered","value":"true"},{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"method":"GET","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"78d84d45-51bc-4861-96e7-50494c66eb1c","name":"Pull recent posts from Meta into the Posts list","request":{"name":"Pull recent posts from Meta into the Posts list","description":{"content":"Fetch the newest posts straight off the connected Instagram account / Facebook\nPage and upsert them into the Posts list — **including posts that have no\ncomments yet**, which is what ordinary comment ingestion never surfaces.\n\nPass `channel_id` to sync one channel, or omit it to sync every connected social\nchannel in the workspace. `limit` (default 25) is how many recent posts to pull\nper channel.\n\nReturns `{ \"synced\": N, \"created\": M }`: `synced` is how many posts were read\nand upserted, `created` is how many of those were new. A channel Meta\nrate-limits or rejects is skipped rather than failing the whole call, so a large\nworkspace still syncs the channels that are reachable.\n\nThe like/comment counts and captions on existing posts are refreshed by the same\npass.\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","comments","posts","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"string\",\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"51475f21-89aa-41ad-8ef5-b6c721a48e36","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","posts","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"string\",\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"synced\": 0,\n \"created\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6c87f4e8-d38e-43b6-886c-000d049629a4","name":"The given `channel_id` is not an Instagram / Facebook Messenger channel (`error_code`: `not_a_social_channel`).","originalRequest":{"url":{"path":["api","v1","comments","posts","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"string\",\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3b9bc0af-96d9-492a-8c8a-2886b3e993d1","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","posts","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"string\",\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0967ce23-ea8f-43d3-8ffc-040ffb07c84f","name":"A `channel_id` was given but no such channel exists in this workspace (`error_code`: `channel_not_found`).","originalRequest":{"url":{"path":["api","v1","comments","posts","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"string\",\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"47f87079-763a-48e5-b438-5a509bec1bf7","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments","posts","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"string\",\n \"limit\": 25\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d87a839d-3095-45ba-8613-f8c90d84f307","name":"Aggregate insights totals across the workspace's posts","request":{"name":"Aggregate insights totals across the workspace's posts","description":{"content":"Totals of the cached per-post insights across all of this workspace's\ncomment-synced posts, for two windows: the **last 30 days** (posts published in\nthat window) and **all time**.\n\nBecause per-post insights are Meta **lifetime** totals, the 30-day window\nselects WHICH posts are summed (by `posted_at`), it is NOT a per-day series — the\nnumbers are still lifetime totals for the posts in scope. Each metric sums only\nthe non-null cached values, so a metric a platform never exposes never distorts\nthe total; `post_count` is how many posts had cached insights and contributed.\n\nServed entirely from the cache — no live Graph call. Use the refresh endpoints to\nupdate the underlying numbers first.\n\n**Required Scopes:** `messages:read`","type":"text/plain"},"url":{"path":["api","v1","comments","posts","insights","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ee878c94-42db-4c39-bf24-a54699f2ba4a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"last_30_days\": {\n \"reach\": {\n \"value\": \"\"\n },\n \"impressions\": {\n \"value\": \"\"\n },\n \"engagement\": {\n \"value\": \"\"\n },\n \"likes\": {\n \"value\": \"\"\n },\n \"comments\": {\n \"value\": \"\"\n },\n \"shares\": {\n \"value\": \"\"\n },\n \"saves\": {\n \"value\": \"\"\n },\n \"video_views\": {\n \"value\": \"\"\n },\n \"clicks\": {\n \"value\": \"\"\n },\n \"post_count\": {\n \"value\": \"\"\n }\n },\n \"all_time\": {\n \"reach\": {\n \"value\": \"\"\n },\n \"impressions\": {\n \"value\": \"\"\n },\n \"engagement\": {\n \"value\": \"\"\n },\n \"likes\": {\n \"value\": \"\"\n },\n \"comments\": {\n \"value\": \"\"\n },\n \"shares\": {\n \"value\": \"\"\n },\n \"saves\": {\n \"value\": \"\"\n },\n \"video_views\": {\n \"value\": \"\"\n },\n \"clicks\": {\n \"value\": \"\"\n },\n \"post_count\": {\n \"value\": \"\"\n }\n },\n \"last_refreshed_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b885efda-3eb3-48f3-8869-abcf116c5990","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"018f9da5-7f07-4e6e-a860-b12cc39457e3","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"37ac8c84-ef7f-4c33-817b-a8954a06565b","name":"Force-refresh cached insights for the workspace's recent posts","request":{"name":"Force-refresh cached insights for the workspace's recent posts","description":{"content":"Force a LIVE Meta re-fetch for the workspace's most recent posts, overwrite the\nper-post cache columns, and return each refreshed post with its updated insights.\n\nBounded by `limit` (default 25, max 50, most-recent-first) so a large workspace\nnever triggers a Graph storm — call it per channel with `channel_id` to refresh a\nspecific account. A post whose page lacks insights access is refreshed to\n`authorized: false` + `insights_not_authorized` (persisted, never a 500); a\nnon-IG/FB post to `insights_unsupported_platform`.\n\n**Required Scopes:** `messages:read`","type":"text/plain"},"url":{"path":["api","v1","comments","posts","insights","refresh"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"channel_id","value":"string","description":"Only refresh posts on this Instagram / Facebook channel. Omit to refresh the most recent posts across the workspace."},{"disabled":false,"key":"limit","value":"25","description":"How many most-recent posts to refresh."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"a80b60d3-b90b-4ea7-9d35-344966eff7bc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","refresh"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"limit","value":"25"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refreshed\": 8682,\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9d975609-0d34-4567-8b56-0cfa24b49cbc","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","refresh"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"limit","value":"25"}],"variable":[]},"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"53da3a25-5cc0-425a-9472-490cea397412","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","refresh"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"limit","value":"25"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b9d20d8-75c6-4c4a-9ce2-e1a013884df8","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments","posts","insights","refresh"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"limit","value":"25"}],"variable":[]},"method":"POST","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ef3616c3-0b56-46cb-9a43-d4caefb3a63c","name":"Force-refresh cached insights for one post","request":{"name":"Force-refresh cached insights for one post","description":{"content":"Force a LIVE Meta re-fetch for one comment-synced post, overwrite its cache\ncolumns (and `insights_refreshed_at`), and return the updated insights.\n\nDegrades softly and persists the degraded state: a page lacking insights access →\n`authorized: false` + `insights_not_authorized`; an object Meta carries no\ninsights for → `insights_unavailable`; a non-IG/FB channel →\n`insights_unsupported_platform`. Never a 500 for a Meta-side condition.\n\n**Required Scopes:** `messages:read`","type":"text/plain"},"url":{"path":["api","v1","comments","posts",":post_id","insights","refresh"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our post id (from `GET /comments/posts`)."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"a061188d-aa2d-416f-bbaf-1f90b8340dc1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","insights","refresh"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our post id (from `GET /comments/posts`)."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"post_id\": \"string\",\n \"insights\": {\n \"reach\": {\n \"value\": \"\"\n },\n \"impressions\": {\n \"value\": \"\"\n },\n \"engagement\": {\n \"value\": \"\"\n },\n \"likes\": {\n \"value\": \"\"\n },\n \"comments\": {\n \"value\": \"\"\n },\n \"shares\": {\n \"value\": \"\"\n },\n \"saves\": {\n \"value\": \"\"\n },\n \"video_views\": {\n \"value\": \"\"\n },\n \"clicks\": {\n \"value\": \"\"\n },\n \"authorized\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"last_refreshed_at\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b581ec3-8f91-4441-b0b1-f47e782f372f","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","insights","refresh"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our post id (from `GET /comments/posts`)."}]},"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3838ee01-d13f-4168-b5a9-eacf75bdd75f","name":"No such post in this workspace (`post_not_found`).","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","insights","refresh"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our post id (from `GET /comments/posts`)."}]},"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e6ca2d88-c29a-4d5d-8401-5030d4d33cc0","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","insights","refresh"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our post id (from `GET /comments/posts`)."}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7b7ef627-9504-44d8-95ed-290874e07904","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","insights","refresh"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our post id (from `GET /comments/posts`)."}]},"method":"POST","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac6f6510-d56d-438b-bf7f-c3eea9aee05d","name":"List the comments on one post","request":{"name":"List the comments on one post","description":{"content":"The comment thread for one post, oldest first so it reads chronologically.\n\n`post_id` is **our** id, as returned by `GET /comments/posts` — not Meta's post\nid.\n\nEvery row carries what it takes to render it and to decide what you may do with\nit: the text, the author, the state, whether it is a threaded reply and to which\ncomment, when Meta's 7-day private-reply window closes, and whether a private\nreply is still possible **with the reason when it is not**. Most comments end up\nunavailable, and that is normal rather than an error — see\n`private_reply_unavailable_reason`.\n\nFilter with `state`, which is repeatable: `?state=unanswered`,\n`?state=replied&state=auto_replied`. Omit it for the \"All\" tab.\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","comments","posts",":post_id","comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"state","value":"string","description":"Repeatable state filter: `unanswered` (alias of `pending`), `pending`, `auto_replied`, `replied`, `handled`, `ignored`. Omit for all states."},{"disabled":false,"key":"state","value":"string","description":"Repeatable state filter: `unanswered` (alias of `pending`), `pending`, `auto_replied`, `replied`, `handled`, `ignored`. Omit for all states."},{"disabled":false,"key":"include_owner","value":"false","description":"Include comments made by the connected account itself. Off by default: Meta echoes our own public replies back as ordinary comments, and they are noise in a work queue."},{"disabled":false,"key":"include_reply","value":"true","description":"Hydrate each answered comment's private-reply message into `private_reply`. One extra query per page; turn it off for bulk exports."},{"disabled":false,"key":"sort_order","value":"asc","description":"Order by `commented_at`. Defaults to `asc` — a thread reads forwards."},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our social post id (not Meta's)."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a80b4590-4b23-427f-adcd-60700140adae","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","comments"],"host":["{{baseUrl}}"],"query":[{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"sort_order","value":"asc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our social post id (not Meta's)."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"35994ec5-ba4e-4536-9843-dbea3e8a1c6b","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","comments"],"host":["{{baseUrl}}"],"query":[{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"sort_order","value":"asc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our social post id (not Meta's)."}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3fd8ee63-a746-4bb0-93b7-a6f4daafc5ad","name":"No such post in this workspace (`error_code`: `post_not_found`).","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","comments"],"host":["{{baseUrl}}"],"query":[{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"sort_order","value":"asc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our social post id (not Meta's)."}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4b6a43ba-cc6d-492e-a9c8-a0ea7a3f065b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","comments"],"host":["{{baseUrl}}"],"query":[{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"sort_order","value":"asc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our social post id (not Meta's)."}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"32cdbc25-039e-480b-8716-ec0c7e8e0b23","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments","posts",":post_id","comments"],"host":["{{baseUrl}}"],"query":[{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"sort_order","value":"asc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"post_id","description":"(Required) Our social post id (not Meta's)."}]},"method":"GET","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6aa3106-652d-4f3b-b2e1-2683a192e01f","name":"Comment inbox — comments across all posts","request":{"name":"Comment inbox — comments across all posts","description":{"content":"Every comment in the workspace, newest first, filtered by state — the screen an\nagent actually works from. It exists so nobody has to guess which post has\nsomething waiting on it: `GET /comments?state=unanswered` is the whole queue.\n\nDefaults to `state=unanswered`, because that is the question this view answers.\nPass `state` explicitly (repeatable) for anything else, or `state=pending&\nstate=auto_replied&state=replied&state=handled&state=ignored` for everything.\n\nEach row embeds a compact `post` reference — permalink, caption, thumbnail — so\na comment is legible without knowing which post it came from, and links back to\nthe post on Instagram / Facebook.\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"channel_id","value":"string","description":"Only comments on this channel's posts."},{"disabled":false,"key":"state","value":"string","description":"Repeatable state filter: `unanswered` (alias of `pending`), `pending`, `auto_replied`, `replied`, `handled`, `ignored`. **Defaults to `unanswered`.**"},{"disabled":false,"key":"state","value":"string","description":"Repeatable state filter: `unanswered` (alias of `pending`), `pending`, `auto_replied`, `replied`, `handled`, `ignored`. **Defaults to `unanswered`.**"},{"disabled":false,"key":"include_owner","value":"false","description":"Include the connected account's own comments (our public replies)."},{"disabled":false,"key":"include_reply","value":"true","description":"Hydrate `private_reply` for answered comments."},{"disabled":false,"key":"include_post","value":"true","description":"Embed each comment's `post` reference. One extra query per page; turn it off if you only need the comments themselves."},{"disabled":false,"key":"sort_order","value":"desc","description":"Order by `commented_at`. Defaults to `desc` (newest first); pass `asc` to work the queue oldest-first."},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"54aa12b9-95a2-48c7-ba2e-3993b3b9c836","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"include_post","value":"true"},{"key":"sort_order","value":"desc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"853ef4a0-364d-4fe3-8f77-c2c5fc8031c0","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"include_post","value":"true"},{"key":"sort_order","value":"desc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8cf08a13-6a74-46cb-a350-182bfbab609b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"include_post","value":"true"},{"key":"sort_order","value":"desc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8613bb1f-e18e-412d-a18e-3137503fee6c","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"state","value":"string"},{"key":"state","value":"string"},{"key":"include_owner","value":"false"},{"key":"include_reply","value":"true"},{"key":"include_post","value":"true"},{"key":"sort_order","value":"desc"},{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]},"method":"GET","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7e3dc400-bd69-4427-a61b-4b75b56ae9d6","name":"Get one comment","request":{"name":"Get one comment","description":{"content":"One comment, with its post and its private reply resolved.\n\n`comment_id` is **Meta's** comment id — the same value\n`POST /comments/{comment_id}/private-reply` takes, the same value the\n`comment.received` webhook delivers, and the same value that appears on the\noutbound reply message as `meta.comment_id`. Our own comment id is accepted too.\n\nThat is what makes this endpoint the **message → comment** direction of the\nreply linkage: a conversation showing a private reply holds only\n`meta.comment_id`, and this turns it into the comment text, author, state and\npost permalink needed to render \"↩ replying to …\".\n\n**🔐 Required Scopes:** `messages:read`\n","type":"text/plain"},"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"include_reply","value":"true","description":"Hydrate the private-reply message into `private_reply`."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`), or our own comment id."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"47ac59f9-10ea-4002-beaf-8b642cfd792c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[{"key":"include_reply","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`), or our own comment id."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"social_post_id\": \"string\",\n \"channel_id\": \"string\",\n \"external_comment_id\": \"string\",\n \"author_external_id\": \"string\",\n \"state\": \"string\",\n \"commented_at\": \"string\",\n \"updated_at\": \"string\",\n \"parent_external_comment_id\": \"string\",\n \"is_reply\": false,\n \"author_username\": \"string\",\n \"is_from_owner\": false,\n \"contact_id\": \"string\",\n \"text\": \"string\",\n \"attachment_url\": \"string\",\n \"attachment_type\": \"string\",\n \"replied_at\": \"string\",\n \"replied_by_user_id\": \"string\",\n \"handled_at\": \"string\",\n \"private_reply_window_expires_at\": \"string\",\n \"private_reply_available\": false,\n \"private_reply_unavailable_reason\": \"string\",\n \"private_reply_message_id\": \"string\",\n \"private_reply\": {\n \"value\": \"\"\n },\n \"public_reply_id\": \"string\",\n \"post\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"477ca807-dca8-4bce-8e9f-bec88720d321","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[{"key":"include_reply","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`), or our own comment id."}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"22665782-01f9-4202-acb1-6ee7bffeda21","name":"No such comment in this workspace (`error_code`: `comment_not_found`). A comment we never stored — one that predates the feature, or that retention has aged out — is indistinguishable from one that never existed.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[{"key":"include_reply","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`), or our own comment id."}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"81bbb4fb-dcf3-4874-8d32-56261acd4fba","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[{"key":"include_reply","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`), or our own comment id."}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1cedc9aa-6891-4ac7-945e-ff754ef94abf","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[{"key":"include_reply","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id (Instagram: numeric; Facebook: `{post_id}_{comment_id}`), or our own comment id."}]},"method":"GET","body":{}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"58397564-dfc7-4586-bb3f-9d929d07b1eb","name":"Mark a comment handled or ignored (or reopen it)","request":{"name":"Mark a comment handled or ignored (or reopen it)","description":{"content":"Clear a comment from the unanswered queue **without** sending a private reply —\nfor the comment you answered publicly, answered on the phone, or simply decided\nto skip. This is what stops the unanswered badge from being a number nobody can\never drive to zero.\n\n* `handled` — dealt with, no private reply sent.\n* `ignored` — not actionable.\n* `pending` — reopen; undoes either of the above.\n\nThe post's comment counters are **recomputed** from the comment rows as part of\nthe same transaction, not nudged up or down, so repeating this call — a\ndouble-click, a retried request, flipping a comment back and forth — can never\nmake the badge drift.\n\n`replied` and `auto_replied` are not settable here: they assert that a private\nreply message exists, and only sending one may assert that.\n\n**🔐 Required Scopes:** `conversations:update, messages:create`\n","type":"text/plain"},"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7fc20a61-db60-416b-922b-da12a7b2b78f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"social_post_id\": \"string\",\n \"channel_id\": \"string\",\n \"external_comment_id\": \"string\",\n \"author_external_id\": \"string\",\n \"state\": \"string\",\n \"commented_at\": \"string\",\n \"updated_at\": \"string\",\n \"parent_external_comment_id\": \"string\",\n \"is_reply\": false,\n \"author_username\": \"string\",\n \"is_from_owner\": false,\n \"contact_id\": \"string\",\n \"text\": \"string\",\n \"attachment_url\": \"string\",\n \"attachment_type\": \"string\",\n \"replied_at\": \"string\",\n \"replied_by_user_id\": \"string\",\n \"handled_at\": \"string\",\n \"private_reply_window_expires_at\": \"string\",\n \"private_reply_available\": false,\n \"private_reply_unavailable_reason\": \"string\",\n \"private_reply_message_id\": \"string\",\n \"private_reply\": {\n \"value\": \"\"\n },\n \"public_reply_id\": \"string\",\n \"post\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1746fba-5ed4-48c0-b82e-be5d85996eb3","name":"The `social_comments_beta` feature is not enabled for this workspace (`error_code`: `feature_not_enabled`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"59b71f2e-29e5-4912-8918-a723dff1360d","name":"No such comment in this workspace (`error_code`: `comment_not_found`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0814a3c5-e5fa-4e11-9281-603a0d0fb6b5","name":"The comment already has a private reply, so its state is no longer yours to set — Meta permits exactly one private reply per comment, forever, and calling such a comment unanswered would advertise an action that can never succeed (`error_code`: `state_not_allowed`).","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7c09617e-2dde-42d6-89bb-f3d5ccfd2012","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62df01c6-325a-4cf9-a15f-ce054ac180e4","name":"Comment storage is not available for this workspace yet (`error_code`: `social_comments_unavailable`). Transient — this is what a shard that has not received the comment tables answers, rather than a 500.","originalRequest":{"url":{"path":["api","v1","comments",":comment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"comment_id","description":"(Required) Meta's comment id, or our own comment id."}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"state\": \"handled\"\n}","options":{"raw":{"language":"json"}}}},"status":"Service Unavailable","code":503,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"e9034c4b-e51e-4b6c-aa89-b3b2358140e1","name":"Company Profile","description":{"content":"Manage your organization's profile information displayed to customers across channels.","type":"text/plain"},"item":[{"id":"7d38a349-903a-4285-b989-b22de6ede43c","name":"Get Company Profile","request":{"name":"Get Company Profile","description":{"content":"Get tenant company profile and branding information\n\nReturns combined data:\n- Legal company information (for email compliance)\n- Branding settings (colors, logo)\n- Computed field: is_complete_for_email\n\n**Database:** PRIMARY (tenants table)\n\n**🔐 Required Scopes:** `settings:read`\n","type":"text/plain"},"url":{"path":["api","v1","company-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a70af48f-c500-4113-8015-fa1ab0765d9c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","company-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"company_legal_name\": \"string\",\n \"company_address_line1\": \"string\",\n \"company_address_line2\": \"string\",\n \"company_city\": \"string\",\n \"company_state_province\": \"string\",\n \"company_postal_code\": \"string\",\n \"company_country\": \"string\",\n \"company_email\": \"string\",\n \"company_phone\": \"string\",\n \"company_name\": \"string\",\n \"company_domain\": \"string\",\n \"brand_colors\": {\n \"value\": \"\"\n },\n \"logo_variants\": {\n \"value\": \"\"\n },\n \"is_complete_for_email\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ca09b10a-cc66-4cf7-a695-6cf3ed2afe89","name":"Update Company Profile","request":{"name":"Update Company Profile","description":{"content":"Update tenant company profile and branding (partial update)\n\nOnly updates provided fields. Unspecified fields remain unchanged.\n\n**Database:** PRIMARY (tenants table)\n\n**Example:**\n```json\n{\n \"company_legal_name\": \"ACME Corporation\",\n \"company_address_line1\": \"123 Main St\",\n \"company_city\": \"San Francisco\",\n \"company_state_province\": \"CA\",\n \"company_postal_code\": \"94102\",\n \"company_country\": \"United States\",\n \"brand_colors\": {\n \"primary\": \"#007bff\",\n \"secondary\": \"#6c757d\",\n \"accent\": \"#28a745\"\n }\n}\n```\n\n**🔐 Required Scopes:** `settings:update`\n","type":"text/plain"},"url":{"path":["api","v1","company-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"company_legal_name\": \"string\",\n \"company_address_line1\": \"string\",\n \"company_address_line2\": \"string\",\n \"company_city\": \"string\",\n \"company_state_province\": \"string\",\n \"company_postal_code\": \"string\",\n \"company_country\": \"string\",\n \"company_email\": \"string\",\n \"company_phone\": \"string\",\n \"company_name\": \"string\",\n \"company_domain\": \"string\",\n \"brand_colors\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ae73721a-f48c-435d-8b34-2e88ca14d117","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","company-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"company_legal_name\": \"string\",\n \"company_address_line1\": \"string\",\n \"company_address_line2\": \"string\",\n \"company_city\": \"string\",\n \"company_state_province\": \"string\",\n \"company_postal_code\": \"string\",\n \"company_country\": \"string\",\n \"company_email\": \"string\",\n \"company_phone\": \"string\",\n \"company_name\": \"string\",\n \"company_domain\": \"string\",\n \"brand_colors\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"company_legal_name\": \"string\",\n \"company_address_line1\": \"string\",\n \"company_address_line2\": \"string\",\n \"company_city\": \"string\",\n \"company_state_province\": \"string\",\n \"company_postal_code\": \"string\",\n \"company_country\": \"string\",\n \"company_email\": \"string\",\n \"company_phone\": \"string\",\n \"company_name\": \"string\",\n \"company_domain\": \"string\",\n \"brand_colors\": {\n \"value\": \"\"\n },\n \"logo_variants\": {\n \"value\": \"\"\n },\n \"is_complete_for_email\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58d5f2d9-bf58-41d4-87a5-2bc13c69dfaa","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","company-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"company_legal_name\": \"string\",\n \"company_address_line1\": \"string\",\n \"company_address_line2\": \"string\",\n \"company_city\": \"string\",\n \"company_state_province\": \"string\",\n \"company_postal_code\": \"string\",\n \"company_country\": \"string\",\n \"company_email\": \"string\",\n \"company_phone\": \"string\",\n \"company_name\": \"string\",\n \"company_domain\": \"string\",\n \"brand_colors\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"f6ef1328-92a1-4200-acbb-be96b71f3f83","name":"Contact Bulk Actions","description":{"content":"Perform bulk operations on contacts such as batch tagging, deletion, and export.","type":"text/plain"},"item":[{"id":"0aeec34f-f22d-427e-b794-6ad895a0a187","name":"Preview Bulk Action","request":{"name":"Preview Bulk Action","description":{"content":"Preview a contact bulk action (mass edit) — no changes are made.\n\n**Required Scopes:** `contacts:update`\n\nValidates the selection and every action against the tenant (tags/list/\ncustom field existence + value/type checks, `set_field` allowlist),\ncomputes how many contacts the selection currently matches and returns a\nsigned `confirmation_token`. Submit the IDENTICAL `selection` + `actions`\ntogether with that token to `/contacts/bulk-actions/execute` within\n`expires_in_seconds` (~10 minutes).\n\nSelection modes:\n- `{\"mode\": \"ids\", \"ids\": [...]}` — explicit contact ids (max 10000).\n- `{\"mode\": \"filter\", \"filter\": {...}}` — same params as `GET /contacts`\n (`search`, `include_live_chat`, `custom_field_id/value/value_to/op`,\n `list_id` + `list_subscription_status`/`list_subscription_channel`,\n `is_blocked`); `{}` targets ALL contacts.\n\nAction types (executed in order per contact): `set_field`,\n`set_custom_field`, `add_tags`, `remove_tags`, `add_to_list`,\n`set_blocked` (`{\"type\": \"set_blocked\", \"blocked\": true|false}` — blocks or\nunblocks the contact and all of its identifiers on every channel; can be\nmixed with the other actions).","type":"text/plain"},"url":{"path":["api","v1","contacts","bulk-actions","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"selection\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"ids\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n }\n },\n \"actions\": [\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3655ffac-e913-478b-b35d-ae0743e78c90","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"selection\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"ids\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n }\n },\n \"actions\": [\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"affected_count\": 234,\n \"sample\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"confirmation_token\": \"string\",\n \"expires_in_seconds\": 249\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d2a4b939-85c0-4cfe-8d8b-58f9063a31f6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"selection\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"ids\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n }\n },\n \"actions\": [\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a1cb1ad0-6675-4f75-ab19-329210a7e06d","name":"Execute Bulk Action","request":{"name":"Execute Bulk Action","description":{"content":"Execute a previously previewed contact bulk action (202 Accepted).\n\n**Required Scopes:** `contacts:update`\n\nRequires the `confirmation_token` from `/contacts/bulk-actions/preview`\ntogether with the IDENTICAL `selection` + `actions`. Errors:\n\n- **400** `{\"detail\": {\"code\": \"TOKEN_INVALID\" | \"TOKEN_EXPIRED\", ...}}` —\n malformed/forged/expired token, or token minted for another tenant/user.\n- **409** `{\"detail\": {\"code\": \"PAYLOAD_MISMATCH\", ...}}` — the submitted\n selection/actions differ from what was previewed.\n- **409** `{\"detail\": {\"code\": \"AFFECTED_COUNT_DRIFT\", \"affected_count\": N,\n ...}}` — the match count changed since preview (any difference when the\n previewed count was < 100, otherwise more than ±2%). Re-preview and\n confirm again with the new count.\n\nOn success the run is recorded as a `BulkActionLog` audit row and executed\nas a chunked background job; poll `poll_url` until `status` is\n`completed`/`failed`. `affected_count` on the poll response is the running\ntotal of actually-changed contacts.","type":"text/plain"},"url":{"path":["api","v1","contacts","bulk-actions","execute"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"selection\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"ids\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n }\n },\n \"actions\": [\n {\n \"value\": \"\"\n }\n ],\n \"confirmation_token\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9df50f86-6411-4ca9-a024-7da3069264dd","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions","execute"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"selection\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"ids\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n }\n },\n \"actions\": [\n {\n \"value\": \"\"\n }\n ],\n \"confirmation_token\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"bulk_action_id\": \"string\",\n \"status\": \"string\",\n \"poll_url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"83765975-277d-4585-9a4a-02d94b11d591","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions","execute"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"selection\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"ids\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n }\n },\n \"actions\": [\n {\n \"value\": \"\"\n }\n ],\n \"confirmation_token\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fb9c5a67-6f01-4b60-b534-cf20f54c99f9","name":"List Bulk Actions","request":{"name":"List Bulk Actions","description":{"content":"List this tenant's contact bulk action runs, newest first (audit history).\n\n**Required Scopes:** `contacts:update`\n\nReturns the standard `{\"items\": [...], \"pagination\": {...}}` envelope;\neach item has the same shape as `GET /contacts/bulk-actions/{id}`.","type":"text/plain"},"url":{"path":["api","v1","contacts","bulk-actions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page (max 100)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ab1849c4-a5d3-4371-8827-1619bf0b73bf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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":"6fb258fc-4d87-4db5-8a83-8a897c022903","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8a7738a7-04a7-4034-8199-524db7f21b6c","name":"Get Bulk Action","request":{"name":"Get Bulk Action","description":{"content":"Poll one contact bulk action run (status + audit detail).\n\n**Required Scopes:** `contacts:update`\n\n`status`: `pending` → `processing` → `completed` | `failed`.\n`affected_count` is the running total of actually-changed contacts\n(committed per chunk) and the final total once completed. `error` carries\nthe failure reason (`failed`) or a truncated summary of individually\nskipped contacts (`completed`).","type":"text/plain"},"url":{"path":["api","v1","contacts","bulk-actions",":bulk_action_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bulk_action_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"d5d39223-1f55-4b9a-8898-19e72206a4b1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions",":bulk_action_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bulk_action_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"user_id\": \"string\",\n \"status\": \"string\",\n \"affected_count\": 1343,\n \"selection\": {\n \"key_0\": \"string\",\n \"key_1\": 6699,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": 5116.222432941238\n },\n \"actions\": [\n {\n \"key_0\": 674,\n \"key_1\": 7780\n },\n {\n \"key_0\": false\n }\n ],\n \"created_at\": \"string\",\n \"error\": \"string\",\n \"started_at\": \"string\",\n \"completed_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1ca1174b-bbd8-4170-ab82-1264cd4302e5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","bulk-actions",":bulk_action_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bulk_action_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"17c34879-7ec6-402d-adb6-6d713eb34074","name":"Contacts","description":{"content":"Create, update, search, and manage customer contacts across all channels. Supports tags, custom fields, and subscription management.","type":"text/plain"},"item":[{"id":"f1d0118b-0d24-4f42-9a15-c5416c9a78b8","name":"Create Contact","request":{"name":"Create Contact","description":{"content":"Create a new contact.\n\nHonors the tenant's `duplicate_contact_mode` setting (or the optional\n`duplicate_mode` body field for a per-request override):\n\n- `auto_merge` (default): if a contact already exists with the same phone,\n email, or platform identifier, return that contact (oldest wins as\n primary). Incoming new methods/fields are merged into it.\n- `allow_duplicates`: always create a new contact. The response includes a\n `potential_duplicates` list with any contacts sharing identifiers.\n- `dont_allow_duplicates`: returns HTTP 409 with a `duplicates` array if\n a duplicate is detected; nothing is created.\n\n`custom_fields` (optional): typed custom field values keyed by custom\nfield definition ID (preferred) or field `key`. Validated BEFORE anything\nis written (422 per-field errors, see PATCH /contacts/{id}); written in the\nsame transaction as the contact. In `auto_merge`, when an existing contact\nis matched, the given values OVERWRITE its values only if the caller also\nholds `contacts:update`; otherwise they only fill fields that are empty\n(fields that already have a value are skipped). null/empty entries are\nignored on create.\n\n**Required Scopes:** `contacts:create`","type":"text/plain"},"url":{"path":["api","v1","contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"contact_methods\": [\n {\n \"method_type\": \"whatsapp_id\",\n \"value\": \"1234567890\"\n }\n ],\n \"email\": \"john@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Doe\",\n \"phone\": \"+1234567890\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c3e62ce5-9430-4d98-a053-8516e18bc926","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"wtT6pT@irNpqbHORWQvYOYnxTnFBtD.lo\",\n \"languages\": \"string\",\n \"birthday\": \"1953-08-28\",\n \"contact_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"duplicate_mode\": {\n \"value\": \"\"\n },\n \"custom_fields\": {\n \"key_0\": false\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"BfpoHEiJ@gndeRXyVYrQLCYsiNYBGwvtG.fjz\",\n \"updated_at\": \"string\",\n \"avatar_url\": \"string\",\n \"avatar_is_custom\": false,\n \"language\": \"string\",\n \"languages\": \"string\",\n \"birthday\": \"1956-10-05\",\n \"is_blocked\": false,\n \"is_archived\": false,\n \"blocked_inbound_count\": 0,\n \"last_blocked_inbound_at\": \"1953-09-05T20:02:23.697Z\",\n \"source\": \"string\",\n \"last_contacted_at\": \"1978-07-25T03:36:49.693Z\",\n \"custom_fields\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contact_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_count\": 3482,\n \"last_conversation_at\": \"1964-10-01T23:13:11.127Z\",\n \"potential_duplicates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"merged_from\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"def59065-0b87-496b-8fbb-58d782e5d80e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"wtT6pT@irNpqbHORWQvYOYnxTnFBtD.lo\",\n \"languages\": \"string\",\n \"birthday\": \"1953-08-28\",\n \"contact_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"duplicate_mode\": {\n \"value\": \"\"\n },\n \"custom_fields\": {\n \"key_0\": false\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0bc5dbc2-c61d-4080-8f07-4e1f7713827b","name":"List Contacts","request":{"name":"List Contacts","description":{"content":"List contacts with pagination, search, server-side sorting, custom-field\nand list-subscription filtering.\n\n**Required Scopes:** `contacts:read`\n\nReturns a paginated list of contacts matching the search criteria.\nEach contact includes tags and custom fields.\n\n**Sorting** (full-dataset, applied in SQL before pagination):\n- `sort_by`: `created_at` (default), `name`, `email`, `custom_field`. Unknown\n values return 422.\n- `sort_dir`: `asc` or `desc` (default `desc`).\n- `sort_by=custom_field` requires `custom_field_id`. Contacts without a value\n for the field still appear (LEFT JOIN); NULLs sort first on asc, last on desc.\n\n**Custom-field filter** (combinable with `search`):\nThe match strategy is selected SERVER-SIDE from the field's `field_type`\n(looked up from `custom_field_definitions`), NOT from a client-trusted\noperator. `custom_field_op` may narrow/override within what the type allows.\n\n- `custom_field_id` alone → contacts that have ANY value for that field.\n- **text** (and email/phone/url) → CONTAINS match (`value LIKE %v%`, with `%`\n and `_` in the input escaped to literals). This is the default for these\n types. (Behavior change: previously exact-match.)\n- **select** → EXACT match; the supplied value must be one of the field's\n configured `options` (422 if not).\n- **number** → operator-based via `custom_field_op`:\n `eq` (default), `gt`, `lt`, `gte`, `lte`, `between`. For `between`,\n `custom_field_value` is the lower bound and `custom_field_value_to` the\n (inclusive) upper bound; lower must be <= upper. Values must parse as\n numbers. Comparisons are numeric (TEXT values are regex-guarded then cast\n to DECIMAL, so non-numeric rows never match and never error).\n- **other types** (boolean/date/datetime/location/multiselect/collection) →\n EXACT match (unchanged, backwards compatible).\n\n`custom_field_op` allowlist: `eq`, `contains`, `gt`, `lt`, `gte`, `lte`,\n`between`. Anything else is rejected by FastAPI (422). Numeric operators are\nonly valid for `number` fields and `contains` only for text-like fields;\nincompatible combinations return 422.\n\nThe `custom_field_id` always validates the field belongs to the tenant\n(422 if not).\n\n**List-subscription filter** (combinable with `search` and the custom-field\nfilter — all filters are AND-ed, and `total` always reflects the filtered\nset):\n\n- `list_id` → a `lists.id`; validated to belong to the tenant (422 if not).\n- `list_subscription_status` (default `subscribed` when `list_id` is set):\n - `subscribed` | `pending` | `unsubscribed` | `bounced` | `complained` →\n the contact has a subscription row with EXACTLY that status.\n - `any` → the contact has a subscription row for the list in ANY status.\n - `not_subscribed` → the contact has NO `subscribed` row for the list\n (i.e. not currently subscribed; includes contacts with no row at all).\n- `list_subscription_channel` → optional narrowing on the subscription's\n channel (`email`, `sms`, `whatsapp`, `telegram`, `messenger`,\n `instagram`, `browser_push`). Subscription rows are PER CHANNEL, so this\n answers \"subscribed to list X via WhatsApp\". Applied inside the\n EXISTS/NOT EXISTS.\n- Supplying `list_subscription_status` or `list_subscription_channel`\n WITHOUT `list_id` returns 422.\n\nContacts are matched with a correlated `EXISTS`/`NOT EXISTS`, so a contact\nsubscribed to the same list via several channels is returned ONCE.\nFor a DYNAMIC list (membership computed from segment conditions, no\nsubscription rows) the list's conditions are evaluated instead:\n`subscribed`/`any` = matches the conditions, `not_subscribed` = does not;\nthe row-level statuses (`pending`/`unsubscribed`/`bounced`/`complained`)\ncannot exist and match nothing.\n\n**Tag-membership filter** (combinable with `search` and every other filter —\nall AND-ed):\n\n- `tag_id` → a `tags.id`; validated to belong to the tenant (422 if not).\n Restricts to contacts that carry that tag via the `contact_tags`\n association.\n- `tag_id` is REPEATABLE (`?tag_id=a&tag_id=b`): several ids match contacts\n carrying ANY of them (OR / at-least-one). Duplicate ids are ignored.\n- This filters by tag **id** (stable), never by tag name. It is a SEPARATE\n parameter from `search` on purpose: `search` matches name/email/phone/IDs\n only and never matches tags, so \"find contacts by tag\" uses `tag_id` and\n is not conflated with name search. When both are given, the text `search`\n is applied WITHIN the set of contacts carrying the tag(s).\n\n**Blocked filter** (`is_blocked`, combinable with every other filter):\n`true` → only blocked contacts, `false` → only unblocked contacts. \"Blocked\"\nmeans the contact's own blocked flag (`is_blocked` on the item). The same\nparameter is accepted by `POST /contacts/export` and the bulk-actions filter\nselection. Every item also carries `blocked_inbound_count` and\n`last_blocked_inbound_at` (inbound messages dropped because of the block).\n\n**Optional extras** (`include`, comma-separated; unknown tokens → 422):\n\n- `subscriptions` → each item gets `subscriptions: [{list_id, list_name,\n channel_type, status}]` — only `subscribed`/`pending` rows, sorted by\n list name then channel; `[]` when none.\n- `conversation_stats` → each item gets `conversation_count` (0 when none)\n and `last_conversation_at` (latest conversation activity, null when none).\n- Without `include` these fields are `null`. Each extra costs one batched\n query per page. `contact_methods` is always present on every item.\n\n**Response format:**\n```json\n{\n \"items\": [...],\n \"pagination\": {\n \"total\": 150,\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 8,\n \"has_next\": true,\n \"has_prev\": false\n }\n}\n```","type":"text/plain"},"url":{"path":["api","v1","contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page (max 250)"},{"disabled":false,"key":"search","value":"string","description":"Search by name, phone, email, or IDs"},{"disabled":false,"key":"include_live_chat","value":"false","description":"Include live chat contacts"},{"disabled":false,"key":"sort_by","value":"created_at","description":"Field to sort by. 'custom_field' requires custom_field_id."},{"disabled":false,"key":"sort_dir","value":"desc","description":"Sort direction"},{"disabled":false,"key":"custom_field_id","value":"string","description":"custom_field_definitions.id used for filtering and/or as the sort target when sort_by='custom_field'."},{"disabled":false,"key":"custom_field_value","value":"string","description":"Value to filter by. Requires custom_field_id. The match strategy is chosen SERVER-SIDE from the field's field_type (text=contains, select=exact, number=operator-based). If custom_field_id is set without this, filters to contacts that have ANY value for that field. For op='between' this is the lower bound."},{"disabled":false,"key":"custom_field_value_to","value":"string","description":"Upper bound for the custom-field filter. Only used when custom_field_op='between' (number fields only); ignored otherwise."},{"disabled":false,"key":"custom_field_op","value":"gte","description":"Optional comparison operator for the custom-field filter. If omitted, defaults are derived from the field_type (text->contains, select->eq, number->eq, others->eq). Numeric operators (gt/lt/gte/lte/between) are only valid for number fields; 'contains' is only valid for text-like fields. Incompatible combinations return 422."},{"disabled":false,"key":"list_id","value":"string","description":"lists.id — filter to contacts by their subscription to that list. Must belong to the tenant (422 if not)."},{"disabled":false,"key":"list_subscription_status","value":"unsubscribed","description":"Subscription status to match for list_id. Defaults to 'subscribed'. 'any' = a subscription row in ANY status; 'not_subscribed' = NOT currently subscribed (includes contacts with no row at all). Requires list_id (422)."},{"disabled":false,"key":"list_subscription_channel","value":"messenger","description":"Optionally narrow the list filter to one subscription channel (subscription rows are per channel). Requires list_id (422)."},{"disabled":false,"key":"tag_id","value":"string","description":"tags.id — filter to contacts carrying that tag. Repeatable (?tag_id=a&tag_id=b) to match contacts carrying ANY of the given tags (OR). Filters by tag id, NOT tag name; this is distinct from `search` (which never matches tags). Each id must belong to the tenant (422 if not). Combinable with `search` and the other filters (all AND-ed)."},{"disabled":false,"key":"tag_id","value":"string","description":"tags.id — filter to contacts carrying that tag. Repeatable (?tag_id=a&tag_id=b) to match contacts carrying ANY of the given tags (OR). Filters by tag id, NOT tag name; this is distinct from `search` (which never matches tags). Each id must belong to the tenant (422 if not). Combinable with `search` and the other filters (all AND-ed)."},{"disabled":false,"key":"is_blocked","value":"true","description":"Blocked-state filter: true = only blocked contacts, false = only unblocked contacts, omitted = all. Uses the contact's blocked flag. Combinable with every other filter."},{"disabled":false,"key":"include","value":"string","description":"Comma-separated optional extras to embed in each item: `subscriptions` (active list subscriptions), `conversation_stats` (conversation_count + last_conversation_at). Unknown tokens return 422."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"bf74c093-2a8c-4806-bc4b-f2547c2739e3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"search","value":"string"},{"key":"include_live_chat","value":"false"},{"key":"sort_by","value":"created_at"},{"key":"sort_dir","value":"desc"},{"key":"custom_field_id","value":"string"},{"key":"custom_field_value","value":"string"},{"key":"custom_field_value_to","value":"string"},{"key":"custom_field_op","value":"gte"},{"key":"list_id","value":"string"},{"key":"list_subscription_status","value":"unsubscribed"},{"key":"list_subscription_channel","value":"messenger"},{"key":"tag_id","value":"string"},{"key":"tag_id","value":"string"},{"key":"is_blocked","value":"true"},{"key":"include","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53628e60-3bc4-4193-a776-9598e4c5a000","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"search","value":"string"},{"key":"include_live_chat","value":"false"},{"key":"sort_by","value":"created_at"},{"key":"sort_dir","value":"desc"},{"key":"custom_field_id","value":"string"},{"key":"custom_field_value","value":"string"},{"key":"custom_field_value_to","value":"string"},{"key":"custom_field_op","value":"gte"},{"key":"list_id","value":"string"},{"key":"list_subscription_status","value":"unsubscribed"},{"key":"list_subscription_channel","value":"messenger"},{"key":"tag_id","value":"string"},{"key":"tag_id","value":"string"},{"key":"is_blocked","value":"true"},{"key":"include","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6d529f70-c104-40f7-ae4c-dde89f3d5678","name":"Bulk Delete Contacts","request":{"name":"Bulk Delete Contacts","description":{"content":"Bulk delete multiple contacts and all their related data.\n\nAccepts up to 100 contact IDs. Each contact is deleted individually\nusing the same full-cascade GDPR deletion as single delete (conversations,\nmessages, attachments, email transcripts, live-chat sessions and flow runs\nare all removed). Each contact commits independently, so one failure does\nnot roll back the others.\n\n**Required Scopes:** `contacts:delete`","type":"text/plain"},"url":{"path":["api","v1","contacts","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"54b634d0-4c71-432b-a6e8-4cfe3cbbdbd6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"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 \"success_count\": 8583,\n \"failed_count\": 3583\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"680a6cbe-a522-42dc-95b3-3205f54eac9f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6e38a76-17e0-4a6c-84ce-abd26ede46ce","name":"List Duplicate Groups","request":{"name":"List Duplicate Groups","description":{"content":"List groups of contacts sharing the same identifier (potential duplicates).\n\n**Required Scopes:** `contacts:read`\n\nReturns groups by signal value. Each group contains 2+ contacts that\nshare the signal, sorted by `created_at` ascending (oldest first — the\ntypical primary candidate).","type":"text/plain"},"url":{"path":["api","v1","contacts","duplicates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"signals","value":"phone,email,platform_id","description":"Comma-separated list of signals to use for duplicate detection. Allowed: phone, email, platform_id, name. 'name' is opt-in (false-positive prone)."},{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"25"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"952fef6b-5174-45bc-a23c-0e7cf4be4a89","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","duplicates"],"host":["{{baseUrl}}"],"query":[{"key":"signals","value":"phone,email,platform_id"},{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fa37fa73-65ab-4579-878c-76f4f893bc9e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","duplicates"],"host":["{{baseUrl}}"],"query":[{"key":"signals","value":"phone,email,platform_id"},{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"eacc32c5-f1b3-413a-8c32-76b9c5c3a1b7","name":"Export Contacts","request":{"name":"Export Contacts","description":{"content":"Start an async contact export to CSV or XLSX (202 Accepted).\n\n**Required Scopes:** `contacts:export`\n\nAccepts the SAME filter parameters as ``GET /contacts`` (search +\ncustom-field filter + list-subscription filter) so a filtered contact list\ncan be exported exactly as seen on screen. With no filters, ALL contacts are\nexported.\n\nThe file's column headers are exactly what ``POST /email-contacts/import``\nauto-detects (including a leading ``contact_id`` column and one flattened\n``custom.`` column per custom field), so the round-trip\n*export → edit in Excel → re-import* needs no manual column mapping.\n\nPoll ``poll_url`` until ``status == completed``, then fetch the file via\n``download_url`` (302 redirect to a short-lived signed URL).\n\nExports are recorded in the audit trail (they are a full-PII dump).","type":"text/plain"},"url":{"path":["api","v1","contacts","export"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"format","value":"csv","description":"Output file format"},{"disabled":false,"key":"search","value":"string","description":"Search by name, phone, email, or IDs (same as GET /contacts)"},{"disabled":false,"key":"include_live_chat","value":"false","description":"Include live chat contacts (same as GET /contacts)"},{"disabled":false,"key":"custom_field_id","value":"string","description":"custom_field_definitions.id used for filtering (same as GET /contacts)."},{"disabled":false,"key":"custom_field_value","value":"string","description":"Custom-field filter value (same semantics as GET /contacts)."},{"disabled":false,"key":"custom_field_value_to","value":"string","description":"Upper bound for custom_field_op='between' (same as GET /contacts)."},{"disabled":false,"key":"custom_field_op","value":"gte","description":"Custom-field comparison operator (same as GET /contacts)."},{"disabled":false,"key":"list_id","value":"string","description":"lists.id — filter by list subscription (same as GET /contacts)."},{"disabled":false,"key":"list_subscription_status","value":"unsubscribed","description":"Subscription status for list_id, default 'subscribed' (same semantics as GET /contacts). Requires list_id."},{"disabled":false,"key":"list_subscription_channel","value":"messenger","description":"Narrow the list filter to one subscription channel (same as GET /contacts). Requires list_id."},{"disabled":false,"key":"is_blocked","value":"true","description":"true = only blocked contacts, false = only unblocked (same as GET /contacts)."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"167faa6e-3cae-4f87-bce9-def5ae08d5d2","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","export"],"host":["{{baseUrl}}"],"query":[{"key":"format","value":"csv"},{"key":"search","value":"string"},{"key":"include_live_chat","value":"false"},{"key":"custom_field_id","value":"string"},{"key":"custom_field_value","value":"string"},{"key":"custom_field_value_to","value":"string"},{"key":"custom_field_op","value":"gte"},{"key":"list_id","value":"string"},{"key":"list_subscription_status","value":"unsubscribed"},{"key":"list_subscription_channel","value":"messenger"},{"key":"is_blocked","value":"true"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"job_id\": \"string\",\n \"message\": \"string\",\n \"poll_url\": \"string\",\n \"download_url\": \"string\",\n \"status\": \"queued\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"97adc916-a6cb-45e6-be91-62eedf484357","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","export"],"host":["{{baseUrl}}"],"query":[{"key":"format","value":"csv"},{"key":"search","value":"string"},{"key":"include_live_chat","value":"false"},{"key":"custom_field_id","value":"string"},{"key":"custom_field_value","value":"string"},{"key":"custom_field_value_to","value":"string"},{"key":"custom_field_op","value":"gte"},{"key":"list_id","value":"string"},{"key":"list_subscription_status","value":"unsubscribed"},{"key":"list_subscription_channel","value":"messenger"},{"key":"is_blocked","value":"true"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1bdc3668-8210-43aa-948b-804eb54de244","name":"Get Contact Export Status","request":{"name":"Get Contact Export Status","description":{"content":"Poll the status/progress of an async contact export job.\n\n**Required Scopes:** `contacts:export`\n\nWhen ``status`` is ``completed``, ``download_url`` points at the download\nendpoint (302 to a short-lived signed URL). ``failed`` carries\n``error_message``.","type":"text/plain"},"url":{"path":["api","v1","contacts","export",":job_id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4fde662d-bbbf-4a87-8a20-9b4de9abe255","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","export",":job_id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"job_id\": \"string\",\n \"status\": \"string\",\n \"message\": \"string\",\n \"progress_percent\": 0,\n \"total_items\": 0,\n \"processed_items\": 0,\n \"format\": \"string\",\n \"filename\": \"string\",\n \"total_contacts\": 7805,\n \"columns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"download_url\": \"string\",\n \"error_message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6ee1b9b4-2ac1-4194-9f9a-e12712f5dd3d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","export",":job_id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cdccaa4c-675a-4478-879d-a7a9b2f9df96","name":"Download Contact Export","request":{"name":"Download Contact Export","description":{"content":"Download a finished contact export (302 redirect to a signed URL).\n\n**Required Scopes:** `contacts:export`\n\nOnly the requesting tenant's own COMPLETED export jobs can be downloaded\n(404 unknown job, 403 foreign tenant, 409 not finished yet). A fresh\nshort-lived (60 min) signed Cloud Storage URL is minted on every call.\nWith ``?redirect=false`` the signed URL is returned as JSON\n``{\"download_url\": ..., \"filename\": ...}`` instead of a 302.","type":"text/plain"},"url":{"path":["api","v1","contacts","export",":job_id","download"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"redirect","value":"true","description":"true (default): 302 redirect to the signed URL. false: return {download_url, filename} JSON instead — needed by browser SPAs whose auth is Bearer-header-only (a top-level navigation cannot carry the header, and an XHR cannot follow the 302 to Cloud Storage because the bucket has no CORS rule)."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7f9ee56b-55fa-417c-b762-9b90fb770db4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts","export",":job_id","download"],"host":["{{baseUrl}}"],"query":[{"key":"redirect","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"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":"73fda451-f6d0-4061-ab92-85100bc4f647","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts","export",":job_id","download"],"host":["{{baseUrl}}"],"query":[{"key":"redirect","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6197f78-6042-4ba1-a212-d40ae297bcaa","name":"Get Contact Integrations","request":{"name":"Get Contact Integrations","description":{"content":"List the contact's external CRM / integration deep-links.\n\nAggregates links across every configured provider (HubSpot today; extensible\nto Salesforce/Shopify/etc.) so the frontend can render an \"Integrations\"\ncard linking straight to the contact's record in each system.\n\nReturns an empty ``items`` list (NOT 404) when the contact has no external\nlinks. 404 is only returned when the contact does not exist for this tenant.\n\n**Required Scopes:** `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"b47971fc-371f-4eaf-883a-d008208e6c6d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f4064a26-6ccb-46b4-bd9d-f6b07baa129b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"978c6dd5-44f6-44d2-8c3c-c8ed4fe394fa","name":"Get Contact","request":{"name":"Get Contact","description":{"content":"Get a specific contact with custom fields and tags.\n\n**Required Scopes:** `contacts:read`\n\nIf the requested ID is the UUID of a contact that has been merged into\nanother (i.e., it appears in `contact_aliases.old_contact_id`), the\nresponse returns the surviving contact, includes a `merged_from`\nobject describing the merge, and sets the `X-Merged-Into` response\nheader to the surviving contact's UUID.","type":"text/plain"},"url":{"path":["api","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"},"response":[{"id":"86db04ce-44ab-4f80-b479-63f859f08104","name":"Successful Response","originalRequest":{"url":{"path":["api","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"BfpoHEiJ@gndeRXyVYrQLCYsiNYBGwvtG.fjz\",\n \"updated_at\": \"string\",\n \"avatar_url\": \"string\",\n \"avatar_is_custom\": false,\n \"language\": \"string\",\n \"languages\": \"string\",\n \"birthday\": \"1956-10-05\",\n \"is_blocked\": false,\n \"is_archived\": false,\n \"blocked_inbound_count\": 0,\n \"last_blocked_inbound_at\": \"1953-09-05T20:02:23.697Z\",\n \"source\": \"string\",\n \"last_contacted_at\": \"1978-07-25T03:36:49.693Z\",\n \"custom_fields\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contact_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_count\": 3482,\n \"last_conversation_at\": \"1964-10-01T23:13:11.127Z\",\n \"potential_duplicates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"merged_from\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09391138-1886-41cb-8db4-46cfc02ff4d7","name":"Validation Error","originalRequest":{"url":{"path":["api","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"721c4920-7fb8-4275-a734-dda194a26947","name":"Update Contact","request":{"name":"Update Contact","description":{"content":"Update a contact\n\n`custom_fields` (optional) MERGES typed custom field values, keyed by\ncustom field definition ID (preferred) or field `key`: only the given\nfields are touched, `null` / `\"\"` / `[]` clears one. Every entry is\nvalidated against the field type BEFORE anything is written; any failure\nreturns 422 with one structured error per field (`code`: unknown_field,\nduplicate_field, invalid_type, invalid_format, not_an_option,\nout_of_range, too_long, too_many_fields) and nothing is changed. When\n`custom_fields` is sent, the response includes the contact's\n`custom_fields` map.\n\nSetting `phone` or `email` to a value another contact already has follows\nthe workspace's duplicate contact setting: `allow_duplicates` saves it on\nthis contact too; `dont_allow_duplicates` returns HTTP 409\n(`detail: \"duplicate_contact\"`, with the other contacts' ids) and nothing\nis changed; `auto_merge` keeps this contact's current value and updates\nthe other fields. Contacts are never merged by an update; use\n`POST /contacts/{contact_id}/merge`.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","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":"PUT","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"email\": \"john.smith@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Smith\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8e7a2763-ad01-45e4-8505-a52d46617300","name":"Successful Response","originalRequest":{"url":{"path":["api","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":"PUT","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"email\": \"john.smith@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Smith\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"BfpoHEiJ@gndeRXyVYrQLCYsiNYBGwvtG.fjz\",\n \"updated_at\": \"string\",\n \"avatar_url\": \"string\",\n \"avatar_is_custom\": false,\n \"language\": \"string\",\n \"languages\": \"string\",\n \"birthday\": \"1956-10-05\",\n \"is_blocked\": false,\n \"is_archived\": false,\n \"blocked_inbound_count\": 0,\n \"last_blocked_inbound_at\": \"1953-09-05T20:02:23.697Z\",\n \"source\": \"string\",\n \"last_contacted_at\": \"1978-07-25T03:36:49.693Z\",\n \"custom_fields\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contact_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_count\": 3482,\n \"last_conversation_at\": \"1964-10-01T23:13:11.127Z\",\n \"potential_duplicates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"merged_from\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a8519b9e-c46d-421b-bf48-b656692b0ac8","name":"Validation Error","originalRequest":{"url":{"path":["api","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":"PUT","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"email\": \"john.smith@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Smith\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d52247c0-fd5d-44ab-9a9e-08a954156104","name":"Partial Update Contact","request":{"name":"Partial Update Contact","description":{"content":"Partial update a contact\n\n`custom_fields` (optional) MERGES typed custom field values, keyed by\ncustom field definition ID (preferred) or field `key`: only the given\nfields are touched, `null` / `\"\"` / `[]` clears one. Every entry is\nvalidated against the field type BEFORE anything is written; any failure\nreturns 422 with one structured error per field (`code`: unknown_field,\nduplicate_field, invalid_type, invalid_format, not_an_option,\nout_of_range, too_long, too_many_fields) and nothing is changed. When\n`custom_fields` is sent, the response includes the contact's\n`custom_fields` map.\n\nSetting `phone` or `email` to a value another contact already has follows\nthe workspace's duplicate contact setting: `allow_duplicates` saves it on\nthis contact too; `dont_allow_duplicates` returns HTTP 409\n(`detail: \"duplicate_contact\"`, with the other contacts' ids) and nothing\nis changed; `auto_merge` keeps this contact's current value and updates\nthe other fields. Contacts are never merged by an update; use\n`POST /contacts/{contact_id}/merge`.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","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","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"email\": \"john.smith@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Smith\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c7111f77-9cf7-4821-9090-5c592b5df07b","name":"Successful Response","originalRequest":{"url":{"path":["api","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":"PATCH","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"email\": \"john.smith@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Smith\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"email\": \"BfpoHEiJ@gndeRXyVYrQLCYsiNYBGwvtG.fjz\",\n \"updated_at\": \"string\",\n \"avatar_url\": \"string\",\n \"avatar_is_custom\": false,\n \"language\": \"string\",\n \"languages\": \"string\",\n \"birthday\": \"1956-10-05\",\n \"is_blocked\": false,\n \"is_archived\": false,\n \"blocked_inbound_count\": 0,\n \"last_blocked_inbound_at\": \"1953-09-05T20:02:23.697Z\",\n \"source\": \"string\",\n \"last_contacted_at\": \"1978-07-25T03:36:49.693Z\",\n \"custom_fields\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contact_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_count\": 3482,\n \"last_conversation_at\": \"1964-10-01T23:13:11.127Z\",\n \"potential_duplicates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"merged_from\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4bd0b2a2-84d9-49a1-af85-1d710aa0e7d8","name":"Validation Error","originalRequest":{"url":{"path":["api","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":"PATCH","body":{"mode":"raw","raw":"{\n \"birthday\": \"1990-04-23\",\n \"email\": \"john.smith@example.com\",\n \"languages\": \"en,de\",\n \"name\": \"John Smith\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2c2c3977-7f22-4c47-a73c-0bb0a2ebafbe","name":"Delete Contact","request":{"name":"Delete Contact","description":{"content":"Delete a contact and all related data.\n\nPerforms GDPR-compliant deletion (full cascade):\n- All PII is removed (subscriptions, custom fields, tags, campaign data)\n- The contact's conversations AND their messages, attachments (incl. stored\n files), reactions, email transcripts, live-chat sessions and flow runs are\n permanently deleted — nothing connected to the customer is retained\n- Billing records are preserved for invoicing\n\n**Required Scopes:** `contacts:delete`","type":"text/plain"},"url":{"path":["api","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"},"response":[{"id":"15b4d609-4d85-46ea-ab84-f96657e13135","name":"Successful Response","originalRequest":{"url":{"path":["api","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"details\": {\n \"conversations_anonymized\": 2,\n \"custom_fields_removed\": 5,\n \"subscriptions_removed\": 3\n },\n \"message\": \"Contact deleted successfully\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"701f1cf8-b040-469b-b9e8-5293bd656b9f","name":"Validation Error","originalRequest":{"url":{"path":["api","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d5521b56-5b17-4c89-bbb8-1f634d7d20f7","name":"Preview Merge Contacts","request":{"name":"Preview Merge Contacts","description":{"content":"Preview what merging contacts would do to running flows. Nothing is changed.\n\n**Required Scopes:** `contacts:update`\n\nTakes the same body as `POST /contacts/{contact_id}/merge` and picks the\nsurviving contact the same way (oldest unless `primary_override: true`).\n\nRunning flows of merged contacts keep running on the surviving contact. A\nflow run is only stopped when the surviving contact is already running the\nsame flow, or when several merged contacts run the same flow (the most\nrecently started one keeps running). The response lists how many runs\nwould be stopped per flow.\n\nReturns 404 if any contact does not exist in this workspace, 422 if the\nrequest names no contact to merge.","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","merge","preview"],"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","body":{"mode":"raw","raw":"{\n \"secondary_ids\": [\n \"string\"\n ],\n \"primary_override\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5ff2f744-5f2e-474f-841e-07b87a97f50c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","merge","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"secondary_ids\": [\n \"string\"\n ],\n \"primary_override\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"primary_contact_id\": \"string\",\n \"flow_runs_to_cancel\": 9425,\n \"flow_runs_to_keep\": 5724,\n \"cancelled_flows\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"efe0d89e-104a-4d3d-a60f-41857820efbd","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","merge","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"secondary_ids\": [\n \"string\"\n ],\n \"primary_override\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3e06fb38-8829-4b95-97c4-90235a761c8e","name":"Merge Contacts","request":{"name":"Merge Contacts","description":{"content":"Manually merge one or more contacts into the contact at `{contact_id}`.\n\n**Required Scopes:** `contacts:update`\n\nBy default the OLDEST contact in the set (`{contact_id}` plus the\n`secondary_ids`) is used as primary. Pass `primary_override: true` to\nforce `{contact_id}` as primary even if a secondary is older.\n\nAll conversations, messages, notes, custom field values, tags,\nsubscriptions, and contact methods are migrated to the primary. The\nsecondary contact rows are hard-deleted; their UUIDs continue to\nresolve to the primary via `contact_aliases`.","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","merge"],"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","body":{"mode":"raw","raw":"{\n \"secondary_ids\": [\n \"string\"\n ],\n \"primary_override\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"66eb83d4-83a4-4f5e-b42b-6d7fc120b576","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","merge"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"secondary_ids\": [\n \"string\"\n ],\n \"primary_override\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"contact\": {\n \"created_at\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"avatar_is_custom\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"languages\": {\n \"value\": \"\"\n },\n \"birthday\": {\n \"value\": \"\"\n },\n \"is_blocked\": {\n \"value\": \"\"\n },\n \"is_archived\": {\n \"value\": \"\"\n },\n \"blocked_inbound_count\": {\n \"value\": \"\"\n },\n \"last_blocked_inbound_at\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"last_contacted_at\": {\n \"value\": \"\"\n },\n \"custom_fields\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"contact_methods\": {\n \"value\": \"\"\n },\n \"subscriptions\": {\n \"value\": \"\"\n },\n \"conversation_count\": {\n \"value\": \"\"\n },\n \"last_conversation_at\": {\n \"value\": \"\"\n },\n \"potential_duplicates\": {\n \"value\": \"\"\n },\n \"merged_from\": {\n \"value\": \"\"\n }\n },\n \"merged_count\": 2877\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5eca8f74-fa3c-42de-a50e-b995cd224840","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","merge"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"secondary_ids\": [\n \"string\"\n ],\n \"primary_override\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8132b90c-5b9d-4891-9238-6b6473ade553","name":"Get Contact Lists","request":{"name":"Get Contact Lists","description":{"content":"Get all list memberships/subscriptions for a contact.\n\n**Required Scopes:** `contacts:read`\n\nReturns all lists that the contact is subscribed to via the unified subscription system,\nincluding channel-specific information and subscription status.\n\nFor newsletter lists, the same contact can be subscribed via multiple channels,\nso there will be separate entries for each channel subscription.","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","lists"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"c287b228-6ec8-45bf-95fc-aa670450fb3d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","lists"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"contact_id\": \"c123\",\n \"contact_name\": \"John Doe\",\n \"lists\": [\n {\n \"channel_type\": \"email\",\n \"list_id\": \"list1\",\n \"list_name\": \"Newsletter\",\n \"list_type\": \"newsletter\",\n \"membership_id\": \"sub123\",\n \"subscribed_at\": \"2025-01-15T10:30:00Z\",\n \"subscription_status\": \"subscribed\"\n }\n ],\n \"total_memberships\": 2\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"34ed19a5-1b0f-4f95-8226-d4dfb1359c39","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","lists"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"710bb1be-b4e5-4dc0-a94a-6386ef73d605","name":"Get Contact Link Activity","request":{"name":"Get Contact Link Activity","description":{"content":"Get all link click activity for a specific contact.\n\nReturns all tracked links the contact has clicked, including:\n- Total click count\n- Unique links clicked\n- Device breakdown (desktop, mobile, tablet, other)\n- Recent click events with link details\n- Top 5 most clicked links by this contact\n\n**Required Scopes:** `contacts:read`\n\nArgs:\n contact_id: The contact's UUID\n limit: Maximum number of recent clicks to return (default: 50, max: 200)","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","link-activity"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ab2a5997-c3cb-444f-b31a-c8144338cfe3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","link-activity"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"total_clicks\": 1039,\n \"unique_links\": 3990,\n \"device_breakdown\": {\n \"key_0\": 6447,\n \"key_1\": 2860\n },\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd20afa7-e8da-4543-aebd-8e415a55564a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","link-activity"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b724f4ae-c720-4766-9349-35d35e05fa5d","name":"Get Contact Available Channels","request":{"name":"Get Contact Available Channels","description":{"content":"Get list of channels available to reach a contact.\n\nReturns all channels the tenant has configured that the contact\nhas identifiers for, along with channel-specific status:\n\n- **WhatsApp**: Includes window_status with 24h messaging window info\n- **Email/Telegram/Messenger/Instagram**: Shows as available or unavailable\n\nWhen `for_user_id` is not provided, the current user's internal ID is\nautomatically resolved from the auth token and used for mailbox access\nfiltering.\n\n**Required Scopes:** `contacts:read`\n\n**Response:**\n```json\n{\n \"contact_id\": \"uuid\",\n \"channels\": [\n {\n \"channel_id\": \"uuid\",\n \"channel_type\": \"whatsapp\",\n \"channel_name\": \"WhatsApp Business\",\n \"identifier\": \"+1234567890\",\n \"status\": \"available\" | \"template_required\" | \"unavailable\",\n \"window_status\": {\n \"in_window\": false,\n \"requires_template\": true,\n \"last_customer_message_at\": \"2026-01-14T10:00:00Z\",\n \"window_end_at\": \"2026-01-15T10:00:00Z\"\n }\n },\n {\n \"channel_id\": \"uuid\",\n \"channel_type\": \"email\",\n \"channel_name\": \"Support Email\",\n \"identifier\": \"john@example.com\",\n \"status\": \"available\"\n }\n ]\n}\n```","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","available-channels"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"for_user_id","value":"string","description":"Filter email mailboxes by user access (internal user UUID). If not provided, automatically resolved from the authenticated user."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"902c4adb-a086-409d-b835-a74ff31a0dfc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","available-channels"],"host":["{{baseUrl}}"],"query":[{"key":"for_user_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"channels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"648a0081-c0fc-4897-8b50-175f3f535035","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","available-channels"],"host":["{{baseUrl}}"],"query":[{"key":"for_user_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a6a72270-f476-4921-9384-fd89a664116d","name":"Block Contact","request":{"name":"Block Contact","description":{"content":"Block a contact across all channels.\n\nBlocks the contact and its identifiers. Incoming messages from any of the\ncontact's phone numbers, email addresses and channel ids are dropped (and\ncounted in ``blocked_inbound_count``) and outgoing sends are refused with\n409 ``CONTACT_BLOCKED`` while the contact is blocked. Verified and\nchannel-native identifiers (the channel account the contact messaged\nfrom, verified email addresses) stay blocked even if the contact is\ndeleted and later re-created; unverified, manually entered details are\ncovered only while the contact exists and is blocked. Idempotent.\n\nCustom-Inbox restricted members can only block contacts they can reach\n(otherwise 404).\n\nFires ``contact.updated`` when the contact was not already blocked.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","block"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"925f7e23-4826-461f-9c28-699983488fe8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","block"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b06d3c8-0e8b-464d-8adf-0934d2f654a7","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","block"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a566c9a1-fd87-4554-a009-d9cb29407cf9","name":"Unblock Contact","request":{"name":"Unblock Contact","description":{"content":"Unblock a contact across all channels.\n\nClears the contact block and removes the blocks on all of its identifiers\n(every channel), including its email addresses on the email sender block\nlist. Idempotent.\n\nCustom-Inbox restricted members can only unblock contacts they can reach\n(otherwise 404).\n\nFires ``contact.updated`` when the contact was blocked.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","unblock"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"801194d0-43a8-43bc-92bd-54afbe4a7a6a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","unblock"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d72225ae-5eea-4b8a-bfbc-0e70dd4cab74","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","unblock"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"018f755f-51e4-4f7f-85e6-61bc4f11977c","name":"Upload Contact Avatar","request":{"name":"Upload Contact Avatar","description":{"content":"Upload a profile picture for a contact.\n\nThe image is downscaled to 256px and stored in our own bucket, then served\nfrom the permanent `/api/v1/public/avatar/...` proxy. A manually uploaded\navatar is marked `avatar_is_custom` and is NEVER overwritten by the\nchannel's own profile picture — remove it (DELETE this endpoint) to let\nplatform syncing resume.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) "}]}},"response":[{"id":"0e07ae5a-3d72-4d97-afb4-b1409e61cec0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"contact_id\": \"string\",\n \"success\": true,\n \"avatar_url\": \"string\",\n \"avatar_is_custom\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e6a40fab-99a7-40f8-a562-8a4a253df263","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b136e3f3-d011-4560-8cc9-45d351110d21","name":"Delete Contact Avatar","request":{"name":"Delete Contact Avatar","description":{"content":"Remove a contact's profile picture.\n\nClears the stored image and re-opens platform syncing: the next inbound\nmessage from this contact re-mirrors whatever picture the channel currently\nreports. Until then the UI shows the contact's initials.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"755f6be8-7ea5-4193-b929-b5c7c2566ac2","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"contact_id\": \"string\",\n \"success\": true,\n \"avatar_url\": \"string\",\n \"avatar_is_custom\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5ae9596b-755e-4a3e-8d0d-7cd1757e489d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fe034b62-4753-4db7-8d9f-c668fcec8854","name":"List Contact Methods","request":{"name":"List Contact Methods","description":{"content":"List all contact methods for a contact.\n\nReturns all external identifiers (phone numbers, emails, platform IDs)\nassociated with this contact, optionally filtered by method type.\n\nBy default, **technical** method types (``LIVE_CHAT`` — the per-device\nvisitor cookie UUID used for fast returning-visitor lookup and flow\nengine channel resolution) are EXCLUDED from the response so the\ncontact-detail UI doesn't show implementation-detail rows. Pass\n``include_technical=true`` to surface them. An explicit\n``method_type=live_chat`` filter overrides this and always returns the\nmatching rows.\n\n**Required Scopes:** `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","methods"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"method_type","value":"string","description":"Filter by method type (phone, email, whatsapp_id, whatsapp_bsuid, telegram_id, messenger_id, instagram_id)"},{"disabled":false,"key":"include_technical","value":"false","description":"Include technical/internal method types in the response. Defaults to false — LIVE_CHAT (per-device visitor cookie UUID) and any future 'technical' types are hidden from the contact detail UI by default. Set true to include them (e.g. for admin tooling or debugging)."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4424faf8-798b-4bf8-8192-1189f2eacec8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods"],"host":["{{baseUrl}}"],"query":[{"key":"method_type","value":"string"},{"key":"include_technical","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"contact_id\": {\n \"value\": \"\"\n },\n \"method_type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"channel_id\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"phone_type\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"email_status\": {\n \"value\": \"\"\n },\n \"bounce_count\": {\n \"value\": \"\"\n },\n \"last_bounce_at\": {\n \"value\": \"\"\n },\n \"last_used_at\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"verified\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n },\n \"verified_source\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"contact_id\": {\n \"value\": \"\"\n },\n \"method_type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"channel_id\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"phone_type\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"email_status\": {\n \"value\": \"\"\n },\n \"bounce_count\": {\n \"value\": \"\"\n },\n \"last_bounce_at\": {\n \"value\": \"\"\n },\n \"last_used_at\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"verified\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n },\n \"verified_source\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"eede756a-b7fd-4135-91d4-7944a48196fc","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods"],"host":["{{baseUrl}}"],"query":[{"key":"method_type","value":"string"},{"key":"include_technical","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5db8672c-501b-41f8-9eb3-51e0ea6bab09","name":"Create Contact Method","request":{"name":"Create Contact Method","description":{"content":"Add a new contact method to a contact.\n\nCreates a new external identifier (phone, email, platform ID) linked to\nthis contact. For page-scoped types (messenger_id, instagram_id),\na channel_id is required.\n\nIf the proposed method's `(method_type, value, channel_id)` already\nbelongs to a *different* contact, this endpoint NEVER silently merges.\nInstead it returns HTTP 409 with a machine-readable\n`detail: \"duplicate_contact_method\"` body so the frontend can prompt the\nuser to either merge the two contacts or open the other contact.\n\nThis is true REGARDLESS of the tenant's `duplicate_contact_mode` default\n(including `auto_merge`): an interactive method-add must never swallow an\nunrelated contact. To actually merge, the client must make an explicit,\nuser-confirmed call to `POST /contacts/{contact_id}/merge` (which carries\nits own `contacts:update` scope check and uses oldest-wins semantics).\n\nThe optional per-request `duplicate_mode` body field still tunes the\nresponse shape on conflict, but none of the modes auto-merge here:\n\n- `allow_duplicates`: returns the existing method on the OTHER contact\n unchanged (the unique constraint prevents duplicate ownership).\n- `dont_allow_duplicates` / `auto_merge` (default) / omitted: returns the\n 409 `duplicate_contact_method` conflict described above.\n\nAdding a method that already exists on the SAME contact is idempotent.\n\n`verified: true` marks the identifier as verified (`verified_source`\n`api`); on an existing method of this contact it upgrades it. Not allowed\nfor OAuth apps (403 `verification_not_allowed`).\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","methods"],"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","body":{"mode":"raw","raw":"{\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"channel_id\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"verified\": false,\n \"duplicate_mode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"63133585-44f5-437d-bab3-cc405d2057f6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"channel_id\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"verified\": false,\n \"duplicate_mode\": {\n \"value\": \"\"\n }\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 \"method_type\": \"string\",\n \"value\": \"string\",\n \"channel_id\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"email_status\": \"string\",\n \"bounce_count\": 0,\n \"last_bounce_at\": \"1978-09-11T01:36:27.178Z\",\n \"last_used_at\": \"1963-09-23T16:06:06.571Z\",\n \"created_at\": \"2012-06-05T07:15:18.652Z\",\n \"verified\": false,\n \"verified_at\": \"1970-08-05T16:04:45.677Z\",\n \"verified_source\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c259eee9-8f27-41cb-9721-bad926b06e8f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"channel_id\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"verified\": false,\n \"duplicate_mode\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"26bdba59-edec-4c88-8c74-841799a44a3c","name":"Update Contact Method","request":{"name":"Update Contact Method","description":{"content":"Update a contact method (value, display_name, is_primary, verified).\n\n`verified: true` marks the identifier as verified (`verified_source`\n`api`), `false` clears it; omit it to keep the current state. Changing\n`value` without `verified: true` resets the method to unverified (a new\nvalue is a new claim). Changing `verified` is not allowed for OAuth apps\n(403 `verification_not_allowed`).\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"verified\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1b23b76f-4e01-428b-9854-74ab37269629","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"verified\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"channel_id\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"email_status\": \"string\",\n \"bounce_count\": 0,\n \"last_bounce_at\": \"1978-09-11T01:36:27.178Z\",\n \"last_used_at\": \"1963-09-23T16:06:06.571Z\",\n \"created_at\": \"2012-06-05T07:15:18.652Z\",\n \"verified\": false,\n \"verified_at\": \"1970-08-05T16:04:45.677Z\",\n \"verified_source\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"55e70554-ad8c-4d04-8287-4747c4cc49bc","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"verified\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b23a49c5-a499-463f-ae1a-cf77bb8f6e52","name":"Delete Contact Method","request":{"name":"Delete Contact Method","description":{"content":"Delete a contact method.\n\nIf the deleted method was primary, the next oldest method of the same type\nis automatically promoted. Denormalized fields (phone, email) on the contact\nare updated accordingly.\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"83c58cb3-65bf-4cb1-b75d-22292fc78e49","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"56d3f41c-8d7c-437b-9523-d33bfeef8bf1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"821702ee-5fdc-458d-89a7-08dc7b106195","name":"Update Contact Method Verification","request":{"name":"Update Contact Method Verification","description":{"content":"Mark a contact method as verified or unverified.\n\nVerified identifiers are trusted by AI agents and by automatic duplicate\nhandling; unverified ones are treated as claims. Sets\n`verified_source` to `manual` and records who changed it. Marking a\nmethod verified also confirms any pending \"typed by a live chat visitor\"\nrecord for that identifier. Unmarking keeps that history.\n\nNot available to OAuth apps or embedded views (403\n`verification_not_allowed`).\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"verified\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fd5856bf-688b-4cbd-bfa0-bbfcf346a58c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"verified\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"contact_id\": \"string\",\n \"method_type\": \"string\",\n \"value\": \"string\",\n \"channel_id\": \"string\",\n \"display_name\": \"string\",\n \"phone_type\": \"string\",\n \"is_primary\": false,\n \"email_status\": \"string\",\n \"bounce_count\": 0,\n \"last_bounce_at\": \"1978-09-11T01:36:27.178Z\",\n \"last_used_at\": \"1963-09-23T16:06:06.571Z\",\n \"created_at\": \"2012-06-05T07:15:18.652Z\",\n \"verified\": false,\n \"verified_at\": \"1970-08-05T16:04:45.677Z\",\n \"verified_source\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb115810-7f93-4a88-849c-1a442ea14985","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","methods",":method_id","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"method_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"verified\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9369e117-23d2-4adb-82d4-35969c08a67a","name":"List Contact History","request":{"name":"List Contact History","description":{"content":"Unified timeline of conversations, flow runs, flow-sent messages,\nscheduled sends, all messages, and AI ticket summaries for a single\ncontact.\n\nPowers the contact-detail \"History\" card (Activity + Messages view\nmodes). Returns a single keyset-paginated, time-descending stream\nmerged from multiple SHARD tables — see\n:class:`app.services.contact_history_service.ContactHistoryService`\nfor the per-source query strategy and batch lookups.\n\nEvent types:\n\n* ``conversation`` — one row per conversation (Activity mode).\n* ``flow_run`` — one row per flow run (Activity mode).\n* ``flow_message`` — flow-attributed messages only (legacy).\n* ``message`` — every message for the contact regardless of\n flow attribution (Messages mode).\n* ``scheduler`` — pending or fired scheduled sends (reminders,\n recurring sends, segment-blast materializations).\n* ``ticket_summary`` — AI conversation summaries persisted as editable\n KB documents (``knowledge_base_documents`` filtered by the indexed\n ``contact_id`` column, ``document_type='ticket_summary'``). The\n ``document_id`` deep-links to the KB editor / raw GET-PUT endpoints.\n\n**Required Scopes:** `contacts:read` AND `flows:read` AND `conversations:read` AND `scheduler:read` AND `knowledge_base:read`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","history"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"types","value":"string","description":"Filter by event_type. Repeatable. Allowed values: `conversation`, `flow_run`, `flow_message`, `message`, `scheduler`, `ticket_summary`. Omit to include all known types (current FE behavior). Use `message` for the flat all-messages stream that powers the Messages view mode; use `scheduler` for pending/fired scheduled sends; use `ticket_summary` for the contact's AI conversation summaries (editable KB documents)."},{"disabled":false,"key":"types","value":"string","description":"Filter by event_type. Repeatable. Allowed values: `conversation`, `flow_run`, `flow_message`, `message`, `scheduler`, `ticket_summary`. Omit to include all known types (current FE behavior). Use `message` for the flat all-messages stream that powers the Messages view mode; use `scheduler` for pending/fired scheduled sends; use `ticket_summary` for the contact's AI conversation summaries (editable KB documents)."},{"disabled":false,"key":"date_from","value":"string","description":"ISO8601 lower bound on each source's sort column."},{"disabled":false,"key":"date_to","value":"string","description":"ISO8601 upper bound on each source's sort column."},{"disabled":false,"key":"q","value":"string","description":"Substring filter (LIKE %q%). Ignored when shorter than 2 chars. Matches conversation.subject + last message text, flow.name, and message.text depending on the event_type."},{"disabled":false,"key":"cursor","value":"string","description":"Opaque cursor from a previous page's `next_cursor`."},{"disabled":false,"key":"page_size","value":"50","description":"Page size (default 50, max 100)."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a898e28a-0b1c-48cf-b214-0e79d41582eb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","history"],"host":["{{baseUrl}}"],"query":[{"key":"types","value":"string"},{"key":"types","value":"string"},{"key":"date_from","value":"string"},{"key":"date_to","value":"string"},{"key":"q","value":"string"},{"key":"cursor","value":"string"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce04f4ed-ca19-47dc-a87c-8d178baf9d6a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","history"],"host":["{{baseUrl}}"],"query":[{"key":"types","value":"string"},{"key":"types","value":"string"},{"key":"date_from","value":"string"},{"key":"date_to","value":"string"},{"key":"q","value":"string"},{"key":"cursor","value":"string"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6ebb1b9d-51fa-4a70-b768-b63cbb4755ed","name":"List Contact Attachments","request":{"name":"List Contact Attachments","description":{"content":"Keyset-paginated, newest-first list of ALL media exchanged with a contact\nacross every one of their conversations.\n\nPowers the WhatsApp-profile-style media gallery on the contact-detail page.\nCovers every media category — images, video, audio, voice notes, AND\ndocuments/files (nothing is filtered out). Each item carries a short-lived\n(60 min) signed VIEW url into the private media bucket plus, when available,\na signed thumbnail url — never raw bucket urls.\n\nSources: a message's primary attachment, interactive/template header\nmedia, and email file attachments (`source=\"email\"`, one item per file,\n`message_id` = the email's message). Inline email images (signature logos,\n`cid:` parts) are never listed; emails received/sent before email files\nwere linked to generic attachments are not shown. Every item carries\n`source` (`message` | `email`).\n\nPagination is keyed on MESSAGES, ordered DESC by `(created_at,\nmessage_id)`: `page_size` bounds the messages per page, so `len(items)`\nmay exceed `page_size` when an email carries several files (all files of\none email always arrive on the same page). `next_cursor` is the opaque\ncursor of the last returned message when `has_more` is true.\n\nVisibility & tenancy: every query is filtered by `tenant_id`; the contact\nmust belong to the tenant (404 otherwise).\n\n**Required Scopes:** `contacts:read` AND `messages:read`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","attachments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"cursor","value":"string","description":"Opaque cursor from a previous page's `next_cursor`"},{"disabled":false,"key":"page_size","value":"30","description":"Page size (default 30, max 100)"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7b18f106-ab8e-4340-8300-da23a91b026e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","attachments"],"host":["{{baseUrl}}"],"query":[{"key":"cursor","value":"string"},{"key":"page_size","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4cafd0bf-d52a-40c1-9ae5-8d53eb355c86","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","attachments"],"host":["{{baseUrl}}"],"query":[{"key":"cursor","value":"string"},{"key":"page_size","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"16817e81-da7c-4966-8345-12ca7f8282c7","name":"List Contact Channel Messages","request":{"name":"List Contact Channel Messages","description":{"content":"Keyset-paginated stream of a contact's messages on a SINGLE channel,\ndrawn from PRIOR conversations only.\n\nReturns this contact's messages on `channel_id` from conversations OTHER\nthan `before_conversation_id` whose parent conversation was created BEFORE\nthe `before_conversation_id` conversation (i.e. earlier threads on the same\nchannel). Newest-first, keyset-paginated on `(created_at, id)`.\n\nReuses the standard `MessageResponse` item shape (each item carries its own\n`conversation_id`) so the frontend renders these with the existing message\nbubble — no new bubble type is needed.\n\nVisibility & tenancy: the contact must belong to the tenant (404 otherwise);\n`before_conversation_id` must belong to the tenant AND this contact AND this\n`channel_id` (404 otherwise); and the requested `channel_id` must be visible\nto the caller via contact-history visibility (404 otherwise).\n\n**Required Scopes:** `contacts:read` AND `messages:read`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","messages"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"channel_id","value":"string","description":"(Required) Channel to scope the timeline to"},{"disabled":false,"key":"before_conversation_id","value":"string","description":"(Required) The currently-open conversation; only PRIOR conversations are included"},{"disabled":false,"key":"cursor","value":"string","description":"Opaque cursor from a previous page's `next_cursor`"},{"disabled":false,"key":"page_size","value":"5","description":"Page size (default 5, max 50)"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"2de468a8-72f3-44d6-b90f-1af80ecb1fc7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","messages"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"before_conversation_id","value":"string"},{"key":"cursor","value":"string"},{"key":"page_size","value":"5"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\",\n \"has_more\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"222dbcd6-7616-4369-bb71-41f51a7ea348","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","messages"],"host":["{{baseUrl}}"],"query":[{"key":"channel_id","value":"string"},{"key":"before_conversation_id","value":"string"},{"key":"cursor","value":"string"},{"key":"page_size","value":"5"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5cd61f94-fe7e-4cd8-adfa-9558216ea521","name":"List Conversation Contact Merge Suggestions","request":{"name":"List Conversation Contact Merge Suggestions","description":{"content":"List pending contact merge suggestions for a conversation's contact.\n\n**Required Scopes:** `conversations:read`\n\nA suggestion is created when a live chat visitor enters an email address\nor phone number (or the website passes a contact ID) that matches an\nexisting contact. The conversation is never linked to that contact\nautomatically: confirm the suggestion to merge the visitor into the\nexisting contact, or dismiss it to keep them separate.\n\n`matched_value` is what the visitor entered and is not verified.\n\nSuggestions are listed on both sides: in the visitor's conversations and in\nevery conversation of the matched contact. `perspective` says which side\nthis conversation's contact is on (`source` = the visitor, `target` = the\nmatched contact). Confirming or dismissing from either side resolves the\nsuggestion for both.\n\nOn the matched contact's side, `conversation_id` and `source_contact` are\nnull when you cannot open the visitor's conversation (for example because\nof your inbox access). You can still confirm or dismiss the suggestion.","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","contact-merge-suggestions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"79a6718c-176c-4997-b944-0094abbc4806","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","contact-merge-suggestions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2bc76ef-eca2-41e7-abfd-a36b3992b0e6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","contact-merge-suggestions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b080b20e-a72d-4fd3-b36f-f04980d0e8b5","name":"Confirm Contact Merge Suggestion","request":{"name":"Confirm Contact Merge Suggestion","description":{"content":"Confirm a contact merge suggestion: merge the visitor contact into the matched contact.\n\n**Required Scopes:** `contacts:update`\n\nThe request body must be `{\"confirmed\": true}`; anything else returns 422.\nThe unverified contact (`source_contact`) is merged into the existing\ncontact (`target_contact`), exactly like `POST /contacts/{contact_id}/merge`:\nconversations, messages, notes, tags and contact methods move to the\nsurviving contact. This cannot be undone.\n\nReturns 404 when the suggestion does not exist and 409 with\n`error_code: suggestion_not_pending` when it was already confirmed or\ndismissed. `conversation_id` and `source_contact` are null in the response\nwhen you cannot open the visitor's conversation.","type":"text/plain"},"url":{"path":["api","v1","contact-merge-suggestions",":suggestion_id","confirm"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"confirmed\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9fa3fa0f-e9d5-447f-9781-02921267b75b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contact-merge-suggestions",":suggestion_id","confirm"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"confirmed\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"status\": \"string\",\n \"origin\": \"string\",\n \"created_at\": \"string\",\n \"matched_method_type\": \"string\",\n \"matched_value\": \"string\",\n \"conversation_id\": \"string\",\n \"resolved_at\": \"string\",\n \"resolved_by_user_id\": \"string\",\n \"verified\": false,\n \"source_contact\": {\n \"value\": \"\"\n },\n \"target_contact\": {\n \"value\": \"\"\n },\n \"survivor_contact_id\": \"string\",\n \"perspective\": \"source\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f8aaeb6e-e971-4a3e-8243-92aa0692abbf","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contact-merge-suggestions",":suggestion_id","confirm"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"confirmed\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dfd6c177-1df3-45ef-9a0e-dd348c8289e4","name":"Dismiss Contact Merge Suggestion","request":{"name":"Dismiss Contact Merge Suggestion","description":{"content":"Dismiss a contact merge suggestion and keep both contacts separate.\n\n**Required Scopes:** `contacts:update`\n\nA dismissed pair is not suggested again. Returns 404 when the suggestion\ndoes not exist and 409 with `error_code: suggestion_not_pending` when it\nwas already confirmed or dismissed. `conversation_id` and `source_contact`\nare null in the response when you cannot open the visitor's conversation.","type":"text/plain"},"url":{"path":["api","v1","contact-merge-suggestions",":suggestion_id","dismiss"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"4b4985d0-bc8f-4213-a649-4ac7e139ba25","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contact-merge-suggestions",":suggestion_id","dismiss"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"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 \"origin\": \"string\",\n \"created_at\": \"string\",\n \"matched_method_type\": \"string\",\n \"matched_value\": \"string\",\n \"conversation_id\": \"string\",\n \"resolved_at\": \"string\",\n \"resolved_by_user_id\": \"string\",\n \"verified\": false,\n \"source_contact\": {\n \"value\": \"\"\n },\n \"target_contact\": {\n \"value\": \"\"\n },\n \"survivor_contact_id\": \"string\",\n \"perspective\": \"source\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1ee03299-e0fd-48d3-bf9f-0cb389818aa4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contact-merge-suggestions",":suggestion_id","dismiss"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"suggestion_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8659e76e-c990-4ce1-87f5-8f3a8871bf6a","name":"Conversations","description":{"content":"Manage customer conversations across all channels. Assign agents, close/reopen, and track conversation state.","type":"text/plain"},"item":[{"id":"9d14ffb7-c972-4d2b-bf6f-a42d91d47eb5","name":"Create Conversation","request":{"name":"Create Conversation","description":{"content":"Create a new conversation\n\n**Required Scopes:** `conversations:create`","type":"text/plain"},"url":{"path":["api","v1","conversations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"ch1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"contact_id\": \"c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"contact_method_id\": \"cm1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"subject\": \"Support request\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a7aeffa3-d1d8-4767-b68b-1728add815a0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"ch1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"contact_id\": \"c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"contact_method_id\": \"cm1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"subject\": \"Support request\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8a9d0743-764f-482b-b90a-909c02fe6e08","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"ch1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"contact_id\": \"c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"contact_method_id\": \"cm1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"subject\": \"Support request\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"34315765-2874-4acd-a4c9-3d23bb14a8c2","name":"List Conversations","request":{"name":"List Conversations","description":{"content":"List all conversations for the tenant with pagination.\n\n**Required Scopes:** `conversations:read`\n\nRespects multi-agent mode setting:\n- Multi-agent mode: Shows all conversations\n- Single-agent mode: Shows only assigned + unassigned (agents only)\n\n**Response format:**\n```json\n{\n \"items\": [...],\n \"pagination\": {\n \"total\": 150,\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 8,\n \"has_next\": true,\n \"has_prev\": false\n }\n}\n```\n\nQuery parameters:\n- page: Page number (1-indexed, default: 1)\n- page_size: Items per page (1-100, default: 20)\n- status: Filter by conversation status (open, closed)\n- assigned_to: Filter by assignment (\"me\", \"unassigned\", or specific user_id)\n- needs_reply: Filter for conversations needing a reply (true/false)\n- filter: Alias for common filters (\"unanswered\" = needs_reply=true)\n- contact_id: Filter by specific contact ID\n- search: Search by contact name, phone, email, or conversation subject;\n plus message text (last 90 days, terms of 3+ characters) when the\n `message_search` feature is enabled for the workspace\n- channel_type: Filter by channel type (whatsapp, telegram, sms, email, messenger, instagram, live_chat)\n- tag_id: Repeatable tag id; matches a tag on the conversation OR its\n contact. Unknown / other-workspace ids -> 422\n- tag_mode: `any` (default) or `all` — how several `tag_id` values combine","type":"text/plain"},"url":{"path":["api","v1","conversations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"},{"disabled":false,"key":"status","value":"string","description":"Filter by tab/status: 'open' (excludes snoozed), 'snoozed', 'closed'"},{"disabled":false,"key":"assigned_to","value":"string","description":"Filter by assignment: 'me', 'unassigned', 'me_and_unassigned', or user_id"},{"disabled":false,"key":"needs_reply","value":"true","description":"Filter for conversations needing a reply"},{"disabled":false,"key":"filter","value":"string","description":"Alias: 'unanswered' sets needs_reply=True"},{"disabled":false,"key":"contact_id","value":"string","description":"Filter by contact ID"},{"disabled":false,"key":"search","value":"string","description":"Search by contact name, phone, email, or subject. When the `message_search` feature is enabled for the workspace (see GET /tenants/features) and the term has at least 3 characters, message text from the last 90 days is searched too (OR)."},{"disabled":false,"key":"inbox_id","value":"string","description":"Filter to conversations in this custom inbox"},{"disabled":false,"key":"channel_type","value":"string","description":"Filter by channel type (e.g. whatsapp, telegram, sms, email, messenger, instagram, live_chat)"},{"disabled":false,"key":"tag_id","value":"string","description":"tags.id — filter to conversations carrying the tag on the conversation OR on its contact. Repeatable (?tag_id=a&tag_id=b, max 20); combine with `tag_mode`. Each id must belong to the workspace (422 if not). AND-ed with all other filters."},{"disabled":false,"key":"tag_id","value":"string","description":"tags.id — filter to conversations carrying the tag on the conversation OR on its contact. Repeatable (?tag_id=a&tag_id=b, max 20); combine with `tag_mode`. Each id must belong to the workspace (422 if not). AND-ed with all other filters."},{"disabled":false,"key":"tag_mode","value":"any","description":"How several `tag_id` values combine: `any` (default) = at least one of the tags, `all` = every tag."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a36b1af7-1258-475d-947e-ee152e7f54b5","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"status","value":"string"},{"key":"assigned_to","value":"string"},{"key":"needs_reply","value":"true"},{"key":"filter","value":"string"},{"key":"contact_id","value":"string"},{"key":"search","value":"string"},{"key":"inbox_id","value":"string"},{"key":"channel_type","value":"string"},{"key":"tag_id","value":"string"},{"key":"tag_id","value":"string"},{"key":"tag_mode","value":"any"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6a58b459-0d3d-48d9-8f0b-430089bbef2a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"status","value":"string"},{"key":"assigned_to","value":"string"},{"key":"needs_reply","value":"true"},{"key":"filter","value":"string"},{"key":"contact_id","value":"string"},{"key":"search","value":"string"},{"key":"inbox_id","value":"string"},{"key":"channel_type","value":"string"},{"key":"tag_id","value":"string"},{"key":"tag_id","value":"string"},{"key":"tag_mode","value":"any"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4cca403-8f32-49b2-9de9-6b8f20819c92","name":"Bulk Close Conversations","request":{"name":"Bulk Close Conversations","description":{"content":"Bulk close multiple conversations without triggering ticket summarization.\n\nThis endpoint is intended for closing spam, duplicates, or other conversations\nthat do not need AI summarization or knowledge base entries.\n\n**Required Scopes:** `conversations:update`\n\nArgs:\n request_body: Request body containing conversation_ids and optional reason\n\nReturns:\n BulkCloseResponse with counts of successes and failures","type":"text/plain"},"url":{"path":["api","v1","conversations","bulk-close"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"conversation_ids\": [\n \"string\"\n ],\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8e818169-204f-43f6-9707-f9b1c9f23691","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations","bulk-close"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"conversation_ids\": [\n \"string\"\n ],\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"failed_count\": 2,\n \"failed_ids\": [\n \"c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"d2b3c4d5-e6f7-g8h9-i0j1-k2l3m4n5o6p7\"\n ],\n \"success_count\": 8\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c23eb89-dcae-449f-930c-57328809336b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations","bulk-close"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"conversation_ids\": [\n \"string\"\n ],\n \"reason\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8d6fbf11-ea35-42b0-b04b-50ed4cb4b67e","name":"Get Trending Tags","request":{"name":"Get Trending Tags","description":{"content":"Get trending AI tags from recently closed conversations.\n\nAnalyzes the most recent closed conversations with AI summaries and returns\nthe most common tags/categories.\n\n**Required Scopes:** `conversations:read`","type":"text/plain"},"url":{"path":["api","v1","conversations","analytics","trending-tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"Number of recent closed conversations to analyze"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"56f1ec57-afa0-4000-9bd5-8451ead396bc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations","analytics","trending-tags"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"}],"variable":[]},"header":[{"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":"d5bf0551-aab0-4f76-9567-4c0fdab2430b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations","analytics","trending-tags"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6e7c43cf-238f-4e38-817a-6bd11cf217bb","name":"Search Similar Conversations","request":{"name":"Search Similar Conversations","description":{"content":"**Retired.** Always returns `410 Gone`.\n\nSimilar ticket search was retired in October 2026. Conversation summaries\nare still stored on each conversation; list them with\n`GET /api/v1/knowledge-base/tickets`.\n\n**Required Scopes:** `conversations:read`","type":"text/plain"},"url":{"path":["api","v1","conversations","search-similar"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c04a8ac4-3db0-4ded-860c-adae92d7701e","name":"Get Conversation","request":{"name":"Get Conversation","description":{"content":"Get a specific conversation\n\n**Required Scopes:** `conversations:read`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ceb7d4af-43d9-4436-ba2b-f46af6f117dd","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6eb56524-b9dc-4d94-a62b-0096456751d4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"97ac662d-f50a-4a00-91ff-055ded095e6b","name":"Update Conversation","request":{"name":"Update Conversation","description":{"content":"Update a conversation\n\n**Required Scopes:** `conversations:update`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"assigned_user_id\": \"u1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"status\": \"assigned\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"af71f2d5-523b-43b0-8c35-3c910342e258","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"assigned_user_id\": \"u1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"status\": \"assigned\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d77542b7-cd41-47ba-8c0e-dc0e4981f56d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"assigned_user_id\": \"u1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6\",\n \"status\": \"assigned\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0121fbac-60af-4b4f-8da3-781a6cc293d2","name":"Assign Conversation","request":{"name":"Assign Conversation","description":{"content":"Assign a conversation to a user\n\n**Required Scopes:** `conversations:update`\n\nCross-agent rules (when allow_messaging_other_agents_conversations is False):\n- Self-assign (\"Assign to me\"): Always allowed for any agent\n- Reassign to someone else: Only ADMIN/OWNER roles","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","assign",":user_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"user_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"bfdead20-3036-49a1-846e-e73f36d497d9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","assign",":user_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"user_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e35f498a-d511-488d-89ce-7c66dbc156e1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","assign",":user_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"user_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4a69ef70-faa9-4936-af39-1e18b2abecf0","name":"Close Conversation","request":{"name":"Close Conversation","description":{"content":"Close a conversation and create a ticket\n\n**Required Scopes:** `conversations:update`\n\nCross-agent rules (when allow_messaging_other_agents_conversations is False):\n- Only ADMIN/OWNER can close a conversation assigned to another agent\n\nArgs:\n conversation_id: ID of the conversation to close\n request_body: Request body containing optional notes and summarize flag","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","close"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"notes\": \"Customer issue resolved\",\n \"summarize\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9493c18b-0a7b-4011-96fb-bded80d41a97","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","close"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"notes\": \"Customer issue resolved\",\n \"summarize\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"566167f7-5150-467b-9175-65e5c606f8ff","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","close"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"notes\": \"Customer issue resolved\",\n \"summarize\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c5a09fdf-437a-4b6d-839e-f7fa425b39a4","name":"Show or clear a typing indicator","request":{"name":"Show or clear a typing indicator","description":{"content":"Show (or clear) a typing indicator to the contact in a conversation.\n\nUse it while a reply is being prepared, e.g. by your own bot. The body is\noptional; an empty body means `{\"state\": \"on\"}`.\n\n## Channel behavior\n- **WhatsApp:** the indicator also marks the contact's latest message as\n read (`implied_read: true`) and lasts up to 25 seconds or until you\n reply. `state: \"off\"` is accepted but has no effect.\n- **Telegram:** lasts about 5 seconds; call again to keep it visible.\n- Check `GET /channels/sender-actions` for every channel's support and\n timeout (`typing_ttl_seconds`). Unsupported channels return\n `422 sender_action_not_supported`.\n\n`message_id` (optional) ties the indicator to a specific inbound message\nof this conversation; channels that need one use the latest inbound\nmessage when omitted (`422 no_inbound_message` if there is none).\n\nThis is **not a message**: nothing is billed, no message is created and\nno webhook is sent. Your inbox's unread state is not changed.\n\n## Errors\n`detail` is an object: `{\"code\", \"message\", \"channel_type\", \"action\"}`.\n- `404 conversation_not_found`, `message_not_found`\n- `422 sender_action_not_supported`, `no_inbound_message`,\n `message_not_inbound`, `channel_unavailable`\n- `429 sender_action_rate_limited` — about 30 calls per minute per\n conversation; retry after the `Retry-After` seconds\n- `502 sender_action_failed` — the messaging platform rejected the request\n\nRepeats are absorbed: a second read receipt for the same message, or a\ntyping `on` while the indicator is still showing, returns 200 with\n`deduplicated: true` and nothing is sent again (typing `off` is never\ndeduplicated).\n\n**Required Scopes:** `messages:create`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","typing"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"on\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"16dc597f-f68a-4597-a1e8-b14b9cd294cc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","typing"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"on\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"action\": \"typing\",\n \"channel_type\": \"whatsapp\",\n \"conversation_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"deduplicated\": false,\n \"expires_in_seconds\": 25,\n \"implied_read\": true,\n \"message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"state\": \"on\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8adf2c0-7c33-46c0-aad9-f1676de1720f","name":"Message or conversation not found.","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","typing"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"on\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": {\n \"action\": \"read\",\n \"channel_type\": \"telegram\",\n \"code\": \"sender_action_not_supported\",\n \"message\": \"Read receipts are not supported on this channel.\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1f51ad09-d640-4011-bf2a-f4f8d8c7284b","name":"Not possible on this channel or message: `sender_action_not_supported`, `message_not_inbound`, `no_inbound_message`, `channel_unavailable` (or a request validation error).","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","typing"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"on\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": {\n \"action\": \"read\",\n \"channel_type\": \"telegram\",\n \"code\": \"sender_action_not_supported\",\n \"message\": \"Read receipts are not supported on this channel.\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb8d9eda-4d3c-42d1-b145-d4989dccb487","name":"Too many read/typing requests for this conversation (`sender_action_rate_limited`, about 30 per minute). Honour `Retry-After`.","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","typing"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"on\"\n}","options":{"raw":{"language":"json"}}}},"status":"Too Many Requests","code":429,"header":[{"disabled":false,"description":"Seconds to wait before retrying.","key":"Retry-After","value":"4595"},{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": {\n \"action\": \"read\",\n \"channel_type\": \"telegram\",\n \"code\": \"sender_action_not_supported\",\n \"message\": \"Read receipts are not supported on this channel.\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"43a0debf-76ad-4bd2-9ae1-eea3b386d475","name":"The messaging platform rejected the action (`sender_action_failed`).","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","typing"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"on\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": {\n \"action\": \"read\",\n \"channel_type\": \"telegram\",\n \"code\": \"sender_action_not_supported\",\n \"message\": \"Read receipts are not supported on this channel.\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"56c6574b-4c05-401c-9b87-465932730ed2","name":"Snooze Conversation","request":{"name":"Snooze Conversation","description":{"content":"Snooze (postpone) a conversation.\n\n**Required Scopes:** `conversations:update`\n\nSnooze is a DERIVED state: the conversation ``status`` stays ``open`` /\n``assigned`` — it simply drops off the **Open** tab and appears on the\n**Snoozed** tab until ``snoozed_until`` passes (query-time expiry, no\nbackground job). Once the timestamp passes it behaves like a normal open\nconversation again.\n\nBody:\n- ``snoozed_until``: timezone-aware ISO datetime; MUST be in the future.\n- ``reopen_on_message``: when true the inbound-message worker clears the\n snooze (returns it to Open) when a customer message arrives.\n\nEmits the ``conversation.updated`` webhook event and a\n``conversation_updated`` WebSocket broadcast so the UI moves the\nconversation to the Snoozed tab in real time.\n\nCross-agent rules (when allow_messaging_other_agents_conversations is\nFalse): only ADMIN/OWNER may snooze a conversation assigned to another\nagent.","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","snooze"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"reopen_on_message\": true,\n \"snoozed_until\": \"2026-06-23T09:00:00Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6fcc78db-4960-47b4-b1b9-7e10c1fc7050","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","snooze"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"reopen_on_message\": true,\n \"snoozed_until\": \"2026-06-23T09:00:00Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"81a105fc-7c3e-453f-980d-d12e6e1eab86","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","snooze"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"reopen_on_message\": true,\n \"snoozed_until\": \"2026-06-23T09:00:00Z\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"383c633d-3d1f-4808-878d-cd337f26dfbf","name":"Unsnooze Conversation","request":{"name":"Unsnooze Conversation","description":{"content":"Clear a conversation's snooze (return it to the Open tab).\n\n**Required Scopes:** `conversations:update`\n\nSets ``snoozed_until`` and ``snooze_reopen_on_message`` back to NULL.\nStatus is untouched. Idempotent — unsnoozing an already-unsnoozed\nconversation succeeds and still emits ``conversation.updated`` so stale\nclient state converges.\n\nCross-agent rules (when allow_messaging_other_agents_conversations is\nFalse): only ADMIN/OWNER may unsnooze a conversation assigned to another\nagent.","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","snooze"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"60f1c8b1-8a08-490c-95b5-f81173118c79","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","snooze"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8b383d05-543f-412c-a9ea-5a18b3271309","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","snooze"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac737af3-98e3-4b43-85fd-808da85f5ce2","name":"Summarize Conversation","request":{"name":"Summarize Conversation","description":{"content":"Manually trigger AI summary generation for a conversation.\n\n**Required Scopes:** `conversations:update` (+ plan feature `ai_features`)","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","summarize"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"ce4492b0-4e70-4cf5-a09e-a62e1c84bd76","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","summarize"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"17aa6653-8e6b-468f-8344-f94440bde148","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","summarize"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a7d306a4-8c10-4394-9652-0fda01fa1621","name":"Create Transcript Export","request":{"name":"Create Transcript Export","description":{"content":"Start an async transcript export (PDF or ZIP) for a conversation.\n\n**Required Scopes:** `conversations:read`\n\nCreates a background job and returns it immediately with status ``queued``\n(HTTP 202). Poll ``GET /conversations/{conversation_id}/transcript/{job_id}``\nuntil ``status`` is ``completed`` (a ``download_url`` is then returned) or\n``failed``.\n\nDeduplication: a double-click / concurrent request is collapsed via a Redis\n``SET NX EX`` lock, and a reload / fresh-completed request reuses the\nexisting job (an in-flight QUEUED/PROCESSING job, or a COMPLETED one from the\nlast few minutes) instead of enqueuing a duplicate.","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","transcript"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"format\": \"pdf\",\n \"wait_for_summary\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1b0c1408-c2d8-4ebd-b316-6d7c183cc135","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","transcript"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"format\": \"pdf\",\n \"wait_for_summary\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"completed_at\": \"2026-07-02T10:00:12Z\",\n \"conversation_id\": \"conv_abc123\",\n \"created_at\": \"2026-07-02T10:00:00Z\",\n \"download_url\": \"https://storage.googleapis.com/...signed...\",\n \"format\": \"pdf\",\n \"job_id\": \"3f9a1c2e-...\",\n \"message\": \"Transcript export ready\",\n \"progress_percent\": 100,\n \"status\": \"completed\",\n \"storage_path\": \"tenants/t1/transcripts/conv_abc123.pdf\",\n \"updated_at\": \"2026-07-02T10:00:12Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"18b0f56d-1cdf-4758-88a1-7e4892bdf0c2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","transcript"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"format\": \"pdf\",\n \"wait_for_summary\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c4fa95d7-5240-424d-bdf5-d5acf4b8ecf6","name":"Get Transcript Export","request":{"name":"Get Transcript Export","description":{"content":"Poll the status of an async transcript export job.\n\n**Required Scopes:** `conversations:read`\n\nWhen ``status`` is ``completed`` the response includes the ``download_url``\n(and ``storage_path``) written by the worker; when ``failed`` see\n``error_message``.","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","transcript",":job_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"55c8c179-9236-4859-a9dd-88300d7071af","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","transcript",":job_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"completed_at\": \"2026-07-02T10:00:12Z\",\n \"conversation_id\": \"conv_abc123\",\n \"created_at\": \"2026-07-02T10:00:00Z\",\n \"download_url\": \"https://storage.googleapis.com/...signed...\",\n \"format\": \"pdf\",\n \"job_id\": \"3f9a1c2e-...\",\n \"message\": \"Transcript export ready\",\n \"progress_percent\": 100,\n \"status\": \"completed\",\n \"storage_path\": \"tenants/t1/transcripts/conv_abc123.pdf\",\n \"updated_at\": \"2026-07-02T10:00:12Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"85c7902f-2ab2-4606-a9f1-a2a9b1b9469d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","transcript",":job_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"74d21777-4fc1-4628-b10f-ad1f9d2d0fd0","name":"Email Conversation Transcript","request":{"name":"Email Conversation Transcript","description":{"content":"Email the conversation transcript to the contact (or any address).\n\n**Required Scopes:** `conversations:update`\n\nOffered when an agent closes a conversation (especially dead live-chat\ntickets where the visitor left before reading the replies), but callable\nfor ANY conversation. Sends SYNCHRONOUSLY in-request: one branded HTML\nemail (tenant logo/name header, localized greeting, optional agent note,\nthe chat transcript, and the tenant's imprint/compliance footer) from the\nselected ``EmailMailbox``.\n\nErrors: 404 unknown conversation/mailbox (tenant-scoped), 400 invalid\nemail address / mailbox not sendable, 409 ``CONTACT_BLOCKED`` (contact or\nrecipient address blocked), 422 request validation, 502 the email\nprovider rejected the send.","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","email-transcript"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"mailbox_id\": \"6f2b9a44-1c7e-4b7f-9d1a-2e8c5a7b9c01\",\n \"note\": \"Thanks for reaching out — here is everything we discussed.\",\n \"save_as_contact_method\": true,\n \"to_email\": \"customer@example.com\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1f1a77cf-df26-4dc5-b1c7-11c9b8c78d43","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","email-transcript"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"mailbox_id\": \"6f2b9a44-1c7e-4b7f-9d1a-2e8c5a7b9c01\",\n \"note\": \"Thanks for reaching out — here is everything we discussed.\",\n \"save_as_contact_method\": true,\n \"to_email\": \"customer@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"to_email\": \"customer@example.com\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"20d676aa-a2f5-496b-8a0f-3cf90c589009","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","email-transcript"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"mailbox_id\": \"6f2b9a44-1c7e-4b7f-9d1a-2e8c5a7b9c01\",\n \"note\": \"Thanks for reaching out — here is everything we discussed.\",\n \"save_as_contact_method\": true,\n \"to_email\": \"customer@example.com\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4c5d565-3e94-4a8d-8168-83d93923dba3","name":"Get Conversation Summary","request":{"name":"Get Conversation Summary","description":{"content":"Full AI ticket summary for a single conversation, broken into the\nthree sections the contact-page timeline renders on expand:\n``user_intent``, ``summary``, ``resolution``.\n\nLazy-loaded by the FE when a ``ticket_summary`` timeline row is\nexpanded — the timeline list itself only carries a 140-char\n``summary_preview`` to keep the list payload small. Reads the text\ndirectly off the ``Conversation`` SHARD row (no KB-doc / RAG fetch).\n\nReturns 404 if the conversation does not exist in the caller's tenant\n(tenant-isolated — never leaks cross-tenant ids). A conversation that\nexists but was never summarized (or was reopened, which NULLs these\nfields) returns 200 with all three sections ``null``.\n\n**Required Scopes:** `knowledge_base:read`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"8e62183b-8bfa-4616-9f6f-64255cfd3a50","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conversation_id\": \"string\",\n \"user_intent\": \"string\",\n \"summary\": \"string\",\n \"resolution\": \"string\",\n \"summarized_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c2ead199-b6c4-4096-b3ac-a647f61214d3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a86ce857-beb1-42cf-9ec4-b5f9d415753b","name":"Get Previous Conversations","request":{"name":"Get Previous Conversations","description":{"content":"Summarize a contact's previous conversations + advertise the merge target.\n\nRedesigned (June 2026) to power a single-line history summary plus the\nreopen-&-merge affordance, instead of a list of heavy per-conversation\ncards. Returns CHEAP aggregates over the SAME contact's prior conversations\n(excluding the current one):\n\n * `total_previous` — COUNT of prior conversations\n * `distinct_channel_count` — COUNT(DISTINCT channel_id)\n * `latest_previous_at` — MAX(last_message_at)\n * `merge_target_conversation_id` — the ONLY conversation this one may be\n merged into: the contact's OVERALL most-recent prior conversation, and\n ONLY when that immediately-previous conversation is on the SAME channel\n (`channel_id`) as the current one. Null when the immediately-previous\n conversation overall is on a different channel (even if an older\n same-channel prior exists). Computed by the SAME server-side helper the\n `POST /{id}/merge` endpoint enforces with, so the FE can never advertise\n a target the backend would reject.\n * `mergeable` — `merge_target_conversation_id is not None`\n\n`items[]` is RETAINED in the response for backwards-compatibility but is\nnow ALWAYS returned EMPTY: the expensive per-item enrichment (bulk message\ncounts, last-message previews, channel-type hydration) is no longer\ncomputed. The only former consumer (`ConversationHistoryBoundary.tsx`) is\nbeing redesigned to use the aggregates. To list actual messages on a\nchannel, use `GET /api/v1/contacts/{contact_id}/messages`. The `limit`\nquery param is retained for compatibility but ignored.\n\nAll aggregates and the merge-target lookup respect contact-history\nvisibility: non-admin agents only see conversations on channels reachable\nthrough their accessible Custom Inboxes. Admins/owners see everything.\n\n**Required Scopes:** `conversations:read`\n\n**Response format:**\n```json\n{ \"items\": [], \"total_previous\": 4, \"distinct_channel_count\": 2,\n \"latest_previous_at\": \"2026-06-01T10:00:00Z\", \"mergeable\": true,\n \"merge_target_conversation_id\": \"...\" }\n```","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","previous"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"3","description":"Deprecated/ignored — items[] is no longer populated"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"8bd8a579-1374-4029-bcdd-6433c3187acc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","previous"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"3"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"total_previous\": 0,\n \"distinct_channel_count\": 0,\n \"latest_previous_at\": \"string\",\n \"mergeable\": false,\n \"merge_target_conversation_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"39b6b169-6df6-4f12-8687-be30414bdb22","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","previous"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"3"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"012a7ad6-c18f-42b0-ac72-338d2a580874","name":"Reopen Conversation","request":{"name":"Reopen Conversation","description":{"content":"Reopen a closed conversation\n\n**Required Scopes:** `conversations:update`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","reopen"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"a18b6c83-1295-48bc-94e7-7962d2ae3603","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","reopen"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4ec12383-afe7-42f6-b873-a1969118031c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","reopen"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"05bf1b5c-b9d5-4128-bd92-3f2a6f4df2a9","name":"Merge Conversation","request":{"name":"Merge Conversation","description":{"content":"Merge a source conversation into this one and reopen it.\n\nThe path conversation (`conversation_id`) SURVIVES and is reopened; the\n`source_conversation_id` from the body is merged in (all its messages,\nnotes, tags, attachments, etc. move over) and then permanently deleted.\nBoth conversations must belong to the SAME contact.\n\nReply routing adopts the source conversation's active channel so future\nreplies go to where the contact last reached us.\n\nServer-side merge gating: the path conversation MUST be the single valid\nmerge target for the source — i.e. the contact's OVERALL most-recent PRIOR\nconversation, and ONLY when that immediately-previous conversation is on the\nSAME channel (`channel_id`) as the source. If the immediately-previous\nconversation overall is on a DIFFERENT channel (even when an older\nsame-channel prior exists), there is NO valid target. This is the exact\ntarget advertised by `GET /{id}/previous` (`merge_target_conversation_id`),\ncomputed by the SAME helper, so the two can never diverge.\n\nRejections:\n * `400` — source == target (cannot merge into itself)\n * `404` — either conversation missing/not in tenant, or a channel not\n visible to the caller (contact-history visibility)\n * `409` — conversations belong to different contacts, OR the path\n conversation is not the valid merge target / no mergeable prior\n conversation exists on this channel\n\n**Required Scopes:** `conversations:update`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","merge"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"source_conversation_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"cb7bce89-714b-4225-8314-d55bd58711fb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","merge"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"source_conversation_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"channel_id\": \"string\",\n \"status\": \"assigned\",\n \"updated_at\": \"string\",\n \"contact_id\": \"string\",\n \"channel_type\": \"string\",\n \"contact_method_id\": \"string\",\n \"active_contact_method_id\": \"string\",\n \"contact_method\": {\n \"value\": \"\"\n },\n \"active_contact_method\": {\n \"value\": \"\"\n },\n \"assigned_user_id\": \"string\",\n \"assigned_user\": {\n \"key_0\": 3429\n },\n \"subject\": \"string\",\n \"last_message_at\": \"string\",\n \"last_message\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"key_0\": 8311\n },\n \"is_live_chat\": false,\n \"is_email\": false,\n \"needs_reply\": true,\n \"last_customer_message_at\": \"string\",\n \"last_agent_reply_at\": \"string\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"live_chat_session_status\": \"string\",\n \"live_chat_last_activity_at\": \"string\",\n \"visitor_online\": false,\n \"visitor_widget_state\": \"string\",\n \"visitor_tab_state\": \"string\",\n \"visitor_focused\": true,\n \"visitor_last_visible_at\": \"string\",\n \"visitor_last_focus_at\": \"string\",\n \"bot_session_id\": \"string\",\n \"active_flow_run\": {\n \"key_0\": \"string\",\n \"key_1\": 5535\n },\n \"snoozed_until\": \"string\",\n \"snooze_reopen_on_message\": true,\n \"closed_at\": \"string\",\n \"closed_by_user_id\": \"string\",\n \"ai_summary\": \"string\",\n \"user_intent\": \"string\",\n \"resolution_summary\": \"string\",\n \"sentiment_analysis\": \"string\",\n \"ai_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"summarized_at\": \"string\",\n \"my_draft\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1fb7677-6917-47bf-9d51-134468ec09f7","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","merge"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"source_conversation_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a680c7a8-49aa-4382-8d74-99d5957d16c8","name":"Get Switchable Channels","request":{"name":"Get Switchable Channels","description":{"content":"List channels available for switching from this conversation.\n\nReturns all active switchable channels (WhatsApp, Telegram, Messenger,\nInstagram) excluding the conversation's current channel. Used by the\nfrontend to render a channel picker before generating deeplinks.\n\nCustom Inboxes security hardening (May 2026): for non-admin callers the\nlist is intersected with the channels reachable through the caller's\naccessible Custom Inboxes. Admins/owners and tenants with zero inboxes\nare unaffected.\n\n**Required Scopes:** `conversations:read`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","switchable-channels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ea88da4d-ad80-48d4-8b3e-e18f0167498c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","switchable-channels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"channels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11a964ce-0a10-4e99-a2b2-5ddf6ff1f8a4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","switchable-channels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2319f9d0-1481-4a0d-a04b-efadb0f98fcb","name":"Get Conversation Sender Options","request":{"name":"Get Conversation Sender Options","description":{"content":"List email senders the caller may use for replying to this conversation.\n\nReturns the user's accessible support-capable email connections, plus an\nACL-override entry when the conversation's default reply sender (the\nreceiving connection's ``outbound_provider``) is NOT already in that set.\nThe client pre-selects ``default_option_id`` and POSTs the chosen value\nas ``MessageCreate.sender_id`` on the outbound send. The server\nre-validates the choice on the send path.\n\nReturns ``{\"options\": [], \"default_option_id\": null,\n\"default_reply_sender_id\": null}`` for non-email conversations so clients\ncan rely on a stable response shape.\n\n**Required Scopes:** `conversations:read`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","sender-options"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4072ba7a-083e-4101-ad3e-206c2907ab74","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","sender-options"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"default_reply_sender_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cdb2ef3f-b819-4ed8-bba9-d3edd079c36c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","sender-options"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9a7c5263-5d86-45f7-a604-7d8ef6c02e3c","name":"Switch Channel","request":{"name":"Switch Channel","description":{"content":"Generate channel switch deeplinks for a conversation.\n\nAccepts a list of ``channel_ids`` to generate links for specific channels,\nor omit to generate for all active switchable channels.\n\n**Required Scopes:** `conversations:update`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","switch-channel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3b605f77-6f51-4096-b490-17c9095af32c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","switch-channel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\",\n \"deeplinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"expires_at\": \"2001-12-25T09:20:41.896Z\",\n \"share_token_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"042853f6-cb26-4c88-9d0d-d7ea867cd3d9","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","switch-channel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9a61f25c-0f37-427c-9ed2-e19a2db405d0","name":"Initiate Conversation","request":{"name":"Initiate Conversation","description":{"content":"Initiate a new outbound conversation with a contact.\n\nThis endpoint allows agents to start new conversations from the UI.\nBehavior varies by channel:\n\n- **WhatsApp**: Checks 24h window. If closed, requires template message.\n- **Email**: Sends email with optional signature appended.\n- **Telegram/Messenger/Instagram**: Sends message directly.\n\n**Required Scopes:** `conversations:create`\n\n**409 `CONTACT_BLOCKED`:** the contact is blocked\n(`{\"error\": \"CONTACT_BLOCKED\", \"message\": ..., \"contact_id\": ...}`).\n\n**409 `conversation_owned_elsewhere`:** for team members restricted by\nCustom Inboxes, when the contact is in an ongoing (non-email)\nconversation handled in an inbox they cannot see. Email starts a new\nthread instead.\n\n**Request Body:**\n```json\n{\n \"contact_id\": \"uuid\",\n \"channel_id\": \"uuid\",\n \"message_type\": \"text\" | \"template\" | \"email\",\n\n // For text messages\n \"content\": \"Hello...\",\n\n // For WhatsApp templates\n \"template\": {\n \"name\": \"hello_world\",\n \"language\": \"en\",\n \"components\": [...]\n },\n\n // For email\n \"email\": {\n \"subject\": \"Re: Your inquiry\",\n \"body_html\": \"

Hello...

\",\n \"include_signature\": true,\n \"cc\": [],\n \"bcc\": []\n }\n}\n```\n\n**Response:**\n```json\n{\n \"conversation_id\": \"uuid\",\n \"message_id\": \"uuid\",\n \"channel_type\": \"whatsapp\",\n \"status\": \"sent\" | \"queued\" | \"failed\" | \"template_required\",\n \"requires_template\": false,\n \"window_status\": {\n \"in_window\": true,\n \"remaining_seconds\": 3600\n }\n}\n```","type":"text/plain"},"url":{"path":["api","v1","conversations","initiate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\",\n \"content\": \"Hello! How can I help you today?\",\n \"message_type\": \"text\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a8764ba8-8197-4be3-806f-1d6d99c2dd1e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations","initiate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\",\n \"content\": \"Hello! How can I help you today?\",\n \"message_type\": \"text\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conversation_id\": \"string\",\n \"channel_type\": \"string\",\n \"status\": \"string\",\n \"message_id\": \"string\",\n \"requires_template\": false,\n \"window_status\": {\n \"value\": \"\"\n },\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"25eb8773-f332-4ed2-854d-cbb7dcd8d51a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations","initiate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\",\n \"content\": \"Hello! How can I help you today?\",\n \"message_type\": \"text\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"defa80cb-b7bd-43ca-a016-0ed2baf64e7b","name":"Check Existing Conversation","request":{"name":"Check Existing Conversation","description":{"content":"Check for existing conversations without creating one.\n\nThis is Phase 1 of the two-phase conversation creation flow.\nUse this endpoint to check if there are existing open or closed\nconversations before deciding to create new or reopen existing.\n\n**No webhooks are fired by this endpoint.**\n\nAfter checking, call `/conversations/open-or-create` with:\n- `action=\"create_new\"` to create a new conversation\n- `action=\"reopen_existing\"` to reopen the closed conversation\n\n**Required Scopes:** `conversations:create`\n\n\n**409 `conversation_owned_elsewhere`:** for team members restricted by\nCustom Inboxes, when the contact is in an ongoing (non-email)\nconversation handled in an inbox they cannot see. Email starts a new\nthread instead.\n\n**Request Body:**\n```json\n{\n \"contact_id\": \"uuid\",\n \"channel_id\": \"uuid\"\n}\n```\n\n**Response:**\n```json\n{\n \"has_existing_open\": true,\n \"existing_open_conversation_id\": \"uuid\",\n \"has_existing_closed\": false,\n \"existing_closed_info\": null,\n \"channel_type\": \"whatsapp\",\n \"window_status\": {\n \"in_window\": true,\n \"requires_template\": false,\n \"last_customer_message_at\": null,\n \"window_end_at\": \"2026-01-17T10:00:00Z\"\n }\n}\n```","type":"text/plain"},"url":{"path":["api","v1","conversations","check-existing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2f845b70-9911-4710-a640-4f60cc760772","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations","check-existing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"has_existing_open\": false,\n \"has_existing_closed\": false,\n \"channel_type\": \"string\",\n \"existing_open_conversation_id\": \"string\",\n \"existing_closed_info\": {\n \"value\": \"\"\n },\n \"window_status\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"60b50819-8952-45c4-a702-56de56c72177","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations","check-existing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2a7847cc-5172-439e-9a65-fe75da0fed75","name":"Open Or Create Conversation","request":{"name":"Open Or Create Conversation","description":{"content":"Open an existing conversation or create a new one.\n\nThis is a simplified endpoint that does NOT send a message.\nUse this when you want to navigate to a conversation and let the user\ncompose messages using the normal chat UI.\n\n**Two-Phase API (Recommended):**\n1. First call `/conversations/check-existing` to check for existing conversations\n2. Then call this endpoint with `action` to control behavior:\n - `action=\"create_new\"`: Always create new conversation (fires webhook)\n - `action=\"reopen_existing\"`: Reopen closed conversation (fires conversation.reopened webhook)\n - `action=\"auto\"` (default): Backwards compatible - may create without webhook if closed exists\n\nFor WhatsApp channels, the response includes window_status to indicate\nwhether templates are required (24h window closed).\n\n**Required Scopes:** `conversations:create`\n\n\n**409 `conversation_owned_elsewhere`:** for team members restricted by\nCustom Inboxes, when the contact is in an ongoing (non-email)\nconversation handled in an inbox they cannot see. Email starts a new\nthread instead.\n\n**Request Body:**\n```json\n{\n \"contact_id\": \"uuid\",\n \"channel_id\": \"uuid\",\n \"action\": \"create_new\"\n}\n```\n\n**Response:**\n```json\n{\n \"conversation_id\": \"uuid\",\n \"is_new\": true,\n \"is_reopened\": false,\n \"channel_type\": \"whatsapp\",\n \"window_status\": {\n \"in_window\": true,\n \"requires_template\": false,\n \"last_customer_message_at\": \"2026-01-16T10:00:00Z\",\n \"window_end_at\": \"2026-01-17T10:00:00Z\"\n }\n}\n```","type":"text/plain"},"url":{"path":["api","v1","conversations","open-or-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1a54186b-a20f-44c5-af58-9c28a33c5c38","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations","open-or-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conversation_id\": \"string\",\n \"is_new\": true,\n \"channel_type\": \"string\",\n \"is_reopened\": false,\n \"window_status\": {\n \"value\": \"\"\n },\n \"existing_closed_conversation\": {\n \"value\": \"\"\n },\n \"existing_open_email_threads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3aa59082-4059-49df-86b3-a51e50ecd0b2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations","open-or-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel_id\": \"channel-uuid\",\n \"contact_id\": \"contact-uuid\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d5c07337-2880-4e43-b3e5-b5cf1fff15d0","name":"Get Bot Session Status","request":{"name":"Get Bot Session Status","description":{"content":"Get current bot session status for a conversation.\n\n**Required Scopes:** `conversations:read`\n\nReturns:\n - bot_active: Whether a bot is currently handling this conversation\n - bot_session_id: The ID of the active bot session (if any)\n - bot_name: The name of the bot handling the conversation (if any)\n - bot_id: The ID of the bot (if any)","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","bot-session"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7796fe5b-ecc8-4de5-beb3-a8d4dec43342","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","bot-session"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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":"c5c4f0d9-2982-4e41-9306-17c386e1023d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","bot-session"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49be3c41-2170-4115-b7ed-a8615cb684d7","name":"Disable Bot Session","request":{"name":"Disable Bot Session","description":{"content":"Manually disable bot for this conversation.\n\nEnds the active bot session with reason AGENT_DISABLED.\nUse this when an agent wants to take over the conversation manually\nwithout sending a message first.\n\n**Required Scopes:** `conversations:update`\n\nReturns:\n - success: Whether the bot session was disabled\n - message: Status message","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","bot-session","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"49c2d883-96c2-4856-9584-2f383ca0364a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","bot-session","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fd626fd1-52eb-46a5-af01-0d762c603c85","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","bot-session","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"afc16d3e-4268-480a-9d8f-35239af84572","name":"Get Available Bots","request":{"name":"Get Available Bots","description":{"content":"Get list of available bots that can handle this conversation.\n\nReturns all active bots for the tenant that could be enabled on this conversation.\n\n**Required Scopes:** `conversations:read`\n\nReturns:\n - bots: List of available bots with id and name","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","available-bots"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"aca6ede9-1d0f-4ca9-84fc-ea80a005b3c8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","available-bots"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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":"922c88c9-e41c-4155-81a8-12f3abe0de8e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","available-bots"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8cf1013f-3140-4830-a9c9-70a408efe494","name":"Enable Bot Session","request":{"name":"Enable Bot Session","description":{"content":"Enable a bot for this conversation.\n\nIf bot_id is provided, enables that specific bot.\nIf bot_id is not provided, finds the best matching bot based on activation rules.\n\n**Required Scopes:** `conversations:update`\n\nArgs:\n bot_id: Optional specific bot ID to enable\n\nReturns:\n - success: Whether the bot session was enabled\n - message: Status message\n - bot_session_id: The ID of the new bot session (if created)\n - bot_name: The name of the bot (if created)","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","bot-session","enable"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"bot_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"a085313e-f850-4526-b28a-a6f5afa6c261","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","bot-session","enable"],"host":["{{baseUrl}}"],"query":[{"key":"bot_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b7b36202-f178-451f-abae-f1fd6737051f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","bot-session","enable"],"host":["{{baseUrl}}"],"query":[{"key":"bot_id","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cbf1c4f4-e547-42f7-b673-898be9f2ae36","name":"Get Conversation Contact Context","request":{"name":"Get Conversation Contact Context","description":{"content":"Get the contact context an AI agent sees for this conversation\n\nReturns `assurance`, the active contact-token `grant` (or null), `fields`\n(`key`, `name`, `value`, `source`, `verified`), `methods`\n(`type`, `value`, `verified`), `tags` (`name`, `verified`; ALL of the\ncontact's tags, always `verified: false`) and `subscriptions` (`list`, `channel_type`, `status`,\n`opt_in_method`, `verified`). `tags` / `subscriptions` are `[]` when unavailable.\n\n**Required Scopes:** `conversations:read` + `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","conversations",":conversation_id","contact-context"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"8b3a9cf3-a1b1-4427-9898-d2ea12fd0939","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","contact-context"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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":"4bf0ced4-9882-4b25-8b7e-401167e3ba01","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","conversations",":conversation_id","contact-context"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"2566fc8b-bdd8-4213-940f-09f25ffb8b63","name":"Custom Fields","description":{"content":"Define and manage custom data fields for contacts to store business-specific information.","type":"text/plain"},"item":[{"id":"e79cce20-3219-4595-811e-2009a388ce87","name":"Create Custom Field","request":{"name":"Create Custom Field","description":{"content":"Create a new custom field definition.\n\nCustom fields extend the contact model with tenant-specific attributes.\nOnce created, the field `key` and `field_type` cannot be changed.\n\n**Required Scopes:** `settings:update`\n\n**Field Types:**\n- `text`: Free-form text\n- `number`: Numeric values\n- `boolean`: True/false\n- `date`: Date only\n- `datetime`: Date and time\n- `select`: Single selection from options\n- `multiselect`: Multiple selections from options\n- `email`: Email address\n- `phone`: Phone number\n- `url`: Website URL\n- `location`: Latitude/longitude\n- `collection`: Array of values\n\n**Validation (optional):** `validation` holds value constraints, type-applicable\nkeys only — `number`: `min`/`max`; `text`/`email`/`phone`/`url`:\n`min_length`/`max_length`/`pattern`; `date`/`datetime`: `date_min`/`date_max`\n(`YYYY-MM-DD` or `today`). Other keys/types → 422 `invalid_validation`.\n\n**AI access:** `ai_access` is `none` (default: AI agents never see the field),\n`read`, `read_write` (agents may update any value) or `fill_if_empty`\n(agents may only fill an empty value).\n`location` / `collection` fields accept only `none` / `read` (422\n`invalid_ai_access`).","type":"text/plain"},"url":{"path":["api","v1","custom-fields"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"key\": \"ig\",\n \"field_type\": \"location\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"required\": false,\n \"default_value\": \"string\",\n \"agent_visible\": true,\n \"agent_editable\": true,\n \"user_editable\": false,\n \"display_order\": 0,\n \"validation\": {\n \"key_0\": 508.4804039152524,\n \"key_1\": \"string\"\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"none\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e334490e-7491-4bd8-91c1-d8abcbb1ef26","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","custom-fields"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"key\": \"lkcrvmz\",\n \"field_type\": \"phone\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"required\": false,\n \"default_value\": \"string\",\n \"agent_visible\": true,\n \"agent_editable\": true,\n \"user_editable\": false,\n \"display_order\": 0,\n \"validation\": {\n \"key_0\": true\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"none\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"key\": \"string\",\n \"field_type\": \"multiselect\",\n \"required\": false,\n \"agent_visible\": false,\n \"agent_editable\": false,\n \"user_editable\": true,\n \"display_order\": 9481,\n \"is_active\": false,\n \"created_at\": \"1994-07-23T18:56:03.212Z\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": \"string\",\n \"validation\": {\n \"key_0\": 1051.423984641111,\n \"key_1\": 2124.6222261986104\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"none\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2fdec488-0b00-469a-b4e8-aef04ad5f39d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","custom-fields"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"key\": \"lkcrvmz\",\n \"field_type\": \"phone\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"required\": false,\n \"default_value\": \"string\",\n \"agent_visible\": true,\n \"agent_editable\": true,\n \"user_editable\": false,\n \"display_order\": 0,\n \"validation\": {\n \"key_0\": true\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"none\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7823ade5-69db-457c-a598-c41fdbd8afc3","name":"List Custom Fields","request":{"name":"List Custom Fields","description":{"content":"List all custom field definitions for the tenant.\n\nReturns a paginated list of custom field definitions ordered by display_order.\n\nCustom field definitions describe contact attributes, so reading them is\ngated by `contacts:read` (NOT `settings:read`). This lets contact-facing\nroles (e.g. Support Agent) render the custom-fields card without being\ngranted broad tenant-settings read access. Write operations remain gated by\n`settings:update` / `settings:admin`.\n\n**Required Scopes:** `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","custom-fields"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"},{"disabled":false,"key":"active_only","value":"true","description":"Only return active fields"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"03f7d634-7570-468f-9ead-d8f5931a963c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","custom-fields"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"active_only","value":"true"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"08442c25-590f-42a8-95e9-b0dcefefbcd6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","custom-fields"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"active_only","value":"true"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5adc71a8-f5bc-404b-bd81-a10b1531d6d9","name":"Get Custom Field","request":{"name":"Get Custom Field","description":{"content":"Get a specific custom field definition.\n\nGated by `contacts:read` (custom fields describe contact attributes), NOT\n`settings:read`. Write operations remain gated by `settings:update` /\n`settings:admin`.\n\n**Required Scopes:** `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"78e7dd10-83ae-4032-b3ce-b3a0711a6354","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"key\": \"string\",\n \"field_type\": \"multiselect\",\n \"required\": false,\n \"agent_visible\": false,\n \"agent_editable\": false,\n \"user_editable\": true,\n \"display_order\": 9481,\n \"is_active\": false,\n \"created_at\": \"1994-07-23T18:56:03.212Z\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": \"string\",\n \"validation\": {\n \"key_0\": 1051.423984641111,\n \"key_1\": 2124.6222261986104\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"none\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7e889a16-4817-42c1-af24-e10bde346083","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"20aa6bd9-63c4-4e38-9428-a724bca38091","name":"Update Custom Field","request":{"name":"Update Custom Field","description":{"content":"Update a custom field definition.\n\nNote: The `key` and `field_type` cannot be changed after creation\nto preserve data integrity.\n\n`validation`: send an object to replace the value constraints, `null` to\nclear them, or omit it to keep them (see create for the allowed keys).\n\n`ai_hint` / `option_descriptions`: same semantics (object/string replaces,\n`null` clears, omitted keeps). `option_descriptions` keys must be options\nof the field after this update (422 `invalid_option_descriptions`). When\n`options` change and `option_descriptions` is omitted, descriptions of\nremoved options are dropped.\n\n`ai_access`: `none` / `read` / `read_write` / `fill_if_empty`; omit to keep,\n`null` resets to `none`. Writable modes on `location` / `collection` fields →\n422 `invalid_ai_access`.\n\n**Required Scopes:** `settings:update`","type":"text/plain"},"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"required\": true,\n \"default_value\": \"string\",\n \"agent_visible\": false,\n \"agent_editable\": false,\n \"user_editable\": true,\n \"display_order\": 7502,\n \"validation\": {\n \"key_0\": \"string\"\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"read\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e8d7da8c-753f-424c-9acf-249d207ec27e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"required\": true,\n \"default_value\": \"string\",\n \"agent_visible\": false,\n \"agent_editable\": true,\n \"user_editable\": false,\n \"display_order\": 6732,\n \"validation\": {\n \"key_0\": 1682,\n \"key_1\": \"string\"\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"read_write\"\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 \"name\": \"string\",\n \"key\": \"string\",\n \"field_type\": \"multiselect\",\n \"required\": false,\n \"agent_visible\": false,\n \"agent_editable\": false,\n \"user_editable\": true,\n \"display_order\": 9481,\n \"is_active\": false,\n \"created_at\": \"1994-07-23T18:56:03.212Z\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": \"string\",\n \"validation\": {\n \"key_0\": 1051.423984641111,\n \"key_1\": 2124.6222261986104\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"none\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b5560c01-6123-4152-b449-7cd38f68ae29","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"required\": true,\n \"default_value\": \"string\",\n \"agent_visible\": false,\n \"agent_editable\": true,\n \"user_editable\": false,\n \"display_order\": 6732,\n \"validation\": {\n \"key_0\": 1682,\n \"key_1\": \"string\"\n },\n \"ai_hint\": \"string\",\n \"option_descriptions\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"ai_access\": \"read_write\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"37189e92-8654-4baa-8d1e-efe5cc7742c7","name":"Delete Custom Field","request":{"name":"Delete Custom Field","description":{"content":"Delete (deactivate) a custom field definition.\n\nThe field is soft-deleted (marked inactive) to preserve existing data.\nInactive fields are not shown in the UI and cannot be assigned new values.\n\n**Required Scopes:** `settings:admin`","type":"text/plain"},"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"662e5c2e-e233-40f0-848b-934179ed9e20","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d74a67e9-75fd-4740-bb26-78bc10a7b7ee","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","custom-fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4f4d04dc-90c6-4144-acc0-19290c6f564d","name":"Set Contact Field Value","request":{"name":"Set Contact Field Value","description":{"content":"Set a custom field value for a contact.\n\nThe value is validated against the field's type and options (if applicable).\nFor SELECT/MULTISELECT fields, values that don't match the defined options\nare rejected with 400 (matching is case-insensitive; the canonical option\nspelling is stored). If the field has `validation` constraints, a value\noutside them is rejected with 422 (`code: validation_failed`).\n\n**Required Scopes:** `contacts:update`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": {}\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"301758f0-3bbc-40b8-9c20-0a6b26ce5728","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": {}\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Resource deleted successfully\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"78de8591-ea9f-4c08-991a-f7dedf9d9479","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","fields",":field_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"field_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": {}\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2d72f197-0b26-434a-b026-ccbc839abe6b","name":"Get Contact Field Values","request":{"name":"Get Contact Field Values","description":{"content":"Get all custom field values for a contact.\n\nReturns all custom fields with their current values for the specified contact.\n\n**Required Scopes:** `contacts:read`","type":"text/plain"},"url":{"path":["api","v1","contacts",":contact_id","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ca6f382c-7d3e-4853-ad27-2f0d50dcab2e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"contact_id\": \"ct-12345678\",\n \"fields\": [\n {\n \"field_id\": \"cf-12345678\",\n \"field_key\": \"company_size\",\n \"field_name\": \"Company Size\",\n \"field_type\": \"select\",\n \"value\": \"51-200\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87268c9f-9d67-4f99-b37a-2f82da484e12","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","contacts",":contact_id","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"contact_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"de7f3c0b-09c2-480f-ac82-4b9c68989c75","name":"Custom Inboxes","description":{"content":"Create and manage custom conversation inboxes with filtered views and per-user access control.","type":"text/plain"},"item":[{"id":"08a4d213-fe49-45dc-be87-361570f3b309","name":"List Inboxes","request":{"name":"List Inboxes","description":{"content":"List custom inboxes the caller can access.\n\nAdmins / owners see every inbox in the tenant. Other users see inboxes\nwhose ``access_mode='all'`` plus any inbox where they're listed in the\nACL.\n\nInboxes are saved conversation views, so reads are gated by\n``conversations:read`` (a dedicated ``inboxes:read`` scope is redundant\nand blocked Support Agent / Viewer roles unnecessarily).\n\n**Required Scopes:** ``conversations:read``","type":"text/plain"},"url":{"path":["api","v1","inboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"585597a3-ea44-43a2-bcb4-18eb61d89b06","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4450071c-30ca-4671-9f60-984b4f81b7b7","name":"Create Inbox","request":{"name":"Create Inbox","description":{"content":"Create a new inbox.\n\n**Required Scopes:** ``inboxes:create`` (+ plan feature ``custom_inboxes``)","type":"text/plain"},"url":{"path":["api","v1","inboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"access_mode\": \"all\",\n \"tag_filter_mode\": \"none\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_active\": true,\n \"sort_order\": 0\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9a357dcd-b844-4c81-8704-cdd21b3a3a6e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"access_mode\": \"all\",\n \"tag_filter_mode\": \"none\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_active\": true,\n \"sort_order\": 0\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"access_mode\": \"string\",\n \"tag_filter_mode\": \"string\",\n \"is_active\": false,\n \"sort_order\": 3474,\n \"created_at\": \"1959-10-01T12:34:21.714Z\",\n \"updated_at\": \"2023-11-08T08:12:23.180Z\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1ba3802e-846d-473b-9614-9a31a821d596","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","inboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"access_mode\": \"all\",\n \"tag_filter_mode\": \"none\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_active\": true,\n \"sort_order\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ffd89411-72a9-415b-a78e-8c47ee395225","name":"Get Inbox","request":{"name":"Get Inbox","description":{"content":"Get a single inbox. 404 if it doesn't exist or the caller can't see it.\n\nInboxes are saved conversation views, so reads are gated by\n``conversations:read``.\n\n**Required Scopes:** ``conversations:read``","type":"text/plain"},"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"42ddc4cc-ee44-4661-a384-0d73f9bc566c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"access_mode\": \"string\",\n \"tag_filter_mode\": \"string\",\n \"is_active\": false,\n \"sort_order\": 3474,\n \"created_at\": \"1959-10-01T12:34:21.714Z\",\n \"updated_at\": \"2023-11-08T08:12:23.180Z\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ca998cbc-e761-4317-8c6f-cbf2c820b441","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2455ad49-fe1d-4e8c-9826-7c97afc8eaae","name":"Update Inbox","request":{"name":"Update Inbox","description":{"content":"Partial update.\n\n**Required Scopes:** ``inboxes:update`` (+ plan feature ``custom_inboxes``)","type":"text/plain"},"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"access_mode\": {\n \"value\": \"\"\n },\n \"tag_filter_mode\": {\n \"value\": \"\"\n },\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"all_channels\": true,\n \"access_tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_active\": false,\n \"sort_order\": 3489\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"32164b24-21fe-49a3-bd09-43a182edd28f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"access_mode\": {\n \"value\": \"\"\n },\n \"tag_filter_mode\": {\n \"value\": \"\"\n },\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"all_channels\": true,\n \"access_tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_active\": false,\n \"sort_order\": 3489\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 \"name\": \"string\",\n \"access_mode\": \"string\",\n \"tag_filter_mode\": \"string\",\n \"is_active\": false,\n \"sort_order\": 3474,\n \"created_at\": \"1959-10-01T12:34:21.714Z\",\n \"updated_at\": \"2023-11-08T08:12:23.180Z\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"23f9247b-f83b-47b5-b1ef-b19d5924480e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"access_mode\": {\n \"value\": \"\"\n },\n \"tag_filter_mode\": {\n \"value\": \"\"\n },\n \"channel_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"all_channels\": true,\n \"access_tag_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"is_active\": false,\n \"sort_order\": 3489\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1003708f-8ed5-4da5-90fd-7a304f0c1c7e","name":"Delete Inbox","request":{"name":"Delete Inbox","description":{"content":"Hard delete an inbox + child rows.\n\n**Required Scopes:** ``inboxes:delete`` (+ plan feature ``custom_inboxes``)","type":"text/plain"},"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"f3cb51d7-152f-468a-91ae-aef1604b0118","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Resource deleted successfully\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0731ed01-836d-4d0f-91bb-b1b7d2c2ecb4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"87dfab0f-9dde-4b1d-99ac-62796565e913","name":"Get Inbox Sender Options","request":{"name":"Get Inbox Sender Options","description":{"content":"List email senders the caller may use for composing a NEW email from\ninside this inbox.\n\nIf the inbox has exactly one receiving email connection and that\nconnection has a configured ``outbound_provider_id``, that's the\npre-selected default. Otherwise the caller picks from their accessible\nsupport-capable mailboxes.\n\nInboxes are saved conversation views, so reads are gated by\n``conversations:read``.\n\n**Required Scopes:** ``conversations:read``","type":"text/plain"},"url":{"path":["api","v1","inboxes",":inbox_id","sender-options"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"c4042715-3851-4582-94db-ccb7890fe7a2","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id","sender-options"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"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":"07307222-12e7-4a44-b581-27c0830c09e5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id","sender-options"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"238d88a9-dcb9-4932-a9bd-2f32f93b480d","name":"Set Inbox Users","request":{"name":"Set Inbox Users","description":{"content":"Replace the full per-inbox ACL list.\n\n**Required Scopes:** ``inboxes:update`` (+ plan feature ``custom_inboxes``)","type":"text/plain"},"url":{"path":["api","v1","inboxes",":inbox_id","users"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"user_ids\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"778be61e-3bbc-4df4-bfd9-fcc7890424f8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id","users"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"user_ids\": [\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 \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"access_mode\": \"string\",\n \"tag_filter_mode\": \"string\",\n \"is_active\": false,\n \"sort_order\": 3474,\n \"created_at\": \"1959-10-01T12:34:21.714Z\",\n \"updated_at\": \"2023-11-08T08:12:23.180Z\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"color\": \"string\",\n \"channel_ids\": [\n \"string\",\n \"string\"\n ],\n \"email_connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"field_filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ],\n \"all_channels\": false,\n \"access_tag_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb6af8dc-cd89-45ea-920a-e17a5b3836ac","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","inboxes",":inbox_id","users"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"inbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"user_ids\": [\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"3e3ef049-a4c1-4555-8fe8-ac54f21a729a","name":"Double Opt-In","description":{"content":"Manage double opt-in confirmation flows for email and messaging subscriptions.","type":"text/plain"},"item":[{"id":"03827011-dd9d-483c-b69c-c5ac0560f7a4","name":"Send Confirmation Email","request":{"name":"Send Confirmation Email","description":{"content":"Send double opt-in confirmation email to contact\n\nThis endpoint:\n1. Creates or finds contact by email\n2. Creates pending subscription record\n3. Generates secure confirmation token\n4. Sends confirmation email with link\n\n**GDPR Compliance:** IP address and user agent are stored for audit trail\n\n**Rate Limiting:** Maximum 3 confirmation emails per email per hour (TODO: implement)\n\nArgs:\n request_data: Email confirmation request details\n tenant_id: Tenant ID from auth token\n\nReturns:\n Confirmation details including token ID and expiry time\n\nRaises:\n HTTPException 400: If email sending fails\n HTTPException 500: If internal error occurs\n\n**🔐 Required Scopes:** `email:update`\n","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","send"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"ZIUHCCIIE9zjMF@HGWNSplvFGZoLrPQOeJNEyRfkV.amyv\",\n \"list_id\": \"string\",\n \"category\": \"string\",\n \"ip_address\": \"string\",\n \"user_agent\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a2aa60a2-7436-4a47-889b-dfed1e7c1ec3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","send"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"ZIUHCCIIE9zjMF@HGWNSplvFGZoLrPQOeJNEyRfkV.amyv\",\n \"list_id\": \"string\",\n \"category\": \"string\",\n \"ip_address\": \"string\",\n \"user_agent\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token_id\": \"string\",\n \"message\": \"string\",\n \"expires_at\": \"1994-10-25T11:02:48.156Z\",\n \"email\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a724772-891d-4654-b1ee-2ff4b8afe469","name":"No list given, a list is not in this workspace, or no email sender is configured","originalRequest":{"url":{"path":["api","v1","double-opt-in","send"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"ZIUHCCIIE9zjMF@HGWNSplvFGZoLrPQOeJNEyRfkV.amyv\",\n \"list_id\": \"string\",\n \"category\": \"string\",\n \"ip_address\": \"string\",\n \"user_agent\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"125f1849-cfdb-4e93-bc06-e3a9e0cd8929","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","send"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"ZIUHCCIIE9zjMF@HGWNSplvFGZoLrPQOeJNEyRfkV.amyv\",\n \"list_id\": \"string\",\n \"category\": \"string\",\n \"ip_address\": \"string\",\n \"user_agent\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"147a7aa6-1d95-4498-9d71-47270bdd5a25","name":"The confirmation email could not be sent (generic message, no internal detail)","originalRequest":{"url":{"path":["api","v1","double-opt-in","send"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"ZIUHCCIIE9zjMF@HGWNSplvFGZoLrPQOeJNEyRfkV.amyv\",\n \"list_id\": \"string\",\n \"category\": \"string\",\n \"ip_address\": \"string\",\n \"user_agent\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"99c7c5bc-ae41-4580-840c-c012e9408447","name":"Resend Confirmation Email","request":{"name":"Resend Confirmation Email","description":{"content":"Resend confirmation email for pending subscription\n\nIf the original token has expired, a new token will be generated.\nIf the original token is still valid, the same confirmation link will be resent.\n\nArgs:\n request_data: Email address to resend confirmation to\n tenant_id: Tenant ID from auth token\n\nReturns:\n Success message\n\nRaises:\n HTTPException 404: If no pending confirmation found for this email\n HTTPException 400: If resend fails\n\n**🔐 Required Scopes:** `email:update`\n","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","resend"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"pvmQxI@tkdpkjmXWutXOuVrUdGDdoRGh.lvrq\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"08f86e2d-8f71-41da-8416-23fd9b5e15f8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","resend"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"pvmQxI@tkdpkjmXWutXOuVrUdGDdoRGh.lvrq\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b4664a6-66b0-4507-a24d-89d02b89d98c","name":"A list is not in this workspace, or no email sender is configured","originalRequest":{"url":{"path":["api","v1","double-opt-in","resend"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"pvmQxI@tkdpkjmXWutXOuVrUdGDdoRGh.lvrq\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bcb866b6-d902-487f-8187-03f8e6788622","name":"No pending confirmation for this email address","originalRequest":{"url":{"path":["api","v1","double-opt-in","resend"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"pvmQxI@tkdpkjmXWutXOuVrUdGDdoRGh.lvrq\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"910e4ef5-3cba-4fcc-9b71-2820ac4103f2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","resend"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"pvmQxI@tkdpkjmXWutXOuVrUdGDdoRGh.lvrq\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c18d9c3c-ff02-4e6a-9da7-8589b19e644f","name":"The confirmation email could not be resent (generic message, no internal detail)","originalRequest":{"url":{"path":["api","v1","double-opt-in","resend"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"pvmQxI@tkdpkjmXWutXOuVrUdGDdoRGh.lvrq\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"57f6043b-75db-4c7f-beeb-ca1fa7193505","name":"Get Pending Confirmations","request":{"name":"Get Pending Confirmations","description":{"content":"Get list of pending email confirmations\n\nShows all contacts awaiting email confirmation for this tenant.\nUseful for admin dashboard to track conversion rates.\n\nArgs:\n limit: Maximum number of results (default 100, max 1000)\n offset: Pagination offset (default 0)\n tenant_id: Tenant ID from auth token\n\nReturns:\n List of pending confirmations with pagination info\n\n**🔐 Required Scopes:** `email:read`\n","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","pending"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100"},{"disabled":false,"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7772c7ab-fa1f-4723-8a46-208cdf60e2de","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","pending"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pending_confirmations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total\": 5327,\n \"limit\": 6098,\n \"offset\": 8421\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"596bbd98-0ada-4acd-b4e2-a4b01ce4d984","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","pending"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"d4757a47-b16b-46c0-aaef-e45e22981ad5","name":"Double Opt-In Templates","description":{"content":"Create and customize confirmation message templates for double opt-in flows.","type":"text/plain"},"item":[{"id":"87125e3c-1ab3-45f3-b115-07bc8a52e524","name":"List Templates","request":{"name":"List Templates","description":{"content":"List all double opt-in templates available to the tenant.\n\nArgs:\n include_system: Include system templates (default: True)\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nReturns:\n List of templates (tenant custom + system if include_system=True)","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"include_system","value":"true"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"254f30b3-2531-4302-9ed4-2d613bb63ff8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates"],"host":["{{baseUrl}}"],"query":[{"key":"include_system","value":"true"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"email_content_id\": {\n \"value\": \"\"\n },\n \"is_system_template\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"button_text\": {\n \"value\": \"\"\n },\n \"subject_line\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"email_content_id\": {\n \"value\": \"\"\n },\n \"is_system_template\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"button_text\": {\n \"value\": \"\"\n },\n \"subject_line\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"c1c09b1e-ddce-4a77-bc50-4fb5284de0a6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates"],"host":["{{baseUrl}}"],"query":[{"key":"include_system","value":"true"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7cea97f4-5682-4c97-b0ca-408098bd1f4f","name":"Create Template","request":{"name":"Create Template","description":{"content":"Create a new double opt-in template.\n\nIf copy_from_system=True, finds the system template and duplicates its EmailContent.\nIf copy_from_system=False, uses the provided email_content_id.\n\nArgs:\n template_data: Template creation data\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nReturns:\n Created template\n\nRaises:\n 400: If validation fails\n 404: If email_content_id or system template not found\n\n**🔐 Required Scopes:** `email:read`\n","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true,\n \"email_content_id\": \"string\",\n \"copy_from_system\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a547a79d-e033-4c82-bf68-b59f66bd716f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true,\n \"email_content_id\": \"string\",\n \"copy_from_system\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"name\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"email_content_id\": \"string\",\n \"is_system_template\": false,\n \"created_at\": \"1980-09-23T04:28:54.328Z\",\n \"updated_at\": \"1963-11-01T06:28:39.422Z\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"863e5d1b-69bf-459b-b050-6c4e1e1dfaa3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true,\n \"email_content_id\": \"string\",\n \"copy_from_system\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6e900544-cff2-49fc-95a8-f8780ac28de8","name":"Get Template","request":{"name":"Get Template","description":{"content":"Get a specific template by ID.\n\nArgs:\n template_id: Template ID\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nReturns:\n Template details\n\nRaises:\n 404: If template not found or not accessible","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","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"},"response":[{"id":"4c97fcd0-a7ee-4bae-85b3-adf006a87534","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"name\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"email_content_id\": \"string\",\n \"is_system_template\": false,\n \"created_at\": \"1980-09-23T04:28:54.328Z\",\n \"updated_at\": \"1963-11-01T06:28:39.422Z\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b8b0057b-b954-4ec2-b8f3-bea0bc42e6de","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"75eaa3ac-f381-4c3a-95ba-18f7afba456e","name":"Update Template","request":{"name":"Update Template","description":{"content":"Update a template.\n\nArgs:\n template_id: Template ID\n template_data: Fields to update\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nReturns:\n Updated template\n\nRaises:\n 404: If template not found\n 403: If trying to edit system template","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","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","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"string\",\n \"subject_line\": \"string\",\n \"email_content_id\": \"string\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2eae4692-9a34-479c-8731-d8ba0ab6044d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","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":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"string\",\n \"subject_line\": \"string\",\n \"email_content_id\": \"string\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"name\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"email_content_id\": \"string\",\n \"is_system_template\": false,\n \"created_at\": \"1980-09-23T04:28:54.328Z\",\n \"updated_at\": \"1963-11-01T06:28:39.422Z\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2143c031-3f99-4905-8047-118f9392625f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","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":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"string\",\n \"subject_line\": \"string\",\n \"email_content_id\": \"string\",\n \"is_active\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a25f6c0e-db7c-4acd-857e-221402a4a855","name":"Delete Template","request":{"name":"Delete Template","description":{"content":"Delete a template.\n\nArgs:\n template_id: Template ID\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nRaises:\n 404: If template not found\n 403: If trying to delete system template","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","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":"DELETE"},"response":[{"id":"aeb11b7f-967b-4fd7-b16b-7d5f5dea1c47","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates",":template_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"template_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"df4b28ea-f715-42e3-91fd-b4b6a7ec2190","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","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":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ae8baf81-ee6d-4dc6-954c-b6ffc58c4143","name":"Copy System Template","request":{"name":"Copy System Template","description":{"content":"Copy a system template to tenant's custom templates.\n\nThis allows tenants to customize system templates. Creates a duplicate\nof the EmailContent and a new DoubleOptInEmailTemplate with tenant_id.\n\nArgs:\n template_id: System template ID to copy\n copy_data: Optional overrides for name, description, button_text, subject_line\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nReturns:\n New template owned by tenant\n\nRaises:\n 404: If system template not found\n 400: If trying to copy non-system template\n\n**🔐 Required Scopes:** `email:create`\n","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","templates",":template_id","copy"],"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":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"string\",\n \"subject_line\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8392c78a-8ad8-4998-a229-35f09beb0800","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates",":template_id","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"template_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"string\",\n \"subject_line\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"name\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"email_content_id\": \"string\",\n \"is_system_template\": false,\n \"created_at\": \"1980-09-23T04:28:54.328Z\",\n \"updated_at\": \"1963-11-01T06:28:39.422Z\",\n \"description\": \"string\",\n \"button_text\": \"Confirm Subscription\",\n \"subject_line\": \"Please confirm your subscription\",\n \"is_active\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d29d5ea9-8642-4bc2-8212-bc983b77eda1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates",":template_id","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"template_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"button_text\": \"string\",\n \"subject_line\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d5cf4ec2-37e3-4389-9568-20fa2e4a8c53","name":"Preview Template","request":{"name":"Preview Template","description":{"content":"Generate HTML preview for a double opt-in template.\n\nUses example/placeholder values for confirmation_url, email, etc.\n\nArgs:\n template_id: Template ID\n tenant_id: Current tenant ID\n current_user: Current authenticated user\n\nReturns:\n {\"html\": \"...rendered HTML...\", \"subject\": \"...subject line...\"}\n\nRaises:\n 400: If the template has no renderable email content yet\n 404: If template or email content not found\n 500: If MJML compilation fails\n\n**🔐 Required Scopes:** `email:read`\n","type":"text/plain"},"url":{"path":["api","v1","double-opt-in","templates",":template_id","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"template_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"e87418ec-99f2-4f16-949d-6214e6acb4d9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates",":template_id","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"template_id","description":"(Required) "}]},"header":[{"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":"0190910f-6482-4b41-9ada-35f2706526bd","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","double-opt-in","templates",":template_id","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"template_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"d6428b4b-e3b0-4c43-b112-221c133fddf1","name":"Email Campaigns","description":{"content":"Create, schedule, and send email marketing campaigns using layout templates and content blocks. Track opens and clicks.","type":"text/plain"},"item":[{"id":"818f4a03-f569-41ec-bd5a-a737c285db67","name":"Get Recipient Count","request":{"name":"Get Recipient Count","description":{"content":"Audience preview and price for an UNSAVED campaign draft.\n\nCounts come from the same recipient resolution the send uses (subscribed\nlist members only, spam complaints / hard bounces / suppressed addresses\nexcluded, duplicate addresses collapsed), so `subscribed` is the number of\nemails the campaign will actually send.\n\nAudience: `all_contacts` wins; else `list_ids`; else\n`subscription_categories`; nothing selected returns zeros.\n\n- **total**: contacts matching the audience before exclusions\n- **subscribed** / **recipient_count**: valid recipients\n- **unsubscribed**, **bounced**, **duplicate_email_skipped_count**,\n **no_email_count**: why the rest are excluded\n (`total` = the sum of all five)\n- **cost**: present when `email_provider_config_id` or\n `email_integration_id` is given -- the real price from the tenant's\n pricing model (managed vs own-provider rate, same as the invoice),\n before the plan's included messages. An id that is not one of this\n workspace's providers / integrations returns HTTP 404\n (\"Email provider configuration not found\" / \"Email integration not found\").\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns","recipient-count"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"all_contacts\": false,\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"757d8060-97fa-46cc-bc0c-22f414d1aa52","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns","recipient-count"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"all_contacts\": false,\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"bounced\": 18,\n \"cost\": {\n \"cost_category\": \"email_campaign_managed\",\n \"cost_per_email\": 0.8,\n \"plan_included_messages\": 1000,\n \"recipient_count\": 950,\n \"sending_type\": \"managed\",\n \"total_cost\": 760,\n \"total_cost_eur\": \"7.60\",\n \"total_cost_eur_precise\": \"7.600000\",\n \"unit_price_eur\": \"0.008000\"\n },\n \"duplicate_email_skipped_count\": 2,\n \"list_breakdown\": {\n \"list-456\": 420,\n \"list-789\": 600\n },\n \"no_email_count\": 0,\n \"recipient_count\": 950,\n \"subscribed\": 950,\n \"subscription_breakdown\": {},\n \"total\": 1000,\n \"unsubscribed\": 30\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5673d4ad-29de-47ce-bfd1-99b02cb97c77","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns","recipient-count"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"all_contacts\": false,\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_provider_config_id\": \"string\",\n \"email_integration_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5a677012-66e1-45ef-900c-a28543fd3dbc","name":"Create Campaign","request":{"name":"Create Campaign","description":{"content":"Create a new email campaign.\n\n- Creates both base Campaign and EmailCampaign records\n- Validates provider/integration and content exist\n- Estimates recipient count\n- Optional `send_rate_limit` (emails per minute, 1-60000) and\n `send_batch_size` (recipients per batch, at least 1). Rejected values\n return HTTP 422 `{code, message}`: `send_rate_limit_out_of_range`,\n `send_batch_size_invalid`, `send_pacing_unavailable`.\n\n**Required Scopes:** `campaigns:create`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"subject_line\": \"string\",\n \"mailbox_id\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"strin\",\n \"from_email\": \"OKUcFEa@zObrLWAxwADQMpXjCZoSEFuLJyvvzlSfQ.tuc\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": false,\n \"track_clicks\": false,\n \"scheduled_at\": \"2015-08-28T06:06:06.871Z\",\n \"status\": \"string\",\n \"send_rate_limit\": 5544,\n \"send_batch_size\": 4289\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"81bf9986-a344-43da-8337-5bf359533c2a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"subject_line\": \"string\",\n \"mailbox_id\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"strin\",\n \"from_email\": \"OKUcFEa@zObrLWAxwADQMpXjCZoSEFuLJyvvzlSfQ.tuc\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": false,\n \"track_clicks\": false,\n \"scheduled_at\": \"2015-08-28T06:06:06.871Z\",\n \"status\": \"string\",\n \"send_rate_limit\": 5544,\n \"send_batch_size\": 4289\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5b348e8e-9212-44a7-88e7-6374c25a9384","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"subject_line\": \"string\",\n \"mailbox_id\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"strin\",\n \"from_email\": \"OKUcFEa@zObrLWAxwADQMpXjCZoSEFuLJyvvzlSfQ.tuc\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": false,\n \"track_clicks\": false,\n \"scheduled_at\": \"2015-08-28T06:06:06.871Z\",\n \"status\": \"string\",\n \"send_rate_limit\": 5544,\n \"send_batch_size\": 4289\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c83fef38-5cb5-4e80-b15f-fdd7deec47d9","name":"List Campaigns","request":{"name":"List Campaigns","description":{"content":"List email campaigns with pagination.\n\nReturns a paginated list of email campaigns for the tenant.\n\n**Required Scopes:** `campaigns:read`\n\n**Response format:**\n```json\n{\n \"items\": [...],\n \"pagination\": {\n \"total\": 50,\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 3,\n \"has_next\": true,\n \"has_prev\": false\n }\n}\n```","type":"text/plain"},"url":{"path":["api","v1","email-campaigns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"},{"disabled":false,"key":"campaign_status","value":"string","description":"Filter by campaign status"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"08896a2a-f426-45ad-9d01-50d2c204a9a8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"campaign_status","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e555aadc-1f11-4f19-b528-5ad3614ae14b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"campaign_status","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dd2c24a7-22de-40eb-980e-1094399a6f88","name":"Get Email Campaign Unsubscribe Counts","request":{"name":"Get Email Campaign Unsubscribe Counts","description":{"content":"Batch opt-out counts for the email campaigns INDEX page.\n\nONE grouped query over ``unsubscribe_tokens`` (used tokens) for the given\nemail campaign ids (``EmailCampaign.id``, tenant-scoped). All email opt-outs\nare link/one-click, so per campaign ``exact == total`` and ``estimated`` is\nalways 0. Campaigns with no opt-outs are OMITTED — treat a missing id as 0.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns","unsubscribe-counts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"ids","value":"string","description":"(Required) Comma-separated email campaign ids (max 200)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"c76f14e4-de1c-4273-9f52-d309ab300613","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns","unsubscribe-counts"],"host":["{{baseUrl}}"],"query":[{"key":"ids","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"counts\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"23332433-eeef-4bb2-8198-00327e9bf0cb","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns","unsubscribe-counts"],"host":["{{baseUrl}}"],"query":[{"key":"ids","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b9ac33ef-431a-4692-9f59-9608f862da9a","name":"Get Campaign","request":{"name":"Get Campaign","description":{"content":"Get email campaign details.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-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"},"response":[{"id":"b47f847e-33d7-49f9-b315-e71cfc4af6be","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1fc232dd-8ae3-4587-a6a5-c65e2f4c09b6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ea4a3ed9-f3f9-4e26-b14f-d4990e6bd5bd","name":"Update Campaign","request":{"name":"Update Campaign","description":{"content":"Update email campaign.\n\n- Can only update campaigns in DRAFT or SCHEDULED status\n- Once sending/sent, campaigns are immutable -- except the send speed\n (`send_rate_limit`, emails per minute) and batch size\n (`send_batch_size`): a sending, paused or failed campaign may change\n ONLY these two (explicit `null` clears one). The next emails and the\n next batch use the new values. Switching them on while the campaign is\n sending moves the recipients not sent yet into batch 1 at the new speed.\n- Rejected values return HTTP 422 `{code, message}`:\n `send_rate_limit_out_of_range`, `send_batch_size_invalid`,\n `send_pacing_unavailable`, `send_pacing_not_editable` (any other status,\n e.g. completed or cancelled).\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","email-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","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"s5aK4Z8u9EXGs@WKeFgERckDtVmCbZym.hxuu\",\n \"reply_to_email\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": true,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"scheduled_at\": \"1949-12-13T13:26:14.721Z\",\n \"send_rate_limit\": 8089,\n \"send_batch_size\": 34\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ed836860-1ef7-4f16-be0d-0a278bbe73eb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-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":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"s5aK4Z8u9EXGs@WKeFgERckDtVmCbZym.hxuu\",\n \"reply_to_email\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": true,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"scheduled_at\": \"1949-12-13T13:26:14.721Z\",\n \"send_rate_limit\": 8089,\n \"send_batch_size\": 34\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"163a6d9a-8048-426f-9c1a-07b237189ba5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-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":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"s5aK4Z8u9EXGs@WKeFgERckDtVmCbZym.hxuu\",\n \"reply_to_email\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": true,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"scheduled_at\": \"1949-12-13T13:26:14.721Z\",\n \"send_rate_limit\": 8089,\n \"send_batch_size\": 34\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4a02240-ea72-4d2c-a25e-e549c189d9d8","name":"Delete Campaign","request":{"name":"Delete Campaign","description":{"content":"Delete email campaign.\n\n- Sending, throttled (paused by the send limit) and completed campaigns\n cannot be deleted: 400 `Cannot delete campaign that has been sent`.\n Pause the campaign first, then delete it.\n- A paused, cancelled or failed campaign can be deleted; the emails it\n already sent stay on the invoice (they are kept for billing before the\n delete, in the month they were sent).\n\n**Required Scopes:** `campaigns:delete`","type":"text/plain"},"url":{"path":["api","v1","email-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":"DELETE"},"response":[{"id":"17e6d402-9dd7-471c-824c-7837295ea44c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9d0e3631-b3b4-4560-8a52-4b60de3e7948","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-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":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ef27fd20-7690-4526-a070-83dbf1cb6dde","name":"Send Campaign","request":{"name":"Send Campaign","description":{"content":"Send or schedule email campaign.\n\n- If send_test=true, sends to test_emails only (TODO)\n- Otherwise, queues campaign to Pub/Sub for async sending\n- Updates campaign status to SENDING\n- Deducts balance upfront (prepaid model)\n- Send speed and batches: with a `send_rate_limit` and/or\n `send_batch_size` saved on the campaign, the emails go out at that\n speed and in batches of that size. After each batch the campaign pauses\n (`status = \"paused\"`, `throttle_reason = \"batch_complete\"`) until\n `POST /email-campaigns/{id}/send-next-batch`. A saved batch size that\n cannot be used returns HTTP 422 `{code, message}` before anything is\n sent (`send_pacing_unavailable`, `send_batch_size_invalid`).\n- HTTP 409 \"This campaign is already being sent\" when the campaign is\n already `sending` / `throttled` / `paused`, or a concurrent request (a\n second click, the scheduled send) started it first -- nothing is queued\n twice. HTTP 409 \"This campaign was paused or cancelled while it was\n being prepared for sending. Refresh and try again.\" when that happened\n during the send.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","send"],"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":"POST","body":{"mode":"raw","raw":"{\n \"send_test\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0d1b8726-10db-4316-8e41-6cc986378e27","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","send"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"send_test\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"campaign_id\": \"campaign-789\",\n \"estimated_recipients\": 1000,\n \"message\": \"Campaign queued for sending\",\n \"status\": \"sending\",\n \"success\": true,\n \"warnings\": []\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb46c125-f8d3-44c6-9453-973d6c43100e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","send"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"send_test\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fbbb72fe-836d-4ef0-9d37-92ac122496c5","name":"Schedule Campaign","request":{"name":"Schedule Campaign","description":{"content":"Schedule an email campaign for future sending.\n\nAccepts a local datetime and IANA timezone string. The backend converts to UTC\nfor storage. The original timezone is preserved for display purposes.\n\nThe scheduled time must be at least 5 minutes in the future.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","schedule"],"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":"POST","body":{"mode":"raw","raw":"{\n \"scheduled_at\": \"2026-03-01T14:00:00\",\n \"timezone\": \"Europe/Berlin\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"32cf2de7-4218-4897-b239-339c7174e0ee","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduled_at\": \"2026-03-01T14:00:00\",\n \"timezone\": \"Europe/Berlin\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"833b095e-f090-43c1-be8e-0beef79c54d8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduled_at\": \"2026-03-01T14:00:00\",\n \"timezone\": \"Europe/Berlin\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"52e10919-086b-49bd-97fe-fbe47d0cf9bf","name":"Cancel Schedule","request":{"name":"Cancel Schedule","description":{"content":"Cancel a scheduled email campaign and move it back to draft.\n\nThis clears the scheduled_at time and reverts the status to draft,\nallowing the user to edit and reschedule. The timezone is preserved\nfor convenience if the user reschedules later.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","cancel-schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"f3f25db8-8e3f-472c-8a8b-97085811f355","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","cancel-schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38bcdfa5-bc1e-49a3-841c-3f5cb8ec4d59","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","cancel-schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e3f1ae36-0ec1-473f-a720-b2751edbe75c","name":"Cancel Campaign","request":{"name":"Cancel Campaign","description":{"content":"Cancel scheduled, sending or paused campaign.\n\n- Updates status to CANCELLED (also from `paused`, including a campaign\n waiting for its next batch)\n- Stops further Pub/Sub processing\n- Recipients still waiting for a later batch are not sent\n- Does NOT refund balance (already deducted)\n\nNeeds the same scope as send / pause / resume (`campaigns:send`):\nstopping a send is a send-control action, not a content edit.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","email-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"},"response":[{"id":"87cf8ed6-b5e7-4c9f-b21c-ef2479e71a16","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8603832c-a0c3-49b4-9b1e-224f23249a92","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"44f30105-a8ab-4522-b87f-963cf004698a","name":"Pause Email Campaign","request":{"name":"Pause Email Campaign","description":{"content":"Pause a sending email campaign\n\nOnly a campaign in `sending` or `throttled` can be paused (anything else\nreturns HTTP 400). Emails already handed to the email provider are not\nrecalled; everyone else waits until `POST /email-campaigns/{id}/resume`.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","email-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"},"response":[{"id":"45d4cd99-76be-4dde-9af1-deb8e5874246","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec0bb95d-f9a4-45c4-996b-ea612ae4791e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"08fdc253-40d5-4b2f-ae0d-26f9531bd565","name":"Resume Email Campaign","request":{"name":"Resume Email Campaign","description":{"content":"Resume a paused email campaign\n\nOnly a `paused` campaign can be resumed (anything else returns HTTP 400).\nSending continues with everyone who has not been sent yet. If a send\nspeed or batch size was saved while the campaign was paused, it applies\nfrom now on. A campaign that finished a batch\n(`throttle_reason = \"batch_complete\"`) sends its next batch, exactly\nlike `POST /email-campaigns/{id}/send-next-batch` with an empty body.\nA campaign sent in batches that ended as `completed` or `failed` while\nrecipients were still waiting is re-opened the same way. HTTP 422\n`send_pacing_unavailable` while sending at a set speed or in batches is\nbriefly unavailable.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","email-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"},"response":[{"id":"64bb7045-0f2a-4a33-adf1-3b1743adf118","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"campaign_id\": \"string\",\n \"subject_line\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"updated_at\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"email_integration_id\": \"string\",\n \"sending_method\": \"string\",\n \"email_template_id\": \"string\",\n \"email_content_id\": \"string\",\n \"preview_text\": \"string\",\n \"reply_to_email\": \"string\",\n \"subscription_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"list_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"personalization_enabled\": false,\n \"tracking_enabled\": true,\n \"track_clicks\": true,\n \"sent_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"clicked_count\": 0,\n \"bounced_count\": 0,\n \"complained_count\": 0,\n \"failed_count\": 0,\n \"recipient_count\": 0,\n \"campaign_name\": \"string\",\n \"campaign_status\": \"string\",\n \"scheduled_at\": \"1969-05-28T06:46:02.366Z\",\n \"timezone\": \"string\",\n \"throttle_reason\": \"string\",\n \"send_rate_limit\": 6116,\n \"send_batch_size\": 5593,\n \"current_batch_number\": 7995\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"93934602-44b9-4901-857e-655b851d13cb","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-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","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f3a84a7c-5343-488d-8572-13295ac7cafa","name":"Send Next Email Batch","request":{"name":"Send Next Email Batch","description":{"content":"Send the next batch of an email campaign sent in batches\n\nOnly for a campaign that finished a batch: `status = \"paused\"` with\n`throttle_reason = \"batch_complete\"`, or one that ended as `completed` /\n`failed` while recipients were still waiting (it continues its unfinished\nbatch first, if any). HTTP 422 `send_pacing_unavailable` while batch\nsending is briefly unavailable. Anything else returns HTTP 409\n`{\"code\": \"campaign_not_awaiting_batch\", \"message\": ...}` (also when two\nrequests race: only the first one sends a batch).\n\nBody (optional): `{\"batch_size\": 500}` sends 500 recipients now and saves\n500 as the campaign's batch size (1-1,000,000; anything else is HTTP 422\n`{\"code\": \"send_batch_size_invalid\", \"message\": ...}`);\n`{\"all_remaining\": true}` sends everyone who is still waiting. An empty\nbody sends the next batch at the saved batch size. Recipients who\nunsubscribed, bounced or were suppressed\nsince the campaign was prepared are skipped (`skipped_ineligible`).\n\n**Response (200):** `{batch_number, armed, skipped_ineligible, remaining,\ncampaign}`.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","send-next-batch"],"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":"POST","body":{"mode":"raw","raw":"{\n \"batch_size\": {\n \"value\": \"\"\n },\n \"all_remaining\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fa95ab56-ad07-4072-8534-7c4e182da73c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","send-next-batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"batch_size\": {\n \"value\": \"\"\n },\n \"all_remaining\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"batch_number\": 8298,\n \"armed\": 5838,\n \"campaign\": {\n \"created_at\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"campaign_id\": {\n \"value\": \"\"\n },\n \"subject_line\": {\n \"value\": \"\"\n },\n \"from_name\": {\n \"value\": \"\"\n },\n \"from_email\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"email_provider_config_id\": {\n \"value\": \"\"\n },\n \"email_integration_id\": {\n \"value\": \"\"\n },\n \"sending_method\": {\n \"value\": \"\"\n },\n \"email_template_id\": {\n \"value\": \"\"\n },\n \"email_content_id\": {\n \"value\": \"\"\n },\n \"preview_text\": {\n \"value\": \"\"\n },\n \"reply_to_email\": {\n \"value\": \"\"\n },\n \"subscription_categories\": {\n \"value\": \"\"\n },\n \"list_ids\": {\n \"value\": \"\"\n },\n \"personalization_enabled\": {\n \"value\": \"\"\n },\n \"tracking_enabled\": {\n \"value\": \"\"\n },\n \"track_clicks\": {\n \"value\": \"\"\n },\n \"sent_count\": {\n \"value\": \"\"\n },\n \"delivered_count\": {\n \"value\": \"\"\n },\n \"opened_count\": {\n \"value\": \"\"\n },\n \"clicked_count\": {\n \"value\": \"\"\n },\n \"bounced_count\": {\n \"value\": \"\"\n },\n \"complained_count\": {\n \"value\": \"\"\n },\n \"failed_count\": {\n \"value\": \"\"\n },\n \"recipient_count\": {\n \"value\": \"\"\n },\n \"campaign_name\": {\n \"value\": \"\"\n },\n \"campaign_status\": {\n \"value\": \"\"\n },\n \"scheduled_at\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"throttle_reason\": {\n \"value\": \"\"\n },\n \"send_rate_limit\": {\n \"value\": \"\"\n },\n \"send_batch_size\": {\n \"value\": \"\"\n },\n \"current_batch_number\": {\n \"value\": \"\"\n }\n },\n \"skipped_ineligible\": 0,\n \"remaining\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bfa3c134-ec77-4311-aee2-e8fd3deb657b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","send-next-batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"batch_size\": {\n \"value\": \"\"\n },\n \"all_remaining\": {\n \"value\": \"\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"90138be1-4e64-4684-aa87-ce9e0951c3e8","name":"List Email Campaign Batches","request":{"name":"List Email Campaign Batches","description":{"content":"Per-batch delivery counts of an email campaign sent in batches\n\nOne item per batch with its recipient counts, oldest batch first.\n`remaining` is the number of recipients waiting for a later batch,\n`current_batch_number` the batch the campaign is on and\n`send_batch_size` the saved batch size. A campaign that is not sent in\nbatches returns an empty list.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","batches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Batches per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"20eebe84-0766-44f2-b609-74a42d3a9810","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","batches"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n },\n \"remaining\": 0,\n \"current_batch_number\": 1092,\n \"send_batch_size\": 4483\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c954878-6f99-41fd-98c8-21a00d8e795d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","batches"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f2ce8fdb-ee60-4f96-b6af-d9cc48b9fc3a","name":"Get Email Campaign Send Plan","request":{"name":"Get Email Campaign Send Plan","description":{"content":"Send plan of an email campaign: speed, batches and estimated duration\n\nRead-only estimate for the campaign's audience at its saved send speed\nand batch size, or at the values given as query parameters (to preview a\nchange before saving it). `eta_seconds` estimates the time to send\neveryone who is left (time paused between batches not included).\n`pacing_available = false` means send speed and batches are not\navailable for this account yet.\n\nOut-of-range query values return HTTP 422 `{code, message}`\n(`send_rate_limit_out_of_range`, `send_batch_size_invalid`).\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","send-plan"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"send_rate_limit","value":"4595","description":"Preview this send speed (emails per minute, 1-60000) instead of the saved one"},{"disabled":false,"key":"send_batch_size","value":"4595","description":"Preview this batch size (>= 1) instead of the saved one"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"865ce1ed-8567-4a96-bed1-42728dc4aa5a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","send-plan"],"host":["{{baseUrl}}"],"query":[{"key":"send_rate_limit","value":"4595"},{"key":"send_batch_size","value":"4595"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pacing_available\": true,\n \"pacing_unavailable_reason\": \"string\",\n \"total_recipients\": 0,\n \"remaining\": 0,\n \"channels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"requested_rate_per_minute\": 1108,\n \"effective_rate_per_minute\": 4324.130843266144,\n \"batch_size\": 6974,\n \"batches\": 6853,\n \"eta_seconds\": 2231,\n \"eta_seconds_per_batch\": 3287,\n \"rate_limited_by\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5300d685-90b1-4c8f-a222-9157b1a899c8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","send-plan"],"host":["{{baseUrl}}"],"query":[{"key":"send_rate_limit","value":"4595"},{"key":"send_batch_size","value":"4595"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"010c4946-e179-458f-9913-c1a31546d53d","name":"Get Campaign Analytics","request":{"name":"Get Campaign Analytics","description":{"content":"Get detailed campaign analytics.\n\nReturns overall stats, rates, time-series data, and top performing links.\n`held_count` is the number of recipients waiting for a later batch\n(campaigns sent in batches); they are neither sent nor failed.\n\n**Required Scopes:** `analytics:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","analytics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"2dc3205e-514b-41af-85dd-7f44b344c7bd","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","analytics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"bounce_rate\": 2,\n \"bounced_count\": 20,\n \"campaign_id\": \"campaign-789\",\n \"click_rate\": 12.2,\n \"click_to_open_rate\": 26.7,\n \"clicked_count\": 120,\n \"clicks_by_hour\": {\n \"12\": 50,\n \"13\": 70\n },\n \"complained_count\": 2,\n \"complaint_rate\": 0.2,\n \"delivered_count\": 980,\n \"delivery_rate\": 98,\n \"email_campaign_id\": \"ecampaign-123\",\n \"open_rate\": 45.9,\n \"opened_count\": 450,\n \"opens_by_hour\": {\n \"12\": 200,\n \"13\": 250\n },\n \"sends_by_hour\": {\n \"12\": 500,\n \"13\": 500\n },\n \"sent_count\": 1000,\n \"top_links\": [\n {\n \"clicks\": 80,\n \"unique_clicks\": 65,\n \"url\": \"https://example.com/page\"\n },\n {\n \"clicks\": 40,\n \"unique_clicks\": 38,\n \"url\": \"https://example.com/other\"\n }\n ],\n \"total_recipients\": 1000\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e95a6d7-9463-4d83-ac95-577aec8701c1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","analytics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b623cec4-2aee-4ae5-a53d-8b58600d369a","name":"Get Campaign Unsubscribes","request":{"name":"Get Campaign Unsubscribes","description":{"content":"List recipients who opted out via THIS email campaign's unsubscribe link.\n\nCampaign-attributed opt-outs, sourced from ``unsubscribe_tokens`` (SHARD)\nstamped with the ``email_campaign_id`` at send time. Ordered by\n``unsubscribed_at`` DESC, paginated (``page``/``page_size``, default 25).\n\nOnly LINK-method opt-outs exist today; ``method_counts.keyword`` is reserved\n(``null``) for a future keyword-based source that lands once an events table\nexists.\n\n**Required Scopes:** `analytics:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"30bbdcd4-9951-40d0-97aa-06a6d6cfb52c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"contact_id\": \"c1a2b3\",\n \"contact_name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"method\": \"link\",\n \"unsubscribed_at\": \"2026-09-14T10:30:00\"\n }\n ],\n \"method_counts\": {\n \"link\": 3\n },\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 25,\n \"total\": 3\n },\n \"total_unsubscribes\": 3\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"81412e62-8172-4199-9296-b26c6fc1744c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"25"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"573751dd-a304-4097-9ad4-a9ac82cf1e9e","name":"Get Campaign Detailed Analytics","request":{"name":"Get Campaign Detailed Analytics","description":{"content":"Get detailed campaign analytics with device breakdown and link performance.\n\nReturns advanced metrics including:\n- Link performance with CTR per link\n- Click timestamps per link\n\n**Required Scopes:** `analytics:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","analytics","detailed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"2038f920-eccd-445e-bb7f-12321bb986ec","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","analytics","detailed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"campaign_id\": \"ecampaign-123\",\n \"device_breakdown\": {\n \"Desktop\": 30,\n \"Mobile\": 42,\n \"Tablet\": 3,\n \"Unknown\": 1\n },\n \"link_performance\": [\n {\n \"click_through_rate\": 12.5,\n \"clicks\": 120,\n \"first_click_at\": \"2024-01-01T12:00:00\",\n \"last_click_at\": \"2024-01-02T14:30:00\",\n \"short_url\": \"https://example.com/l/abc123\",\n \"url\": \"https://example.com/page\"\n }\n ],\n \"total_tracked_links\": 5\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0cc1a6b1-804f-4899-8e38-a81d81264289","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","analytics","detailed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"116efc0e-55db-497d-b4a3-e72cfc9de36d","name":"Get Campaign Recipients","request":{"name":"Get Campaign Recipients","description":{"content":"List an email campaign's recipients with delivery status.\n\nGroups: `successful` = sent/delivered/opened/clicked, `failed` =\nfailed/bounced/complained, `all` = the union of both, `held` =\nrecipients waiting for a later batch (campaigns sent in batches; status\n`held`, not part of `all`). Each item:\n`{id, contact_id, name, identifier, status, error_reason, sent_at,\ndelivered_at, failed_at}` where `identifier` is the email address and\n`error_reason` is the bounce reason (bounces) or the send error.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"status","value":"all","description":"Recipient group: failed | successful | held | all"},{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"},{"disabled":false,"key":"search","value":"string","description":"Search email address or contact name"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"abbc934a-c52e-40a9-922f-f1c55a622b0b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"all"},{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"search","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a594433f-3caa-42c6-9a4d-433e83f853e4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"all"},{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"search","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"40413f2b-168d-4a43-acc7-fd12ae1703fe","name":"Retry Email Campaign Recipient","request":{"name":"Retry Email Campaign Recipient","description":{"content":"Retry a single failed recipient of an email campaign.\n\nCalls the retry execution in ``EmailCampaignService.retry_single_recipient``\nand returns the updated recipient item so the UI can update the row inline.\n\n- Recipient not found -> 404\n- Campaign not `completed`, `failed` or `paused` -> 409 \"Recipients can\n only be retried on a completed, failed or paused campaign\"\n- Recipient reported the email as spam (`complained`) -> 409 \"This\n recipient reported the email as spam and cannot be sent to again\"\n- Recipient not retryable in its current state (e.g. not failed) -> 409\n- Recipient permanently undeliverable (hard email bounce) -> 422\n\nA `completed` / `failed` campaign goes back to `sending` and the recipient\nis sent right away. A `paused` campaign stays paused: the recipient waits\nand is sent together with everyone else when the campaign is resumed.\nCampaigns sent in batches: the recipient rejoins the current batch\n(status `held`) and is sent at the campaign's send speed.\n\n**Required Scopes:** `campaigns:send`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id","retry"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"d496c695-34a6-4d7f-a310-3a87c83fca0f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id","retry"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"contact_id\": \"string\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"error_reason\": \"string\",\n \"last_error_code\": \"string\",\n \"sent_at\": \"string\",\n \"delivered_at\": \"string\",\n \"failed_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f4611834-e90b-455d-bcf7-c1164822d5c9","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id","retry"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e92132d9-c34a-462e-b6da-3fa09bbad10d","name":"Delete Email Campaign Recipient","request":{"name":"Delete Email Campaign Recipient","description":{"content":"Remove a single recipient from an email campaign.\n\nHard-deletes the per-recipient row (tenant + campaign ownership validated),\nthen recomputes the email campaign's denormalized counters.\n\n- HTTP 409 \"This recipient is queued for sending and cannot be removed\n while the campaign is sending or paused. Cancel the campaign first.\"\n for a `queued` recipient of a `sending` / `throttled` / `paused`\n campaign (its email may already be on its way).\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"92d66503-40d3-4338-9cb5-8cdaf0f73c0f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"success\": true,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"584d4a52-c91c-46cb-9b60-e319d64b841b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f096e4cd-6448-431f-9746-5b2bf4373ab2","name":"Remove Failed Email Campaign Recipients","request":{"name":"Remove Failed Email Campaign Recipients","description":{"content":"Bulk-remove all failed recipients (failed/bounced/complained) from an email\ncampaign.\n\nHard-deletes every failed-group row for this campaign and recomputes the\nemail campaign counters.\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients","remove-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"bee0e0a6-d381-437c-a44d-b2661d97fdbf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients","remove-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"removed_count\": 8419,\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5804bc59-ca55-497b-b4fb-ed88a4531e8a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients","remove-failed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"65fa86d0-77dc-4290-95eb-50962c98b663","name":"Unsubscribe Email Campaign Recipient","request":{"name":"Unsubscribe Email Campaign Recipient","description":{"content":"Opt an email recipient's contact out of this campaign's lists.\n\nThis is DISTINCT from `DELETE /{campaign_id}/recipients/{recipient_id}`\n(\"Remove\"), which only deletes the per-recipient row and does NOT change\nsubscription state. This endpoint resolves the recipient's contact, computes\nthe campaign's originating list(s) (`campaign_lists` on the base campaign ∩\nthe contact's currently-subscribed lists) and opts the contact out of all of\nthem via the subscription chokepoint, writing the opt-out ledger with\ncampaign attribution (`method='manual'`). ``{campaign_id}`` is the\n``EmailCampaign.id`` (as elsewhere on this router).\n\n- Recipient (or its campaign) not found for this tenant -> 404\n- Recipient has no linked contact -> 422\n- Contact subscribed to none of the campaign's lists (or the campaign targets\n no lists) -> 200 with an empty `unsubscribed_lists`\n- Contact already opted out of all of the campaign's lists -> 200 with\n `already_unsubscribed: true`\n\n**Required Scopes:** `campaigns:update`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"91b4b511-55fb-4a10-bd43-4544cb8ac267","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"unsubscribed_lists\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"already_unsubscribed\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d9193ac9-9ad8-46d4-882d-4431ab0b1b68","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","recipients",":recipient_id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"recipient_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9f72e165-d046-46ee-a780-d29218e6e9dd","name":"Estimate Campaign Cost","request":{"name":"Estimate Campaign Cost","description":{"content":"Estimate campaign sending cost and check balance.\n\nReturns detailed cost breakdown including:\n- **recipient_count**: Number of email recipients\n- **cost_per_email**: Cost per email in cents\n- **total_cost**: Total cost in cents\n- **total_cost_eur**: Total cost formatted as EUR string (e.g., \"0.80\")\n- **current_balance**: Current account balance in cents\n- **current_balance_eur**: Balance formatted as EUR string\n- **sufficient_balance**: Whether the account has enough balance to send\n\nUse this endpoint before sending to verify costs and balance availability.\n\n**Required Scopes:** `campaigns:read`","type":"text/plain"},"url":{"path":["api","v1","email-campaigns",":campaign_id","estimate-cost"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"5323b727-fe13-4afb-b2bf-c96f91b4b6f1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","estimate-cost"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cost_per_email\": 0.08,\n \"current_balance\": 5000,\n \"current_balance_eur\": \"50.00\",\n \"recipient_count\": 1000,\n \"sufficient_balance\": true,\n \"total_cost\": 80,\n \"total_cost_eur\": \"0.80\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3dd88471-6cb1-43d2-b0d7-24c6357a2788","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-campaigns",":campaign_id","estimate-cost"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaign_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"f35091c6-ceb6-4996-b087-4d8a588ea1d8","name":"Email Connections","description":{"content":"Test and validate email server connections (SMTP/IMAP) for email integrations.","type":"text/plain"},"item":[{"id":"c0e9882f-2be5-423c-b399-b2cd5a295a65","name":"List Email Connections","request":{"name":"List Email Connections","description":{"content":"List all email connections for the tenant.\n\nReturns a unified view of both email_provider_configs (SendGrid, Mailgun, SES)\nand email_integrations (Gmail, SMTP/IMAP, Proxy).\n\nEach connection includes computed capabilities:\n- can_send_campaigns: Can send bulk email campaigns\n- can_receive_support: Can receive inbound support emails\n- can_reply_support: Can send replies to support emails\n\n**Required Scopes:** `email_integrations:read`","type":"text/plain"},"url":{"path":["api","v1","email-connections"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"include_inactive","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"bd7bd74e-2e03-4371-847f-baeddb4ce105","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections"],"host":["{{baseUrl}}"],"query":[{"key":"include_inactive","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"connections\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total\": 8481\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"709fb31a-79ae-4141-8214-e0b6b46504a6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-connections"],"host":["{{baseUrl}}"],"query":[{"key":"include_inactive","value":"false"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"505ed47c-1cad-472c-a74d-2b29296d3201","name":"Get Campaign Provider","request":{"name":"Get Campaign Provider","description":{"content":"Get the current campaign provider for the tenant.\n\nReturns the email connection that is configured as the active campaign provider.\nOnly one connection can be the campaign provider at a time.\n\n**Required Scopes:** `email_integrations:read`","type":"text/plain"},"url":{"path":["api","v1","email-connections","campaign-provider"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ad058288-95c0-4b37-a1e4-5284f8390341","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections","campaign-provider"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"source_type\": \"integration\",\n \"connection_type\": \"sendgrid_managed\",\n \"is_active\": true,\n \"connection_status\": \"string\",\n \"can_send_campaigns\": true,\n \"can_receive_support\": true,\n \"can_reply_support\": false,\n \"is_campaign_provider\": false,\n \"created_at\": \"2015-09-30T02:26:03.152Z\",\n \"is_support_default\": false,\n \"outbound_mailbox_id\": \"string\",\n \"outbound_mailbox_name\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"outbound_provider_name\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"any\",\n \"has_received_email\": false,\n \"proxy_address\": \"string\",\n \"email_address\": \"string\",\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_status\": {\n \"key_0\": 6483,\n \"key_1\": 9176,\n \"key_2\": 2783.013635168742,\n \"key_3\": 6971,\n \"key_4\": false\n },\n \"last_error\": \"string\",\n \"updated_at\": \"1963-08-29T17:21:05.178Z\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4e0b8da-a2ef-4bf0-b107-985a892e5228","name":"Get Email Connection","request":{"name":"Get Email Connection","description":{"content":"Get a single email connection by ID.\n\nSearches both email_provider_configs and email_integrations tables.\n\n**Required Scopes:** `email_integrations:read`","type":"text/plain"},"url":{"path":["api","v1","email-connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3d5a6c0a-6cd1-409f-8dd3-680055cb5bbb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"source_type\": \"integration\",\n \"connection_type\": \"sendgrid_managed\",\n \"is_active\": true,\n \"connection_status\": \"string\",\n \"can_send_campaigns\": true,\n \"can_receive_support\": true,\n \"can_reply_support\": false,\n \"is_campaign_provider\": false,\n \"created_at\": \"2015-09-30T02:26:03.152Z\",\n \"is_support_default\": false,\n \"outbound_mailbox_id\": \"string\",\n \"outbound_mailbox_name\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"outbound_provider_name\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"any\",\n \"has_received_email\": false,\n \"proxy_address\": \"string\",\n \"email_address\": \"string\",\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_status\": {\n \"key_0\": 6483,\n \"key_1\": 9176,\n \"key_2\": 2783.013635168742,\n \"key_3\": 6971,\n \"key_4\": false\n },\n \"last_error\": \"string\",\n \"updated_at\": \"1963-08-29T17:21:05.178Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"784ff806-6602-4d87-ae13-c575fb84578c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"54b4d43a-8110-4809-be61-608a34f68d2f","name":"Delete Email Connection","request":{"name":"Delete Email Connection","description":{"content":"Delete an email connection.\n\nSearches both email_provider_configs and email_integrations tables\nand deletes the matching connection.\n\n**WARNING:** This is a destructive operation. If you delete a campaign provider,\nyou will need to set a new one before sending campaigns.\n\n**Required Scopes:** `email_integrations:delete`","type":"text/plain"},"url":{"path":["api","v1","email-connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"e4f18f96-7b52-4766-81f3-f78f5e59c037","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5239d1c5-bd4e-41ea-9124-fc692ebff39d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4fd18844-4b31-4989-839d-b05d8437b87a","name":"Set Campaign Provider","request":{"name":"Set Campaign Provider","description":{"content":"Set this connection as the active campaign provider.\n\nOnly connections with can_send_campaigns=True can be set as campaign providers\n(SendGrid, Mailgun, SES).\n\nThis will unset any other campaign provider for the tenant.\nOnly one connection can be the campaign provider at a time.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-connections",":connection_id","set-campaign-provider"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH"},"response":[{"id":"aa6e43f6-366a-4858-9234-c58a55c2916a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id","set-campaign-provider"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"message\": \"string\",\n \"connection\": {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"source_type\": {\n \"value\": \"\"\n },\n \"connection_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"can_send_campaigns\": {\n \"value\": \"\"\n },\n \"can_receive_support\": {\n \"value\": \"\"\n },\n \"can_reply_support\": {\n \"value\": \"\"\n },\n \"is_campaign_provider\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"is_support_default\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_id\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_name\": {\n \"value\": \"\"\n },\n \"outbound_provider_id\": {\n \"value\": \"\"\n },\n \"outbound_provider_name\": {\n \"value\": \"\"\n },\n \"proxy_forward_to\": {\n \"value\": \"\"\n },\n \"accepted_aliases\": {\n \"value\": \"\"\n },\n \"recipient_validation_mode\": {\n \"value\": \"\"\n },\n \"has_received_email\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"key_status\": {\n \"value\": \"\"\n },\n \"last_error\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d499e9b8-c124-40cd-8f50-8f23764ff0a0","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id","set-campaign-provider"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"df625383-1c32-4aec-856b-e5efc84448c9","name":"Link Outbound Provider","request":{"name":"Link Outbound Provider","description":{"content":"Link an outbound provider to a proxy integration.\n\nThis allows proxy integrations (which can receive inbound emails)\nto send replies using a SendGrid, Mailgun, or SES provider.\n\nOnly proxy integrations can have linked outbound providers.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-connections",":connection_id","link-outbound"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"outbound_provider_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"072ad114-6706-46d1-88cb-c007dbc38c3a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id","link-outbound"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"outbound_provider_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"message\": \"string\",\n \"connection\": {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"source_type\": {\n \"value\": \"\"\n },\n \"connection_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"can_send_campaigns\": {\n \"value\": \"\"\n },\n \"can_receive_support\": {\n \"value\": \"\"\n },\n \"can_reply_support\": {\n \"value\": \"\"\n },\n \"is_campaign_provider\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"is_support_default\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_id\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_name\": {\n \"value\": \"\"\n },\n \"outbound_provider_id\": {\n \"value\": \"\"\n },\n \"outbound_provider_name\": {\n \"value\": \"\"\n },\n \"proxy_forward_to\": {\n \"value\": \"\"\n },\n \"accepted_aliases\": {\n \"value\": \"\"\n },\n \"recipient_validation_mode\": {\n \"value\": \"\"\n },\n \"has_received_email\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"key_status\": {\n \"value\": \"\"\n },\n \"last_error\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"80bfe7c8-fb30-4234-a1d0-032fdd523077","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id","link-outbound"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"outbound_provider_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"863e270b-1515-4f9c-ae28-860669e9af38","name":"Unlink Outbound Provider","request":{"name":"Unlink Outbound Provider","description":{"content":"Unlink the outbound provider from a proxy integration.\n\nAfter unlinking, the proxy integration will no longer be able to send replies.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-connections",":connection_id","link-outbound"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"744a3be0-2bc9-45e8-b911-2bf8c57f4191","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id","link-outbound"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": true,\n \"message\": \"string\",\n \"connection\": {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"source_type\": {\n \"value\": \"\"\n },\n \"connection_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"can_send_campaigns\": {\n \"value\": \"\"\n },\n \"can_receive_support\": {\n \"value\": \"\"\n },\n \"can_reply_support\": {\n \"value\": \"\"\n },\n \"is_campaign_provider\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"is_support_default\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_id\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_name\": {\n \"value\": \"\"\n },\n \"outbound_provider_id\": {\n \"value\": \"\"\n },\n \"outbound_provider_name\": {\n \"value\": \"\"\n },\n \"proxy_forward_to\": {\n \"value\": \"\"\n },\n \"accepted_aliases\": {\n \"value\": \"\"\n },\n \"recipient_validation_mode\": {\n \"value\": \"\"\n },\n \"has_received_email\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"key_status\": {\n \"value\": \"\"\n },\n \"last_error\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5b7315d2-259e-4340-9802-dd7484898a5f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-connections",":connection_id","link-outbound"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"connection_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8e56e3ad-f6c8-4ea5-96ca-c99c4f5f5a77","name":"Email Contacts","description":{"content":"Manage email-specific contact data including subscription preferences and email addresses.","type":"text/plain"},"item":[{"id":"a13995af-ee38-41bc-ae71-f368a3b2404e","name":"Import Email Contacts","request":{"name":"Import Email Contacts","description":{"content":"Import contacts from CSV file\n\n**Required Scopes:** `contacts:create`\n\nImports contacts from a CSV file. At least one of `email`, `phone`,\n`whatsapp_id`, `display_name`, `first_name`, or `last_name` is\nrequired per row. Optionally creates email subscriptions for contacts\nthat have an email address.\n\n**Supported columns (all optional except for the row anchor above):**\n\n| Column | Maps to | Normalization |\n|--------|---------|---------------|\n| `first_name` | `Contact.first_name` | trim |\n| `last_name` | `Contact.last_name` | trim |\n| `display_name` (alias: `name`) | `Contact.name` | trim; falls back to `\"{first} {last}\"` |\n| `email` | `Contact.email` + `ContactMethod` (EMAIL) | trim + lowercase |\n| `phone` | `Contact.phone` + `ContactMethod` (PHONE) | parsed via libphonenumber to E.164 |\n| `whatsapp_id` | `ContactMethod` (WHATSAPP_ID) | digits-only (strips `+`, spaces, formatting) |\n| `languages` | `Contact.languages` | comma-separated ISO 639-1 codes; quote the cell if more than one |\n| `birthday` | `Contact.birthday` | `YYYY-MM-DD` |\n| `tags` | `contact_tags` (many-to-many) | comma-separated; quote the cell; missing tags auto-created |\n| `linkedin` | `ContactMethod` (LINKEDIN) | trim |\n| `instagram_handle` | `ContactMethod` (INSTAGRAM_HANDLE) | trim; strips leading `@` |\n| `facebook` | `ContactMethod` (FACEBOOK) | trim |\n| `homepage` | `ContactMethod` (HOMEPAGE) | trim |\n| `custom_fields` | `Contact.custom_data` | JSON object string |\n\nHeader names are matched case-insensitively. Common aliases are\naccepted out-of-the-box: `firstname`/`given` → `first_name`,\n`lastname`/`surname` → `last_name`, `full name` → `display_name`,\n`lang`/`language` → `languages`, `dob`/`born` → `birthday`,\n`wa`/`wa_id` → `whatsapp_id`, `ig` → `instagram_handle`,\n`fb` → `facebook`, `website`/`url` → `homepage`, `labels` → `tags`.\n\n**CSV quoting:** Cells containing commas (e.g. multiple tags or\nlanguages) **must be quoted** per RFC 4180.\n\n**Example CSV:**\n```\nfirst_name,last_name,display_name,email,phone,whatsapp_id,languages,birthday,tags,linkedin,instagram_handle,facebook,homepage,custom_fields\nJohn,Doe,John Doe,john.doe@acme.com,+1 234 567 89,+1 234 567 89,\"en,de\",1990-04-12,\"vip,lead\",john-doe,@johndoe,john.doe.42,https://acme.com,\"{\"company\":\"Acme Corp\"}\"\nJane,Smith,,jane@acme.com,+49 30 12345678,4930123456789,de,,\"customer\",,,,,\n,,Acme Bot,,,,en,,\"bot\",,,,,\n```\n\n**Subscription creation:**\n- Set `create_subscription=true` to create email subscriptions\n- Requires `optin_confirmed=true` when creating subscriptions (GDPR/CAN-SPAM compliance)\n- Subscriptions only created for contacts with a valid email address\n- Use `list_ids` to subscribe to multiple lists (comma-separated)\n\n**Process:**\n1. Validates the CSV has at least one anchor column (see above).\n2. Validates and normalizes each row (phone → E.164, whatsapp_id\n → digits-only, email → lowercase, birthday → date).\n3. Checks for duplicates by email and phone within tenant (subject\n to the tenant's `duplicate_contact_mode`).\n4. Creates contacts and one `ContactMethod` row per non-empty\n method field. Tags are looked up or auto-created within the\n tenant and attached to the contact.\n5. Optionally creates email subscriptions and adds to specified lists.\n\n**Returns:**\n- Summary with total, imported, duplicates, invalid_rows, and errors","type":"text/plain"},"url":{"path":["api","v1","email-contacts","import"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"create_subscription","value":"false","description":"Create email subscriptions for imported contacts"},{"disabled":false,"key":"optin_confirmed","value":"false","description":"User confirms all contacts have valid opt-in consent"},{"disabled":false,"key":"list_id","value":"string","description":"Optional list ID to add imported contacts to"},{"disabled":false,"key":"list_ids","value":"string","description":"Comma-separated list IDs to subscribe contacts to"},{"disabled":false,"key":"identifiers_verified","value":"false","description":"Same as the identifiers_verified form field; either one enables it."}],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) CSV or XLSX file (.xlsx: first sheet, first row = headers). Anchor columns (at least one per row): contact_id, email, phone, whatsapp_id, display_name, first_name, last_name. Supports contact_id (UUID match target), first_name, last_name, display_name, email, phone, whatsapp_id, languages, birthday, tags, linkedin, instagram_handle, facebook, homepage, custom_fields."},{"key":"column_mapping","value":"string","type":"text","description":"JSON string mapping target fields to CSV column names, e.g. {\"email\": \"E-Mail\", \"name\": \"Full Name\", \"phone\": \"Telefon\"}. Per-EAV custom-field targets use the key \"custom_field:\"."},{"key":"duplicate_mode","value":"string","type":"text","description":"Override the tenant's duplicate_contact_mode for this import. Values: auto_merge, allow_duplicates, dont_allow_duplicates, update_existing. Omit to use the tenant default."},{"key":"update_field_mode","value":"string","type":"text","description":"Only used with duplicate_mode=update_existing. 'overwrite' (default) replaces standard + EAV custom fields from the CSV (blank cells never wipe); 'fill_empty' only populates empty fields. Values: overwrite, fill_empty."},{"key":"subscriptions","value":"string","type":"text","description":"JSON array of structured channel->list subscription targets, e.g. [{\"channel_type\":\"email\",\"list_id\":\"...\"},{\"channel_type\":\"whatsapp\",\"list_id\":\"...\"}]. A contact is subscribed to a target only if it has the channel's required method (email→email, sms→phone, whatsapp→whatsapp_id/phone); others are silently skipped. Supported channels: email, sms, whatsapp. Takes precedence over create_subscription. Requires optin_confirmed=true."},{"key":"delimiter","value":"string","type":"text","description":"CSV delimiter override. One of: ',' ';' tab '|'. Omit to auto-sniff."},{"key":"quotechar","value":"string","type":"text","description":"CSV quote character override (default '\"'). Omit to auto-detect."},{"key":"default_phone_region","value":"string","type":"text","description":"ISO-3166 alpha-2 region (e.g. 'DE') used to auto-prefix phone numbers lacking a '+' to E.164 (national '0175…' → '+49175…'). Omit to keep the lenient digit-prepend behaviour."},{"key":"apply_tag_ids","value":"string","type":"text","description":"Post-import action: JSON array of tag IDs (e.g. [\"id1\",\"id2\"]) applied to EVERY contact this import creates OR updates. Tag IDs must belong to the tenant (404 otherwise)."},{"key":"apply_custom_field","value":"string","type":"text","description":"Post-import action: JSON object {\"field_id\": \"...\", \"value\": ...} — the custom-field value is set (overwrite) on EVERY contact this import creates OR updates. The field must be an active custom field of the tenant; SELECT/MULTISELECT values are options-validated, DATE/DATETIME must be ISO."},{"key":"identifiers_verified","value":"false","type":"text","description":"Treat the imported phone numbers, email addresses and WhatsApp IDs as verified (you have confirmed the contacts control them). Stored with verified_source='import'. Default false: imported identifiers are unverified claims. Not available to OAuth apps."}]}},"response":[{"id":"e1bc374c-187e-4865-b627-027871c1569f","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts","import"],"host":["{{baseUrl}}"],"query":[{"key":"create_subscription","value":"false"},{"key":"optin_confirmed","value":"false"},{"key":"list_id","value":"string"},{"key":"list_ids","value":"string"},{"key":"identifiers_verified","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) CSV or XLSX file (.xlsx: first sheet, first row = headers). Anchor columns (at least one per row): contact_id, email, phone, whatsapp_id, display_name, first_name, last_name. Supports contact_id (UUID match target), first_name, last_name, display_name, email, phone, whatsapp_id, languages, birthday, tags, linkedin, instagram_handle, facebook, homepage, custom_fields.","type":"text/plain"},"key":"file","type":"file"},{"description":{"content":"JSON string mapping target fields to CSV column names, e.g. {\"email\": \"E-Mail\", \"name\": \"Full Name\", \"phone\": \"Telefon\"}. Per-EAV custom-field targets use the key \"custom_field:\".","type":"text/plain"},"key":"column_mapping","value":"string","type":"text"},{"description":{"content":"Override the tenant's duplicate_contact_mode for this import. Values: auto_merge, allow_duplicates, dont_allow_duplicates, update_existing. Omit to use the tenant default.","type":"text/plain"},"key":"duplicate_mode","value":"string","type":"text"},{"description":{"content":"Only used with duplicate_mode=update_existing. 'overwrite' (default) replaces standard + EAV custom fields from the CSV (blank cells never wipe); 'fill_empty' only populates empty fields. Values: overwrite, fill_empty.","type":"text/plain"},"key":"update_field_mode","value":"string","type":"text"},{"description":{"content":"JSON array of structured channel->list subscription targets, e.g. [{\"channel_type\":\"email\",\"list_id\":\"...\"},{\"channel_type\":\"whatsapp\",\"list_id\":\"...\"}]. A contact is subscribed to a target only if it has the channel's required method (email→email, sms→phone, whatsapp→whatsapp_id/phone); others are silently skipped. Supported channels: email, sms, whatsapp. Takes precedence over create_subscription. Requires optin_confirmed=true.","type":"text/plain"},"key":"subscriptions","value":"string","type":"text"},{"description":{"content":"CSV delimiter override. One of: ',' ';' tab '|'. Omit to auto-sniff.","type":"text/plain"},"key":"delimiter","value":"string","type":"text"},{"description":{"content":"CSV quote character override (default '\"'). Omit to auto-detect.","type":"text/plain"},"key":"quotechar","value":"string","type":"text"},{"description":{"content":"ISO-3166 alpha-2 region (e.g. 'DE') used to auto-prefix phone numbers lacking a '+' to E.164 (national '0175…' → '+49175…'). Omit to keep the lenient digit-prepend behaviour.","type":"text/plain"},"key":"default_phone_region","value":"string","type":"text"},{"description":{"content":"Post-import action: JSON array of tag IDs (e.g. [\"id1\",\"id2\"]) applied to EVERY contact this import creates OR updates. Tag IDs must belong to the tenant (404 otherwise).","type":"text/plain"},"key":"apply_tag_ids","value":"string","type":"text"},{"description":{"content":"Post-import action: JSON object {\"field_id\": \"...\", \"value\": ...} — the custom-field value is set (overwrite) on EVERY contact this import creates OR updates. The field must be an active custom field of the tenant; SELECT/MULTISELECT values are options-validated, DATE/DATETIME must be ISO.","type":"text/plain"},"key":"apply_custom_field","value":"string","type":"text"},{"description":{"content":"Treat the imported phone numbers, email addresses and WhatsApp IDs as verified (you have confirmed the contacts control them). Stored with verified_source='import'. Default false: imported identifiers are unverified claims. Not available to OAuth apps.","type":"text/plain"},"key":"identifiers_verified","value":"false","type":"text"}]}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"job_id\": \"string\",\n \"message\": \"string\",\n \"poll_url\": \"string\",\n \"status\": \"queued\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5796ec06-8620-48ad-baad-577e57b99ca1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts","import"],"host":["{{baseUrl}}"],"query":[{"key":"create_subscription","value":"false"},{"key":"optin_confirmed","value":"false"},{"key":"list_id","value":"string"},{"key":"list_ids","value":"string"},{"key":"identifiers_verified","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) CSV or XLSX file (.xlsx: first sheet, first row = headers). Anchor columns (at least one per row): contact_id, email, phone, whatsapp_id, display_name, first_name, last_name. Supports contact_id (UUID match target), first_name, last_name, display_name, email, phone, whatsapp_id, languages, birthday, tags, linkedin, instagram_handle, facebook, homepage, custom_fields.","type":"text/plain"},"key":"file","type":"file"},{"description":{"content":"JSON string mapping target fields to CSV column names, e.g. {\"email\": \"E-Mail\", \"name\": \"Full Name\", \"phone\": \"Telefon\"}. Per-EAV custom-field targets use the key \"custom_field:\".","type":"text/plain"},"key":"column_mapping","value":"string","type":"text"},{"description":{"content":"Override the tenant's duplicate_contact_mode for this import. Values: auto_merge, allow_duplicates, dont_allow_duplicates, update_existing. Omit to use the tenant default.","type":"text/plain"},"key":"duplicate_mode","value":"string","type":"text"},{"description":{"content":"Only used with duplicate_mode=update_existing. 'overwrite' (default) replaces standard + EAV custom fields from the CSV (blank cells never wipe); 'fill_empty' only populates empty fields. Values: overwrite, fill_empty.","type":"text/plain"},"key":"update_field_mode","value":"string","type":"text"},{"description":{"content":"JSON array of structured channel->list subscription targets, e.g. [{\"channel_type\":\"email\",\"list_id\":\"...\"},{\"channel_type\":\"whatsapp\",\"list_id\":\"...\"}]. A contact is subscribed to a target only if it has the channel's required method (email→email, sms→phone, whatsapp→whatsapp_id/phone); others are silently skipped. Supported channels: email, sms, whatsapp. Takes precedence over create_subscription. Requires optin_confirmed=true.","type":"text/plain"},"key":"subscriptions","value":"string","type":"text"},{"description":{"content":"CSV delimiter override. One of: ',' ';' tab '|'. Omit to auto-sniff.","type":"text/plain"},"key":"delimiter","value":"string","type":"text"},{"description":{"content":"CSV quote character override (default '\"'). Omit to auto-detect.","type":"text/plain"},"key":"quotechar","value":"string","type":"text"},{"description":{"content":"ISO-3166 alpha-2 region (e.g. 'DE') used to auto-prefix phone numbers lacking a '+' to E.164 (national '0175…' → '+49175…'). Omit to keep the lenient digit-prepend behaviour.","type":"text/plain"},"key":"default_phone_region","value":"string","type":"text"},{"description":{"content":"Post-import action: JSON array of tag IDs (e.g. [\"id1\",\"id2\"]) applied to EVERY contact this import creates OR updates. Tag IDs must belong to the tenant (404 otherwise).","type":"text/plain"},"key":"apply_tag_ids","value":"string","type":"text"},{"description":{"content":"Post-import action: JSON object {\"field_id\": \"...\", \"value\": ...} — the custom-field value is set (overwrite) on EVERY contact this import creates OR updates. The field must be an active custom field of the tenant; SELECT/MULTISELECT values are options-validated, DATE/DATETIME must be ISO.","type":"text/plain"},"key":"apply_custom_field","value":"string","type":"text"},{"description":{"content":"Treat the imported phone numbers, email addresses and WhatsApp IDs as verified (you have confirmed the contacts control them). Stored with verified_source='import'. Default false: imported identifiers are unverified claims. Not available to OAuth apps.","type":"text/plain"},"key":"identifiers_verified","value":"false","type":"text"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"873e7cb2-8992-4144-960b-241c48c9173e","name":"Get Import Job Status","request":{"name":"Get Import Job Status","description":{"content":"Get the status/progress of an async contact import job.\n\n**Required Scopes:** `contacts:create`\n\nPoll this endpoint after POST /email-contacts/import. When ``status`` is\n``completed`` the full import summary is returned under ``summary``; when\n``failed`` see ``error_message``.","type":"text/plain"},"url":{"path":["api","v1","email-contacts","import",":job_id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"5d451e10-9186-43d7-a693-0a26b6c07b93","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts","import",":job_id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"job_id\": \"string\",\n \"status\": \"string\",\n \"message\": \"string\",\n \"progress_percent\": 0,\n \"total_items\": 0,\n \"processed_items\": 0,\n \"failed_items\": 0,\n \"summary\": {\n \"value\": \"\"\n },\n \"error_message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa2fdd31-d6fe-4d4f-9b8c-a4b57c88599b","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts","import",":job_id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"job_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1fd7209f-72e4-47b9-a752-d1bc293fdd1c","name":"Download Import Template","request":{"name":"Download Import Template","description":{"content":"Download a contact-import template (CSV or XLSX) with 1–2 example rows.\n\n**Required Scopes:** `contacts:create`\n\nThe headers are EXACTLY the contact-export format (auto-detected by the\nimporter with no manual mapping): a leading ``contact_id`` column (empty\nin the template — fill it to update an existing contact, leave it empty\nto create), the standard contact fields, and one ``custom.`` column\nper active custom-field definition of the tenant.\n\nNote: ``telegram_id`` / ``messenger_id`` / ``instagram_id`` appear for\nexport parity but are ignored on import (channel-scoped platform IDs\ncannot be imported).","type":"text/plain"},"url":{"path":["api","v1","email-contacts","import","template"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"format","value":"csv","description":"Template file format: csv | xlsx"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"00b6cf9a-8cff-45b6-a781-b349c42f4e94","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts","import","template"],"host":["{{baseUrl}}"],"query":[{"key":"format","value":"csv"}],"variable":[]},"header":[{"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":"785ef528-1e4a-43d2-9464-a4b5b888cae3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts","import","template"],"host":["{{baseUrl}}"],"query":[{"key":"format","value":"csv"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"763f2296-4a12-4656-8da5-92f6af36d096","name":"Sniff Csv","request":{"name":"Sniff Csv","description":{"content":"Sniff a CSV/XLSX file's dialect and headers.\n\n**Required Scopes:** `contacts:create`\n\nReturns the detected delimiter, quote character, header column names,\nand a best-effort suggested phone region (from the tenant's\ncompany_country) so the frontend preview parser matches the backend\nimporter exactly. Does NOT import anything. For ``.xlsx`` uploads the\nheaders come from the first sheet's first row and ``delimiter``/\n``quotechar`` are reported as ``\",\"`` / ``'\"'`` (the dialect the\nbackend's xlsx→csv conversion emits).\n\n**Returns:** `{ delimiter, quotechar, headers, suggested_phone_region }`","type":"text/plain"},"url":{"path":["api","v1","email-contacts","sniff"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"(Required) CSV or XLSX file to inspect for delimiter/quotechar/headers"}]}},"response":[{"id":"b5669639-24c3-4926-9106-460151942e58","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts","sniff"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) CSV or XLSX file to inspect for delimiter/quotechar/headers","type":"text/plain"},"key":"file","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"delimiter\": \"string\",\n \"quotechar\": \"string\",\n \"headers\": [\n \"string\",\n \"string\"\n ],\n \"suggested_phone_region\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98cf944e-b385-4fbb-9046-8ee8e5388c70","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts","sniff"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) CSV or XLSX file to inspect for delimiter/quotechar/headers","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"25dc419e-80da-46d7-87f5-05e573ed60fe","name":"List Email Contacts","request":{"name":"List Email Contacts","description":{"content":"List email contacts with filters\n\n**Filters:**\n- subscription_status: pending, subscribed, unsubscribed\n- category: newsletter, promotions, updates, etc.\n- search: Search by email or name\n\n**Pagination:**\n- limit: Max results per page (1-100)\n- offset: Number of results to skip\n\n**🔐 Required Scopes:** `contacts:read`\n","type":"text/plain"},"url":{"path":["api","v1","email-contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"subscription_status","value":"subscribed","description":"Filter by subscription status"},{"disabled":false,"key":"category","value":"string","description":"Filter by category"},{"disabled":false,"key":"search","value":"string","description":"Search by email or name"},{"disabled":false,"key":"limit","value":"50","description":"Maximum number of results"},{"disabled":false,"key":"offset","value":"0","description":"Pagination offset"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"50adeac6-1cba-4115-b3a0-ea6969365f91","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts"],"host":["{{baseUrl}}"],"query":[{"key":"subscription_status","value":"subscribed"},{"key":"category","value":"string"},{"key":"search","value":"string"},{"key":"limit","value":"50"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"contacts\": [],\n \"limit\": 50,\n \"offset\": 0,\n \"total\": 150\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a1cd9ee6-62ac-47cc-8bfe-3620125a9ba4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts"],"host":["{{baseUrl}}"],"query":[{"key":"subscription_status","value":"subscribed"},{"key":"category","value":"string"},{"key":"search","value":"string"},{"key":"limit","value":"50"},{"key":"offset","value":"0"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d7b36318-987c-451b-8fb1-c6f563c806e8","name":"Get Email Contact","request":{"name":"Get Email Contact","description":{"content":"Get email contact details by subscription ID\n\n**🔐 Required Scopes:** `contacts:read`\n","type":"text/plain"},"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"7a3f48ac-0c7a-487b-809c-d250bad2f062","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"contact_id\": \"string\",\n \"email\": \"string\",\n \"subscription_status\": \"pending\",\n \"subscription_category\": \"string\",\n \"opt_in_method\": \"manual\",\n \"created_at\": \"1954-04-07T08:43:01.221Z\",\n \"updated_at\": \"2013-01-02T09:14:58.579Z\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"opt_in_confirmed_at\": \"1955-01-03T19:42:47.527Z\",\n \"unsubscribed_at\": \"2026-09-03T18:49:58.540Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a2e1f64a-a5db-4a51-a3ec-55b286cdbb7f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9e1196dc-5ee0-403e-afcf-c81e137fb25d","name":"Update Email Contact","request":{"name":"Update Email Contact","description":{"content":"Update email contact subscription\n\n**Updatable fields:**\n- name\n- phone\n- subscription_status (pending, subscribed, unsubscribed)\n- subscription_category\n- unsubscribe_reason (when unsubscribing)\n\n**🔐 Required Scopes:** `contacts:update`\n","type":"text/plain"},"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"Jane Doe\",\n \"subscription_status\": \"unsubscribed\",\n \"unsubscribe_reason\": \"No longer interested\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1f0231d4-6e45-49b2-a8a7-bf4e2cd81bbf","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"Jane Doe\",\n \"subscription_status\": \"unsubscribed\",\n \"unsubscribe_reason\": \"No longer interested\"\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 \"contact_id\": \"string\",\n \"email\": \"string\",\n \"subscription_status\": \"pending\",\n \"subscription_category\": \"string\",\n \"opt_in_method\": \"manual\",\n \"created_at\": \"1954-04-07T08:43:01.221Z\",\n \"updated_at\": \"2013-01-02T09:14:58.579Z\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"opt_in_confirmed_at\": \"1955-01-03T19:42:47.527Z\",\n \"unsubscribed_at\": \"2026-09-03T18:49:58.540Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8d4d5560-ea02-4651-9bff-94264c111dfa","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"Jane Doe\",\n \"subscription_status\": \"unsubscribed\",\n \"unsubscribe_reason\": \"No longer interested\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4c98736d-d1d2-4526-97fe-2fd4d3585152","name":"Delete Email Contact","request":{"name":"Delete Email Contact","description":{"content":"Delete email contact subscription\n\n**Note:** This permanently removes the email subscription.\nThe contact record itself is not deleted.\n\n**🔐 Required Scopes:** `contacts:delete`\n","type":"text/plain"},"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"c949572f-75a3-4cf5-9bb5-dd691344d535","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8341dc9d-f287-4fa1-9ee7-f856ffa50333","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contacts",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"subscription_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"b50e28ea-4423-4b9d-af06-d01e3109e099","name":"Email Contents","description":{"content":"Create and edit email content blocks that populate layout template slots for campaigns.","type":"text/plain"},"item":[{"id":"bf15d97e-1c7c-4b89-b0a9-5831ae65e3b5","name":"Get Email Variables","request":{"name":"Get Email Variables","description":{"content":"Get all available email template variables organized by category.\n\nReturns a comprehensive list of variables that can be used in email templates:\n\n- **contact**: Recipient contact information (name, email, phone, etc.)\n- **company**: Your company/organization details (including brand colors)\n- **campaign**: Auto-filled campaign variables (unsubscribe link, etc.)\n- **system**: System variables (current year, date, etc.)\n- **custom_fields**: Your tenant's custom contact fields\n\n**Required Scopes:** `email:read`\n\n**Usage in templates:**\n```\nHello {{contact.name}}!\n\nWelcome to {{company.name}}.\n\n
...
\n\n(c) {{system.year}} All rights reserved.\n\nUnsubscribe\n```\n\n**Custom variables:** You can use any `{{variable_name}}` in your template.\nValues are provided when creating email content from a layout.","type":"text/plain"},"url":{"path":["api","v1","email-contents","variables"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"40b61ff8-2f42-4549-a076-247feae76b31","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents","variables"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"categories\": {\n \"contact\": {\n \"description\": \"Recipient contact information\",\n \"label\": \"Contact\",\n \"variables\": [\n {\n \"description\": \"Contact's full name\",\n \"example\": \"John Doe\",\n \"name\": \"contact.name\",\n \"preview_filled\": false,\n \"required\": false\n }\n ]\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4cb63f95-6e91-4955-81ab-f412659d1e23","name":"Create Email Content","request":{"name":"Create Email Content","description":{"content":"Create a new email content with variable system.\n\n**Required Scopes:** `email:create`\n\nThe variable system supports 4 types of variables:\n- **Template variables**: Custom content (e.g., {{hero_title}}, {{cta_url}})\n- **Contact variables**: Auto-filled from contact data (e.g., {{contact.name}})\n- **Company variables**: Auto-filled from company data (e.g., {{company.name}})\n- **System variables**: Auto-filled by platform (e.g., {{system.year}})\n\n**Variable Naming Convention:**\n- Must use lowercase_with_underscores format\n- Can contain dots for nested properties (contact.field_name)\n- Examples: hero_title (valid), heroTitle (invalid), hero-title (invalid)\n\n**Features:**\n- Full MJML content with {{variable}} placeholders\n- Optional layout reference (analytics only, no FK constraint)\n- Variable values for form mode (optional)\n- Subject line supports {{variables}} for personalization\n- Variables are automatically extracted and validated","type":"text/plain"},"url":{"path":["api","v1","email-contents"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"ai_generated\": false,\n \"content_type\": \"html\",\n \"description\": \"Welcome email for new subscribers (HTML)\",\n \"mjml_source\": \"Hello {{contact.name}}!\",\n \"name\": \"Welcome Email - HTML\",\n \"preview_text\": \"Get started with your new account\",\n \"subject_line\": \"Welcome to {{company.name}}, {{contact.name}}!\",\n \"variable_values\": {\n \"cta_url\": \"https://example.com/get-started\",\n \"hero_title\": \"Welcome to Our Platform!\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2f031ba3-3079-469d-b6fa-982ff5343080","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"ai_generated\": false,\n \"content_type\": \"html\",\n \"description\": \"Welcome email for new subscribers (HTML)\",\n \"mjml_source\": \"Hello {{contact.name}}!\",\n \"name\": \"Welcome Email - HTML\",\n \"preview_text\": \"Get started with your new account\",\n \"subject_line\": \"Welcome to {{company.name}}, {{contact.name}}!\",\n \"variable_values\": {\n \"cta_url\": \"https://example.com/get-started\",\n \"hero_title\": \"Welcome to Our Platform!\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_valid\": false,\n \"version\": 2889,\n \"created_at\": \"1953-07-07T10:42:57.041Z\",\n \"updated_at\": \"1947-10-20T16:28:16.639Z\",\n \"description\": \"string\",\n \"content_type\": \"html\",\n \"template_id\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"editor_type\": \"string\",\n \"mjml_source\": \"string\",\n \"compiled_html\": \"string\",\n \"stripo_design_json\": \"string\",\n \"text_body\": \"string\",\n \"variable_values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"variables_used\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"footer_mode\": \"string\",\n \"ai_generated\": false,\n \"ai_prompt\": \"string\",\n \"ai_model_used\": \"string\",\n \"ai_generation_cost_cents\": 4392,\n \"is_system\": false,\n \"validation_errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_by\": \"string\",\n \"layout_template\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0d6b68c7-10ab-474e-b4cb-d34e701cead6","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"ai_generated\": false,\n \"content_type\": \"html\",\n \"description\": \"Welcome email for new subscribers (HTML)\",\n \"mjml_source\": \"Hello {{contact.name}}!\",\n \"name\": \"Welcome Email - HTML\",\n \"preview_text\": \"Get started with your new account\",\n \"subject_line\": \"Welcome to {{company.name}}, {{contact.name}}!\",\n \"variable_values\": {\n \"cta_url\": \"https://example.com/get-started\",\n \"hero_title\": \"Welcome to Our Platform!\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bb50c439-2678-4f33-a8d0-8b025b4e9fa6","name":"List Email Contents","request":{"name":"List Email Contents","description":{"content":"List email contents for the tenant with pagination.\n\n**Required Scopes:** `email:read`\n\n- Can filter by layout template ID (optional reference)\n- By default excludes hidden contents (use include_hidden=true to include)\n- Returns list without full MJML source (for performance)\n- Includes basic layout template info","type":"text/plain"},"url":{"path":["api","v1","email-contents"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"},{"disabled":false,"key":"layout_id","value":"string","description":"Filter by layout template ID"},{"disabled":false,"key":"include_hidden","value":"false","description":"Include hidden/archived contents"},{"disabled":false,"key":"exclude_system","value":"false","description":"Exclude system templates"},{"disabled":false,"key":"exclude_doi","value":"true","description":"Exclude double opt-in templates (they have their own page)"},{"disabled":false,"key":"search","value":"string","description":"Case-insensitive search across name and subject_line"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4b982509-4abc-431f-a7d5-63fe2a5e8203","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"layout_id","value":"string"},{"key":"include_hidden","value":"false"},{"key":"exclude_system","value":"false"},{"key":"exclude_doi","value":"true"},{"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05bf7679-8671-40eb-8069-85211ac56abd","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"},{"key":"layout_id","value":"string"},{"key":"include_hidden","value":"false"},{"key":"exclude_system","value":"false"},{"key":"exclude_doi","value":"true"},{"key":"search","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7b6f3176-df7b-463a-bb9a-2c7b96dab38c","name":"Get Email Content","request":{"name":"Get Email Content","description":{"content":"Get a specific email content with full details.\n\n**Required Scopes:** `email:read`","type":"text/plain"},"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"450e4fef-886d-4903-a5e3-dfbfbf59c4a8","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_valid\": false,\n \"version\": 2889,\n \"created_at\": \"1953-07-07T10:42:57.041Z\",\n \"updated_at\": \"1947-10-20T16:28:16.639Z\",\n \"description\": \"string\",\n \"content_type\": \"html\",\n \"template_id\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"editor_type\": \"string\",\n \"mjml_source\": \"string\",\n \"compiled_html\": \"string\",\n \"stripo_design_json\": \"string\",\n \"text_body\": \"string\",\n \"variable_values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"variables_used\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"footer_mode\": \"string\",\n \"ai_generated\": false,\n \"ai_prompt\": \"string\",\n \"ai_model_used\": \"string\",\n \"ai_generation_cost_cents\": 4392,\n \"is_system\": false,\n \"validation_errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_by\": \"string\",\n \"layout_template\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5a148165-3cb2-4289-8bb2-1ecd9d4b90f4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5f9442a9-7e17-4c10-ad0c-de783978b840","name":"Update Email Content","request":{"name":"Update Email Content","description":{"content":"Update email content with variable system.\n\n**Required Scopes:** `email:create`\n\n**Variable Replacement Examples:**\n- Template: {{hero_title}} -> \"Welcome to Our Amazing Platform\"\n- Contact: {{contact.name}} -> Actual contact's name at send time\n- Company: {{company.name}} -> Actual company name at send time\n- System: {{system.year}} -> Current year (e.g., 2025)\n\n**Features:**\n- Update MJML source, variable values, subject, etc.\n- Creates new version (increments version number)\n- Variables are automatically re-extracted and validated\n- Content changes will affect future campaigns using this content","type":"text/plain"},"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"mjml_source\": \"Updated {{hero_title}}\",\n \"name\": \"Updated Content Name\",\n \"subject_line\": \"New subject line with {{contact.name}}\",\n \"variable_values\": {\n \"hero_title\": \"New Title\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"793be79c-1df6-4c2b-8a8b-bf0925dbbe81","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"mjml_source\": \"Updated {{hero_title}}\",\n \"name\": \"Updated Content Name\",\n \"subject_line\": \"New subject line with {{contact.name}}\",\n \"variable_values\": {\n \"hero_title\": \"New Title\"\n }\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 \"name\": \"string\",\n \"is_valid\": false,\n \"version\": 2889,\n \"created_at\": \"1953-07-07T10:42:57.041Z\",\n \"updated_at\": \"1947-10-20T16:28:16.639Z\",\n \"description\": \"string\",\n \"content_type\": \"html\",\n \"template_id\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"editor_type\": \"string\",\n \"mjml_source\": \"string\",\n \"compiled_html\": \"string\",\n \"stripo_design_json\": \"string\",\n \"text_body\": \"string\",\n \"variable_values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"variables_used\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"footer_mode\": \"string\",\n \"ai_generated\": false,\n \"ai_prompt\": \"string\",\n \"ai_model_used\": \"string\",\n \"ai_generation_cost_cents\": 4392,\n \"is_system\": false,\n \"validation_errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_by\": \"string\",\n \"layout_template\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f72bcdb-f78f-4c5f-b304-b858c11d51d2","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"mjml_source\": \"Updated {{hero_title}}\",\n \"name\": \"Updated Content Name\",\n \"subject_line\": \"New subject line with {{contact.name}}\",\n \"variable_values\": {\n \"hero_title\": \"New Title\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fca4d339-0271-4043-8b61-5377b598fd74","name":"Delete Email Content","request":{"name":"Delete Email Content","description":{"content":"Delete email content.\n\n**Required Scopes:** `email:admin`\n\n- Email contents with campaigns referencing them cannot be deleted (409 Conflict)\n- Use this endpoint to clean up unused content","type":"text/plain"},"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"33eab1e2-069a-4f24-a06f-20c673953df3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3033f3f6-299c-4fb4-a34c-444868750653","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b5f97737-0a7a-48a9-acde-1b89b97084c9","name":"Duplicate Email Content","request":{"name":"Duplicate Email Content","description":{"content":"Duplicate an email content.\n\n**Required Scopes:** `email:create`\n\nCreates a copy of the content with a new name. All content fields are copied\n(MJML, HTML, variables, subject line, preview text, etc.). The duplicate is\nalways a non-system, non-hidden content owned by the requesting tenant.","type":"text/plain"},"url":{"path":["api","v1","email-contents",":content_id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"new_name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1a984b2f-1f48-4f4a-a159-f0129cc04662","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"new_name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"is_valid\": false,\n \"version\": 2889,\n \"created_at\": \"1953-07-07T10:42:57.041Z\",\n \"updated_at\": \"1947-10-20T16:28:16.639Z\",\n \"description\": \"string\",\n \"content_type\": \"html\",\n \"template_id\": \"string\",\n \"subject_line\": \"string\",\n \"preview_text\": \"string\",\n \"from_name\": \"string\",\n \"from_email\": \"string\",\n \"editor_type\": \"string\",\n \"mjml_source\": \"string\",\n \"compiled_html\": \"string\",\n \"stripo_design_json\": \"string\",\n \"text_body\": \"string\",\n \"variable_values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"variables_used\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"footer_mode\": \"string\",\n \"ai_generated\": false,\n \"ai_prompt\": \"string\",\n \"ai_model_used\": \"string\",\n \"ai_generation_cost_cents\": 4392,\n \"is_system\": false,\n \"validation_errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_by\": \"string\",\n \"layout_template\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a192a8b-33ad-4dc5-8e2e-84c7290da557","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"new_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6311e11e-c737-4d58-a8d9-4c379b11a1a8","name":"Preview Email Content","request":{"name":"Preview Email Content","description":{"content":"Preview email content with test variables.\n\n**Required Scopes:** `email:read`\n\n**Use Case:**\n- Test how email will look with specific contact/company data\n- Preview personalization before launching campaigns\n- Debug variable replacement issues\n\n**Example Request:**\n```json\n{\n \"variables\": {\n \"contact.name\": \"Jane Smith\",\n \"contact.email\": \"jane@example.com\",\n \"company.name\": \"Tech Solutions Inc\",\n \"hero_title\": \"Exclusive Offer for You\",\n \"cta_url\": \"https://example.com/special-offer\"\n }\n}\n```\n\n**Features:**\n- Compiles content with provided variable values\n- Returns rendered HTML and subject line\n- Returns list of variables used in content\n- Useful for testing personalization before sending campaign","type":"text/plain"},"url":{"path":["api","v1","email-contents",":content_id","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": {\n \"company\": {\n \"name\": \"Acme Corp\"\n },\n \"contact\": {\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\"\n },\n \"cta_url\": \"https://example.com/get-started\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8b1f810d-9cd3-43f9-a6b6-fa4b35d9fe4c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": {\n \"company\": {\n \"name\": \"Acme Corp\"\n },\n \"contact\": {\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\"\n },\n \"cta_url\": \"https://example.com/get-started\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subject_line\": \"string\",\n \"variables_used\": [\n \"string\",\n \"string\"\n ],\n \"html_content\": \"string\",\n \"text_content\": \"string\",\n \"content_type\": \"html\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f876adb2-3943-4f6d-9cdd-e568a9287f5a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-contents",":content_id","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"content_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": {\n \"company\": {\n \"name\": \"Acme Corp\"\n },\n \"contact\": {\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\"\n },\n \"cta_url\": \"https://example.com/get-started\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"2979b65c-0bce-41b7-8ed0-feb96c6e9e86","name":"Email Integrations","description":{"content":"Connect email providers (SendGrid, Mailgun, SMTP/IMAP, Gmail) for sending and receiving emails.","type":"text/plain"},"item":[{"id":"9a5fd278-c3c6-4071-bc7c-f925a565d100","name":"List Email Integrations","request":{"name":"List Email Integrations","description":{"content":"List all active (non-archived) email integrations for the tenant.\n\n**Required Scopes:** `email_integrations:read`\n\nNote: Archived integrations are excluded. Use GET /archived to view archived integrations.","type":"text/plain"},"url":{"path":["api","v1","email-integrations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"integration_type","value":"gmail"},{"disabled":false,"key":"active_only","value":"true"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"2109f9d9-f5b1-45c3-8a7b-61b825d02a2b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations"],"host":["{{baseUrl}}"],"query":[{"key":"integration_type","value":"gmail"},{"key":"active_only","value":"true"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"created_at\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"integration_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"oauth_email\": {\n \"value\": \"\"\n },\n \"last_error\": {\n \"value\": \"\"\n },\n \"last_error_at\": {\n \"value\": \"\"\n },\n \"smtp_host\": {\n \"value\": \"\"\n },\n \"smtp_port\": {\n \"value\": \"\"\n },\n \"smtp_username\": {\n \"value\": \"\"\n },\n \"smtp_use_tls\": {\n \"value\": \"\"\n },\n \"imap_host\": {\n \"value\": \"\"\n },\n \"imap_port\": {\n \"value\": \"\"\n },\n \"imap_username\": {\n \"value\": \"\"\n },\n \"imap_use_ssl\": {\n \"value\": \"\"\n },\n \"ses_tenant_name\": {\n \"value\": \"\"\n },\n \"ses_domain\": {\n \"value\": \"\"\n },\n \"ses_sending_status\": {\n \"value\": \"\"\n },\n \"ses_reputation_policy\": {\n \"value\": \"\"\n },\n \"dns_verification_status\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n },\n \"proxy_forward_to\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_id\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_name\": {\n \"value\": \"\"\n },\n \"outbound_provider_id\": {\n \"value\": \"\"\n },\n \"accepted_aliases\": {\n \"value\": \"\"\n },\n \"recipient_validation_mode\": {\n \"value\": \"\"\n },\n \"default_signature\": {\n \"value\": \"\"\n },\n \"include_signature\": {\n \"value\": \"\"\n },\n \"sync_enabled\": {\n \"value\": \"\"\n },\n \"last_sync_at\": {\n \"value\": \"\"\n },\n \"initial_sync_hours\": {\n \"value\": \"\"\n }\n },\n {\n \"created_at\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"integration_type\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"oauth_email\": {\n \"value\": \"\"\n },\n \"last_error\": {\n \"value\": \"\"\n },\n \"last_error_at\": {\n \"value\": \"\"\n },\n \"smtp_host\": {\n \"value\": \"\"\n },\n \"smtp_port\": {\n \"value\": \"\"\n },\n \"smtp_username\": {\n \"value\": \"\"\n },\n \"smtp_use_tls\": {\n \"value\": \"\"\n },\n \"imap_host\": {\n \"value\": \"\"\n },\n \"imap_port\": {\n \"value\": \"\"\n },\n \"imap_username\": {\n \"value\": \"\"\n },\n \"imap_use_ssl\": {\n \"value\": \"\"\n },\n \"ses_tenant_name\": {\n \"value\": \"\"\n },\n \"ses_domain\": {\n \"value\": \"\"\n },\n \"ses_sending_status\": {\n \"value\": \"\"\n },\n \"ses_reputation_policy\": {\n \"value\": \"\"\n },\n \"dns_verification_status\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n },\n \"proxy_forward_to\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_id\": {\n \"value\": \"\"\n },\n \"outbound_mailbox_name\": {\n \"value\": \"\"\n },\n \"outbound_provider_id\": {\n \"value\": \"\"\n },\n \"accepted_aliases\": {\n \"value\": \"\"\n },\n \"recipient_validation_mode\": {\n \"value\": \"\"\n },\n \"default_signature\": {\n \"value\": \"\"\n },\n \"include_signature\": {\n \"value\": \"\"\n },\n \"sync_enabled\": {\n \"value\": \"\"\n },\n \"last_sync_at\": {\n \"value\": \"\"\n },\n \"initial_sync_hours\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"32a17901-8988-4e96-a37a-3025cf451916","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations"],"host":["{{baseUrl}}"],"query":[{"key":"integration_type","value":"gmail"},{"key":"active_only","value":"true"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49737053-dc17-471e-9dd2-0f8ceeaa6c32","name":"Create Email Integration","request":{"name":"Create Email Integration","description":{"content":"Create a new email integration.\n\n**Required Scopes:** `email_integrations:create`\n\nIntegration Types:\n- `gmail` - OAuth2 connection to Gmail\n- `smtp_imap` - Generic SMTP/IMAP server\n- `sendgrid` - Customer's own SendGrid account (deprecated for new integrations)\n- `ses_managed` - SendSeven managed SES (auto-setup: creates tenant, config set, starts domain verification)\n- `proxy` - Email forwarding via proxy address\n\nFor `ses_managed` integrations with `ses_domain` provided:\n- Automatically creates SES Configuration Set\n- Automatically starts domain verification\n- Returns DNS records that must be added to complete verification","type":"text/plain"},"url":{"path":["api","v1","email-integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"email_address\": \"eijrGKq-KCg0@gQJk.somk\",\n \"integration_type\": \"sendgrid\",\n \"smtp_config\": {\n \"value\": \"\"\n },\n \"imap_config\": {\n \"value\": \"\"\n },\n \"ses_domain\": \"string\",\n \"ses_reputation_policy\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"recipient_validation_mode\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_signature\": \"string\",\n \"include_signature\": true,\n \"initial_sync_hours\": 3747\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"38256763-ba57-41ac-b16f-3e8b655f6bcc","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"email_address\": \"eNoy@SDocxGs.mk\",\n \"integration_type\": \"sendgrid\",\n \"smtp_config\": {\n \"value\": \"\"\n },\n \"imap_config\": {\n \"value\": \"\"\n },\n \"ses_domain\": \"string\",\n \"ses_reputation_policy\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"recipient_validation_mode\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_signature\": \"string\",\n \"include_signature\": true,\n \"initial_sync_hours\": 3314\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"integration_type\": \"string\",\n \"is_active\": false,\n \"connection_status\": \"string\",\n \"created_at\": \"1962-01-21T20:46:42.910Z\",\n \"email_address\": \"string\",\n \"oauth_email\": \"string\",\n \"ses_tenant_name\": \"string\",\n \"ses_configuration_set\": \"string\",\n \"ses_domain\": \"string\",\n \"ses_reputation_policy\": \"string\",\n \"dns_verification_status\": \"string\",\n \"dns_records\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"setup_message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ddaa4fc0-5b91-4c1b-ad50-0b082c551585","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"email_address\": \"eNoy@SDocxGs.mk\",\n \"integration_type\": \"sendgrid\",\n \"smtp_config\": {\n \"value\": \"\"\n },\n \"imap_config\": {\n \"value\": \"\"\n },\n \"ses_domain\": \"string\",\n \"ses_reputation_policy\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"recipient_validation_mode\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_signature\": \"string\",\n \"include_signature\": true,\n \"initial_sync_hours\": 3314\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c278f115-a11f-4b8b-9bd2-063bb7925d92","name":"List Archived Email Integrations","request":{"name":"List Archived Email Integrations","description":{"content":"List all archived email integrations for the tenant.\n\n**Required Scopes:** `email_integrations:read`\n\nReturns integrations that have been deleted (soft-deleted/archived).\nUseful for audit purposes and billing history.\n\nNote: Sensitive credentials are cleared when an integration is archived.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","archived"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"integration_type","value":"gmail"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"3b39d88e-0792-422d-85bf-05d7b4310616","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","archived"],"host":["{{baseUrl}}"],"query":[{"key":"integration_type","value":"gmail"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"created_at\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"integration_type\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"oauth_email\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"is_archived\": {\n \"value\": \"\"\n },\n \"archived_at\": {\n \"value\": \"\"\n },\n \"archived_by_user_id\": {\n \"value\": \"\"\n },\n \"ses_domain\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n }\n },\n {\n \"created_at\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"integration_type\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n },\n \"oauth_email\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"is_archived\": {\n \"value\": \"\"\n },\n \"archived_at\": {\n \"value\": \"\"\n },\n \"archived_by_user_id\": {\n \"value\": \"\"\n },\n \"ses_domain\": {\n \"value\": \"\"\n },\n \"proxy_address\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"c792a42e-49aa-4c40-a5d6-2830ca4ad11c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","archived"],"host":["{{baseUrl}}"],"query":[{"key":"integration_type","value":"gmail"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cf76c2a2-228c-4477-a851-a6d4ff7b3888","name":"Get Email Integration","request":{"name":"Get Email Integration","description":{"content":"Get a specific email integration by ID.\n\n**Required Scopes:** `email_integrations:read`","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"02571f61-3d18-4576-aba5-501e330cc69a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"integration_type\": \"string\",\n \"is_active\": false,\n \"connection_status\": \"string\",\n \"updated_at\": \"string\",\n \"email_address\": \"string\",\n \"oauth_email\": \"string\",\n \"last_error\": \"string\",\n \"last_error_at\": \"2003-10-06T22:35:02.062Z\",\n \"smtp_host\": \"string\",\n \"smtp_port\": 6077,\n \"smtp_username\": \"string\",\n \"smtp_use_tls\": false,\n \"imap_host\": \"string\",\n \"imap_port\": 6565,\n \"imap_username\": \"string\",\n \"imap_use_ssl\": false,\n \"ses_tenant_name\": \"string\",\n \"ses_domain\": \"string\",\n \"ses_sending_status\": \"string\",\n \"ses_reputation_policy\": \"string\",\n \"dns_verification_status\": \"string\",\n \"proxy_address\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_mailbox_name\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"any\",\n \"default_signature\": \"string\",\n \"include_signature\": false,\n \"sync_enabled\": false,\n \"last_sync_at\": \"2009-03-29T17:59:09.812Z\",\n \"initial_sync_hours\": 8542\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87a91580-d1c2-48db-aeeb-235f7268bddc","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b77c7ae8-ff60-47e1-91f1-3317312993a0","name":"Update Email Integration","request":{"name":"Update Email Integration","description":{"content":"Update an existing email integration.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"is_active\": false,\n \"smtp_config\": {\n \"value\": \"\"\n },\n \"imap_config\": {\n \"value\": \"\"\n },\n \"default_signature\": \"string\",\n \"include_signature\": true,\n \"sync_enabled\": true,\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"string\",\n \"initial_sync_hours\": 5338\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"60692b47-bbfb-4d55-8a03-627f2e898780","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"is_active\": true,\n \"smtp_config\": {\n \"value\": \"\"\n },\n \"imap_config\": {\n \"value\": \"\"\n },\n \"default_signature\": \"string\",\n \"include_signature\": true,\n \"sync_enabled\": false,\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"string\",\n \"initial_sync_hours\": 2500\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"integration_type\": \"string\",\n \"is_active\": false,\n \"connection_status\": \"string\",\n \"updated_at\": \"string\",\n \"email_address\": \"string\",\n \"oauth_email\": \"string\",\n \"last_error\": \"string\",\n \"last_error_at\": \"2003-10-06T22:35:02.062Z\",\n \"smtp_host\": \"string\",\n \"smtp_port\": 6077,\n \"smtp_username\": \"string\",\n \"smtp_use_tls\": false,\n \"imap_host\": \"string\",\n \"imap_port\": 6565,\n \"imap_username\": \"string\",\n \"imap_use_ssl\": false,\n \"ses_tenant_name\": \"string\",\n \"ses_domain\": \"string\",\n \"ses_sending_status\": \"string\",\n \"ses_reputation_policy\": \"string\",\n \"dns_verification_status\": \"string\",\n \"proxy_address\": \"string\",\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_mailbox_name\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"any\",\n \"default_signature\": \"string\",\n \"include_signature\": false,\n \"sync_enabled\": false,\n \"last_sync_at\": \"2009-03-29T17:59:09.812Z\",\n \"initial_sync_hours\": 8542\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c177873d-3c76-4184-b582-95184983599e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"is_active\": true,\n \"smtp_config\": {\n \"value\": \"\"\n },\n \"imap_config\": {\n \"value\": \"\"\n },\n \"default_signature\": \"string\",\n \"include_signature\": true,\n \"sync_enabled\": false,\n \"proxy_forward_to\": \"string\",\n \"outbound_mailbox_id\": \"string\",\n \"outbound_provider_id\": \"string\",\n \"accepted_aliases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"recipient_validation_mode\": \"string\",\n \"initial_sync_hours\": 2500\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"59363431-3994-4102-9179-32cee816f75b","name":"Delete Email Integration","request":{"name":"Delete Email Integration","description":{"content":"Archive (soft-delete) an email integration with full resource cleanup.\n\n**Required Scopes:** `email_integrations:delete`\n\nThis archives the integration and cleans up all associated resources:\n- For SES managed integrations: removes domain identity from AWS SES\n (only if no other active integration uses the same domain), deletes\n the SES configuration set, and removes the SES tenant\n- Deletes DNS verification records from the database\n- Deactivates proxy mappings for proxy integrations\n- Clears sensitive credentials (OAuth tokens, passwords, API keys)\n- Marks the integration as archived with timestamp\n- Preserves the integration record for billing history and audit purposes\n\nThe integration will no longer appear in the list or be usable.\nAfter archiving, the same domain can be re-added to a new integration.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"87b9116d-e679-492e-80e0-b31c24c6829b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"integration_id\": \"string\",\n \"message\": \"string\",\n \"archived_at\": \"1963-08-23T11:32:32.132Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"39d9b8c9-e6bd-4d3d-bcc3-e36a06886065","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0d9a48ac-5261-4ca3-9648-f8da6f5be840","name":"Test Email Integration","request":{"name":"Test Email Integration","description":{"content":"Test the connection for an email integration.\n\n**Required Scopes:** `email_integrations:update`\n\nReturns connection status and any errors.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"1d1e63f8-3a9e-42e6-ac93-3930e1e7f420","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"integration_id\": \"string\",\n \"success\": false,\n \"status\": \"string\",\n \"message\": \"string\",\n \"smtp\": {\n \"key_0\": 7434\n },\n \"imap\": {\n \"key_0\": 1822,\n \"key_1\": true\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70337db5-7b0d-40c5-920c-f7fff770815f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b54f09fd-94ad-4750-8004-4d7a2d3a9c73","name":"Sync Email Integration","request":{"name":"Sync Email Integration","description":{"content":"Trigger a manual sync for an email integration.\n\n**Required Scopes:** `email_integrations:update`\n\nThis is typically used for SMTP/IMAP or Gmail integrations to fetch new emails.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"52da2591-0fb8-439d-9239-8f0141e7b64d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"integration_id\": \"string\",\n \"status\": \"string\",\n \"message\": \"string\",\n \"emails_found\": 0\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a2c24175-8bf1-4a92-9a36-c3e9055b57be","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"477335e4-078c-4214-be92-2b7f1525b178","name":"Get Dns Records","request":{"name":"Get Dns Records","description":{"content":"Get DNS records required for domain verification.\n\n**Required Scopes:** `email_integrations:read`\n\nReturns DKIM, SPF, and DMARC records that need to be set in DNS.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","dns-records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"6b6299f6-72ee-4dd1-8a21-4d39b70833b4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","dns-records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"record_type\": {\n \"value\": \"\"\n },\n \"record_name\": {\n \"value\": \"\"\n },\n \"record_value\": {\n \"value\": \"\"\n },\n \"is_verified\": {\n \"value\": \"\"\n },\n \"last_check_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"record_type\": {\n \"value\": \"\"\n },\n \"record_name\": {\n \"value\": \"\"\n },\n \"record_value\": {\n \"value\": \"\"\n },\n \"is_verified\": {\n \"value\": \"\"\n },\n \"last_check_at\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a3ce21d-af56-4316-b371-fe4e3929e28e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","dns-records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"58f3fea1-8890-48df-93a5-06b0df778e7f","name":"Verify Dns","request":{"name":"Verify Dns","description":{"content":"Trigger DNS verification check.\n\n**Required Scopes:** `email_integrations:update`\n\nChecks if the required DNS records have been properly configured.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","verify-dns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"bffa4868-ba27-4e5f-a5bc-f29adfb28243","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","verify-dns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"integration_id\": \"string\",\n \"status\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6632fe4d-6e10-4059-9de0-b638db244033","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","verify-dns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"633582ca-06e2-4896-b21e-7a85c191d78d","name":"Add Domain","request":{"name":"Add Domain","description":{"content":"Start domain verification for an SES managed integration.\n\n**Required Scopes:** `email_integrations:update`\n\nThis:\n1. Creates an email identity for the domain in SES\n2. Returns DNS records (DKIM, SPF, DMARC) that need to be added\n3. Associates the domain with the SES tenant once verified\n\nThe customer must add these DNS records to their domain before emails can be sent.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","add-domain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0bed3008-cea1-40e5-a3b4-71e407c7c0a0","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","add-domain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"domain\": \"string\",\n \"verification_status\": \"string\",\n \"verified\": true,\n \"dkim_status\": \"UNKNOWN\",\n \"dns_records\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b4ebc699-ef1d-4354-a11e-565336dcba16","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","add-domain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ef44e86b-1a62-4c97-a7e1-a53312c972df","name":"Get Domain Status","request":{"name":"Get Domain Status","description":{"content":"Check domain verification status for an SES managed integration.\n\n**Required Scopes:** `email_integrations:read`\n\nReturns the current verification status and DNS records.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","domain-status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"649c6d98-b6bd-44ac-a0c6-f70840a2a848","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","domain-status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"domain\": \"string\",\n \"verification_status\": \"string\",\n \"verified\": true,\n \"dkim_status\": \"UNKNOWN\",\n \"dns_records\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"41c60343-1acb-4972-8597-f4bf4b9ad454","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","domain-status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cd9c3570-4637-4fb2-acdc-97c57962c43d","name":"Pause Sending","request":{"name":"Pause Sending","description":{"content":"Pause email sending for an SES managed integration.\n\n**Required Scopes:** `email_integrations:update`\n\nThis manually pauses the SES tenant, stopping all email sending.\nUse this if you need to temporarily disable sending (e.g., suspected abuse).","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","pause-sending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"4facd49d-8f45-4913-bd3f-665603155d8b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","pause-sending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"integration_id\": \"string\",\n \"ses_tenant_name\": \"string\",\n \"sending_status\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05e2f152-f8c4-43b1-8a5a-107f351d9a7e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","pause-sending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"88a1cfb8-5276-4e5b-8bc2-6d6f3792c55f","name":"Resume Sending","request":{"name":"Resume Sending","description":{"content":"Resume email sending for an SES managed integration.\n\n**Required Scopes:** `email_integrations:update`\n\nThis resumes sending for a paused SES tenant.\n\nNote: If the tenant was auto-paused due to reputation issues,\nyou should address the underlying problem before resuming.","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","resume-sending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"152d88ff-df22-4e42-8345-3a7e138a36a9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","resume-sending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"integration_id\": \"string\",\n \"ses_tenant_name\": \"string\",\n \"sending_status\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f650bbe1-f341-49f0-8278-7977abbc7269","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","resume-sending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f17e2b3f-ed87-429c-8860-ef1f4bbc1e16","name":"Add Gmail Alias","request":{"name":"Add Gmail Alias","description":{"content":"Add a Gmail send-as alias.\n\nAdds the alias email and creates a corresponding mailbox.\nThe alias MUST be configured in Gmail under Settings > Accounts and Import > Send mail as,\notherwise Gmail will silently send from the primary email instead.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","test-alias"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"alias_email\": \"zat@rnzNzwnXXKSpBsNvXXBP.fnh\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b6546e43-35f6-439b-b5ad-0a156245108b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","test-alias"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"alias_email\": \"zat@rnzNzwnXXKSpBsNvXXBP.fnh\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"alias_email\": \"string\",\n \"message\": \"string\",\n \"mailbox_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae0a0c16-d85f-44bb-96ee-a15992bf9e4a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","test-alias"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"alias_email\": \"zat@rnzNzwnXXKSpBsNvXXBP.fnh\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"41396991-cc34-4416-8ab4-9354da3fdb4a","name":"Remove Gmail Alias","request":{"name":"Remove Gmail Alias","description":{"content":"Remove a verified Gmail send-as alias.\n\nDeactivates the corresponding mailbox (preserves history).\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","aliases",":alias_email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"alias_email","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"91e4dcaf-1d69-44be-a7e6-54d382dd85bb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","aliases",":alias_email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"alias_email","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"311cf9e5-a145-41d0-8384-817e859d26d0","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","aliases",":alias_email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "},{"disabled":false,"type":"any","value":"string","key":"alias_email","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"edce4f83-3f59-4e85-abdc-69295b2ecdc5","name":"Sync Gmail Integration","request":{"name":"Sync Gmail Integration","description":{"content":"Trigger a manual sync for a Gmail integration.\n\n**Required Scopes:** `email_integrations:update`\n\nThis will:\n1. Fetch new messages from Gmail since last sync\n2. Process and store them in the system\n3. Update the integration's history ID","type":"text/plain"},"url":{"path":["api","v1","email-integrations",":integration_id","gmail","sync"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"full_sync","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"8d7461f5-ff9a-472e-8c73-54d5c29bfc6c","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","gmail","sync"],"host":["{{baseUrl}}"],"query":[{"key":"full_sync","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"integration_id\": \"string\",\n \"status\": \"string\",\n \"message\": \"string\",\n \"messages_synced\": 0,\n \"new_history_id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71ae5d01-34f0-40de-83ba-03c5b61d2c36","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations",":integration_id","gmail","sync"],"host":["{{baseUrl}}"],"query":[{"key":"full_sync","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"integration_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3f8afeae-9296-4af7-b1a5-38e1d6874f3a","name":"Get email thread for conversation","request":{"name":"Get email thread for conversation","description":{"content":"Get the full email thread for a conversation.\n\n**Required Scopes:** `email_integrations:read` OR `conversations:read`\n\nReturns all email messages associated with this conversation, including:\n- RFC 5322 headers (Message-ID, In-Reply-To, References)\n- From, To, CC, BCC addresses\n- Subject and body (text + signed URL for HTML)\n- Attachments with download URLs\n- Thread relationships for proper email client display\n\nThis is the primary endpoint for the email thread view in Conversations UI.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","email-thread"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"f5589521-213d-405c-93bf-1b9ceea64576","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","email-thread"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conversation_id\": \"string\",\n \"thread_id\": \"string\",\n \"subject\": \"string\",\n \"messages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total_messages\": 0,\n \"original_from\": {\n \"value\": \"\"\n },\n \"original_to\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"original_cc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1f1c6552-729f-473a-9f05-5ccba9874608","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","email-thread"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71f15b0e-2e43-4e8e-8bf5-fb66f03401ba","name":"Compose and send new outbound email","request":{"name":"Compose and send new outbound email","description":{"content":"Compose and send a new outbound email (not a reply).\n\n**Required Scopes:** `email_integrations:update` OR `messages:create`\n\nUse this endpoint for initiating new email conversations where there's\nno existing message to reply to.\n\nFeatures:\n- Plain text and/or HTML body support (rich text)\n- Subject line required\n- CC/BCC support\n- Attachment support via attachment IDs\n\nThe email is sent via the conversation's associated email integration.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","compose-email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"s\",\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"to_email\": \"ybV0K0Lzg9oIx@SmVgNM.to\",\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"attachment_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f9daab57-3b26-4a8a-b01b-4bb267c725f7","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","compose-email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"string\",\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"to_email\": \"j-1MDQ6hkp5y-ZY@wcgehqgKjOVjAvWP.agb\",\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"attachment_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"email_message_id\": \"string\",\n \"status\": \"string\",\n \"message_id\": \"string\",\n \"sent_at\": \"string\",\n \"to_emails\": [\n \"string\",\n \"string\"\n ],\n \"cc_emails\": [\n \"string\",\n \"string\"\n ],\n \"bcc_emails\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5fb65083-7d50-4964-97ab-45695058bcb0","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","compose-email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"string\",\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"to_email\": \"j-1MDQ6hkp5y-ZY@wcgehqgKjOVjAvWP.agb\",\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"attachment_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a8762b5f-9668-47a1-adc3-b941024fa0d9","name":"Compose and send email from an EmailContent template","request":{"name":"Compose and send email from an EmailContent template","description":{"content":"Compose and send an outbound email using a pre-designed EmailContent template.\n\n**Required Scopes:** `email_integrations:update` OR `messages:create`\n\nThe template is compiled with the conversation contact's data (name, email, phone)\nsubstituted into template variables. Optional variable_overrides allow the caller\nto override or supplement template variable values before compilation.\n\nUses the same 3-tier sending identity resolution as compose-email:\nmailbox -> integration -> channel.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","compose-from-template"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_content_id\": \"string\",\n \"variable_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"include_signature\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3fa2102f-9813-48e7-9803-9029cc7249c9","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","compose-from-template"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_content_id\": \"string\",\n \"variable_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"include_signature\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"email_message_id\": \"string\",\n \"status\": \"string\",\n \"message_id\": \"string\",\n \"sent_at\": \"string\",\n \"to_emails\": [\n \"string\",\n \"string\"\n ],\n \"cc_emails\": [\n \"string\",\n \"string\"\n ],\n \"bcc_emails\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"81275e16-eeb6-4d84-96ea-f5fe3147bce8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","compose-from-template"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_content_id\": \"string\",\n \"variable_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"include_signature\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"520be88b-0241-4740-bf0b-7c69d1ae87fc","name":"Preview an EmailContent template with conversation contact data","request":{"name":"Preview an EmailContent template with conversation contact data","description":{"content":"Preview an EmailContent template compiled with the conversation contact's data.\n\n**Required Scopes:** `email_integrations:read`\n\nReturns the fully compiled HTML and subject line with all template variables\nreplaced using the actual contact data from the conversation. Also resolves\nthe sending identity so the frontend can display the from address.\n\nUse this endpoint to show a live preview before sending via compose-from-template.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","preview-template"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_content_id\": \"string\",\n \"variable_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"890f6224-7cf2-4a61-8b3a-36458b1e1794","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","preview-template"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_content_id\": \"string\",\n \"variable_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subject_line\": \"string\",\n \"html_content\": \"string\",\n \"text_content\": \"string\",\n \"from_email\": \"string\",\n \"from_name\": \"string\",\n \"variables_used\": [\n \"string\",\n \"string\"\n ],\n \"content_type\": \"html\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1b877a29-ac7d-45aa-944b-2f77b68d198e","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","preview-template"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_content_id\": \"string\",\n \"variable_overrides\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d141a1af-d073-4a8a-8275-2f73ec532ec3","name":"Get email summary for conversation sidebar","request":{"name":"Get email summary for conversation sidebar","description":{"content":"Get email summary for the conversation sidebar.\n\n**Required Scopes:** `email_integrations:read` OR `conversations:read`\n\nReturns:\n- Whether this conversation has email messages\n- Total message and attachment counts\n- Latest email information\n- All unique participants in the thread\n- Email integration type and ID\n\nThis is a lightweight endpoint for displaying email info in the sidebar.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","email-summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"5b4bbc95-75f5-4c94-a7da-ad6eb53ddca2","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","email-summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conversation_id\": \"string\",\n \"subject\": \"\",\n \"participant_email\": \"\",\n \"participant_name\": \"string\",\n \"integration_email\": \"\",\n \"thread_count\": 0,\n \"total_attachments\": 0,\n \"first_message_at\": \"string\",\n \"last_message_at\": \"string\",\n \"participants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"cc_participants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"labels\": [\n \"string\",\n \"string\"\n ],\n \"is_unread\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dfdcd6a8-bcc3-47f1-ac5e-9600e3a27ed3","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","conversations",":conversation_id","email-summary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"conversation_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"38ddbf5d-07fb-4aa0-90b3-c8f8244914f0","name":"Get single email message detail","request":{"name":"Get single email message detail","description":{"content":"Get detailed information for a single email message.\n\n**Required Scopes:** `email_integrations:read`\n\nReturns full email details including:\n- All headers\n- Full text body\n- Signed URL for HTML body\n- Attachment list with download URLs\n\nUse this endpoint when expanding a collapsed email in the thread view.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"df015889-7654-4b19-a4f3-59e2893012cb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"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\": \"string\",\n \"from_email\": \"string\",\n \"status\": \"string\",\n \"created_at\": \"string\",\n \"message_id\": \"string\",\n \"thread_id\": \"string\",\n \"from_name\": \"string\",\n \"to_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_to\": \"string\",\n \"subject\": \"string\",\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"raw_headers\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"error_message\": \"string\",\n \"sent_at\": \"string\",\n \"received_at\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e172f819-add1-42f2-8aed-c8bd483710ec","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"56cc5073-a389-4a09-82fc-f9f91dc79565","name":"Delete Email Message","request":{"name":"Delete Email Message","description":{"content":"Permanently delete an email message.\n\nThis action cannot be undone. Consider using hide instead for soft-delete.\n\n**Required Scopes:** `email_integrations:delete`","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"6223a4a1-dcaa-4759-8458-33f88fbbaabe","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b4402380-ba6e-444e-b1bd-c0ae3a6ca087","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e4b2865f-0e99-4418-b83c-6b863335da39","name":"Get all messages in email thread","request":{"name":"Get all messages in email thread","description":{"content":"Get all messages in the same thread as the specified email message.\n\n**Required Scopes:** `email_integrations:read`\n\nThis loads the full email chain using the thread_id from the specified message.\nUseful for viewing the complete thread context.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","thread"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"01df30d7-c81e-4e30-a72a-a614cc20f7e6","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","thread"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conversation_id\": \"string\",\n \"thread_id\": \"string\",\n \"subject\": \"string\",\n \"messages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total_messages\": 0,\n \"original_from\": {\n \"value\": \"\"\n },\n \"original_to\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"original_cc\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4501a4b9-e16b-4126-8785-2cfa5ffcae7a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","thread"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"428b5e60-de31-492e-8d1f-fde3f283859d","name":"Send email reply","request":{"name":"Send email reply","description":{"content":"Send a reply to an email message.\n\n**Required Scopes:** `email_integrations:update` OR `messages:create`\n\nFeatures:\n- Plain text and/or HTML body support (rich text)\n- CC/BCC handling with option to preserve original CCs\n- Reply-all option\n- Attachment support via attachment IDs\n- Automatic subject line (Re: original) with override option\n\nThe reply is queued for sending via the configured email integration.\nThread headers (In-Reply-To, References) are automatically set.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preserve_cc\": true,\n \"attachment_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"to_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_all\": false,\n \"subject_override\": \"string\",\n \"include_thread_history\": true,\n \"sender_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"34c1e864-79b0-46c1-90ea-00aadeaa7bf4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preserve_cc\": true,\n \"attachment_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"to_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_all\": false,\n \"subject_override\": \"string\",\n \"include_thread_history\": true,\n \"sender_id\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"email_message_id\": \"string\",\n \"status\": \"string\",\n \"message_id\": \"string\",\n \"sent_at\": \"string\",\n \"to_emails\": [\n \"string\",\n \"string\"\n ],\n \"cc_emails\": [\n \"string\",\n \"string\"\n ],\n \"bcc_emails\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b3cae6a1-3b47-42e4-918f-38d692cb9feb","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","reply"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"text_body\": \"string\",\n \"html_body\": \"string\",\n \"cc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bcc_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preserve_cc\": true,\n \"attachment_ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"to_emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reply_all\": false,\n \"subject_override\": \"string\",\n \"include_thread_history\": true,\n \"sender_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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7067b60d-5926-4ee9-bc18-423f44e9a6bc","name":"Upload inline image for rich text email","request":{"name":"Upload inline image for rich text email","description":{"content":"Upload an inline image for use in rich text email replies.\n\n**Required Scopes:** `email_integrations:update`\n\nReturns:\n- attachment_id: ID to reference in reply\n- content_id: CID for use in HTML (e.g., ``)\n- url: Signed URL for preview in composer\n\nUsage in HTML body:\n```html\n\"Inline\n```\n\nThen include the attachment_id in the reply request's attachment_ids array.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","inline-images"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"filename","value":""},{"disabled":false,"key":"content_type","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"47ee6db1-26db-4a81-aa71-36b218d0e979","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","inline-images"],"host":["{{baseUrl}}"],"query":[{"key":"filename","value":""},{"key":"content_type","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attachment_id\": \"string\",\n \"content_id\": \"string\",\n \"url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0025701f-ba09-4386-af6c-e334f5d209d1","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","inline-images"],"host":["{{baseUrl}}"],"query":[{"key":"filename","value":""},{"key":"content_type","value":""}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0ac159e7-07b5-4627-9bc5-14f1ff817deb","name":"Upload inline image via multipart form","request":{"name":"Upload inline image via multipart form","description":{"content":"Upload an inline image via multipart form data.\n\n**Required Scopes:** `email_integrations:update`\n\nThis is an alternative to the raw body upload endpoint,\ndesigned for standard HTML file upload forms.\n\nForm fields:\n- file: The image file\n\nReturns same response as /inline-images endpoint.","type":"text/plain"},"url":{"path":["api","v1","email-integrations","inline-images","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"612679d6-bf0c-4497-b58c-64f8de8db07a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","inline-images","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attachment_id\": \"string\",\n \"content_id\": \"string\",\n \"url\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d59cc3fd-a55b-4ff3-aa9e-69d47524cb1d","name":"Hide Email Message","request":{"name":"Hide Email Message","description":{"content":"Hide (soft-delete/archive) an email message.\n\nThe message will be hidden from the conversation view but kept in the database.\nUse unhide to restore it.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","hide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"0cbc70e1-bd09-4bad-82cd-e209c2076cb1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","hide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"direction\": \"string\",\n \"status\": \"string\",\n \"from_email\": \"string\",\n \"created_at\": \"1952-11-11T10:49:21.589Z\",\n \"from_name\": \"string\",\n \"subject\": \"string\",\n \"is_hidden\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8976eebf-f830-4567-b285-69fbb4e863cb","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","hide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d39936a0-afdd-4f87-b909-146aa8ae69a2","name":"Unhide Email Message","request":{"name":"Unhide Email Message","description":{"content":"Unhide (restore) a hidden email message.\n\n**Required Scopes:** `email_integrations:update`","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","unhide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"0604bbce-8b82-4ae2-8e24-22262e4aef45","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","unhide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"direction\": \"string\",\n \"status\": \"string\",\n \"from_email\": \"string\",\n \"created_at\": \"1952-11-11T10:49:21.589Z\",\n \"from_name\": \"string\",\n \"subject\": \"string\",\n \"is_hidden\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a77c6df-8f00-4527-9fac-fa8310d94712","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","unhide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"79e86d85-5f10-4210-b682-2ca8b99ba9ff","name":"Block Sender From Message","request":{"name":"Block Sender From Message","description":{"content":"Block the sender of an email message.\n\nAdds the sender's email address to the blacklist. Future emails from this\nsender will be skipped during polling.\n\nOptionally hide all existing messages from this sender.\n\nThe whole contact (all channels) is blocked only when the address clearly\nbelongs to exactly one contact AND the caller also has `contacts:update`;\notherwise only the address itself is blocked.\n\n**Required Scopes:** `email_integrations:update` (+ `contacts:update` for\na contact-level block)","type":"text/plain"},"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","block-sender"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"reason\": \"string\",\n \"hide_existing_messages\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"96278563-c6a6-4f75-b38d-f69735690e14","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","block-sender"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"reason\": \"string\",\n \"hide_existing_messages\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"email_address\": \"string\",\n \"created_at\": \"1997-12-18T10:52:12.359Z\",\n \"blocked_by_user_id\": \"string\",\n \"reason\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6425a78d-e39f-4b84-8fb2-89a9ba83a54d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","email-messages",":email_message_id","block-sender"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_message_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"reason\": \"string\",\n \"hide_existing_messages\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"07c868aa-f1d7-4e1f-a23c-a21a03f0e470","name":"List Blocked Senders","request":{"name":"List Blocked Senders","description":{"content":"List all blocked email senders.\n\n**Required Scopes:** `email_integrations:read`","type":"text/plain"},"url":{"path":["api","v1","email-integrations","blocked-senders"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"20","description":"Items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"ab0cccf6-607e-4709-bce7-7e67f69215ad","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a735c671-c6d1-487b-aa2b-4c6d40d63ded","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2a26f8c1-fe12-473b-b56a-35a69a9fe286","name":"Block Sender Directly","request":{"name":"Block Sender Directly","description":{"content":"Directly block an email address.\n\nAdds the email address to the blacklist. Future emails from this\nsender will be skipped during polling.\n\nThe whole contact (all channels) is blocked only when the address clearly\nbelongs to exactly one contact AND the caller also has `contacts:update`;\notherwise only the address itself is blocked.\n\n**Required Scopes:** `email_integrations:update` (+ `contacts:update` for\na contact-level block)","type":"text/plain"},"url":{"path":["api","v1","email-integrations","blocked-senders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_address\": \"2PKQ29zQIPU0qO@eQmWNrAAWRx.hedb\",\n \"reason\": \"string\",\n \"hide_existing_messages\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"deaca099-b912-420b-a204-19e271a0f9b1","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_address\": \"2PKQ29zQIPU0qO@eQmWNrAAWRx.hedb\",\n \"reason\": \"string\",\n \"hide_existing_messages\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"email_address\": \"string\",\n \"created_at\": \"1997-12-18T10:52:12.359Z\",\n \"blocked_by_user_id\": \"string\",\n \"reason\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a948612a-f3e6-4416-95c8-409b8bc77d48","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email_address\": \"2PKQ29zQIPU0qO@eQmWNrAAWRx.hedb\",\n \"reason\": \"string\",\n \"hide_existing_messages\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cc677f69-d65c-4fde-842f-c16f15e7a4b3","name":"Unblock Sender","request":{"name":"Unblock Sender","description":{"content":"Unblock an email sender (remove from blacklist).\n\nUnblocks the owning contact as a whole only when the caller also has\n`contacts:update`; otherwise only the address itself is unblocked.\n\n**Required Scopes:** `email_integrations:update` (+ `contacts:update` for\na contact-level unblock)","type":"text/plain"},"url":{"path":["api","v1","email-integrations","blocked-senders",":email_address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_address","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"585a5ffd-f83c-47e7-95f6-f350c3724164","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders",":email_address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_address","description":"(Required) "}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e738a58b-22bf-45e8-913b-bfa1cb2fe5f8","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders",":email_address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_address","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"314bd6c1-3433-4223-b06d-4637613b4d64","name":"Get Blocked Sender","request":{"name":"Get Blocked Sender","description":{"content":"Get details of a specific blocked sender.\n\n**Required Scopes:** `email_integrations:read`","type":"text/plain"},"url":{"path":["api","v1","email-integrations","blocked-senders",":email_address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_address","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"1b493bf8-41bd-4cfd-841c-16d7b3ed99ba","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders",":email_address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_address","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"email_address\": \"string\",\n \"created_at\": \"1997-12-18T10:52:12.359Z\",\n \"blocked_by_user_id\": \"string\",\n \"reason\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"14687546-ae94-415b-8c0e-78fe7e3933aa","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-integrations","blocked-senders",":email_address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email_address","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"7ebf5064-fa69-4897-b27a-e15cc10b27e5","name":"Email Mailboxes","description":{"content":"Manage connected email mailboxes used for sending and receiving email conversations.","type":"text/plain"},"item":[{"id":"9e4e90c3-8199-4b91-bf1f-742edb72fd78","name":"List Email Mailboxes","request":{"name":"List Email Mailboxes","description":{"content":"List email mailboxes for the tenant.\n\nReturns active mailboxes by default. Set `active_only=false` to include\ndeactivated mailboxes.\n\nOptional filters:\n- `purpose=campaign` - only mailboxes with can_send_campaigns=True\n- `purpose=support` - only mailboxes with can_send_support=True\n- `for_user_id` - only mailboxes the given user can access (all + specific with user in list)\n\n**Required Scopes:** `channels:read`","type":"text/plain"},"url":{"path":["api","v1","email-mailboxes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (1-indexed)"},{"disabled":false,"key":"page_size","value":"50","description":"Items per page"},{"disabled":false,"key":"active_only","value":"true","description":"Only return active mailboxes"},{"disabled":false,"key":"purpose","value":"string","description":"Filter by capability: 'campaign' (can_send_campaigns=True) or 'support' (can_send_support=True)"},{"disabled":false,"key":"for_user_id","value":"string","description":"Filter to mailboxes accessible by this user (respects access_mode)"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"79c34b5d-4192-4590-88a0-e8c3115bda7d","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-mailboxes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"active_only","value":"true"},{"key":"purpose","value":"string"},{"key":"for_user_id","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"page_size\": {\n \"value\": \"\"\n },\n \"total_pages\": {\n \"value\": \"\"\n },\n \"has_next\": {\n \"value\": \"\"\n },\n \"has_prev\": {\n \"value\": \"\"\n },\n \"next_cursor\": {\n \"value\": \"\"\n },\n \"prev_cursor\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21bfac78-7cfe-4f87-9092-d4e146f8db8f","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-mailboxes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"active_only","value":"true"},{"key":"purpose","value":"string"},{"key":"for_user_id","value":"string"}],"variable":[]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6f503abf-4bb8-4c7c-9c3f-cb35a6999ed9","name":"Create Email Mailbox","request":{"name":"Create Email Mailbox","description":{"content":"Create a new email mailbox.\n\nEither `email_integration_id` or `email_provider_config_id` must be set\n(but not both). If `is_default` is True the previous default mailbox\nfor the tenant is unset.\n\n**Required Scopes:** `channels:create`","type":"text/plain"},"url":{"path":["api","v1","email-mailboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"access_mode\": \"all\",\n \"can_send_campaigns\": false,\n \"can_send_support\": true,\n \"email_address\": \"support@company.com\",\n \"email_integration_id\": \"integration-uuid\",\n \"is_default\": true,\n \"name\": \"Support\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"55079d7b-e178-40f4-b5c3-a7720884331b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-mailboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"access_mode\": \"all\",\n \"can_send_campaigns\": false,\n \"can_send_support\": true,\n \"email_address\": \"support@company.com\",\n \"email_integration_id\": \"integration-uuid\",\n \"is_default\": true,\n \"name\": \"Support\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"email_address\": \"string\",\n \"is_active\": true,\n \"is_default\": false,\n \"updated_at\": \"string\",\n \"display_name\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"integration_name\": \"string\",\n \"provider_name\": \"string\",\n \"can_send_campaigns\": false,\n \"can_send_support\": true,\n \"include_thread_history\": true,\n \"access_mode\": \"all\",\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"998dbea9-12b5-4e7e-a53b-c16d5ad1be65","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-mailboxes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"access_mode\": \"all\",\n \"can_send_campaigns\": false,\n \"can_send_support\": true,\n \"email_address\": \"support@company.com\",\n \"email_integration_id\": \"integration-uuid\",\n \"is_default\": true,\n \"name\": \"Support\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"24310d1e-29da-48ae-b1d8-a0ade80d89fa","name":"Get Email Mailbox","request":{"name":"Get Email Mailbox","description":{"content":"Get a single email mailbox by ID.\n\n**Required Scopes:** `channels:read`","type":"text/plain"},"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"abe24b89-eb13-45c2-ade7-848c6e8eb928","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"email_address\": \"string\",\n \"is_active\": true,\n \"is_default\": false,\n \"updated_at\": \"string\",\n \"display_name\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"integration_name\": \"string\",\n \"provider_name\": \"string\",\n \"can_send_campaigns\": false,\n \"can_send_support\": true,\n \"include_thread_history\": true,\n \"access_mode\": \"all\",\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d9a79e56-4a78-4dae-bc0b-56aba5444474","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dacb2c3e-bdd9-4656-8907-cf8fd487d0d6","name":"Update Email Mailbox","request":{"name":"Update Email Mailbox","description":{"content":"Update an email mailbox.\n\nWhen setting `is_default=true`, the previous default mailbox for the\ntenant is automatically unset.\n\n**Required Scopes:** `channels:update`","type":"text/plain"},"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"access_mode\": \"specific\",\n \"allowed_user_ids\": [\n \"user-uuid-1\",\n \"user-uuid-2\"\n ],\n \"can_send_campaigns\": true,\n \"is_default\": true,\n \"name\": \"Updated Support\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"79dfd0f8-fe0a-4963-8515-0fdc51b28610","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"access_mode\": \"specific\",\n \"allowed_user_ids\": [\n \"user-uuid-1\",\n \"user-uuid-2\"\n ],\n \"can_send_campaigns\": true,\n \"is_default\": true,\n \"name\": \"Updated Support\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"created_at\": \"string\",\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"name\": \"string\",\n \"email_address\": \"string\",\n \"is_active\": true,\n \"is_default\": false,\n \"updated_at\": \"string\",\n \"display_name\": \"string\",\n \"email_integration_id\": \"string\",\n \"email_provider_config_id\": \"string\",\n \"integration_name\": \"string\",\n \"provider_name\": \"string\",\n \"can_send_campaigns\": false,\n \"can_send_support\": true,\n \"include_thread_history\": true,\n \"access_mode\": \"all\",\n \"allowed_user_ids\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aef8dc98-27bf-4ecc-a04b-44b7a326871c","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"access_mode\": \"specific\",\n \"allowed_user_ids\": [\n \"user-uuid-1\",\n \"user-uuid-2\"\n ],\n \"can_send_campaigns\": true,\n \"is_default\": true,\n \"name\": \"Updated Support\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d71d4e13-ef01-4bf8-86ec-d262530b7d17","name":"Delete Email Mailbox","request":{"name":"Delete Email Mailbox","description":{"content":"Delete an email mailbox (soft-delete: sets is_active=False).\n\n**Required Scopes:** `channels:delete`","type":"text/plain"},"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"b8fe8df2-43dd-4ee4-af2f-9914eced009b","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Resource deleted successfully\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d7610cf7-2c4b-4861-aff0-0d7e1347ae93","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"mailbox_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"17fc24fb-f389-4b9e-af20-2d0c8e3e1f1c","name":"Email Providers","description":{"content":"Manage email delivery provider configurations and DNS verification for custom domains.","type":"text/plain"},"item":[{"id":"62f41b6a-b872-4eb1-b914-ecdb4e414a43","name":"List Providers","request":{"name":"List Providers","description":{"content":"List all active (non-archived) email provider configurations for the tenant","type":"text/plain"},"url":{"path":["api","v1","email-providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"4ca3282f-4978-457c-bb22-6671af1030fb","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"provider_type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"api_key_preview\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"is_default\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"config\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"key_status\": {\n \"value\": \"\"\n },\n \"webhook_configured\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"provider_type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"api_key_preview\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"is_default\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"config\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"key_status\": {\n \"value\": \"\"\n },\n \"webhook_configured\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7703226d-002c-4e09-ad34-d6d064c0f30c","name":"Create Provider","request":{"name":"Create Provider","description":{"content":"Create a new email provider configuration\n\n- Encrypts API key before storage\n- If set as default, removes default flag from other providers\n- Validates provider configuration","type":"text/plain"},"url":{"path":["api","v1","email-providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"api_key\": \"SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"config\": {\n \"from_email\": \"marketing@example.com\",\n \"from_name\": \"Example Company\"\n },\n \"is_active\": true,\n \"is_default\": true,\n \"name\": \"Marketing Emails\",\n \"provider_type\": \"sendgrid\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b5384ff1-6687-4982-9881-b87d7957c260","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"api_key\": \"SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"config\": {\n \"from_email\": \"marketing@example.com\",\n \"from_name\": \"Example Company\"\n },\n \"is_active\": true,\n \"is_default\": true,\n \"name\": \"Marketing Emails\",\n \"provider_type\": \"sendgrid\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"provider_type\": \"sendgrid_managed\",\n \"name\": \"string\",\n \"api_key_preview\": \"string\",\n \"is_active\": false,\n \"is_default\": true,\n \"created_at\": \"2024-10-07T19:05:31.006Z\",\n \"updated_at\": \"2014-04-17T14:17:04.579Z\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_status\": {\n \"key_0\": 6076\n },\n \"webhook_configured\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d242ec5e-4bb9-450e-90a9-533099a470f5","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"api_key\": \"SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"config\": {\n \"from_email\": \"marketing@example.com\",\n \"from_name\": \"Example Company\"\n },\n \"is_active\": true,\n \"is_default\": true,\n \"name\": \"Marketing Emails\",\n \"provider_type\": \"sendgrid\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a9deb9b4-3d68-4ab8-a8fd-8927f60b4217","name":"List Archived Providers","request":{"name":"List Archived Providers","description":{"content":"List all archived email provider configurations for the tenant (admin/audit)\n\nReturns archived providers with metadata but without sensitive credentials.\nUseful for audit trails and reviewing historical configurations.\n\n**Required Scopes:** `settings:read`","type":"text/plain"},"url":{"path":["api","v1","email-providers","archived"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"602daa86-f1aa-48db-8200-e7dd1d9543e4","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers","archived"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"provider_type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"is_default\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"config\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"webhook_configured\": {\n \"value\": \"\"\n },\n \"archived_at\": {\n \"value\": \"\"\n },\n \"archived_by_user_id\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"tenant_id\": {\n \"value\": \"\"\n },\n \"provider_type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"is_active\": {\n \"value\": \"\"\n },\n \"is_default\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"config\": {\n \"value\": \"\"\n },\n \"verified_domains\": {\n \"value\": \"\"\n },\n \"webhook_configured\": {\n \"value\": \"\"\n },\n \"archived_at\": {\n \"value\": \"\"\n },\n \"archived_by_user_id\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e9415845-8dc4-4753-a63a-93af3191662e","name":"Get Provider","request":{"name":"Get Provider","description":{"content":"Get a specific email provider configuration (excludes archived)\n\n**🔐 Required Scopes:** `settings:read`\n","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"318b0d29-1e2a-4554-81b6-7f604d3dab73","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"provider_type\": \"sendgrid_managed\",\n \"name\": \"string\",\n \"api_key_preview\": \"string\",\n \"is_active\": false,\n \"is_default\": true,\n \"created_at\": \"2024-10-07T19:05:31.006Z\",\n \"updated_at\": \"2014-04-17T14:17:04.579Z\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_status\": {\n \"key_0\": 6076\n },\n \"webhook_configured\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a6a3d55-aa1c-4c9b-99ff-e98f26083e31","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f1bcddea-923c-4619-bd4c-29aa2ca54870","name":"Update Provider","request":{"name":"Update Provider","description":{"content":"Update email provider configuration\n\n- Can update name, API key, config, active status, default status\n- If setting as default, removes default flag from other providers\n\n**🔐 Required Scopes:** `settings:update`\n","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"api_key\": \"string\",\n \"config\": {\n \"key_0\": 8896,\n \"key_1\": false,\n \"key_2\": 959\n },\n \"is_active\": true,\n \"is_default\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"05f91fb8-3344-42dc-8628-162e3bc1dd46","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"api_key\": \"string\",\n \"config\": {\n \"key_0\": 8896,\n \"key_1\": false,\n \"key_2\": 959\n },\n \"is_active\": true,\n \"is_default\": 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 \"provider_type\": \"sendgrid_managed\",\n \"name\": \"string\",\n \"api_key_preview\": \"string\",\n \"is_active\": false,\n \"is_default\": true,\n \"created_at\": \"2024-10-07T19:05:31.006Z\",\n \"updated_at\": \"2014-04-17T14:17:04.579Z\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_status\": {\n \"key_0\": 6076\n },\n \"webhook_configured\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9fb60330-baf6-4d6f-9c7a-d6081c161e2d","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"api_key\": \"string\",\n \"config\": {\n \"key_0\": 8896,\n \"key_1\": false,\n \"key_2\": 959\n },\n \"is_active\": true,\n \"is_default\": 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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5c6d6776-f080-4e82-8b5b-cf16641c6c0e","name":"Delete Provider","request":{"name":"Delete Provider","description":{"content":"Archive (soft-delete) email provider configuration\n\n- Archives the provider instead of hard deleting for audit trail\n- Clears sensitive credentials (API keys) while preserving metadata\n- If this was the default provider, unsets the default flag\n\n**Required Scopes:** `settings:update`","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"02c11dd0-d161-4548-9ad3-27f75e282ec3","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": false,\n \"message\": \"string\",\n \"id\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"29713156-608e-4aa8-afb5-2dbe5ae40c88","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bfae9c50-6ece-43ab-9877-2dda8a5a7a12","name":"Test Provider","request":{"name":"Test Provider","description":{"content":"Send a test email to verify provider configuration\n\n- Validates API credentials by actually sending an email\n- Returns success/failure status and provider message ID","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"body\": \"This is a test email.\",\n \"subject\": \"Test Email\",\n \"to_email\": \"test@example.com\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6122da47-4913-4d2b-98df-9074b7888d00","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"body\": \"This is a test email.\",\n \"subject\": \"Test Email\",\n \"to_email\": \"test@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Test email sent successfully\",\n \"provider_message_id\": \"msg-abc123\",\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0dc4d44a-197e-4100-b682-466a2883f291","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"body\": \"This is a test email.\",\n \"subject\": \"Test Email\",\n \"to_email\": \"test@example.com\"\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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a2718d3d-0030-47bb-850a-8e8477b3c009","name":"Set Default Provider","request":{"name":"Set Default Provider","description":{"content":"Set a provider as the default for the tenant\n\n- Removes default flag from all other providers\n- Sets this provider as default\n\n**🔐 Required Scopes:** `settings:update`\n","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id","set-default"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH"},"response":[{"id":"ec2b382d-0a1f-4946-9bd0-366d8f61ee28","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","set-default"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"string\",\n \"tenant_id\": \"string\",\n \"provider_type\": \"sendgrid_managed\",\n \"name\": \"string\",\n \"api_key_preview\": \"string\",\n \"is_active\": false,\n \"is_default\": true,\n \"created_at\": \"2024-10-07T19:05:31.006Z\",\n \"updated_at\": \"2014-04-17T14:17:04.579Z\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_status\": {\n \"key_0\": 6076\n },\n \"webhook_configured\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"72a7104a-836e-4f92-90a0-42ad3e84df01","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","set-default"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"detail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"87e07614-c744-4b9f-a197-4a4a0700b94c","name":"Configure Webhooks","request":{"name":"Configure Webhooks","description":{"content":"Auto-configure SendGrid event webhooks via API\n\n- Sets up event webhook URL with tenant_id and config_id parameters\n- Enables all event types (delivered, open, click, bounce, spam_report, etc.)\n- Only works for SendGrid providers\n\nReturns:\n - success: bool\n - webhook_url: configured webhook URL\n - message: status message\n - current_settings: current webhook configuration (if successful)","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id","configure-webhooks"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"c8652595-3dc0-44cb-8a9b-0dceb0e29497","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","configure-webhooks"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"current_settings\": {\n \"enabled\": true,\n \"url\": \"https://api.example.com/webhooks/sendgrid/email\"\n },\n \"message\": \"SendGrid event webhooks configured successfully\",\n \"success\": true,\n \"webhook_url\": \"https://api.example.com/webhooks/sendgrid/email?tenant_id=xxx&config_id=yyy\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"10e367cf-97c4-4367-81b4-4767f288839a","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","configure-webhooks"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"522a37ed-ff35-4823-bac9-e01f94fe20f0","name":"Refresh Verified Domains","request":{"name":"Refresh Verified Domains","description":{"content":"Refresh the list of verified domains from the provider API.\n\nFetches current verified domains and updates provider config.\nSupports SendGrid and Mailgun. For Mailgun a domain-scoped SENDING key\n401s on /v3/domains and the live list cannot be read — in that case the\nstored verified_domains degrades to the manually-configured domain.","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id","refresh-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"},"response":[{"id":"a11543f6-8d45-4454-a112-07e4e007022a","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","refresh-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"domain_count\": 2,\n \"success\": true,\n \"updated_at\": \"2024-01-15T10:30:00Z\",\n \"verified_domains\": [\n \"example.com\",\n \"mail.example.com\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e7e5e5a0-0cfc-474b-909e-6aeb7c41adec","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","refresh-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f3f16ee7-53b7-4ddd-9f8d-577177544e1c","name":"Get Webhook Settings","request":{"name":"Get Webhook Settings","description":{"content":"Get current SendGrid webhook settings for a provider\n\nOnly works for SendGrid providers.\n\n**🔐 Required Scopes:** `settings:read`\n","type":"text/plain"},"url":{"path":["api","v1","email-providers",":provider_id","webhook-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"a2a42e9b-37de-43c3-90b6-470b30833bbe","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","webhook-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"expected_webhook_url\": \"https://api.example.com/api/v1/webhooks/sendgrid/email?tenant_id=xxx&config_id=yyy\",\n \"settings\": {\n \"bounce\": true,\n \"click\": true,\n \"delivered\": true,\n \"enabled\": true,\n \"open\": true,\n \"url\": \"https://api.example.com/webhooks/sendgrid/email\"\n },\n \"success\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c63bfce-579c-4232-a38c-f85330d4efa9","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-providers",":provider_id","webhook-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"provider_id","description":"(Required) "}]},"header":[{"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"25fe8dbb-a65e-484e-9753-c50cf52cb2a1","name":"Email Settings","description":{"content":"Configure email-specific settings including sender defaults, reply-to addresses, and footer preferences.","type":"text/plain"},"item":[{"id":"2eb378c4-88f7-403f-a804-1082f0980a2c","name":"Get Email Settings","request":{"name":"Get Email Settings","description":{"content":"Get tenant email settings.\n\nReturns configured settings or defaults if not yet configured.\n\n**Database:** PRIMARY (tenants table), SHARD (email_provider_configs)\n\n**🔐 Required Scopes:** `settings:read`\n","type":"text/plain"},"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"},"response":[{"id":"8944679d-fb31-4ef3-898d-0dd8ebbd4e62","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"default_from_name\": \"string\",\n \"default_from_email\": \"8802ZZR7J4tuhF@JfGPoCMjJuGVSPAyZHulJax.glnh\",\n \"default_reply_to\": \"nShvtNJuBkd9@JTGMkURXxO.njg\",\n \"double_opt_in_enabled\": true,\n \"default_double_opt_in_template_id\": \"string\",\n \"compliance_footer_html\": \"string\",\n \"footer_mode\": \"both\",\n \"unsubscribe_link_format\": \"\",\n \"has_email_provider\": false,\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4819477d-635d-46c7-bc33-66c1e2048f05","name":"Reset Email Settings","request":{"name":"Reset Email Settings","description":{"content":"Reset email settings to defaults (clears all custom settings).\n\n**Database:** PRIMARY (tenants table)\n\n**🔐 Required Scopes:** `settings:admin`\n","type":"text/plain"},"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"},"response":[{"id":"bc6e84e6-4dd4-4e9b-93e9-d2f790024342","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Email settings reset to defaults\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c29cac08-39d1-4ca7-8e86-faf9f88352f4","name":"Update Email Settings","request":{"name":"Update Email Settings","description":{"content":"Update tenant email settings (partial update).\n\nOnly updates provided fields. Unspecified fields remain unchanged.\n\n**Database:** PRIMARY (tenants table)\n\n**Example:**\n```json\n{\n \"default_from_name\": \"ACME Corp\",\n \"default_from_email\": \"hello@acme.com\",\n \"double_opt_in_enabled\": true\n}\n```\n\n**🔐 Required Scopes:** `settings:update`\n","type":"text/plain"},"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"default_from_name\": \"string\",\n \"default_from_email\": \"F223-6mvEtRuWb@NlTFcutOC.fy\",\n \"default_reply_to\": \"JXf1R@iFuN.hr\",\n \"double_opt_in_enabled\": true,\n \"default_double_opt_in_template_id\": \"string\",\n \"compliance_footer_html\": \"string\",\n \"footer_mode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"92e0b5b6-c5eb-4784-b4f1-9a70e3c70a4e","name":"Successful Response","originalRequest":{"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"default_from_name\": \"string\",\n \"default_from_email\": \"F223-6mvEtRuWb@NlTFcutOC.fy\",\n \"default_reply_to\": \"JXf1R@iFuN.hr\",\n \"double_opt_in_enabled\": true,\n \"default_double_opt_in_template_id\": \"string\",\n \"compliance_footer_html\": \"string\",\n \"footer_mode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"default_from_name\": \"string\",\n \"default_from_email\": \"8802ZZR7J4tuhF@JfGPoCMjJuGVSPAyZHulJax.glnh\",\n \"default_reply_to\": \"nShvtNJuBkd9@JTGMkURXxO.njg\",\n \"double_opt_in_enabled\": true,\n \"default_double_opt_in_template_id\": \"string\",\n \"compliance_footer_html\": \"string\",\n \"footer_mode\": \"both\",\n \"unsubscribe_link_format\": \"\",\n \"has_email_provider\": false,\n \"verified_domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e7a345fa-4a9e-4ec5-9c29-87d597672eb4","name":"Validation Error","originalRequest":{"url":{"path":["api","v1","email-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"default_from_name\": \"string\",\n \"default_from_email\": \"F223-6mvEtRuWb@NlTFcutOC.fy\",\n \"default_reply_to\": \"JXf1R@iFuN.hr\",\n \"double_opt_in_enabled\": true,\n \"default_double_opt_in_template_id\": \"string\",\n \"compliance_footer_html\": \"string\",\n \"footer_mode\": \"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 \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2d219245-a038-49b2-8443-444679016bb8","name":"Validate Compliance Footer","request":{"name":"Validate Compliance Footer","description":{"content":"Validate compliance footer HTML without saving\n\nUse this endpoint to preview validation results in the template builder.\n\n**Request Body:**\n```json\n{\n \"html\": \"

Footer HTML with {{unsubscribe_link}} and {{company.address}}

\"\n}\n```\n\n**Response:**\n```json\n{\n \"is_valid\": true,\n \"errors\": [],\n \"warnings\": [\"Removed