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.
\n","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":"2025-04-23T11:53:28.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":"Return support productivity analytics for the authenticated company.
\nUse this endpoint to get conversation volume and median handling timings for a selected period. The response contains an overall summary and daily series rows.
Metrics:
\nconversations_total: conversations opened or closed during the period.conversations_new: conversations opened during the period.conversations_closed: conversations closed during the period.first_response_median_seconds: median time to first manager response.close_time_median_seconds: median time to close a conversation.Start date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"End date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"},{"description":{"content":"Optional manager filter. Omit to return company-wide data.
\n","type":"text/plain"},"key":"manager_id","value":"42"}],"variable":[]}},"response":[{"id":"560b43a0-a15e-b954-1646-0c1e70ffefe8","name":"200 productivity analytics","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/analytics/productivity?date_from=2026-07-01&date_to=2026-07-23&manager_id=42","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","productivity"],"query":[{"key":"date_from","value":"2026-07-01","description":"Start date of the reporting period. Required."},{"key":"date_to","value":"2026-07-23","description":"End date of the reporting period. Required."},{"key":"manager_id","value":"42","description":"Optional manager filter. Omit to return company-wide data."}]},"description":"Return support productivity analytics for the authenticated company.\n\nUse this endpoint to get conversation volume and median handling timings for a selected period. The response contains an overall `summary` and daily `series` rows.\n\nMetrics:\n- `conversations_total`: conversations opened or closed during the period.\n- `conversations_new`: conversations opened during the period.\n- `conversations_closed`: conversations closed during the period.\n- `first_response_median_seconds`: median time to first manager response.\n- `close_time_median_seconds`: median time to close a conversation."},"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":"Return support quality analytics for the authenticated company.
\nUse this endpoint to get quality ratings for closed conversations in a selected period. The response contains an overall summary, daily series, and paginated rated conversation items.
Ratings are returned as bad_count, middle_count, and perfect_count. quality_level_percent is the percentage of perfect ratings among all rated conversations.
Start date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"End date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"},{"description":{"content":"Optional manager filter. Omit to return company-wide data.
\n","type":"text/plain"},"key":"manager_id","value":"42"},{"description":{"content":"Page for rated conversation items.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page for rated conversation items. Max 100.
\n","type":"text/plain"},"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"b5f5e5ea-13cf-39c0-5694-e9f156d83daf","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=42&page=1&per_page=20","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","quality"],"query":[{"key":"date_from","description":"Start date of the reporting period. Required.","value":"2026-07-01"},{"key":"date_to","description":"End date of the reporting period. Required.","value":"2026-07-23"},{"key":"manager_id","description":"Optional manager filter. Omit to return company-wide data.","value":"42"},{"key":"page","description":"Page for rated conversation items.","value":"1"},{"key":"per_page","description":"Items per page for rated conversation items. Max 100.","value":"20"}]},"description":"Return support quality analytics for the authenticated company.\n\nUse this endpoint to get quality ratings for closed conversations in a selected period. The response contains an overall `summary`, daily `series`, and paginated rated conversation `items`.\n\nRatings are returned as `bad_count`, `middle_count`, and `perfect_count`. `quality_level_percent` is the percentage of perfect ratings among all rated conversations."},"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\": \"Yurii Vorona\",\n \"customer_image_url\": \"https://app.jedidesk.com/storage/customers/avatar.jpg\",\n \"manager_name\": \"Support 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":"Return conversation subject analytics for the authenticated company.
\nUse this endpoint to see which active subjects were assigned to conversations in a selected period. Each subject contains count and percent relative to total conversations in the same filtered period.
Start date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"End date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"},{"description":{"content":"Optional manager filter. Omit to return company-wide data.
\n","type":"text/plain"},"key":"manager_id","value":"42"}],"variable":[]}},"response":[{"id":"1c1622b3-eb96-9fb4-5738-b4c0646c6f0d","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=42","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","analytics","subjects"],"query":[{"key":"date_from","description":"Start date of the reporting period. Required.","value":"2026-07-01"},{"key":"date_to","description":"End date of the reporting period. Required.","value":"2026-07-23"},{"key":"manager_id","description":"Optional manager filter. Omit to return company-wide data.","value":"42"}]},"description":"Return conversation subject analytics for the authenticated company.\n\nUse this endpoint to see which active subjects were assigned to conversations in a selected period. Each subject contains `count` and `percent` relative to total conversations in the same filtered period."},"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":"Return AI summary analytics for the authenticated company.
\nUse this endpoint to measure how much AI participated in support answers and conversation closing for a selected period.
\nMetrics:
\nai_answers_count: manager messages generated with AI.ai_answer_request_percent: percentage of manager messages that used AI.ai_closed_conversations_percent: percentage of closed conversations handled only by AI messages without manual manager replies in the same period.Future GET /api/v1/analytics/ai/usage 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.
Start date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_from","value":"2026-07-01"},{"description":{"content":"End date of the reporting period. Required.
\n","type":"text/plain"},"key":"date_to","value":"2026-07-23"}],"variable":[]}},"response":[{"id":"ab51c510-bbc0-fadc-2837-2bef8abf6e53","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":[{"value":"2026-07-01","key":"date_from","description":"Start date of the reporting period. Required."},{"value":"2026-07-23","key":"date_to","description":"End date of the reporting period. Required."}]},"description":"Return AI summary analytics for the authenticated company.\n\nUse this endpoint to measure how much AI participated in support answers and conversation closing for a selected period.\n\nMetrics:\n- `ai_answers_count`: manager messages generated with AI.\n- `ai_answer_request_percent`: percentage of manager messages that used AI.\n- `ai_closed_conversations_percent`: percentage of closed conversations handled only by AI messages without manual manager replies in the same period.\n\nFuture `GET /api/v1/analytics/ai/usage` 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."},"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":"Return customer custom field definitions for the authenticated company.
\nUse these field id values when setting customer custom field values in customers/create or customers/edit via custom_fields: [{ \"id\": 103, \"value\": \"...\" }].
Available field types: integer, string, phone, email, link. Use status=active to return only active fields.
Create a customer custom field definition for the authenticated company.
\nAfter the field is created, use its id in customers/create or customers/edit to set values for specific customers.
Available field types: integer, string, phone, email, link.
\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":"bce20b0f-9dc0-817d-bfcd-01add85e7169","name":"200 customer custom field created","originalRequest":{"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":"Create a customer custom field definition for the authenticated company.\n\nAfter the field is created, use its `id` in `customers/create` or `customers/edit` to set values for specific customers.\n\nAvailable field types: integer, string, phone, email, link."},"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":"Return one customer custom field definition by id.
\nUse this to inspect field metadata before assigning values to customers.
\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":"8af4f1c9-49fd-4690-dd3e-3bf035f22e3b","name":"200 customer custom field details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/103","description":"Return one customer custom field definition by id.\n\nUse this to inspect field metadata before assigning values to customers."},"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":"Edit a customer custom field definition by id.
\nThe payload is partial: send only fields that should change. Supported fields: name, type, sort, status, data.
Delete a customer custom field definition by id.
\nDeleting a field also removes customer values linked to this field because linked values reference the field with cascade delete.
\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":"077f282c-a061-72d4-775e-f3d373a1c39c","name":"200 customer custom field deleted","originalRequest":{"method":"DELETE","header":[],"url":"https://app.jedidesk.com/api/v1/customer-custom-fields/103","description":"Delete a customer custom field definition by id.\n\nDeleting a field also removes customer values linked to this field because linked values reference the field with cascade delete."},"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":"Customer custom fields are field definitions configured for a company. Use this folder to create and manage the available fields, then use their id values in customer create/update payloads as custom_fields: [{ \"id\": 103, \"value\": \"...\" }].
JSON request body.
\n"}],"body":{"mode":"raw","raw":"{\n \"bot_id\": 55,\n \"platform_id\": \"external-user-1001\",\n \"name\": \"Yurii Vorona\",\n \"username\": \"yuvdevlpr\",\n \"phone\": \"380989898999\",\n \"email\": \"client@example.com\",\n \"status\": \"active\",\n \"language\": \"uk\",\n \"note\": \"Created by API\",\n \"tags\": [\"VIP\"],\n \"custom_fields\": [\n {\n \"id\": 103,\n \"value\": \"https://example.com/profile\"\n }\n ]\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"}],"id":"5a04cbb4-6d2d-483c-a1f2-fa89c0264720","description":"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.
\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":"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.
\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":"3c60d24b-9b70-706f-a3e6-bc7a6950f240","name":"200 chats list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/chats?customer_id=215&status=open&platform=instagram&team_id=4&sort=-id","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","chats"],"query":[{"key":"customer_id","value":"215"},{"key":"status","value":"open"},{"key":"platform","value":"instagram"},{"key":"team_id","value":"4"},{"key":"sort","value":"-id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 120,\n \"customer\": {\n \"id\": 215,\n \"name\": \"Yurii Vorona\",\n \"platform\": \"telegram\",\n \"platform_id\": \"384607648\"\n },\n \"integration\": {\n \"id\": 55,\n \"platform\": \"telegram\",\n \"external_id\": \"17841411111111111\",\n \"name\": \"Support account\",\n \"username\": \"shop_support\"\n },\n \"manager\": {\n \"id\": 17,\n \"name\": \"Manager\"\n },\n \"team\": {\n \"id\": 4,\n \"name\": \"Sales\"\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":"cd986f4e-b086-f3df-63ca-a5a613f7e2a2","name":"200 chat details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/chats/120"},"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\": 120,\n \"customer\": {\n \"id\": 215,\n \"name\": \"Yurii Vorona\",\n \"platform_id\": \"384607648\"\n },\n \"integration\": {\n \"id\": 55,\n \"platform\": \"telegram\",\n \"external_id\": \"17841411111111111\",\n \"name\": \"Support account\",\n \"username\": \"shop_support\"\n },\n \"status\": \"open\",\n \"team\": {\n \"id\": 4,\n \"name\": \"Sales\"\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":[{"value":"application/json","key":"Content-Type","description":"JSON request body.
\n"}],"body":{"mode":"raw","raw":"{\n \"bot_id\": 55,\n \"phone\": \"380989898999\",\n \"username\": \"yuvdevlpr\",\n \"name\": \"Yurii Vorona\",\n \"text\": \"Hello from JediDesk\",\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":"76f2be91-7cb3-ab28-5da0-7bc4eefe526e","name":"200 first outgoing message sent","originalRequest":{"method":"POST","header":[{"value":"application/json","key":"Content-Type","description":"JSON request body."}],"body":{"mode":"raw","raw":"{\n \"bot_id\": 55,\n \"phone\": \"380989898999\",\n \"username\": \"yuvdevlpr\",\n \"name\": \"Yurii Vorona\",\n \"text\": \"Hello from JediDesk\",\n \"media\": null,\n \"type\": \"message\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.jedidesk.com/api/v1/chats/start-message"},"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\": 4998,\n \"chat_id\": 120,\n \"from\": \"manager\",\n \"type\": \"message\",\n \"text\": \"Hello from JediDesk\",\n \"platform_id\": \"0c1fc457-4f53-4cc4-9d74-bf9d3f2526f5\",\n \"additional_info\": {\n \"echat_response\": {\n \"status\": \"Success\",\n \"description\": \"Message accepted by provider\"\n }\n },\n \"status\": \"send\"\n },\n \"chat_id\": 120\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":"28a48bf2-ad06-95ed-4d44-2fe223caf115","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\": 55,\n \"platform\": \"telegram\",\n \"external_id\": null,\n \"name\": \"Support account\",\n \"username\": \"shop_support\"\n }\n ]\n}"}],"_postman_id":"48357241-7bfb-605b-e456-45e4fdb7930b"}],"id":"004504b6-7d09-4a55-94d5-ef537f6c4954","description":"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.
\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":"f638d3bf-3da8-bb1a-8242-7952f4add38d","name":"200 messages list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/messages?chat_id=120&from=customer&type=message&sort=-id","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","messages"],"query":[{"key":"chat_id","value":"120"},{"key":"from","value":"customer"},{"key":"type","value":"message"},{"key":"sort","value":"-id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 4998,\n \"chat_id\": 120,\n \"customer\": {\n \"id\": 215,\n \"name\": \"Yurii Vorona\",\n \"platform\": \"telegram\",\n \"platform_id\": \"384607648\"\n },\n \"integration\": {\n \"id\": 55,\n \"platform\": \"telegram\",\n \"external_id\": \"17841411111111111\",\n \"name\": \"Support account\",\n \"username\": \"shop_support\"\n },\n \"from\": \"customer\",\n \"type\": \"message\",\n \"text\": \"Hello\",\n \"media\": null,\n \"platform_id\": \"msg-1001\",\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":"4818bc4b-a835-1376-e78c-3593349a42ed","name":"200 message details","originalRequest":{"method":"GET","header":[],"url":"https://app.jedidesk.com/api/v1/messages/4998"},"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\": 4998,\n \"chat_id\": 120,\n \"customer\": {\n \"id\": 215,\n \"name\": \"Yurii Vorona\",\n \"platform_id\": \"384607648\"\n },\n \"integration\": {\n \"id\": 55,\n \"platform\": \"telegram\",\n \"external_id\": \"17841411111111111\",\n \"name\": \"Support account\",\n \"username\": \"shop_support\"\n },\n \"from\": \"manager\",\n \"type\": \"message\",\n \"text\": \"Hello from JediDesk\",\n \"media\": null,\n \"platform_id\": \"0c1fc457-4f53-4cc4-9d74-bf9d3f2526f5\",\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"}],"id":"7bd26c68-d0f0-4b95-8dfa-22697d333544","description":"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.
\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":"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.
\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":"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":"AI endpoints allow external systems to use JediDesk AI logic. Use them to send a query to configured AI behavior or call custom AI functions connected to company data and workflows.
\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/list?phone=380989898999&external_id=order-1001","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","list"],"host":["app.jedidesk.com"],"query":[{"key":"phone","value":"380989898999"},{"key":"external_id","value":"order-1001"}],"variable":[]}},"response":[{"id":"d0268666-cb89-f0bb-1c46-ed740aa2c7b0","name":"200 orders list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.jedidesk.com/api/v1/order/list?phone=380989898999&external_id=order-1001","protocol":"https","host":["app.jedidesk.com"],"path":["api","v1","order","list"],"query":[{"key":"phone","value":"380989898999"},{"key":"external_id","value":"order-1001"}]}},"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\": 901,\n \"external_id\": \"order-1001\",\n \"phone\": \"380989898999\",\n \"name\": \"Yurii Vorona\",\n \"status\": \"paid\",\n \"amount\": 1200,\n \"currency\": \"UAH\",\n \"products\": [\n {\n \"external_id\": \"sku-1001\",\n \"name\": \"Product name\",\n \"price\": 1200,\n \"quantity\": 1\n }\n ],\n \"created_at\": \"2026-07-22T23:30:00.000000Z\",\n \"updated_at\": \"2026-07-22T23:59:00.000000Z\"\n }\n ]\n}"}],"_postman_id":"e1f99f3e-033e-4ef7-aa81-fd869a7bbe95"},{"name":"get","id":"0ab83dff-3826-4d44-abbf-662b10ef662d","request":{"method":"POST","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/get","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","get"],"host":["app.jedidesk.com"],"query":[],"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 \"phone\": \"380989898999\",\n \"name\": \"Yurii Vorona\",\n \"status\": \"new\",\n \"amount\": 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":"POST","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":"POST","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":"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.
\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":"outgoing message event payload","id":"14a2efe9-97cd-7691-ff85-2a46674e5c4f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"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":"91d58e48-74a3-4c1e-a89b-8f328284ba38","description":"Webhooks document outgoing payloads sent from JediDesk to external systems. These examples describe what your external webhook endpoint receives; they are not endpoints that should be called on JediDesk.
\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=Instagram&tag=Lead&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":"Instagram"},{"key":"tag","value":"Lead"},{"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":"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.
\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)"}]}