{"info":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","description":"<html><head></head><body><p>The JediDesk API provides programmatic access to the core features of the JediDesk platform. It allows you to work with customers, teams, chats, messages, AI, orders, goods, webhooks and UTM campaigns. Use Bearer zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token) for authenticated /api/v1 requests.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8460280","collectionId":"b735d3ed-5fca-4b3d-8444-297321200d93","publishedId":"2sAYkLoJ2S","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"438df6"},"publishDate":"2026-10-14T10:52:00.000Z"},"item":[{"name":"analytics","item":[{"name":"productivity","id":"6a62437d-d9fe-db0f-bc24-bcba87c80626","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/analytics/productivity?date_from=2026-07-01&date_to=2026-07-23&manager_id=42","description":"<p>Return support productivity analytics for the authenticated company.</p>\n<p>Use this endpoint to get conversation volume and median handling timings for a selected period. The response contains an overall <code>summary</code> and daily <code>series</code> rows.</p>\n<p>Metrics:</p>\n<ul>\n<li><code>conversations_total</code>: conversations opened or closed during the period.</li>\n<li><code>conversations_new</code>: conversations opened during the period.</li>\n<li><code>conversations_closed</code>: conversations closed during the period.</li>\n<li><code>first_response_median_seconds</code>: median time to first manager response.</li>\n<li><code>close_time_median_seconds</code>: median time to close a conversation.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","analytics","productivity"],"host":["app.jedidesk.com"],"query":[{"description":{"content":"<p>Start date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"<p>End date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"},{"description":{"content":"<p>Optional manager filter. Omit to return company-wide data.</p>\n","type":"text/plain"},"key":"manager_id","value":"42"}],"variable":[]}},"response":[{"id":"f98eb0e9-76db-1e8f-122e-f75150dff8b3","name":"200 productivity analytics","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}],"url":{"raw":"https://app.jedidesk.com/api/v1/analytics/productivity?date_from=2026-07-01&date_to=2026-07-23&manager_id={{manager_id}}","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","productivity"],"query":[{"key":"date_from","value":"2026-07-01"},{"key":"date_to","value":"2026-07-23"},{"key":"manager_id","value":"{{manager_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"meta\": {\n    \"date_from\": \"2026-07-01 00:00:00\",\n    \"date_to\": \"2026-07-23 23:59:59\",\n    \"manager_id\": \"42\"\n  },\n  \"summary\": {\n    \"conversations_total\": 128,\n    \"conversations_new\": 76,\n    \"conversations_closed\": 52,\n    \"first_response_median_seconds\": 180,\n    \"close_time_median_seconds\": 3600\n  },\n  \"series\": [\n    {\n      \"date\": \"2026-07-01\",\n      \"conversations_total\": 8,\n      \"conversations_new\": 5,\n      \"conversations_closed\": 3,\n      \"first_response_median_seconds\": 160,\n      \"close_time_median_seconds\": 3400\n    }\n  ]\n}"}],"_postman_id":"6a62437d-d9fe-db0f-bc24-bcba87c80626"},{"name":"quality","id":"4443adde-57e5-6ac6-ad87-fbff8c727032","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/analytics/quality?date_from=2026-07-01&date_to=2026-07-23&manager_id=42&page=1&per_page=20","description":"<p>Return support quality analytics for the authenticated company.</p>\n<p>Use this endpoint to get quality ratings for closed conversations in a selected period. The response contains an overall <code>summary</code>, daily <code>series</code>, and paginated rated conversation <code>items</code>.</p>\n<p>Ratings are returned as <code>bad_count</code>, <code>middle_count</code>, and <code>perfect_count</code>. <code>quality_level_percent</code> is the percentage of perfect ratings among all rated conversations.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","analytics","quality"],"host":["app.jedidesk.com"],"query":[{"description":{"content":"<p>Start date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"<p>End date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"},{"description":{"content":"<p>Optional manager filter. Omit to return company-wide data.</p>\n","type":"text/plain"},"key":"manager_id","value":"42"},{"description":{"content":"<p>Page for rated conversation items.</p>\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"<p>Items per page for rated conversation items. Max 100.</p>\n","type":"text/plain"},"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"3a90a63d-a885-690c-6ba1-878626aeb43d","name":"200 quality analytics","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/analytics/quality?date_from=2026-07-01&date_to=2026-07-23&manager_id={{manager_id}}&page=1&per_page=20","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","quality"],"query":[{"key":"date_from","value":"2026-07-01"},{"key":"date_to","value":"2026-07-23"},{"key":"manager_id","value":"{{manager_id}}"},{"key":"page","value":"1"},{"key":"per_page","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"meta\": {\n    \"date_from\": \"2026-07-01 00:00:00\",\n    \"date_to\": \"2026-07-23 23:59:59\",\n    \"manager_id\": \"42\"\n  },\n  \"summary\": {\n    \"bad_count\": 4,\n    \"middle_count\": 9,\n    \"perfect_count\": 39,\n    \"closed_conversations_count\": 52,\n    \"quality_level_percent\": 75\n  },\n  \"series\": [\n    {\n      \"date\": \"2026-07-01\",\n      \"bad_count\": 0,\n      \"middle_count\": 1,\n      \"perfect_count\": 3,\n      \"closed_conversations_count\": 4,\n      \"quality_level_percent\": 75\n    }\n  ],\n  \"items\": {\n    \"data\": [\n      {\n        \"id\": 901,\n        \"conversation_id\": 120,\n        \"customer_name\": \"Example Customer\",\n        \"customer_image_url\": \"https://app.jedidesk.com/storage/customers/avatar.jpg\",\n        \"manager_name\": \"Example Manager\",\n        \"rating\": \"perfect\",\n        \"comment\": \"Fast and helpful answer\",\n        \"date\": \"2026-07-23 15:20:00\",\n        \"platform\": \"instagram\"\n      }\n    ],\n    \"page\": 1,\n    \"per_page\": 20,\n    \"last_page\": 3\n  }\n}"}],"_postman_id":"4443adde-57e5-6ac6-ad87-fbff8c727032"},{"name":"subjects","id":"2d370f18-18a8-95b0-88ac-412e93d44d34","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/analytics/subjects?date_from=2026-07-01&date_to=2026-07-23&manager_id=42","description":"<p>Return conversation subject analytics for the authenticated company.</p>\n<p>Use this endpoint to see which active subjects were assigned to conversations in a selected period. Each subject contains <code>count</code> and <code>percent</code> relative to total conversations in the same filtered period.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","analytics","subjects"],"host":["app.jedidesk.com"],"query":[{"description":{"content":"<p>Start date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"<p>End date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"},{"description":{"content":"<p>Optional manager filter. Omit to return company-wide data.</p>\n","type":"text/plain"},"key":"manager_id","value":"42"}],"variable":[]}},"response":[{"id":"2b55b039-a302-fe10-6825-668816f63c8b","name":"200 subject analytics","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/analytics/subjects?date_from=2026-07-01&date_to=2026-07-23&manager_id={{manager_id}}","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","subjects"],"query":[{"key":"date_from","value":"2026-07-01"},{"key":"date_to","value":"2026-07-23"},{"key":"manager_id","value":"{{manager_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"meta\": {\n    \"date_from\": \"2026-07-01 00:00:00\",\n    \"date_to\": \"2026-07-23 23:59:59\",\n    \"manager_id\": \"42\"\n  },\n  \"subjects\": [\n    {\n      \"id\": 12,\n      \"name\": \"Delivery\",\n      \"count\": 34,\n      \"percent\": 26.56\n    },\n    {\n      \"id\": 18,\n      \"name\": \"Payment\",\n      \"count\": 21,\n      \"percent\": 16.41\n    }\n  ]\n}"}],"_postman_id":"2d370f18-18a8-95b0-88ac-412e93d44d34"},{"name":"ai summary","id":"0e2829e9-a1d0-0b7e-f942-55befea6afc4","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/analytics/ai/summary?date_from=2026-07-01&date_to=2026-07-23","description":"<p>Return AI summary analytics for the authenticated company.</p>\n<p>Use this endpoint to measure how much AI participated in support answers and conversation closing for a selected period.</p>\n<p>Metrics:</p>\n<ul>\n<li><code>ai_answers_count</code>: manager messages generated with AI.</li>\n<li><code>ai_answer_request_percent</code>: percentage of manager messages that used AI.</li>\n<li><code>ai_closed_conversations_percent</code>: percentage of closed conversations handled only by AI messages without manual manager replies in the same period.</li>\n</ul>\n<p>Future <code>GET /api/v1/analytics/ai/usage</code> should stay separate from this summary endpoint. It should expose technical usage and billing metrics: AI request count, credits spent, prompt/completion/cached tokens, token units, breakdown by model/source/reason, daily series, and paginated usage logs with conversation_id, amount and balance_after. It should not expose raw prompts or AI responses.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","analytics","ai","summary"],"host":["app.jedidesk.com"],"query":[{"description":{"content":"<p>Start date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"<p>End date of the reporting period. Required.</p>\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"}],"variable":[]}},"response":[{"id":"4dd01ff3-9a76-7bb9-9443-a33e7ee6d33f","name":"200 ai summary analytics","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/analytics/ai/summary?date_from=2026-07-01&date_to=2026-07-23","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","ai","summary"],"query":[{"key":"date_from","value":"2026-07-01"},{"key":"date_to","value":"2026-07-23"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"meta\": {\n    \"date_from\": \"2026-07-01 00:00:00\",\n    \"date_to\": \"2026-07-23 23:59:59\",\n    \"manager_id\": null\n  },\n  \"summary\": {\n    \"ai_answers_count\": 418,\n    \"ai_answer_request_percent\": 36.25,\n    \"ai_closed_conversations_percent\": 18.5\n  }\n}"}],"_postman_id":"0e2829e9-a1d0-0b7e-f942-55befea6afc4"}],"id":"001436a4-b4ac-459d-9679-d0de674476a5","_postman_id":"001436a4-b4ac-459d-9679-d0de674476a5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"customers","item":[{"name":"custom fields","item":[{"name":"list","id":"33d0251d-a1b4-6f29-ac27-f718d40fbb41","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields?status=active","description":"<p>Return customer custom field definitions for the authenticated company.</p>\n<p>Use these field <code>id</code> values when setting customer custom field values in <code>customers/create</code> or <code>customers/edit</code> via <code>custom_fields: [{ \"id\": 103, \"value\": \"...\" }]</code>.</p>\n<p>Available field types: integer, string, phone, email, link. Use <code>status=active</code> to return only active fields.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customer-custom-fields"],"host":["app.jedidesk.com"],"query":[{"key":"status","value":"active"}],"variable":[]}},"response":[{"id":"d323bdac-b4e9-17f8-c22e-35effe9f2254","name":"200 customer custom fields list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/customer-custom-fields?status=active","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","customer-custom-fields"],"query":[{"key":"status","value":"active"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 103,\n      \"name\": \"Profile URL\",\n      \"type\": \"link\",\n      \"sort\": 10,\n      \"status\": \"active\",\n      \"data\": null,\n      \"created_at\": \"2026-07-23T00:14:00.000000Z\",\n      \"updated_at\": \"2026-07-23T00:14:00.000000Z\"\n    }\n  ]\n}"}],"_postman_id":"33d0251d-a1b4-6f29-ac27-f718d40fbb41"},{"name":"create","id":"70ad8679-24fd-e722-e9ca-6bdabe96ac8b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Profile URL\",\n  \"type\": \"link\",\n  \"sort\": 10,\n  \"status\": \"active\"\n}"},"url":"https://app.jedidesk.com/api/v1/customer-custom-fields","description":"<p>Create a customer custom field definition for the authenticated company.</p>\n<p>After the field is created, use its <code>id</code> in <code>customers/create</code> or <code>customers/edit</code> to set values for specific customers.</p>\n<p>Available field types: integer, string, phone, email, link.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customer-custom-fields"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"15cf5f6d-d7f4-6e1f-f87f-c6a490e3c57d","name":"200 customer custom field created","originalRequest":{"method":"POST","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"field\": {\n    \"id\": 103,\n    \"name\": \"Profile URL\",\n    \"type\": \"link\",\n    \"sort\": 10,\n    \"status\": \"active\",\n    \"data\": null,\n    \"created_at\": \"2026-07-23T00:14:00.000000Z\",\n    \"updated_at\": \"2026-07-23T00:14:00.000000Z\"\n  }\n}"}],"_postman_id":"70ad8679-24fd-e722-e9ca-6bdabe96ac8b"},{"name":"get","id":"8454ac3b-b292-a1d0-2441-e26641787c9a","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/103","description":"<p>Return one customer custom field definition by id.</p>\n<p>Use this to inspect field metadata before assigning values to customers.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customer-custom-fields","103"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"8134b43f-196d-fc64-1346-6efaa41a0190","name":"200 customer custom field details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"field\": {\n    \"id\": 103,\n    \"name\": \"Profile URL\",\n    \"type\": \"link\",\n    \"sort\": 10,\n    \"status\": \"active\",\n    \"data\": null,\n    \"created_at\": \"2026-07-23T00:14:00.000000Z\",\n    \"updated_at\": \"2026-07-23T00:14:00.000000Z\"\n  }\n}"}],"_postman_id":"8454ac3b-b292-a1d0-2441-e26641787c9a"},{"name":"edit","id":"4bf7245a-0b25-a89a-aec5-eb202d4a9189","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Customer profile URL\",\n  \"sort\": 20,\n  \"status\": \"active\"\n}"},"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/103","description":"<p>Edit a customer custom field definition by id.</p>\n<p>The payload is partial: send only fields that should change. Supported fields: <code>name</code>, <code>type</code>, <code>sort</code>, <code>status</code>, <code>data</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customer-custom-fields","103"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"02fc51bf-825b-0d43-b955-c567c6b5cb44","name":"200 customer custom field updated","originalRequest":{"method":"PUT","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"field\": {\n    \"id\": 103,\n    \"name\": \"Customer profile URL\",\n    \"type\": \"link\",\n    \"sort\": 20,\n    \"status\": \"active\",\n    \"data\": null,\n    \"created_at\": \"2026-07-23T00:14:00.000000Z\",\n    \"updated_at\": \"2026-07-23T00:16:00.000000Z\"\n  }\n}"}],"_postman_id":"4bf7245a-0b25-a89a-aec5-eb202d4a9189"},{"name":"delete","id":"942c398e-4a5d-9e09-c1f7-bb5e2be1e3c6","request":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/103","description":"<p>Delete a customer custom field definition by id.</p>\n<p>Deleting a field also removes customer values linked to this field because linked values reference the field with cascade delete.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customer-custom-fields","103"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"ea430846-b8ca-3fd9-a9de-9cb44cfd8bcd","name":"200 customer custom field deleted","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"message\": \"custom field deleted\"\n}"}],"_postman_id":"942c398e-4a5d-9e09-c1f7-bb5e2be1e3c6"}],"id":"b02a8b59-6bc4-4eb3-a91f-6f2fbe96ec1c","description":"<p>Customer custom fields are field definitions configured for a company. Use this folder to create and manage the available fields, then use their <code>id</code> values in customer create/update payloads as <code>custom_fields: [{ \"id\": 103, \"value\": \"...\" }]</code>.</p>\n","_postman_id":"b02a8b59-6bc4-4eb3-a91f-6f2fbe96ec1c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"list","id":"09f4cce4-d63d-4689-971f-08a485f3d8eb","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customers?id={{customer_id}}&name=Example customer&username=example_customer&platform=telegram&platform_id={{customer_platform_id}}&phone={{customer_phone}}&email=customer@example.test&status=active&tag=example&search=Example customer&sort=-id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["app.jedidesk.com"],"query":[{"key":"id","value":"{{customer_id}}"},{"key":"name","value":"Example customer"},{"key":"username","value":"example_customer"},{"key":"platform","value":"telegram"},{"key":"platform_id","value":"{{customer_platform_id}}"},{"key":"phone","value":"{{customer_phone}}"},{"key":"email","value":"customer@example.test"},{"key":"status","value":"active"},{"key":"tag","value":"example"},{"key":"search","value":"Example customer"},{"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"21c30d2c-66ac-962a-940b-0a4fa71da122","name":"200 customers list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/customers?page=1","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","customers"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"chat_id\": 1,\n      \"name\": \"Example\",\n      \"username\": \"[redacted]\",\n      \"phone\": \"[redacted]\",\n      \"email\": \"[redacted]\",\n      \"platform\": \"telegram\",\n      \"platform_id\": \"[redacted]\",\n      \"integration\": {\n        \"id\": 1,\n        \"platform\": \"telegram\",\n        \"external_id\": \"[redacted]\",\n        \"name\": \"Example\",\n        \"username\": \"[redacted]\"\n      },\n      \"status\": \"active\",\n      \"tags\": [\n        \"VIP\"\n      ],\n      \"custom_fields\": [\n        {\n          \"field_id\": 1,\n          \"field_name\": \"Example\",\n          \"value\": \"https://example.com/profile\"\n        }\n      ]\n    }\n  ],\n  \"links\": {\n    \"first\": \"https://app.jedidesk.com/api/v1/customers?page=1\",\n    \"last\": \"https://app.jedidesk.com/api/v1/customers?page=1\",\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"from\": 1,\n    \"last_page\": 1,\n    \"per_page\": 20,\n    \"to\": 1,\n    \"total\": 1\n  }\n}"}],"_postman_id":"09f4cce4-d63d-4689-971f-08a485f3d8eb"},{"name":"get","id":"4d41dbc0-ace0-4d09-b78b-6a6de157dc8a","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customers/215","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers","215"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"1ff95d3b-e17e-0b5f-80f0-143f6d23e12e","name":"200 customer details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customers/{{customer_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1,\n    \"chat_id\": 1,\n    \"name\": \"Example\",\n    \"username\": \"[redacted]\",\n    \"phone\": \"[redacted]\",\n    \"email\": \"[redacted]\",\n    \"platform\": \"telegram\",\n    \"platform_id\": \"[redacted]\",\n    \"integration\": {\n      \"id\": 1,\n      \"platform\": \"telegram\",\n      \"external_id\": \"[redacted]\",\n      \"name\": \"Example\",\n      \"username\": \"[redacted]\"\n    },\n    \"status\": \"active\",\n    \"tags\": [\n      \"VIP\",\n      \"Lead\"\n    ],\n    \"custom_fields\": [\n      {\n        \"field_id\": 1,\n        \"field_name\": \"Example\",\n        \"value\": \"https://example.com/profile\"\n      }\n    ]\n  }\n}"}],"_postman_id":"4d41dbc0-ace0-4d09-b78b-6a6de157dc8a"},{"name":"edit","id":"2ee9eab7-591d-4f1b-9fdc-2c9ebb045c80","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Example customer\",\n  \"username\": \"example_customer\",\n  \"phone\": \"{{customer_phone}}\",\n  \"email\": \"customer@example.test\",\n  \"note\": \"Example note\",\n  \"language\": \"uk\",\n  \"ip\": \"192.0.2.1\",\n  \"location\": \"Example location\",\n  \"href\": \"https://example.com\",\n  \"tags\": [\n    \"example\"\n  ],\n  \"custom_fields\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/customers/531765","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers","531765"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ee9eab7-591d-4f1b-9fdc-2c9ebb045c80"},{"name":"create","id":"09a08765-4f46-03b3-38ca-91378e3dbe38","request":{"method":"POST","header":[{"description":"<p>JSON request body.</p>\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"bot_id\": \"{{bot_id}}\",\n  \"platform_id\": \"{{customer_platform_id}}\",\n  \"name\": \"Example customer\",\n  \"username\": \"example_customer\",\n  \"phone\": \"{{customer_phone}}\",\n  \"email\": \"customer@example.test\",\n  \"status\": \"active\",\n  \"language\": \"uk\",\n  \"note\": \"Example note\",\n  \"tags\": [\n    \"example\"\n  ],\n  \"custom_fields\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/customers","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"09a08765-4f46-03b3-38ca-91378e3dbe38"},{"name":"Create API-source customer","id":"a0bafb9b-f871-0706-6625-22997596f2a4","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"platform_id\": \"qa-api-26558436-5cde-4672-9fee-7eb969cdcbf3\",\n  \"name\": \"QA API dialog\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/customers","description":"<p>Create a customer for an AI test using <code>platform_id</code> and <code>name</code>. Omit <code>bot_id</code> to use the company's API traffic source.</p>\n<p>Save the returned customer ID as <code>customer_id</code>, then create a conversation in <strong>chats → Create real conversation</strong>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"99d0df56-8ce5-7a1e-ccec-45c800bbb57b","name":"200 Create API-source customer — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"platform_id\":\"qa-doc-1791966010\",\"name\":\"Documentation QA\"}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"customer\": {\n    \"id\": 2559,\n    \"chat_id\": null,\n    \"name\": \"Documentation QA\",\n    \"username\": null,\n    \"phone\": \"[redacted]\",\n    \"email\": \"[redacted]\",\n    \"img\": \"127.0.0.1/img/bot-black.png\",\n    \"platform\": \"api\",\n    \"platform_id\": \"qa-doc-1791966010\",\n    \"integration\": {\n      \"id\": 190,\n      \"platform\": \"api\",\n      \"external_id\": null,\n      \"name\": \"API\",\n      \"username\": null\n    },\n    \"is_allow_ai\": false,\n    \"is_subscriber\": true,\n    \"condition\": null,\n    \"note\": null,\n    \"language\": \"uk\",\n    \"ip\": null,\n    \"location\": null,\n    \"href\": null,\n    \"status\": \"active\",\n    \"tags\": [],\n    \"custom_fields\": [],\n    \"created_at\": \"2026-10-14T08:20:10.000000Z\"\n  }\n}"}],"_postman_id":"a0bafb9b-f871-0706-6625-22997596f2a4"}],"id":"5a04cbb4-6d2d-483c-a1f2-fa89c0264720","description":"<p>Customers are contacts/users inside JediDesk. A customer belongs to a company and a connected integration, stores external platform identity, contact data, tags and custom fields, and is used as the base entity for chats, messages, UTM tracking and outgoing-dialog flows.</p>\n","_postman_id":"5a04cbb4-6d2d-483c-a1f2-fa89c0264720","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"teams","item":[{"name":"list","id":"6e467b90-6764-8c55-44d5-8314562c3bb1","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/teams","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","teams"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e467b90-6764-8c55-44d5-8314562c3bb1"}],"id":"5b8f7764-82ec-4fa8-851c-8c8b1d705dc3","description":"<p>Teams are groups of company managers. They are used for routing, ownership and reassignment of chats, and can be used by external systems to send a dialog to the right support or sales team.</p>\n","_postman_id":"5b8f7764-82ec-4fa8-851c-8c8b1d705dc3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"chats","item":[{"name":"list","id":"07ae2bc7-f994-4ef8-9145-8eb4520f7bd4","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats?customer_id=215&status=open&platform=instagram&team_id=4&sort=-id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats"],"host":["app.jedidesk.com"],"query":[{"key":"customer_id","value":"215"},{"key":"status","value":"open"},{"key":"platform","value":"instagram"},{"key":"team_id","value":"4"},{"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"d6745510-c42c-c0fd-9af3-1ca4a0f026c1","name":"200 chats list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/chats?customer_id={{customer_id}}&status=open","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","chats"],"query":[{"key":"customer_id","value":"{{customer_id}}"},{"key":"status","value":"open"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"customer\": {\n        \"id\": 1,\n        \"name\": \"Example\",\n        \"platform\": \"telegram\",\n        \"platform_id\": \"[redacted]\"\n      },\n      \"integration\": {\n        \"id\": 1,\n        \"platform\": \"telegram\",\n        \"external_id\": \"[redacted]\",\n        \"name\": \"Example\",\n        \"username\": \"[redacted]\"\n      },\n      \"manager\": {\n        \"id\": 1,\n        \"name\": \"Example\"\n      },\n      \"team\": {\n        \"id\": 1,\n        \"name\": \"Example\"\n      },\n      \"status\": \"open\",\n      \"is_read\": true,\n      \"is_allow_ai\": false,\n      \"created_at\": \"2026-07-22T23:30:00.000000Z\",\n      \"updated_at\": \"2026-07-22T23:59:00.000000Z\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"https://app.jedidesk.com/api/v1/chats?page=1\",\n    \"last\": \"https://app.jedidesk.com/api/v1/chats?page=1\",\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"last_page\": 1,\n    \"per_page\": 20,\n    \"total\": 1\n  }\n}"}],"_postman_id":"07ae2bc7-f994-4ef8-9145-8eb4520f7bd4"},{"name":"get","id":"5020e1b9-cf82-4869-ab03-82b8e6344ec6","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats/120","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","120"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"7da0da35-8afd-d821-ffca-ccd73d0a0e09","name":"200 chat details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats/{{chat_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1,\n    \"customer\": {\n      \"id\": 1,\n      \"name\": \"Example\",\n      \"platform_id\": \"[redacted]\"\n    },\n    \"integration\": {\n      \"id\": 1,\n      \"platform\": \"telegram\",\n      \"external_id\": \"[redacted]\",\n      \"name\": \"Example\",\n      \"username\": \"[redacted]\"\n    },\n    \"status\": \"open\",\n    \"team\": {\n      \"id\": 1,\n      \"name\": \"Example\"\n    }\n  }\n}"}],"_postman_id":"5020e1b9-cf82-4869-ab03-82b8e6344ec6"},{"name":"create","id":"86df49d0-e51d-4cde-a9c6-e51f342b1841","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"customer_id\": 215,\n  \"text\": \"New chat from API\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/chats","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"86df49d0-e51d-4cde-a9c6-e51f342b1841"},{"name":"start message","id":"5a391238-dd98-8b77-272d-053d7e75f97a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"<p>JSON request body.</p>\n"}],"body":{"mode":"raw","raw":"{\n  \"bot_id\": \"{{bot_id}}\",\n  \"phone\": \"{{customer_phone}}\",\n  \"username\": \"example_customer\",\n  \"name\": \"Example customer\",\n  \"text\": \"Example message\",\n  \"media\": null,\n  \"type\": \"message\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/chats/start-message","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","start-message"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"0d5bd253-2381-b5d8-08b2-6a3afa2f349c","name":"200 first outgoing message sent","originalRequest":{"method":"POST","header":[],"url":"https://app.jedidesk.com/api/v1/chats/start-message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1,\n    \"chat_id\": 1,\n    \"from\": \"manager\",\n    \"type\": \"message\",\n    \"text\": \"Hello from JediDesk\",\n    \"platform_id\": \"[redacted]\",\n    \"additional_info\": {\n      \"echat_response\": {\n        \"status\": \"Success\",\n        \"description\": \"[redacted]\"\n      }\n    },\n    \"status\": \"send\"\n  },\n  \"chat_id\": 1\n}"}],"_postman_id":"5a391238-dd98-8b77-272d-053d7e75f97a"},{"name":"change team","id":"7994c435-8f25-8581-54eb-e0fbc4660abb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"team_id\": 4\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/chats/120/team","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","120","team"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7994c435-8f25-8581-54eb-e0fbc4660abb"},{"name":"start message bots","id":"48357241-7bfb-605b-e456-45e4fdb7930b","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats/start-message/bots","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","start-message","bots"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"f75917a2-b964-21ad-fc88-0d86ab97f1c7","name":"200 start-message bots","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats/start-message/bots"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"platform\": \"telegram\",\n      \"external_id\": null,\n      \"name\": \"Example\",\n      \"username\": \"[redacted]\"\n    }\n  ]\n}"}],"_postman_id":"48357241-7bfb-605b-e456-45e4fdb7930b"},{"name":"Create real conversation","id":"f40c2fc5-16d5-705e-5397-38fbd6764a38","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/chats","description":"<p>Create a real dialog with <code>customer_id</code>. Save the returned dialog ID as <code>chat_id</code>, then send a customer message.</p>\n<p>The dialog appears in manager history. Normal AI settings, tariff, balance and function side effects apply; use a test account.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"9f20a28b-9bfe-a542-a2bf-7d1f697fd9ae","name":"200 Create real conversation — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"customer_id\":2560}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/chats"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1383,\n    \"customer\": {\n      \"id\": 2560,\n      \"name\": \"Documentation QA\",\n      \"username\": null,\n      \"phone\": \"[redacted]\",\n      \"platform\": \"api\",\n      \"platform_id\": \"qa-doc-1791966318\",\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      }\n    },\n    \"integration\": {\n      \"id\": 190,\n      \"platform\": \"api\",\n      \"external_id\": null,\n      \"name\": \"API\",\n      \"username\": null\n    },\n    \"manager\": null,\n    \"team\": null,\n    \"link\": \"127.0.0.1/chat/?f-i=1383\",\n    \"is_read\": false,\n    \"is_allow_ai\": true,\n    \"close_at\": null,\n    \"status\": \"new\",\n    \"created_at\": \"2026-10-14 11:25:18\"\n  }\n}"}],"_postman_id":"f40c2fc5-16d5-705e-5397-38fbd6764a38"},{"name":"Read conversation","id":"24cffd7b-7097-c8b1-5cbb-ddeb00585983","request":{"method":"GET","header":[{"value":"application/json","key":"Accept"}],"url":"https://app.jedidesk.com/api/v1/chats/{{chat_id}}","description":"<p>Return the real dialog identified by <code>{{chat_id}}</code> and its current state.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","{{chat_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"6f59a0c7-0f95-101c-336a-beadfcea2ba2","name":"200 Read conversation — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats/1382"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1382,\n    \"customer\": {\n      \"id\": 2558,\n      \"name\": \"QA API — webhook інтеграція\",\n      \"username\": null,\n      \"phone\": \"[redacted]\",\n      \"platform\": \"api\",\n      \"platform_id\": \"qa-webhook-1791910990\",\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      }\n    },\n    \"integration\": {\n      \"id\": 190,\n      \"platform\": \"api\",\n      \"external_id\": null,\n      \"name\": \"API\",\n      \"username\": null\n    },\n    \"manager\": null,\n    \"team\": null,\n    \"link\": \"127.0.0.1/chat/?f-i=1382\",\n    \"is_read\": true,\n    \"is_allow_ai\": true,\n    \"close_at\": null,\n    \"status\": \"new\",\n    \"created_at\": \"2026-10-13 20:03:10\"\n  }\n}"}],"_postman_id":"24cffd7b-7097-c8b1-5cbb-ddeb00585983"},{"name":"Read conversation history","id":"f60f5282-b87e-92d8-04e3-7ee5418f3a6c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.jedidesk.com/api/v1/chats/{{chat_id}}/messages?limit=20","description":"<p>Return saved messages for <code>{{chat_id}}</code>. Poll this endpoint after sending a customer message to inspect the AI reply. The same history is visible to managers.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","{{chat_id}}","messages"],"host":["app.jedidesk.com"],"query":[{"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"e9f3559e-b0ba-eaf9-66dd-74b7d8c810fa","name":"200 Read conversation history — local QA","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/chats/1382/messages?limit=20","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","chats","1382","messages"],"query":[{"key":"limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"id\": 17380,\n      \"chat_id\": 1382,\n      \"customer\": {\n        \"id\": 2558,\n        \"name\": \"QA API — webhook інтеграція\",\n        \"username\": null,\n        \"phone\": \"[redacted]\",\n        \"platform\": \"api\",\n        \"platform_id\": \"qa-webhook-1791910990\",\n        \"integration\": {\n          \"id\": 190,\n          \"platform\": \"api\",\n          \"external_id\": null,\n          \"name\": \"API\",\n          \"username\": null\n        }\n      },\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      },\n      \"manager\": null,\n      \"is_ai\": true,\n      \"is_read\": true,\n      \"is_system\": false,\n      \"is_show_customer\": true,\n      \"from\": \"manager\",\n      \"type\": \"message\",\n      \"text\": \"<p>Фактична помилка при перевірці webhook: <strong>QA_WEBHOOK_FAILURE</strong>.</p>\\n\",\n      \"media\": null,\n      \"platform_id\": null,\n      \"reply_to_message_id\": null,\n      \"additional_info\": null,\n      \"schedule_at\": null,\n      \"status\": \"active\",\n      \"created_at\": \"2026-10-13 20:04:54\"\n    },\n    {\n      \"id\": 17379,\n      \"chat_id\": 1382,\n      \"customer\": {\n        \"id\": 2558,\n        \"name\": \"QA API — webhook інтеграція\",\n        \"username\": null,\n        \"phone\": \"[redacted]\",\n        \"platform\": \"api\",\n        \"platform_id\": \"qa-webhook-1791910990\",\n        \"integration\": {\n          \"id\": 190,\n          \"platform\": \"api\",\n          \"external_id\": null,\n          \"name\": \"API\",\n          \"username\": null\n        }\n      },\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      },\n      \"manager\": null,\n      \"is_ai\": false,\n      \"is_read\": true,\n      \"is_system\": false,\n      \"is_show_customer\": true,\n      \"from\": \"customer\",\n      \"type\": \"message\",\n      \"text\": \"Перевір помилку webhook: виклич qa_api_webhook рівно один раз з marker=WEBHOOK-FAIL. Не повторюй виклик; повідом фактичну помилку.\",\n      \"media\": null,\n      \"platform_id\": null,\n      \"reply_to_message_id\": null,\n      \"additional_info\": null,\n      \"schedule_at\": null,\n      \"status\": \"active\",\n      \"created_at\": \"2026-10-13 20:04:50\"\n    },\n    {\n      \"id\": 17378,\n      \"chat_id\": 1382,\n      \"customer\": {\n        \"id\": 2558,\n        \"name\": \"QA API — webhook інтеграція\",\n        \"username\": null,\n        \"phone\": \"[redacted]\",\n        \"platform\": \"api\",\n        \"platform_id\": \"qa-webhook-1791910990\",\n        \"integration\": {\n          \"id\": 190,\n          \"platform\": \"api\",\n          \"external_id\": null,\n          \"name\": \"API\",\n          \"username\": null\n        }\n      },\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      },\n      \"manager\": null,\n      \"is_ai\": true,\n      \"is_read\": true,\n      \"is_system\": false,\n      \"is_show_customer\": true,\n      \"from\": \"manager\",\n      \"type\": \"message\",\n      \"text\": \"<p>Результат перевірки webhook: <strong>QA_WEBHOOK_OK</strong>.</p>\\n\",\n      \"media\": null,\n      \"platform_id\": null,\n      \"reply_to_message_id\": null,\n      \"additional_info\": null,\n      \"schedule_at\": null,\n      \"status\": \"active\",\n      \"created_at\": \"2026-10-13 20:03:16\"\n    },\n    {\n      \"id\": 17377,\n      \"chat_id\": 1382,\n      \"customer\": {\n        \"id\": 2558,\n        \"name\": \"QA API — webhook інтеграція\",\n        \"username\": null,\n        \"phone\": \"[redacted]\",\n        \"platform\": \"api\",\n        \"platform_id\": \"qa-webhook-1791910990\",\n        \"integration\": {\n          \"id\": 190,\n          \"platform\": \"api\",\n          \"external_id\": null,\n          \"name\": \"API\",\n          \"username\": null\n        }\n      },\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      },\n      \"manager\": null,\n      \"is_ai\": false,\n      \"is_read\": true,\n      \"is_system\": false,\n      \"is_show_customer\": true,\n      \"from\": \"customer\",\n      \"type\": \"message\",\n      \"text\": \"Перевір webhook: виклич qa_api_webhook з marker=WEBHOOK-API-20261013 та поверни result.\",\n      \"media\": null,\n      \"platform_id\": null,\n      \"reply_to_message_id\": null,\n      \"additional_info\": null,\n      \"schedule_at\": null,\n      \"status\": \"active\",\n      \"created_at\": \"2026-10-13 20:03:10\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"http://127.0.0.1:8001/api/v1/chats/1382/messages?page=1\",\n    \"last\": \"http://127.0.0.1:8001/api/v1/chats/1382/messages?page=1\",\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"from\": 1,\n    \"last_page\": 1,\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"&laquo; Назад\",\n        \"active\": false\n      },\n      {\n        \"url\": \"http://127.0.0.1:8001/api/v1/chats/1382/messages?page=1\",\n        \"label\": \"1\",\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Далі &raquo;\",\n        \"active\": false\n      }\n    ],\n    \"path\": \"http://127.0.0.1:8001/api/v1/chats/1382/messages\",\n    \"per_page\": 20,\n    \"to\": 4,\n    \"total\": 4\n  },\n  \"success\": true\n}"}],"_postman_id":"f60f5282-b87e-92d8-04e3-7ee5418f3a6c"},{"name":"Start AI in manual mode","id":"9c3b0ad8-f339-3c3d-7364-481d16307bfa","request":{"method":"POST","header":[{"value":"application/json","key":"Accept"}],"url":"https://app.jedidesk.com/api/v1/chats/{{chat_id}}/start-ai","description":"<p>Start AI for <code>{{chat_id}}</code> when manual AI start is enabled. This uses the normal dialog-processing flow; read conversation history for the resulting reply.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats","{{chat_id}}","start-ai"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"b110fb5b-d791-746b-7266-d1e017438a69","name":"409 Start AI in manual mode — local QA","originalRequest":{"method":"POST","header":[],"url":"https://app.jedidesk.com/api/v1/chats/1383/start-ai"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": false,\n  \"status\": \"unavailable\",\n  \"reason\": \"manual_mode_disabled\"\n}"}],"_postman_id":"9c3b0ad8-f339-3c3d-7364-481d16307bfa"}],"id":"004504b6-7d09-4a55-94d5-ef537f6c4954","description":"<p>Chats are conversations between a customer and the company. A chat connects the customer, integration, messages, status, assigned manager and team. Use this section to read dialogs, create internal/API dialogs, change the responsible team, or send a message to an existing dialog or initialize a new one.</p>\n","_postman_id":"004504b6-7d09-4a55-94d5-ef537f6c4954","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"messages","item":[{"name":"list","id":"42ee4c02-5ca7-4ef8-9145-8eb4520f7bd4","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/messages?chat_id=120&from=customer&type=message&sort=-id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","messages"],"host":["app.jedidesk.com"],"query":[{"key":"chat_id","value":"120"},{"key":"from","value":"customer"},{"key":"type","value":"message"},{"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"1c6821ee-34e7-9282-8d0c-01b597d8f58c","name":"200 messages list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/messages?chat_id={{chat_id}}&from=customer&type=message","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","messages"],"query":[{"key":"chat_id","value":"{{chat_id}}"},{"key":"from","value":"customer"},{"key":"type","value":"message"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"chat_id\": 1,\n      \"customer\": {\n        \"id\": 1,\n        \"name\": \"Example\",\n        \"platform\": \"telegram\",\n        \"platform_id\": \"[redacted]\"\n      },\n      \"integration\": {\n        \"id\": 1,\n        \"platform\": \"telegram\",\n        \"external_id\": \"[redacted]\",\n        \"name\": \"Example\",\n        \"username\": \"[redacted]\"\n      },\n      \"from\": \"customer\",\n      \"type\": \"message\",\n      \"text\": \"Hello\",\n      \"media\": null,\n      \"platform_id\": \"[redacted]\",\n      \"additional_info\": null,\n      \"status\": \"send\",\n      \"created_at\": \"2026-07-22T23:59:00.000000Z\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"https://app.jedidesk.com/api/v1/messages?page=1\",\n    \"last\": \"https://app.jedidesk.com/api/v1/messages?page=1\",\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"last_page\": 1,\n    \"per_page\": 20,\n    \"total\": 1\n  }\n}"}],"_postman_id":"42ee4c02-5ca7-4ef8-9145-8eb4520f7bd4"},{"name":"get","id":"e88b6338-3fea-4527-8550-31339194144d","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/messages/4998","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","messages","4998"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"d67257d2-778d-70f7-8614-9ee3fc3a3890","name":"200 message details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/messages/{{message_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1,\n    \"chat_id\": 1,\n    \"customer\": {\n      \"id\": 1,\n      \"name\": \"Example\",\n      \"platform_id\": \"[redacted]\"\n    },\n    \"integration\": {\n      \"id\": 1,\n      \"platform\": \"telegram\",\n      \"external_id\": \"[redacted]\",\n      \"name\": \"Example\",\n      \"username\": \"[redacted]\"\n    },\n    \"from\": \"manager\",\n    \"type\": \"message\",\n    \"text\": \"Hello from JediDesk\",\n    \"media\": null,\n    \"platform_id\": \"[redacted]\",\n    \"additional_info\": {\n      \"echat_response\": {\n        \"status\": \"Success\"\n      }\n    },\n    \"status\": \"send\"\n  }\n}"}],"_postman_id":"e88b6338-3fea-4527-8550-31339194144d"},{"name":"create","id":"c5d67696-2599-481c-a044-c2e77d4c8267","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"chat_id\": 120,\n  \"text\": \"Message from API\",\n  \"media\": null,\n  \"type\": \"message\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/messages","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","messages"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5d67696-2599-481c-a044-c2e77d4c8267"},{"name":"Send customer message","id":"67db15c5-3f38-72b0-05ff-8dc204dd4120","request":{"method":"POST","header":[{"value":"application/json","key":"Accept"},{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"chat_id\": \"{{chat_id}}\",\n  \"from\": \"customer\",\n  \"text\": \"Hello! Please answer briefly.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/messages","description":"<p>Send <code>chat_id</code>, <code>from=\"customer\"</code> and <code>text</code> to a real dialog.</p>\n<p>AI processing is asynchronous. Read <strong>chats → Read conversation history</strong> for the resulting reply. Active functions can perform real external actions.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","messages"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"76ecaf1a-843b-c094-14fa-39b6fadfbb8c","name":"200 Send customer message — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"chat_id\":1383,\"from\":\"customer\",\"text\":\"Call qa_api_webhook with marker DOCUMENTATION-20261014 and return its result.\"}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"id\": 17381,\n    \"chat_id\": 1383,\n    \"customer\": {\n      \"id\": 2560,\n      \"name\": \"Documentation QA\",\n      \"username\": null,\n      \"phone\": \"[redacted]\",\n      \"platform\": \"api\",\n      \"platform_id\": \"qa-doc-1791966318\",\n      \"integration\": {\n        \"id\": 190,\n        \"platform\": \"api\",\n        \"external_id\": null,\n        \"name\": \"API\",\n        \"username\": null\n      }\n    },\n    \"integration\": {\n      \"id\": 190,\n      \"platform\": \"api\",\n      \"external_id\": null,\n      \"name\": \"API\",\n      \"username\": null\n    },\n    \"manager\": null,\n    \"is_ai\": false,\n    \"is_read\": false,\n    \"is_system\": false,\n    \"is_show_customer\": false,\n    \"from\": \"customer\",\n    \"type\": null,\n    \"text\": \"Call qa_api_webhook with marker DOCUMENTATION-20261014 and return its result.\",\n    \"media\": null,\n    \"platform_id\": null,\n    \"reply_to_message_id\": null,\n    \"additional_info\": null,\n    \"schedule_at\": null,\n    \"status\": null,\n    \"created_at\": \"2026-10-14 11:25:18\"\n  }\n}"}],"_postman_id":"67db15c5-3f38-72b0-05ff-8dc204dd4120"}],"id":"7bd26c68-d0f0-4b95-8dfa-22697d333544","description":"<p>Messages are individual records inside a chat. They can be created by customers, managers, API calls or automation, and may contain text, media, reply references, status and external provider metadata.</p>\n","_postman_id":"7bd26c68-d0f0-4b95-8dfa-22697d333544","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"ai","item":[{"name":"goods","item":[{"name":"batch update","id":"7234de80-fd7f-a02a-942b-817c5aca03a5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"goods\": [\n    {\n      \"external_id\": \"sku-1001\",\n      \"price\": 1200,\n      \"available\": 1\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/goods/batch-update","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","goods","batch-update"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7234de80-fd7f-a02a-942b-817c5aca03a5"}],"id":"5b85006e-87ff-427e-a28e-701150a72891","description":"<p>Goods represent products or catalog items synchronized from an external system. Use this section to keep JediDesk product availability and prices up to date for support, sales automation and AI-assisted workflows.</p>\n","_postman_id":"5b85006e-87ff-427e-a28e-701150a72891","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"agent","item":[{"name":"profile","item":[{"name":"Get profile","id":"c7cc231c-ad07-fff6-060a-eb212d4efe01","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent","description":"<p>Return the current AI configuration, AI company flags and selected assistant character.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"c9f40dd0-b5c7-f2d1-dcb9-743c0748ed2f","name":"200 Get profile — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"config\": {\n      \"core\": \"[redacted]\",\n      \"site\": \"\",\n      \"model\": \"gpt-4o-mini\",\n      \"languages\": [\n        \"ua\"\n      ],\n      \"temperature\": \"0.30\",\n      \"top_p\": \"1.00\",\n      \"search_threshold\": \"0.10\",\n      \"limit_per_conversation\": null,\n      \"limit_per_week\": null,\n      \"is_enabled_in_out_work_time\": true,\n      \"is_disabled_in_work_time\": false,\n      \"bot_platforms\": [\n        \"api\"\n      ],\n      \"version\": 2,\n      \"character_id\": 7,\n      \"balance_requests\": \"[redacted]\",\n      \"updated_at\": \"2026-10-13T17:04:55.000000Z\"\n    },\n    \"company_settings\": {\n      \"is_enable_ai\": true,\n      \"is_display_connect_manager_button_ai\": false,\n      \"is_closed_bot_ai\": false,\n      \"is_deleted_customer_thread_after_close_conversation\": false,\n      \"is_disabled_ai_when_manager_connected\": false,\n      \"is_manual_ai_start\": false\n    },\n    \"character\": {\n      \"id\": 7,\n      \"name\": \"JD AI\",\n      \"description\": \"Твій AI помічник\",\n      \"instructions\": \"[redacted]\",\n      \"language\": \"uk\"\n    }\n  }\n}"}],"_postman_id":"c7cc231c-ad07-fff6-060a-eb212d4efe01"},{"name":"Get configuration options","id":"af44b767-68c8-d469-7de3-440742696845","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.jedidesk.com/api/v1/ai/agent/options","description":"<p>Return available models, assistant characters, languages and platform identifiers. Use these values when updating the profile.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","options"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"4b9a0ce8-b92a-44c6-14bd-58dd92b2d76a","name":"200 Get configuration options — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/options"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"models\": [\n      {\n        \"model_id\": \"gpt-5.6-luna\",\n        \"label\": \"GPT-5.6 Luna\",\n        \"coefficient\": 1\n      },\n      {\n        \"model_id\": \"gpt-5.6-terra\",\n        \"label\": \"GPT-5.6 Terra\",\n        \"coefficient\": 6\n      },\n      {\n        \"model_id\": \"gpt-5.6-sol\",\n        \"label\": \"GPT-5.6 Sol\",\n        \"coefficient\": 15\n      }\n    ],\n    \"characters\": [\n      {\n        \"id\": 15,\n        \"name\": \"Lexi\",\n        \"description\": \"AI-асистент для інтернет-магазинів\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 8,\n        \"name\": \"Lexi\",\n        \"description\": \"AI Assistant for Online Stores\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 1,\n        \"name\": \"Lexi\",\n        \"description\": \"AI-асистент для інтернет-магазинів\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 2,\n        \"name\": \"Nova\",\n        \"description\": \"AI-асистент для агенції\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 16,\n        \"name\": \"Nova\",\n        \"description\": \"AI-асистент для агенції\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 9,\n        \"name\": \"Nova\",\n        \"description\": \"AI Assistant for Agencies\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 3,\n        \"name\": \"Bella\",\n        \"description\": \"AI-асистент для салону краси\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 17,\n        \"name\": \"Bella\",\n        \"description\": \"AI-асистент для салону краси\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 10,\n        \"name\": \"Bella\",\n        \"description\": \"AI Assistant for Beauty Salons\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 11,\n        \"name\": \"Luna\",\n        \"description\": \"AI Assistant for an Instagram Shop\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 18,\n        \"name\": \"Luna\",\n        \"description\": \"AI-асистент для instagram магазину\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 4,\n        \"name\": \"Luna\",\n        \"description\": \"AI-асистент для instagram магазину\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 12,\n        \"name\": \"Max\",\n        \"description\": \"AI Sales Assistant\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 5,\n        \"name\": \"Max\",\n        \"description\": \"AI-асистент для продавця\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 19,\n        \"name\": \"Max\",\n        \"description\": \"AI-асистент для продавця\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 13,\n        \"name\": \"Zara\",\n        \"description\": \"AI Customer Support Assistant\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 6,\n        \"name\": \"Zara\",\n        \"description\": \"AI-асистент для підтримки клієнтів\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 20,\n        \"name\": \"Zara\",\n        \"description\": \"AI-асистент для підтримки клієнтів\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 0\n      },\n      {\n        \"id\": 14,\n        \"name\": \"JD AI\",\n        \"description\": \"Your AI Assistant\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"en\",\n        \"is_default\": 1\n      },\n      {\n        \"id\": 7,\n        \"name\": \"JD AI\",\n        \"description\": \"Твій AI помічник\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"uk\",\n        \"is_default\": 1\n      },\n      {\n        \"id\": 21,\n        \"name\": \"JD AI\",\n        \"description\": \"Твій AI помічник\",\n        \"instructions\": \"[redacted]\",\n        \"language\": \"ru\",\n        \"is_default\": 1\n      }\n    ],\n    \"languages\": {\n      \"ua\": \"Українська\",\n      \"en\": \"English\",\n      \"es\": \"Español\",\n      \"de\": \"Deutsch\",\n      \"fr\": \"Français\",\n      \"it\": \"Italiano\",\n      \"nl\": \"Nederlands\",\n      \"pt\": \"Português\",\n      \"sv\": \"Svenska\",\n      \"da\": \"Dansk\",\n      \"no\": \"Norsk\",\n      \"fi\": \"Suomen kieli\",\n      \"pl\": \"Polski\",\n      \"cs\": \"Čeština\",\n      \"zh\": \"漢語\",\n      \"ja\": \"日本語, にほんご, にっぽんご\",\n      \"ko\": \"한국어\",\n      \"ru\": \"Русский\"\n    },\n    \"platforms\": {\n      \"viber\": \"Viber\",\n      \"telegram\": \"Telegram\",\n      \"instagram\": \"Instagram\",\n      \"messenger\": \"Messenger\",\n      \"widget\": \"Widget\",\n      \"api\": \"API\",\n      \"telegram-people\": \"Telegram People\",\n      \"telegram-business\": \"Telegram Business\",\n      \"email\": \"[redacted]\",\n      \"whatsapp\": \"Whatsapp\",\n      \"echat-telegram\": \"E-chat Telegram\",\n      \"echat-viber\": \"E-chat Viber\",\n      \"echat-whatsapp\": \"E-chat WhatsApp\"\n    }\n  }\n}"}],"_postman_id":"af44b767-68c8-d469-7de3-440742696845"},{"name":"Update profile","id":"ae8d4c09-acd1-baf2-2c32-623e6d467fb4","request":{"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"config\": {\n    \"core\": \"You are a helpful assistant.\",\n    \"model\": \"gpt-5-mini\",\n    \"temperature\": 0.3,\n    \"search_threshold\": 0.5\n  },\n  \"company_settings\": {\n    \"is_enable_ai\": true\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent","description":"<p>Update only the supplied <code>config</code> and <code>company_settings</code> fields. Omitted fields remain unchanged.</p>\n<p>Use <code>config.core</code> for the prompt. Available models, languages, platforms and characters are listed in <strong>Get configuration options</strong>. Enabling AI requires the company tariff to allow AI.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"c026efa9-2cb5-b9e6-d690-063126048d49","name":"200 Update profile — local QA","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"config\":{\"core\":\"[redacted]\"}}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"config\": {\n      \"core\": \"[redacted]\",\n      \"site\": \"\",\n      \"model\": \"gpt-4o-mini\",\n      \"languages\": [\n        \"ua\"\n      ],\n      \"temperature\": \"0.30\",\n      \"top_p\": \"1.00\",\n      \"search_threshold\": \"0.10\",\n      \"limit_per_conversation\": null,\n      \"limit_per_week\": null,\n      \"is_enabled_in_out_work_time\": true,\n      \"is_disabled_in_work_time\": false,\n      \"bot_platforms\": [\n        \"api\"\n      ],\n      \"version\": 2,\n      \"character_id\": 7,\n      \"balance_requests\": \"[redacted]\",\n      \"updated_at\": \"2026-10-14T08:18:58.000000Z\"\n    },\n    \"company_settings\": {\n      \"is_enable_ai\": true,\n      \"is_display_connect_manager_button_ai\": false,\n      \"is_closed_bot_ai\": false,\n      \"is_deleted_customer_thread_after_close_conversation\": false,\n      \"is_disabled_ai_when_manager_connected\": false,\n      \"is_manual_ai_start\": false\n    },\n    \"character\": {\n      \"id\": 7,\n      \"name\": \"JD AI\",\n      \"description\": \"Твій AI помічник\",\n      \"instructions\": \"[redacted]\",\n      \"language\": \"uk\"\n    }\n  }\n}"},{"id":"2de5c772-c584-2c6b-d303-6a574bdf155c","name":"422 422 profile validation — local QA","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"config\":{\"temperature\":3}}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": false,\n  \"message\": \"Поле config.temperature має бути не більше 2.\",\n  \"errors\": {\n    \"config.temperature\": [\n      \"Поле config.temperature має бути не більше 2.\"\n    ]\n  }\n}"}],"_postman_id":"ae8d4c09-acd1-baf2-2c32-623e6d467fb4"}],"id":"64de7e9a-0c77-4d13-8048-457a0849c4fa","description":"<p>Read or update the AI prompt, model, limits, language/platform selection and AI company flags. Updates are partial; omitted fields remain unchanged.</p>\n","_postman_id":"64de7e9a-0c77-4d13-8048-457a0849c4fa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"knowledge files","item":[{"name":"List files","id":"0d35fe4d-06ab-61b2-23d1-1a888afa0fde","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/files","description":"<p>Return the company's knowledge files, provider attachment status and download links. Use the returned file ID for deletion.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","files"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"0c5bbbe2-f4cd-5f56-7ff1-edfa9af88048","name":"200 List files — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"id\": 8054,\n      \"name\": \"qa-knowledge.txt\",\n      \"status\": \"attached\",\n      \"size\": 281,\n      \"download_url\": \"127.0.0.1/storage/company153/ai-assistant/9ff2fdbe-be40-4728-944c-8773e5effdb8/8051/qa-knowledge.txt\",\n      \"created_at\": \"2026-10-13T14:00:22.000000Z\",\n      \"updated_at\": \"2026-10-13T14:00:22.000000Z\"\n    }\n  ]\n}"}],"_postman_id":"0d35fe4d-06ab-61b2-23d1-1a888afa0fde"},{"name":"Upload files","id":"e34fb1b7-6c98-9d3f-496a-922d07d13f75","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files[]","type":"file","value":""}]},"url":"https://app.jedidesk.com/api/v1/ai/agent/files","description":"<p>Upload knowledge documents as multipart <code>files[]</code>.</p>\n<ul>\n<li>1–10 files per request; up to 10 MB each.</li>\n<li>Formats: DOC, DOCX, HTML, TXT, JSON and PDF.</li>\n<li>Do not manually set <code>Content-Type</code>; Postman sets the multipart boundary.</li>\n</ul>\n<p><strong>Result:</strong> <code>201 Created</code>. Inspect attachment status before testing knowledge retrieval. Different content under an existing filename returns <code>422</code>; delete the old file before replacing it.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","files"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"5f2fd5b5-c30c-8ecc-6daa-73eb12b4bafc","name":"201 Upload files — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files[]","type":"file","src":[]}]},"url":"https://app.jedidesk.com/api/v1/ai/agent/files"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"id\": 8055,\n      \"name\": \"qa-knowledge.txt\",\n      \"status\": \"attached\",\n      \"size\": 281,\n      \"download_url\": \"127.0.0.1/storage/company153/ai-assistant/qa-knowledge.txt\",\n      \"created_at\": \"2026-10-14T08:18:58.000000Z\",\n      \"updated_at\": \"2026-10-14T08:19:06.000000Z\"\n    }\n  ]\n}"}],"_postman_id":"e34fb1b7-6c98-9d3f-496a-922d07d13f75"},{"name":"Delete file","id":"2ff8723f-3598-1547-f7fc-0685aaef865a","request":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/files/{{file_id}}","description":"<p>Delete <code>{{file_id}}</code> from the company's knowledge base and provider index.</p>\n<p><strong>Result:</strong> <code>204 No Content</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","files","{{file_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"5f1f0e5f-430d-33fb-9b9d-b8a188571b84","name":"204 Delete file — local QA","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/files/8056"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b41b4953-dbd7-05e6-3b4b-e8832f7c7be1","name":"404 404 file — local QA","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/files/999999999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Resource not found\"\n}"}],"_postman_id":"2ff8723f-3598-1547-f7fc-0685aaef865a"}],"id":"2c65db57-9d13-45ad-81ad-829b30746f45","description":"<p>Manage documents used by the AI knowledge base. Uploaded files must be attached to the provider index before they can be retrieved in a dialog.</p>\n","_postman_id":"2c65db57-9d13-45ad-81ad-829b30746f45","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"built-in functions","item":[{"name":"List functions","id":"7b505eb8-5795-471c-9be6-3275edd4b7dd","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/functions","description":"<p>Return built-in and custom functions, activation state, instructions, settings fields and required integrations. Built-in slugs are used in <strong>Update built-in function</strong>; custom IDs are used for custom-function operations.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","functions"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"1b17fae2-4f01-f382-454c-92796ff2949d","name":"200 List functions — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/functions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"built_in\": [\n      {\n        \"name\": \"stop_conversation\",\n        \"label\": \"Зупинка ШІ та передача менеджеру\",\n        \"description\": \"ШІ зупиняє діалог, передає його менеджеру, сповіщує команду та відправляє клієнту повідомлення про очікування.\",\n        \"is_active\": false,\n        \"is_hidden\": false,\n        \"settings\": {\n          \"description\": null,\n          \"response_text\": null\n        },\n        \"settings_fields\": [\n          \"description\",\n          \"response_text\"\n        ],\n        \"required_sources\": []\n      },\n      {\n        \"name\": \"search_goods\",\n        \"label\": \"Каталог товарів і послуг\",\n        \"description\": \"Надає ШІ доступ до вашого каталогу. Асистент консультує клієнтів, підбирає варіанти за параметрами та відповідає на запитання про наявність, характеристики й умови.\",\n        \"is_active\": false,\n        \"is_hidden\": false,\n        \"settings\": {\n          \"prompt_instruction\": \"[redacted]\",\n          \"vendor_priority\": null,\n          \"filters\": null,\n          \"use_categories\": null\n        },\n        \"settings_fields\": [\n          \"prompt_instruction\",\n          \"vendor_priority\",\n          \"filters\",\n          \"use_categories\"\n        ],\n        \"required_sources\": [\n          \"yml_goods\",\n          \"horoshop\"\n        ]\n      },\n      {\n        \"name\": \"collect_user_data\",\n        \"label\": \"Збір даних користувача\",\n        \"description\": \"Автоматично поповнює картку контакту телефоном, email та ім’ям із діалогу, щоб команда мала актуальні дані клієнта для подальших дій.\",\n        \"is_active\": false,\n        \"is_hidden\": false,\n        \"settings\": {\n          \"prompt_instruction\": \"[redacted]\",\n          \"use_customer_context\": null\n        },\n        \"settings_fields\": [\n          \"prompt_instruction\",\n          \"use_customer_context\"\n        ],\n        \"required_sources\": []\n      },\n      {\n        \"name\": \"set_customer_language\",\n        \"label\": \"Мова клієнта\",\n        \"description\": \"Визначає і встановлює мову спілкування клієнта.\",\n        \"is_active\": false,\n        \"is_hidden\": true,\n        \"settings\": [],\n        \"settings_fields\": [],\n        \"required_sources\": []\n      },\n      {\n        \"name\": \"order_details\",\n        \"label\": \"Деталі замовлення\",\n        \"description\": \"Дозволяє ШІ знаходити замовлення клієнта за номером або телефоном. Показує статус, товари, доставку та оплату.\",\n        \"is_active\": false,\n        \"is_hidden\": false,\n        \"settings\": [],\n        \"settings_fields\": [],\n        \"required_sources\": [\n          \"sales_drive\",\n          \"horoshop\",\n          \"api\"\n        ]\n      },\n      {\n        \"name\": \"search_knowledge_base\",\n        \"label\": \"Пошук у базі знань\",\n        \"description\": \"Дає більше контролю над пошуком у базі знань: логування запитів пошуку, окремі правила саме для пошуку, налаштування відповіді при відсутності результатів, передача моделі назв файлів-джерел.\",\n        \"is_active\": true,\n        \"is_hidden\": false,\n        \"settings\": {\n          \"prompt_instruction\": \"[redacted]\",\n          \"empty_result_response\": null\n        },\n        \"settings_fields\": [\n          \"prompt_instruction\",\n          \"empty_result_response\"\n        ],\n        \"required_sources\": []\n      }\n    ],\n    \"custom\": [\n      {\n        \"id\": 7,\n        \"name\": \"qa_echo\",\n        \"description\": \"Call this function to verify the QA webhook. Return its result to the user.\",\n        \"parameters\": {\n          \"type\": \"object\",\n          \"required\": [\n            \"marker\"\n          ],\n          \"properties\": {\n            \"marker\": {\n              \"type\": \"string\"\n            }\n          }\n        },\n        \"prompt_instruction\": \"[redacted]\",\n        \"is_active\": true,\n        \"created_at\": \"2026-10-13T14:00:22.000000Z\",\n        \"updated_at\": \"2026-10-13T14:00:22.000000Z\"\n      },\n      {\n        \"id\": 8,\n        \"name\": \"qa_api_webhook\",\n        \"description\": \"Call this function to verify the QA API-configured webhook. Return its result.\",\n        \"parameters\": {\n          \"type\": \"object\",\n          \"required\": [\n            \"marker\"\n          ],\n          \"properties\": {\n            \"marker\": {\n              \"type\": \"string\"\n            }\n          }\n        },\n        \"prompt_instruction\": \"[redacted]\",\n        \"is_active\": true,\n        \"created_at\": \"2026-10-13T17:03:10.000000Z\",\n        \"updated_at\": \"2026-10-13T17:03:10.000000Z\"\n      }\n    ]\n  }\n}"}],"_postman_id":"7b505eb8-5795-471c-9be6-3275edd4b7dd"},{"name":"Update built-in function","id":"0dc30888-6e91-e42b-8035-f567e6961e8a","request":{"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"is_active\": true,\n  \"settings\": {\n    \"prompt_instruction\": \"Search products before answering product questions.\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/search_goods","description":"<p>Update the function slug in the URL (the example uses <code>search_goods</code>) using <code>is_active</code> and optional <code>settings</code>. Send only fields to change; supported settings are returned by <strong>List functions</strong>.</p>\n<p>Functions that depend on product/order integrations require those integrations to be configured separately.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","functions","search_goods"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"976cb067-18d0-3bbd-9164-6d45562cb4df","name":"200 Update built-in function — local QA","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"is_active\":true}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/search_knowledge_base"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"name\": \"search_knowledge_base\",\n    \"label\": \"Пошук у базі знань\",\n    \"description\": \"Дає більше контролю над пошуком у базі знань: логування запитів пошуку, окремі правила саме для пошуку, налаштування відповіді при відсутності результатів, передача моделі назв файлів-джерел.\",\n    \"is_active\": true,\n    \"is_hidden\": false,\n    \"settings\": {\n      \"prompt_instruction\": \"[redacted]\",\n      \"empty_result_response\": null\n    },\n    \"settings_fields\": [\n      \"prompt_instruction\",\n      \"empty_result_response\"\n    ],\n    \"required_sources\": []\n  }\n}"}],"_postman_id":"0dc30888-6e91-e42b-8035-f567e6961e8a"}],"id":"1f95694a-bf8f-476c-966f-7fb4f34a56f3","description":"<p>Inspect all registered functions and configure the activation state and supported settings of a built-in function.</p>\n","_postman_id":"1f95694a-bf8f-476c-966f-7fb4f34a56f3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"custom functions","item":[{"name":"Create custom function","id":"72f5ab87-cf75-c9b6-85af-81da84556700","request":{"method":"POST","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"lookup_delivery\",\n  \"description\": \"Look up delivery status.\",\n  \"parameters\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"order_id\": {\"type\": \"string\"}\n    },\n    \"required\": [\"order_id\"]\n  },\n  \"prompt_instruction\": \"Use for delivery status.\",\n  \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom","description":"<p>Create a function using <code>name</code>, <code>description</code>, a JSON Schema in <code>parameters</code>, optional <code>prompt_instruction</code> and <code>is_active</code>.</p>\n<p><strong>Result:</strong> <code>201 Created</code>. Subscribe a trusted handler to <code>ai.func_call</code> in <strong>webhooks → configuration</strong> before executing the function.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","functions","custom"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"de7cf765-81d8-39e5-76fe-4e2dd840e35d","name":"201 Create custom function — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\":\"qa_documentation_example\",\"description\":\"Documentation test function\",\"parameters\":{\"type\":\"object\",\"properties\":{}},\"is_active\":false}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 9,\n    \"name\": \"qa_documentation_1791965946\",\n    \"description\": \"Documentation test function\",\n    \"parameters\": {\n      \"type\": \"object\"\n    },\n    \"prompt_instruction\": \"[redacted]\",\n    \"is_active\": false,\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\"\n  }\n}"}],"_postman_id":"72f5ab87-cf75-c9b6-85af-81da84556700"},{"name":"Update custom function","id":"c2ba2a53-e6bc-2d29-4179-9704b4227bb9","request":{"method":"PUT","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"lookup_delivery\",\n  \"description\": \"Look up delivery status.\",\n  \"parameters\": {\"type\": \"object\"},\n  \"is_active\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom/{{custom_function_id}}","description":"<p>Update <code>{{custom_function_id}}</code>.</p>\n<p><strong>Required JSON fields:</strong> <code>name</code>, <code>description</code>.</p>\n<p>Optional: <code>parameters</code> (complete JSON Schema), <code>prompt_instruction</code>, <code>is_active</code>. Omitted optional fields remain unchanged. Missing required fields return <code>422</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","functions","custom","{{custom_function_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"be482c8d-b0fe-8707-e1fa-74cce624091e","name":"422 Update custom function — local QA","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"description\":\"Updated documentation test function\",\"is_active\":false}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom/9"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": false,\n  \"message\": \"Поле Ім'я є обов'язковим для заповнення.\",\n  \"errors\": {\n    \"name\": [\n      \"Поле Ім'я є обов'язковим для заповнення.\"\n    ]\n  }\n}"},{"id":"62b8a236-d3a1-84cb-c4d2-e67f3f16a82c","name":"200 Update custom function — local QA","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"name\":\"qa_doc_extra_1791966324\",\"description\":\"Updated documentation example\",\"parameters\":{\"type\":\"object\",\"properties\":{}},\"is_active\":false}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 10,\n    \"name\": \"qa_doc_extra_1791966324\",\n    \"description\": \"Updated documentation example\",\n    \"parameters\": {\n      \"type\": \"object\"\n    },\n    \"prompt_instruction\": \"[redacted]\",\n    \"is_active\": false,\n    \"created_at\": \"2026-10-14T08:25:24.000000Z\",\n    \"updated_at\": \"2026-10-14T08:25:24.000000Z\"\n  }\n}"}],"_postman_id":"c2ba2a53-e6bc-2d29-4179-9704b4227bb9"},{"name":"Delete custom function","id":"ad26b1e0-4279-6633-95a9-5fcac9862b8e","request":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom/{{custom_function_id}}","description":"<p>Delete <code>{{custom_function_id}}</code>. The function will no longer be registered for new AI requests.</p>\n<p><strong>Result:</strong> <code>204 No Content</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","functions","custom","{{custom_function_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"eab06102-0516-f0e9-3d4a-54913c754652","name":"204 Delete custom function — local QA","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/functions/custom/9"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ad26b1e0-4279-6633-95a9-5fcac9862b8e"}],"id":"50235d3c-9d57-470d-bd1e-dcb2e4bb6420","description":"<p>Create and manage custom function definitions.</p>\n<p><strong>Access:</strong> the tariff must include <code>ai_custom_functions</code>; writes return <code>403</code> without it, and unavailable functions are excluded at runtime.</p>\n<p><strong>Execution:</strong> configure a trusted webhook subscribed to <code>ai.func_call</code>. The existing runtime calls the first subscribed webhook; the handler routes requests by function name.</p>\n","_postman_id":"50235d3c-9d57-470d-bd1e-dcb2e4bb6420","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"stop words","item":[{"name":"List stop words","id":"862769aa-2f05-689e-6733-240846a89868","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words","description":"<p>Return all stop-word rules for the company, including each rule's ID, phrase, message source and action.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","stop-words"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"0e4f06d5-e331-7116-ac73-296470d88d5e","name":"200 List stop words — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": []\n}"}],"_postman_id":"862769aa-2f05-689e-6733-240846a89868"},{"name":"Create stop word","id":"b11231e2-dc63-9515-9bdb-264f9bb134bd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"word\": \"manager\",\n  \"from\": \"customer\",\n  \"action\": \"notify_manager\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words","description":"<p>Create a rule using <code>word</code>, <code>from</code> and <code>action</code>.</p>\n<p><strong>Result:</strong> <code>201 Created</code>; the rule is returned in <code>data</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","stop-words"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"75369603-eb78-ed59-82fa-434e79e4f854","name":"201 Create stop word — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"word\":\"QA documentation stop\",\"from\":\"customer\",\"action\":\"notify_manager\"}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"word\": \"QA documentation stop\",\n    \"from\": \"customer\",\n    \"action\": \"notify_manager\",\n    \"company_id\": 153,\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"id\": 1956\n  }\n}"}],"_postman_id":"b11231e2-dc63-9515-9bdb-264f9bb134bd"},{"name":"Update stop word","id":"aec6098c-95e5-4c30-6d02-8d6db996e46d","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"word\": \"manager\",\n  \"from\": \"customer\",\n  \"action\": \"stop_bot\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words/{{stop_word_id}}","description":"<p>Replace the phrase, source and action of the rule identified by <code>{{stop_word_id}}</code>. Send <code>word</code>, <code>from</code> and <code>action</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","stop-words","{{stop_word_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"29c5b26c-0076-41f7-8906-c296e66d6859","name":"200 Update stop word — local QA","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"word\":\"QA documentation stop updated\",\"from\":\"customer\",\"action\":\"stop_bot\"}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words/1956"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 1956,\n    \"company_id\": 153,\n    \"word\": \"QA documentation stop updated\",\n    \"from\": \"customer\",\n    \"action\": \"stop_bot\",\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\"\n  }\n}"}],"_postman_id":"aec6098c-95e5-4c30-6d02-8d6db996e46d"},{"name":"Delete stop word","id":"260cea77-fb54-5c35-02b7-c5608f24fb82","request":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words/{{stop_word_id}}","description":"<p>Delete the rule identified by <code>{{stop_word_id}}</code>.</p>\n<p><strong>Result:</strong> <code>204 No Content</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","stop-words","{{stop_word_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"395e6db4-1075-6ad8-2ae7-42a4932198f8","name":"204 Delete stop word — local QA","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/stop-words/1956"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"260cea77-fb54-5c35-02b7-c5608f24fb82"}],"id":"9f8c6db0-84e8-4b68-ada4-662a472ff59d","description":"<p>Manage rules that respond to specified phrases in customer or AI messages. A rule defines the phrase, source and action.</p>\n","_postman_id":"9f8c6db0-84e8-4b68-ada4-662a472ff59d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"logs","item":[{"name":"List usage logs","id":"0ec2e053-fe20-37da-7e34-06297b3072e0","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/usage?days=7","description":"<p>Return paginated AI usage records. Use <code>days</code> (1–90), <code>page</code> and <code>per_page</code> (1–100) to select the reporting window and page.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","logs","usage"],"host":["app.jedidesk.com"],"query":[{"key":"days","value":"7"}],"variable":[]}},"response":[{"id":"fa5d3159-0b1d-044d-fd21-670a75258846","name":"200 List usage logs — local QA","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/ai/agent/logs/usage?days=7","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","ai","agent","logs","usage"],"query":[{"key":"days","value":"7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"stats\": {\n      \"extra_credits\": 0,\n      \"extra_requests\": 0,\n      \"avg_multiplier\": 0,\n      \"max_multiplier\": 0,\n      \"max_amount\": 0\n    },\n    \"logs\": {\n      \"data\": [],\n      \"total\": 0,\n      \"page\": 1,\n      \"per_page\": 20,\n      \"last_page\": 1\n    }\n  }\n}"}],"_postman_id":"0ec2e053-fe20-37da-7e34-06297b3072e0"},{"name":"List function logs","id":"42784e93-b832-4c05-78fe-9df44b443048","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/functions?conversation_id={{chat_id}}","description":"<p>Return paginated function calls with arguments, results, execution time and conversation IDs.</p>\n<p>Filter by <code>conversation_id</code>, <code>function_name</code> or <code>result_status</code>; use <code>page</code> and <code>per_page</code> for pagination. Use <code>conversation_id</code> to trace a real test dialog.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","logs","functions"],"host":["app.jedidesk.com"],"query":[{"key":"conversation_id","value":"{{chat_id}}"}],"variable":[]}},"response":[{"id":"1842e2ce-8d57-1034-c08b-13f27bdac913","name":"200 List function logs — local QA","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/ai/agent/logs/functions?conversation_id=1382","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","ai","agent","logs","functions"],"query":[{"key":"conversation_id","value":"1382"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"stats\": [\n      {\n        \"function_name\": \"search_knowledge_base\",\n        \"function_type\": \"built_in\",\n        \"total_calls\": 2,\n        \"success_calls\": \"2\",\n        \"error_calls\": \"0\",\n        \"avg_execution_time_ms\": \"1018.0000\"\n      },\n      {\n        \"function_name\": \"qa_api_webhook\",\n        \"function_type\": \"custom\",\n        \"total_calls\": 2,\n        \"success_calls\": \"0\",\n        \"error_calls\": \"0\",\n        \"avg_execution_time_ms\": \"41.5000\"\n      },\n      {\n        \"function_name\": \"qa_echo\",\n        \"function_type\": \"custom\",\n        \"total_calls\": 1,\n        \"success_calls\": \"0\",\n        \"error_calls\": \"0\",\n        \"avg_execution_time_ms\": \"124.0000\"\n      }\n    ],\n    \"logs\": {\n      \"data\": [\n        {\n          \"id\": 50,\n          \"created_at\": \"2026-10-13T17:04:53.000000Z\",\n          \"function_name\": \"qa_api_webhook\",\n          \"function_type\": \"custom\",\n          \"conversation_id\": 1382,\n          \"customer_id\": 2558,\n          \"result_status\": null,\n          \"execution_time_ms\": 32,\n          \"correlation_id\": \"1382\",\n          \"input\": {\n            \"marker\": \"WEBHOOK-FAIL\"\n          },\n          \"output\": {\n            \"error\": \"QA_WEBHOOK_FAILURE\"\n          }\n        },\n        {\n          \"id\": 49,\n          \"created_at\": \"2026-10-13T17:03:14.000000Z\",\n          \"function_name\": \"qa_api_webhook\",\n          \"function_type\": \"custom\",\n          \"conversation_id\": 1382,\n          \"customer_id\": 2558,\n          \"result_status\": null,\n          \"execution_time_ms\": 51,\n          \"correlation_id\": \"1382\",\n          \"input\": {\n            \"marker\": \"WEBHOOK-API-20261013\"\n          },\n          \"output\": {\n            \"marker\": \"WEBHOOK-API-20261013\",\n            \"result\": \"QA_WEBHOOK_OK\",\n            \"function\": \"qa_api_webhook\"\n          }\n        }\n      ],\n      \"total\": 2,\n      \"page\": 1,\n      \"per_page\": 20,\n      \"last_page\": 1\n    }\n  }\n}"}],"_postman_id":"42784e93-b832-4c05-78fe-9df44b443048"},{"name":"Get function log","id":"dc9de080-fcca-9a21-0360-1cb65cae74b6","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/functions/{{function_log_id}}","description":"<p>Return <code>{{function_log_id}}</code> from the function-call list, including arguments and result. Sensitive structured fields are redacted.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","logs","functions","{{function_log_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"bfc3c0e2-949d-d441-2498-be5b46fcf4a0","name":"200 Get function log — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/functions/50"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 50,\n    \"created_at\": \"2026-10-13T17:04:53.000000Z\",\n    \"function_name\": \"qa_api_webhook\",\n    \"function_type\": \"custom\",\n    \"conversation_id\": 1382,\n    \"customer_id\": 2558,\n    \"result_status\": null,\n    \"execution_time_ms\": 32,\n    \"correlation_id\": \"1382\",\n    \"input\": {\n      \"marker\": \"WEBHOOK-FAIL\"\n    },\n    \"output\": {\n      \"error\": \"QA_WEBHOOK_FAILURE\"\n    }\n  }\n}"}],"_postman_id":"dc9de080-fcca-9a21-0360-1cb65cae74b6"},{"name":"List runtime logs","id":"94e64580-5782-1458-b3f4-9a9a313ba65d","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/runtime?page=1&per_page=20","description":"<p>Return paginated AI provider/runtime records. Filter by <code>slug</code>; use <code>page</code> and <code>per_page</code> for pagination.</p>\n<p>The saved QA example shows one record. Internal provider payload and resource identifiers are omitted from public examples.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","logs","runtime"],"host":["app.jedidesk.com"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"766789fd-722b-9174-68a0-9c7fb3f1a323","name":"200 List runtime logs — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/runtime"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"data\": [\n      {\n        \"id\": 47111,\n        \"slug\": \"App\\\\Services\\\\Api\\\\OpenAi\\\\OpenAiAssistantApi::curl\",\n        \"created_at\": \"2026-10-14T08:19:05.000000Z\",\n        \"correlation_id\": null\n      }\n    ],\n    \"total\": 76,\n    \"page\": 1,\n    \"per_page\": 20,\n    \"last_page\": 4\n  }\n}"}],"_postman_id":"94e64580-5782-1458-b3f4-9a9a313ba65d"},{"name":"Get runtime log","id":"f7c0985e-5ded-eb7d-8b4b-02ec3f52f2d8","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/runtime/{{runtime_log_id}}","description":"<p>Return <code>{{runtime_log_id}}</code> from the runtime list. Provider request/response details are available through the authenticated API. Public examples omit sensitive payload and local debug traces.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","logs","runtime","{{runtime_log_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"c72f0bd3-ee9c-1b06-821b-b4e6b5486cf2","name":"404 Get runtime log — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/logs/runtime/999999999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Resource not found\"\n}"}],"_postman_id":"f7c0985e-5ded-eb7d-8b4b-02ec3f52f2d8"}],"id":"538a1ce9-525c-46ba-b191-6ca3898ea52e","description":"<p>Inspect AI usage, function calls and provider/runtime records. Results are company-scoped and paginated. Sensitive structured fields are masked; arbitrary free-text personal data is not automatically removed.</p>\n","_postman_id":"538a1ce9-525c-46ba-b191-6ca3898ea52e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"backups","item":[{"name":"Create backup","id":"7deeb03b-8b5a-4aee-9799-2c54ad8636f8","request":{"method":"POST","header":[{"value":"application/json","key":"Accept"}],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups","description":"<p>Queue a complete AI settings and knowledge-file archive.</p>\n<p><strong>Result:</strong> <code>202 Accepted</code>. Save the operation's ID as <code>backup_id</code>, poll <strong>Get backup status</strong>, then download when status is <code>ready</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"3ce9042a-95ee-df4e-e692-8fe45f918807","name":"202 Create backup — local QA","originalRequest":{"method":"POST","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"386c428b-2ecc-4cde-b551-dab35b32997f\",\n    \"operation\": \"backup\",\n    \"status\": \"queued\",\n    \"sections\": [\n      \"prompt\",\n      \"config\",\n      \"character\",\n      \"company_settings\",\n      \"files\",\n      \"functions\",\n      \"stop_words\",\n      \"site_scraper\"\n    ],\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\"\n  }\n}"}],"_postman_id":"7deeb03b-8b5a-4aee-9799-2c54ad8636f8"},{"name":"List backups","id":"22ec4eb0-80c5-d39f-13c7-87db4f651336","request":{"method":"GET","header":[{"value":"application/json","key":"Accept"}],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups?page=1","description":"<p>Return dated backup, import and restore operations, including status, applied sections and archive size. Use <code>page</code> for pagination.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups"],"host":["app.jedidesk.com"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"30ef9775-ce4f-8d29-c90a-9bf8157f12f8","name":"200 List backups — local QA","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/ai/agent/backups?page=1","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","ai","agent","backups"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"current_page\": 1,\n    \"data\": [\n      {\n        \"id\": \"386c428b-2ecc-4cde-b551-dab35b32997f\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2869,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n        \"updated_at\": \"2026-10-14T08:19:07.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"fcb0ecba-4b1e-4fe5-ac17-8329d8242d3f\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2511,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T16:32:41.000000Z\",\n        \"updated_at\": \"2026-10-13T16:32:42.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"034c9e76-812e-497e-b99e-4ab2eb9651a7\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2339,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:31:21.000000Z\",\n        \"updated_at\": \"2026-10-13T15:31:21.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"4ba9fff0-d643-4c08-b911-7bdd33fc44b3\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2358,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:28:15.000000Z\",\n        \"updated_at\": \"2026-10-13T15:28:15.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"c758cef9-b935-4f8a-8a64-9b9a4b9a8112\",\n        \"operation\": \"restore\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": \"4ba9fff0-d643-4c08-b911-7bdd33fc44b3\",\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:28:14.000000Z\",\n        \"updated_at\": \"2026-10-13T15:28:15.000000Z\",\n        \"sections\": [\n          \"prompt\"\n        ]\n      },\n      {\n        \"id\": \"279c133a-ee75-4de1-b456-cb6f587e9939\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2352,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:22:38.000000Z\",\n        \"updated_at\": \"2026-10-13T15:22:38.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"eb69c74c-c974-4212-b3df-404d182075a4\",\n        \"operation\": \"import\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": \"279c133a-ee75-4de1-b456-cb6f587e9939\",\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:22:36.000000Z\",\n        \"updated_at\": \"2026-10-13T15:22:38.000000Z\",\n        \"sections\": [\n          \"prompt\"\n        ]\n      },\n      {\n        \"id\": \"b7f55d0e-ee32-41d7-ab4d-9b389834a826\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2358,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:11:28.000000Z\",\n        \"updated_at\": \"2026-10-13T15:11:28.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"a51205bb-5bdb-43f7-9dda-b27468b730e9\",\n        \"operation\": \"import\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": \"b7f55d0e-ee32-41d7-ab4d-9b389834a826\",\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:11:27.000000Z\",\n        \"updated_at\": \"2026-10-13T15:11:28.000000Z\",\n        \"sections\": [\n          \"prompt\"\n        ]\n      },\n      {\n        \"id\": \"4ad47f1a-4d72-41ff-ae8a-cdefe2df4e1d\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2358,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:10:17.000000Z\",\n        \"updated_at\": \"2026-10-13T15:10:17.000000Z\",\n        \"sections\": [\n          \"prompt\",\n          \"config\",\n          \"character\",\n          \"company_settings\",\n          \"files\",\n          \"functions\",\n          \"stop_words\",\n          \"site_scraper\"\n        ]\n      },\n      {\n        \"id\": \"3fce75cc-1549-4dcd-879f-69c9289de562\",\n        \"operation\": \"restore\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": \"4ad47f1a-4d72-41ff-ae8a-cdefe2df4e1d\",\n        \"error\": null,\n        \"created_at\": \"2026-10-13T15:10:15.000000Z\",\n        \"updated_at\": \"2026-10-13T15:10:17.000000Z\",\n        \"sections\": [\n          \"prompt\"\n        ]\n      },\n      {\n        \"id\": \"9ff2fdbe-be40-4728-944c-8773e5effdb8\",\n        \"operation\": \"import\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": \"c707cead-5e46-4f46-be60-9aed34bb3ec4\",\n        \"error\": null,\n        \"created_at\": \"2026-10-13T14:00:11.000000Z\",\n        \"updated_at\": \"2026-10-13T14:00:24.000000Z\",\n        \"sections\": null\n      },\n      {\n        \"id\": \"c707cead-5e46-4f46-be60-9aed34bb3ec4\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2313,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T14:00:11.000000Z\",\n        \"updated_at\": \"2026-10-13T14:00:11.000000Z\",\n        \"sections\": null\n      },\n      {\n        \"id\": \"c00d3a19-6049-4ef1-94a3-d8d1630062ce\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T13:58:28.000000Z\",\n        \"updated_at\": \"2026-10-13T13:58:28.000000Z\",\n        \"sections\": null\n      },\n      {\n        \"id\": \"05bba83f-e990-4e27-80b0-1ceb352d4d39\",\n        \"operation\": \"restore\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": \"c00d3a19-6049-4ef1-94a3-d8d1630062ce\",\n        \"error\": null,\n        \"created_at\": \"2026-10-13T13:58:27.000000Z\",\n        \"updated_at\": \"2026-10-13T13:58:41.000000Z\",\n        \"sections\": null\n      },\n      {\n        \"id\": \"53e4cd51-7f64-47c2-b681-576ea2f74a51\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T13:56:53.000000Z\",\n        \"updated_at\": \"2026-10-13T13:56:55.000000Z\",\n        \"sections\": null\n      },\n      {\n        \"id\": \"a9b87316-73d4-428a-acb3-d9e2fb9248dc\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2311,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T13:55:04.000000Z\",\n        \"updated_at\": \"2026-10-13T13:55:05.000000Z\",\n        \"sections\": null\n      },\n      {\n        \"id\": \"34e9750c-b509-4d27-97fa-7457120d3fc8\",\n        \"operation\": \"backup\",\n        \"status\": \"ready\",\n        \"size\": 2171,\n        \"previous_backup_id\": null,\n        \"error\": null,\n        \"created_at\": \"2026-10-13T13:11:18.000000Z\",\n        \"updated_at\": \"2026-10-13T13:11:19.000000Z\",\n        \"sections\": null\n      }\n    ],\n    \"first_page_url\": \"http://127.0.0.1:8001/api/v1/ai/agent/backups?page=1\",\n    \"from\": 1,\n    \"last_page\": 1,\n    \"last_page_url\": \"http://127.0.0.1:8001/api/v1/ai/agent/backups?page=1\",\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"&laquo; Назад\",\n        \"active\": false\n      },\n      {\n        \"url\": \"http://127.0.0.1:8001/api/v1/ai/agent/backups?page=1\",\n        \"label\": \"1\",\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Далі &raquo;\",\n        \"active\": false\n      }\n    ],\n    \"next_page_url\": null,\n    \"path\": \"http://127.0.0.1:8001/api/v1/ai/agent/backups\",\n    \"per_page\": 20,\n    \"prev_page_url\": null,\n    \"to\": 18,\n    \"total\": 18\n  }\n}"}],"_postman_id":"22ec4eb0-80c5-d39f-13c7-87db4f651336"},{"name":"Get backup status","id":"bada7d2f-26fb-c0c3-2b87-9bbffc4d659b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/{{backup_id}}","description":"<p>Return <code>{{backup_id}}</code>, its status and available archive metadata.</p>\n<p>Statuses: <code>queued</code>, <code>processing</code>, <code>ready</code>, <code>failed</code>. Import/restore records also reference the prior safety backup.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups","{{backup_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"a7713686-5335-69bf-f76a-1ccc47ea3d03","name":"200 Get backup status — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/386c428b-2ecc-4cde-b551-dab35b32997f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"386c428b-2ecc-4cde-b551-dab35b32997f\",\n    \"operation\": \"backup\",\n    \"status\": \"ready\",\n    \"size\": 2869,\n    \"previous_backup_id\": null,\n    \"error\": null,\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"updated_at\": \"2026-10-14T08:19:07.000000Z\",\n    \"sections\": [\n      \"prompt\",\n      \"config\",\n      \"character\",\n      \"company_settings\",\n      \"files\",\n      \"functions\",\n      \"stop_words\",\n      \"site_scraper\"\n    ]\n  }\n}"}],"_postman_id":"bada7d2f-26fb-c0c3-2b87-9bbffc4d659b"},{"name":"Download backup","id":"57ecbb46-d993-e01c-b3cb-30df5738a604","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/{{backup_id}}/download","description":"<p>Download the private ZIP archive identified by <code>{{backup_id}}</code>.</p>\n<p><strong>Result:</strong> binary ZIP when ready; <code>409 Conflict</code> if the archive is not ready. Use <strong>Send and Download</strong> in Postman.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups","{{backup_id}}","download"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"0e6acd5c-cee6-c7e0-e539-e4687ae6b503","name":"200 Download backup — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/386c428b-2ecc-4cde-b551-dab35b32997f/download"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"value":"application/zip","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"57ecbb46-d993-e01c-b3cb-30df5738a604"},{"name":"Import backup","id":"2ebba61e-e326-701c-056a-409ab04b7745","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":"","type":"file","key":"archive"},{"value":"1","type":"text","key":"confirm"}]},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/import","description":"<p>Import a ZIP exported from this or another account.</p>\n<p><strong>Multipart:</strong> <code>archive</code> (file), <code>confirm=1</code>, optional repeated <code>sections[]</code>.</p>\n<p><strong>Result:</strong> <code>202 Accepted</code>. Without <code>sections[]</code>, all groups are selected. Poll the returned operation until complete.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups","import"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"fa952cc9-dc36-271c-aa62-0e83b0df103e","name":"202 Import backup — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"archive","type":"file","src":[]},{"key":"confirm","value":"1","type":"text"},{"key":"sections[]","value":"prompt","type":"text"}]},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/import"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"6ca9c6b5-65b4-4b96-bcb0-15bca7905ef6\",\n    \"operation\": \"import\",\n    \"status\": \"queued\",\n    \"sections\": [\n      \"prompt\"\n    ],\n    \"updated_at\": \"2026-10-14T08:19:08.000000Z\",\n    \"created_at\": \"2026-10-14T08:19:08.000000Z\"\n  }\n}"}],"_postman_id":"2ebba61e-e326-701c-056a-409ab04b7745"},{"name":"Restore backup","id":"affa8052-216c-2c33-b0d1-7bca8dc28507","request":{"method":"POST","header":[{"value":"application/json","key":"Accept"},{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"confirm\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/{{backup_id}}/restore","description":"<p>Restore the stored archive identified by <code>{{backup_id}}</code>.</p>\n<p><strong>JSON:</strong> <code>confirm=true</code>, optional <code>sections</code> array.</p>\n<p><strong>Result:</strong> <code>202 Accepted</code>. Omit <code>sections</code> to restore all groups; poll the returned operation until complete.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups","{{backup_id}}","restore"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"76dc6e72-47b6-71ed-86ee-01b279031fd3","name":"422 422 empty restore selection — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"confirm\":true,\"sections\":[]}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/1/restore"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": false,\n  \"message\": \"Поле sections є обов'язковим для заповнення.\",\n  \"errors\": {\n    \"sections\": [\n      \"Поле sections є обов'язковим для заповнення.\"\n    ]\n  }\n}"},{"id":"5cb22317-5a49-28f7-3b88-ddc94ebb38bf","name":"202 Restore backup — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"confirm\":true,\"sections\":[\"prompt\"]}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/{{backup_id}}/restore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"5c86deb7-a546-420b-b9ee-31d60069129e\",\n    \"operation\": \"restore\",\n    \"status\": \"queued\",\n    \"sections\": [\n      \"prompt\"\n    ],\n    \"updated_at\": \"2026-10-14T08:19:10.000000Z\",\n    \"created_at\": \"2026-10-14T08:19:10.000000Z\"\n  }\n}"}],"_postman_id":"affa8052-216c-2c33-b0d1-7bca8dc28507"},{"name":"Import prompt only","id":"a2e7f083-64c1-dd2c-785c-5f67648dc6f2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":"","key":"archive","type":"file"},{"value":"1","key":"confirm","type":"text"},{"value":"prompt","key":"sections[]","type":"text"}]},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/import","description":"<p>Import only the prompt from a ZIP. All other settings, files and functions remain unchanged.</p>\n<p><strong>Multipart:</strong> <code>archive</code> (file), <code>confirm=1</code>, <code>sections[]=prompt</code>.</p>\n<p><strong>Result:</strong> <code>202 Accepted</code>; a full safety backup is created before replacement.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups","import"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"7a0d78a8-bae9-ae6b-36f4-7a2146b4d960","name":"202 Import prompt only — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"archive","type":"file","src":[]},{"key":"confirm","value":"1","type":"text"},{"key":"sections[]","value":"prompt","type":"text"}]},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/import"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"8a3fa3a3-c29e-4d84-a576-653b03fc7c77\",\n    \"operation\": \"import\",\n    \"status\": \"queued\",\n    \"sections\": [\n      \"prompt\"\n    ],\n    \"updated_at\": \"2026-10-14T08:19:09.000000Z\",\n    \"created_at\": \"2026-10-14T08:19:09.000000Z\"\n  }\n}"}],"_postman_id":"a2e7f083-64c1-dd2c-785c-5f67648dc6f2"},{"name":"Restore prompt only","id":"3aaca878-a3f7-3c9d-aebd-04ee5cfc29aa","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"confirm\": true,\n  \"sections\": [\n    \"prompt\"\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/{{backup_id}}/restore","description":"<p>Restore only the prompt from <code>{{backup_id}}</code>.</p>\n<p><strong>JSON:</strong> <code>{\"confirm\":true,\"sections\":[\"prompt\"]}</code>.</p>\n<p>All unselected groups remain unchanged. <strong>Result:</strong> <code>202 Accepted</code>; a full safety backup is created first.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","agent","backups","{{backup_id}}","restore"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"546e09a5-14e4-4d1b-fe5d-626bbae4ad36","name":"202 Restore prompt only — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"confirm\":true,\"sections\":[\"prompt\"]}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/agent/backups/{{backup_id}}/restore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"39fe891b-effe-462e-a967-e5a16b4abc01\",\n    \"operation\": \"restore\",\n    \"status\": \"queued\",\n    \"sections\": [\n      \"prompt\"\n    ],\n    \"updated_at\": \"2026-10-14T08:19:12.000000Z\",\n    \"created_at\": \"2026-10-14T08:19:12.000000Z\"\n  }\n}"}],"_postman_id":"3aaca878-a3f7-3c9d-aebd-04ee5cfc29aa"}],"id":"698ae83e-9f04-4453-b434-ce0b11fe2fe7","description":"<p>Export, import or restore AI settings and knowledge files using ZIP archives.</p>\n<h3 id=\"processing\">Processing</h3>\n<p>Create/import/restore returns <code>202 Accepted</code>. Poll the operation: <code>queued</code> → <code>processing</code> → <code>ready</code> or <code>failed</code>. Download is available when ready. Import/restore creates a full prior safety backup.</p>\n<h3 id=\"selective-replacement\">Selective replacement</h3>\n<p>Omit <code>sections</code> to select all groups. Available values: <code>prompt</code>, <code>config</code>, <code>character</code>, <code>company_settings</code>, <code>files</code>, <code>functions</code>, <code>stop_words</code>, <code>site_scraper</code>.</p>\n<p>Selected groups are replaced, not merged; unselected data remains unchanged. Empty, duplicate or unknown selections return <code>422</code>. Selecting custom functions requires the destination tariff entitlement.</p>\n<h3 id=\"archive-scope\">Archive scope</h3>\n<p>Includes prompts, AI parameters/flags, character drafts, knowledge files, functions, stop words and website-source settings. Excludes API keys, balance, tariff, dialogs, logs, webhook configuration and external credentials.</p>\n<p>Maximum unpacked size: 512 MB; maximum 1,000 ZIP entries. Server upload limits may be lower.</p>\n","_postman_id":"698ae83e-9f04-4453-b434-ce0b11fe2fe7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}}],"id":"5383afe4-69c1-4036-b534-fd7128d62a87","description":"<p>Configure the company's AI profile, knowledge base and functions, inspect logs, and manage backups.</p>\n<p><strong>Access:</strong> company owner API key using the collection's Bearer authorization. Resources are scoped to the authenticated company. New endpoints require the AI Agent API release on the selected server.</p>\n<p><strong>Setup flow:</strong> get configuration options → update profile → upload files → configure functions and webhook handler → create a real API-source customer and chat → send customer messages → inspect history and logs.</p>\n<p>Testing uses real dialogs and consumes AI balance. Third-party integration credentials must be configured separately. Legacy FAQ and MCP are not part of this API.</p>\n","_postman_id":"5383afe4-69c1-4036-b534-fd7128d62a87","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"query","id":"95a34d62-3fa1-4cdd-af6f-2cd00ee6607b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"text\": \"Tell me about my order\",\n  \"customer_id\": 215\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/query","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","query"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"95a34d62-3fa1-4cdd-af6f-2cd00ee6607b"},{"name":"query custom","id":"73dddb5c-3279-1202-aded-8d7482db7d62","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"function\": \"find_order\",\n  \"arguments\": {\n    \"external_id\": \"order-1001\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/ai/query-custom","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","ai","query-custom"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"73dddb5c-3279-1202-aded-8d7482db7d62"}],"id":"6f5d3181-7ca8-4307-95ae-5aa9e1c9319b","description":"<p>Use <code>query</code> / <code>query custom</code> for the existing AI query endpoints, <code>goods</code> for product synchronization, and <code>agent</code> for AI configuration, files, functions, logs and backups.</p>\n<p>To test a configured agent with persistent history, create an API-source customer and real conversation, send customer messages, then inspect conversation history.</p>\n","_postman_id":"6f5d3181-7ca8-4307-95ae-5aa9e1c9319b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"order","item":[{"name":"list","id":"e1f99f3e-033e-4ef7-aa81-fd869a7bbe95","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/order?customer_phone={{customer_phone}}&page=1","description":"<p>List orders for the authenticated company. Optional query filters: customer_phone (partial phone match), status and resource. Use page for pagination; page size is fixed at 20. phone and external_id are not supported list filters. Orders are linked to customers by customer_phone.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","order"],"host":["app.jedidesk.com"],"query":[{"key":"customer_phone","value":"{{customer_phone}}"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"050b9ba5-e33f-0ad6-0b1f-f4d47f9528a0","name":"200 orders list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/order?customer_phone={{customer_phone}}&page=1","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","order"],"query":[{"key":"customer_phone","value":"{{customer_phone}}"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": \"[redacted]\",\n      \"external_id\": \"[redacted]\",\n      \"customer_phone\": \"[redacted]\",\n      \"customer_name\": \"[redacted]\",\n      \"status\": \"[redacted]\",\n      \"total\": 0,\n      \"currency\": \"UAH\",\n      \"products\": [\n        {\n          \"name\": \"[redacted]\",\n          \"price\": 0,\n          \"quantity\": 0,\n          \"sku\": \"[redacted]\",\n          \"price_old\": null,\n          \"total\": 0\n        }\n      ],\n      \"created_at\": \"[redacted]\",\n      \"updated_at\": \"[redacted]\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"https://app.jedidesk.com/api/v1/order?page=1\",\n    \"last\": \"https://app.jedidesk.com/api/v1/order?page=1\",\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"from\": 1,\n    \"last_page\": 1,\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"&laquo; Previous\",\n        \"active\": false\n      },\n      {\n        \"url\": \"https://app.jedidesk.com/api/v1/order?page=1\",\n        \"label\": \"1\",\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Next &raquo;\",\n        \"active\": false\n      }\n    ],\n    \"path\": \"https://app.jedidesk.com/api/v1/order\",\n    \"per_page\": 20,\n    \"to\": 1,\n    \"total\": 0\n  }\n}"}],"_postman_id":"e1f99f3e-033e-4ef7-aa81-fd869a7bbe95"},{"name":"get","id":"0ab83dff-3826-4d44-abbf-662b10ef662d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://app.jedidesk.com/api/v1/order/show?external_id=order-1001","description":"<p>Get an order by external_id for the authenticated company. This endpoint only finds orders with resource=api; orders imported from CRM integrations are available through the list endpoint.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","order","show"],"host":["app.jedidesk.com"],"query":[{"key":"external_id","value":"order-1001"}],"variable":[]}},"response":[],"_postman_id":"0ab83dff-3826-4d44-abbf-662b10ef662d"},{"name":"create","id":"6e46a216-4bad-45b9-9dd2-fa828d9da1ff","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"external_id\": \"order-1001\",\n  \"customer_phone\": \"{{customer_phone}}\",\n  \"customer_name\": \"Example Customer\",\n  \"status\": \"new\",\n  \"total\": 1200,\n  \"currency\": \"UAH\",\n  \"products\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/order/create","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","order","create"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e46a216-4bad-45b9-9dd2-fa828d9da1ff"},{"name":"edit","id":"d3f7c94f-9d2a-41fa-b377-7f647bbdf8b8","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"external_id\": \"order-1001\",\n  \"status\": \"paid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/order/edit","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","order","edit"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3f7c94f-9d2a-41fa-b377-7f647bbdf8b8"},{"name":"delete","id":"bd7cede8-a333-4e97-a1e1-d6d6cfe2dfd0","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"external_id\": \"order-1001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/order/delete","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","order","delete"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd7cede8-a333-4e97-a1e1-d6d6cfe2dfd0"}],"id":"2d0d6985-df05-4ce1-b2ff-934c08dc32be","description":"<p>Orders are external commerce/CRM records synchronized with JediDesk. They can be attached to customer support context, used in integrations and AI functions, and managed by external systems through stable external identifiers.</p>\n","_postman_id":"2d0d6985-df05-4ce1-b2ff-934c08dc32be","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"webhooks","item":[{"name":"configuration","item":[{"name":"List events","id":"a2504b96-858e-9b7a-e891-9d7959c4224e","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/events","description":"<p>Return supported subscription event names. Use these exact values in <code>events</code> when creating or updating a webhook; custom AI functions use <code>ai.func_call</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks","events"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"2cdb1f10-e9c6-ac71-3454-762b3bb430e0","name":"200 List events — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    \"customer.created\",\n    \"customer.updated\",\n    \"customer.deleted\",\n    \"chat.created\",\n    \"chat.updated\",\n    \"chat.deleted\",\n    \"message.created\",\n    \"message.updated\",\n    \"message.deleted\",\n    \"ai.func_call\"\n  ]\n}"}],"_postman_id":"a2504b96-858e-9b7a-e891-9d7959c4224e"},{"name":"List webhooks","id":"f85fa634-c4c3-65ed-358a-7c9dcd1db81d","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks?per_page=20","description":"<p>Return the company's registered webhook URLs and subscribed events.</p>\n<p><strong>Pagination:</strong> <code>page</code>, <code>per_page</code> (1–100; default 20). URL query values are hidden in responses.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks"],"host":["app.jedidesk.com"],"query":[{"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"ba75bf48-6477-af96-7c1f-f5af5cfe9f68","name":"200 List webhooks — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"current_page\": 1,\n    \"data\": [\n      {\n        \"id\": 2,\n        \"url\": \"http://127.0.0.1:8002\",\n        \"events\": [\n          \"ai.func_call\"\n        ],\n        \"created_at\": \"2026-10-13T13:21:39.000000Z\",\n        \"updated_at\": \"2026-10-13T13:21:39.000000Z\"\n      }\n    ],\n    \"first_page_url\": \"http://127.0.0.1:8001/api/v1/webhooks?page=1\",\n    \"from\": 1,\n    \"last_page\": 1,\n    \"last_page_url\": \"http://127.0.0.1:8001/api/v1/webhooks?page=1\",\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"&laquo; Назад\",\n        \"active\": false\n      },\n      {\n        \"url\": \"http://127.0.0.1:8001/api/v1/webhooks?page=1\",\n        \"label\": \"1\",\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Далі &raquo;\",\n        \"active\": false\n      }\n    ],\n    \"next_page_url\": null,\n    \"path\": \"http://127.0.0.1:8001/api/v1/webhooks\",\n    \"per_page\": 20,\n    \"prev_page_url\": null,\n    \"to\": 1,\n    \"total\": 1\n  }\n}"}],"_postman_id":"f85fa634-c4c3-65ed-358a-7c9dcd1db81d"},{"name":"Create webhook","event":[{"listen":"test","script":{"type":"text/javascript","exec":["if (pm.response.code === 201) pm.collectionVariables.set('webhook_id', pm.response.json().data.id);"]}}],"id":"1649056a-3b6d-2356-068b-f9e15e0a8ca2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"url\": \"{{webhook_url}}\",\n  \"events\": [\n    \"ai.func_call\"\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/webhooks","description":"<p>Register a destination using <code>url</code> and a nonempty, distinct <code>events</code> array.</p>\n<p><strong>Result:</strong> <code>201 Created</code>; save <code>data.id</code> as <code>webhook_id</code>. The test script stores it automatically. Registration does not send a test delivery.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"4eef10ca-edf3-99cc-2507-96f9c07aa81f","name":"201 Create webhook — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"url\":\"{{webhook_url}}\",\"events\":[\"chat.updated\"]}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/webhooks"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 4,\n    \"url\": \"http://127.0.0.1:8002\",\n    \"events\": [\n      \"chat.updated\"\n    ],\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\"\n  }\n}"},{"id":"3863586c-be2a-d0f8-360d-c30acc9a466e","name":"422 422 webhook URL — local QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"url\":\"http://169.254.169.254\",\"events\":[\"ai.func_call\"]}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/webhooks"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": false,\n  \"message\": \"Webhook URL must resolve only to public HTTP(S) addresses on port 80 or 443, without credentials or fragments.\",\n  \"errors\": {\n    \"url\": [\n      \"Webhook URL must resolve only to public HTTP(S) addresses on port 80 or 443, without credentials or fragments.\"\n    ]\n  }\n}"}],"_postman_id":"1649056a-3b6d-2356-068b-f9e15e0a8ca2"},{"name":"Get webhook","id":"87a7ed43-824d-9ad3-45b6-638dd26cfdc5","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/{{webhook_id}}","description":"<p>Return the URL and event subscriptions of <code>{{webhook_id}}</code>. URL query values are redacted; retain the original URL for future updates.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks","{{webhook_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"26171985-9a92-18aa-e8b9-a4ed8f6b91f5","name":"200 Get webhook — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 4,\n    \"url\": \"http://127.0.0.1:8002\",\n    \"events\": [\n      \"chat.updated\"\n    ],\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\"\n  }\n}"},{"id":"30dd5e26-c992-5d8d-0dda-10d4de63e2ec","name":"404 404 webhook — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/999999999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Resource not found\"\n}"}],"_postman_id":"87a7ed43-824d-9ad3-45b6-638dd26cfdc5"},{"name":"Update webhook","id":"d1fa8a79-74ab-c286-4c9b-96f7c16c80d6","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"url\": \"{{webhook_url}}\",\n  \"events\": [\n    \"ai.func_call\"\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/webhooks/{{webhook_id}}","description":"<p>Replace the destination URL and complete event subscription list for <code>{{webhook_id}}</code>.</p>\n<p><strong>JSON:</strong> both <code>url</code> and <code>events</code> are required. Send the original destination URL, not its redacted representation. Updating does not send a test delivery.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks","{{webhook_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"71a1eca2-001b-de59-8c91-60caf5f52b0f","name":"200 Update webhook — local QA","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"url\":\"{{webhook_url}}\",\"events\":[\"customer.updated\"]}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/webhooks/4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 4,\n    \"url\": \"http://127.0.0.1:8002\",\n    \"events\": [\n      \"customer.updated\"\n    ],\n    \"created_at\": \"2026-10-14T08:19:06.000000Z\",\n    \"updated_at\": \"2026-10-14T08:19:06.000000Z\"\n  }\n}"}],"_postman_id":"d1fa8a79-74ab-c286-4c9b-96f7c16c80d6"},{"name":"Delete webhook","id":"d54b9f62-9f0b-3b75-d1db-97a5db0e74dd","request":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/{{webhook_id}}","description":"<p>Delete <code>{{webhook_id}}</code> and its delivery logs. This does not delete AI function definitions.</p>\n<p><strong>Result:</strong> <code>204 No Content</code>. Deletion is permanent.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks","{{webhook_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"7a215db9-cf50-72e6-a57a-55c584f9a89c","name":"204 Delete webhook — local QA","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/4"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d54b9f62-9f0b-3b75-d1db-97a5db0e74dd"}],"id":"dfbf645d-1122-4853-a927-79ac38c0dbf7","description":"<p>Register and manage company webhook destinations and event subscriptions.</p>\n<p><strong>Destination requirements:</strong> public HTTP(S) URL on port 80 or 443, without embedded credentials or fragments. Private/reserved IPs and redirects are blocked; DNS is checked again before delivery. Connection timeout: 5 seconds; total timeout: 20 seconds.</p>\n<p>The outgoing envelope contains <code>event</code>, <code>data</code>, <code>timestamp</code>, <code>token</code> and <code>request_id</code>. Use a trusted HTTPS handler and protect the company token. Registration does not send a test delivery; trigger the subscribed event and inspect delivery logs.</p>\n","_postman_id":"dfbf645d-1122-4853-a927-79ac38c0dbf7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"delivery logs","item":[{"name":"List delivery logs","id":"e368a1c2-40cd-d8e9-6674-6c555ae35599","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/{{webhook_id}}/logs?per_page=20&event=ai.func_call","description":"<p>Return paginated deliveries for <code>{{webhook_id}}</code>.</p>\n<p><strong>Filters:</strong> <code>event</code>, <code>response_status</code>, <code>request_id</code> (UUID), <code>conversation_id</code>, <code>function_name</code>, <code>from</code>, <code>to</code>, <code>page</code>, <code>per_page</code> (1–100).</p>\n<p>Dates are compared in UTC. <code>response_status=0</code> indicates a transport failure. Tokens, authorization and named email/phone fields are redacted.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks","{{webhook_id}}","logs"],"host":["app.jedidesk.com"],"query":[{"key":"per_page","value":"20"},{"key":"event","value":"ai.func_call"}],"variable":[]}},"response":[{"id":"98ec03ef-3d98-dfb3-c320-a629f6ce27d5","name":"200 List delivery logs — local QA","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/webhooks/2/logs?conversation_id=1382","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","webhooks","2","logs"],"query":[{"key":"conversation_id","value":"1382"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"current_page\": 1,\n    \"data\": [\n      {\n        \"id\": 14,\n        \"webhook_id\": 2,\n        \"event\": \"ai.func_call\",\n        \"request\": {\n          \"data\": {\n            \"chat\": {\n              \"chat_id\": 1382,\n              \"customer_id\": 2558\n            },\n            \"function\": \"qa_api_webhook\",\n            \"parameters\": {\n              \"marker\": \"WEBHOOK-FAIL\"\n            }\n          },\n          \"event\": \"ai.func_call\",\n          \"token\": \"[redacted]\",\n          \"timestamp\": \"2026-10-13T17:04:53+00:00\",\n          \"request_id\": \"8e232618-f391-48eb-be4c-42db656d6c91\"\n        },\n        \"response_status\": 500,\n        \"response_body\": {\n          \"error\": \"QA_WEBHOOK_FAILURE\"\n        },\n        \"attempts\": 1,\n        \"last_attempt_at\": \"2026-10-13 17:04:53\",\n        \"created_at\": \"2026-10-13T17:04:53.000000Z\"\n      },\n      {\n        \"id\": 13,\n        \"webhook_id\": 2,\n        \"event\": \"ai.func_call\",\n        \"request\": {\n          \"data\": {\n            \"chat\": {\n              \"chat_id\": 1382,\n              \"customer_id\": 2558\n            },\n            \"function\": \"qa_api_webhook\",\n            \"parameters\": {\n              \"marker\": \"WEBHOOK-API-20261013\"\n            }\n          },\n          \"event\": \"ai.func_call\",\n          \"token\": \"[redacted]\",\n          \"timestamp\": \"2026-10-13T17:03:14+00:00\",\n          \"request_id\": \"e44f6157-b8be-4dd0-8fcd-bc50a76e62c8\"\n        },\n        \"response_status\": 200,\n        \"response_body\": {\n          \"marker\": \"WEBHOOK-API-20261013\",\n          \"result\": \"QA_WEBHOOK_OK\",\n          \"function\": \"qa_api_webhook\"\n        },\n        \"attempts\": 1,\n        \"last_attempt_at\": \"2026-10-13 17:03:14\",\n        \"created_at\": \"2026-10-13T17:03:14.000000Z\"\n      }\n    ],\n    \"first_page_url\": \"http://127.0.0.1:8001/api/v1/webhooks/2/logs?page=1\",\n    \"from\": 1,\n    \"last_page\": 1,\n    \"last_page_url\": \"http://127.0.0.1:8001/api/v1/webhooks/2/logs?page=1\",\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"&laquo; Назад\",\n        \"active\": false\n      },\n      {\n        \"url\": \"http://127.0.0.1:8001/api/v1/webhooks/2/logs?page=1\",\n        \"label\": \"1\",\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Далі &raquo;\",\n        \"active\": false\n      }\n    ],\n    \"next_page_url\": null,\n    \"path\": \"http://127.0.0.1:8001/api/v1/webhooks/2/logs\",\n    \"per_page\": 20,\n    \"prev_page_url\": null,\n    \"to\": 2,\n    \"total\": 2\n  }\n}"}],"_postman_id":"e368a1c2-40cd-d8e9-6674-6c555ae35599"},{"name":"Get delivery log","id":"b369fb41-688a-699a-5a2f-7f243b143285","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/{{webhook_id}}/logs/{{webhook_log_id}}","description":"<p>Return the delivery identified by <code>{{webhook_log_id}}</code> under <code>{{webhook_id}}</code>, including request, response, HTTP status, attempts and timestamps. Sensitive structured fields are redacted.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","webhooks","{{webhook_id}}","logs","{{webhook_log_id}}"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[{"id":"4c1190c6-3ae8-8b3e-2a81-b86756b99512","name":"200 Get delivery log — local QA","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/webhooks/2/logs/14"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": 14,\n    \"webhook_id\": 2,\n    \"event\": \"ai.func_call\",\n    \"request\": {\n      \"data\": {\n        \"chat\": {\n          \"chat_id\": 1382,\n          \"customer_id\": 2558\n        },\n        \"function\": \"qa_api_webhook\",\n        \"parameters\": {\n          \"marker\": \"WEBHOOK-FAIL\"\n        }\n      },\n      \"event\": \"ai.func_call\",\n      \"token\": \"[redacted]\",\n      \"timestamp\": \"2026-10-13T17:04:53+00:00\",\n      \"request_id\": \"8e232618-f391-48eb-be4c-42db656d6c91\"\n    },\n    \"response_status\": 500,\n    \"response_body\": {\n      \"error\": \"QA_WEBHOOK_FAILURE\"\n    },\n    \"attempts\": 1,\n    \"last_attempt_at\": \"2026-10-13 17:04:53\",\n    \"created_at\": \"2026-10-13T17:04:53.000000Z\"\n  }\n}"}],"_postman_id":"b369fb41-688a-699a-5a2f-7f243b143285"}],"id":"91e34a3c-b110-47ca-8aca-61a7e3d1bd32","description":"<p>Inspect delivery attempts for a registered webhook. First obtain <code>webhook_id</code> from configuration, then inspect/filter the delivery list and use a returned ID as <code>webhook_log_id</code>.</p>\n","_postman_id":"91e34a3c-b110-47ca-8aca-61a7e3d1bd32","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"payload examples","item":[{"name":"outgoing message event payload","id":"14a2efe9-97cd-7691-ff85-2a46674e5c4f","request":{"method":"POST","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n  \"event\": \"message.created\",\n  \"data\": {\n    \"id\": 4998,\n    \"chat_id\": 120,\n    \"from\": \"customer\",\n    \"type\": \"message\",\n    \"text\": \"Hello\",\n    \"media\": null,\n    \"customer\": {\n      \"id\": 215,\n      \"platform\": \"instagram\",\n      \"platform_id\": \"17841400000000000\"\n    },\n    \"integration\": {\n      \"id\": 55,\n      \"platform\": \"instagram\",\n      \"external_id\": \"17841411111111111\",\n      \"name\": \"Shop Instagram\",\n      \"username\": \"shop_ig\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/your-webhook-url","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["your-webhook-url"],"host":["example","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"14a2efe9-97cd-7691-ff85-2a46674e5c4f"}],"id":"a2601414-89af-49d9-bf47-5e59bffab7ea","description":"<p>Examples of outgoing payloads sent by JediDesk to your handler. These example destinations are not JediDesk API endpoints.</p>\n","_postman_id":"a2601414-89af-49d9-bf47-5e59bffab7ea","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}}],"id":"91d58e48-74a3-4c1e-a89b-8f328284ba38","description":"<p>Configure outgoing webhook subscriptions, inspect delivery logs and review sample event payloads. API management endpoints and outbound payload examples are separated below.</p>\n","_postman_id":"91d58e48-74a3-4c1e-a89b-8f328284ba38","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}},{"name":"utm","item":[{"name":"list","id":"b8161274-b359-c263-5e1f-0dc849d6ebc4","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/utm?name=Example campaign&tag=example&sort=-created_at","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","utm"],"host":["app.jedidesk.com"],"query":[{"key":"name","value":"Example campaign"},{"key":"tag","value":"example"},{"key":"sort","value":"-created_at"}],"variable":[]}},"response":[],"_postman_id":"b8161274-b359-c263-5e1f-0dc849d6ebc4"},{"name":"get","id":"4c2fea03-7a27-dbdc-7c83-fb52af9ee173","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/utm/12","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","utm","12"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c2fea03-7a27-dbdc-7c83-fb52af9ee173"},{"name":"create","id":"1c1e4558-1098-c007-399d-905bf0ae1497","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Instagram guide campaign\",\n  \"code\": \"ig-guide-2026\",\n  \"text\": \"Thanks for your interest. Here is the guide:\",\n  \"tag\": \"Lead magnet\",\n  \"keywords\": [\n    \"guide\",\n    \"price\"\n  ],\n  \"buttons\": [\n    {\n      \"name\": \"Open guide\",\n      \"link\": \"https://example.com/guide\"\n    }\n  ],\n  \"is_only_subscribers\": true,\n  \"subscriber_text\": \"Subscribe to our page and tap Check.\",\n  \"subscriber_button\": \"Check\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/utm","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","utm"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c1e4558-1098-c007-399d-905bf0ae1497"},{"name":"edit","id":"179083b5-5746-54c0-a69d-8203956bd410","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Instagram guide campaign\",\n  \"text\": \"Updated guide text\",\n  \"tag\": \"Lead magnet\",\n  \"keywords\": [\n    \"guide\",\n    \"demo\"\n  ],\n  \"buttons\": [\n    {\n      \"name\": \"Open guide\",\n      \"link\": \"https://example.com/guide\"\n    }\n  ],\n  \"is_only_subscribers\": false,\n  \"subscriber_text\": null,\n  \"subscriber_button\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/utm/12","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","utm","12"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"179083b5-5746-54c0-a69d-8203956bd410"},{"name":"delete","id":"c6b53414-1d76-9e00-b09c-a674e147202a","request":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/utm/12","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","utm","12"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6b53414-1d76-9e00-b09c-a674e147202a"},{"name":"tags","id":"83f1ab93-262c-26c6-a6c0-7c39fd8b9d47","request":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/utm/tags","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","utm","tags"],"host":["app.jedidesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"83f1ab93-262c-26c6-a6c0-7c39fd8b9d47"}],"id":"f1492c13-7d50-49fd-a379-a04311ef3684","description":"<p>UTM campaigns describe marketing trigger flows connected to integrations and customer entry points. They store a campaign code, keywords, reply text, buttons, tag, optional subscriber checks and analytics, so external systems can create and maintain acquisition/automation flows through the API.</p>\n","_postman_id":"f1492c13-7d50-49fd-a379-a04311ef3684","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]},"isInherited":true,"source":{"_postman_id":"b735d3ed-5fca-4b3d-8444-297321200d93","id":"b735d3ed-5fca-4b3d-8444-297321200d93","name":"#jedidesk REST API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"key":"domain","value":"app.jedidesk.com"},{"key":"api_key","value":"zL4a40BpPTjYusyLE9aa7PmmYK1GoYrVk2F \n(This is an example token. Replace it with your own token)"}]}