{ "info": { "name": "Inboxy API", "description": "Every operation an Inboxy API key can call. Set the apiKey variable to your inboxy_ token.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.inboxy.chat" }, { "key": "apiKey", "value": "inboxy_your_token" } ], "item": [ { "name": "Contacts", "item": [ { "name": "List contacts", "request": { "method": "GET", "description": "Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts" ], "variable": [], "query": [ { "key": "search", "value": "", "description": "Name, phone or email.", "disabled": true }, { "key": "tagIds", "value": "", "description": "Comma-separated tag ids.", "disabled": true }, { "key": "hasPhone", "value": "", "disabled": true }, { "key": "hasEmail", "value": "", "disabled": true }, { "key": "hasOrders", "value": "", "disabled": true }, { "key": "channelType", "value": "", "description": "Channel the contact came from.", "disabled": true }, { "key": "source", "value": "", "description": "Comma-separated sources (MANUAL, WHATSAPP, SHOPIFY, …).", "disabled": true }, { "key": "status", "value": "", "description": "Comma-separated: ACTIVE, INACTIVE, ARCHIVED.", "disabled": true }, { "key": "label", "value": "", "description": "Comma-separated: HOT_LEAD, WARM_LEAD, COLD_LEAD, FOLLOW_UP, VIP, CHURNED, DO_NOT_CONTACT.", "disabled": true }, { "key": "lifecycleStage", "value": "", "description": "Comma-separated: LEAD, SUBSCRIBER, OPPORTUNITY, CUSTOMER, REPEAT_CUSTOMER, EVANGELIST.", "disabled": true }, { "key": "assignedAgentId", "value": "", "disabled": true }, { "key": "minTotalSpent", "value": "", "disabled": true }, { "key": "maxTotalSpent", "value": "", "disabled": true }, { "key": "lastInteractionAfter", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "lastInteractionBefore", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "createdAfter", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "createdBefore", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sort direction.", "disabled": true } ] } } }, { "name": "Create a contact", "request": { "method": "POST", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Al-Otaibi\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"avatar\": \"avatar\",\n \"externalId\": \"externalId\",\n \"customFields\": {},\n \"tagIds\": [\n \"tagIds\"\n ]\n}" } } }, { "name": "Search contacts", "request": { "method": "GET", "description": "Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "search" ], "variable": [], "query": [ { "key": "q", "value": "", "description": "Name, phone or email to search for.", "disabled": false }, { "key": "limit", "value": "", "description": "Max results (default 10).", "disabled": true } ] } } }, { "name": "Find a contact or create it", "request": { "method": "POST", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/find-or-create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "find-or-create" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"phone\": \"966500000000\",\n \"name\": \"Ahmed Al-Otaibi\"\n}" } } }, { "name": "List custom field keys", "request": { "method": "GET", "description": "Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/custom-field-keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "custom-field-keys" ], "variable": [], "query": [] } } }, { "name": "Get a contact", "request": { "method": "GET", "description": "Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a contact", "request": { "method": "PUT", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Al-Otaibi\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"avatar\": \"avatar\",\n \"externalId\": \"externalId\",\n \"customFields\": {},\n \"tagIds\": [\n \"tagIds\"\n ],\n \"label\": \"HOT_LEAD\",\n \"status\": \"ACTIVE\",\n \"lifecycleStage\": \"LEAD\",\n \"assignedAgentId\": \"assignedAgentId\",\n \"notes\": \"notes\"\n}" } } }, { "name": "Delete a contact", "request": { "method": "DELETE", "description": "Requires contacts:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Add a tag to a contact", "request": { "method": "POST", "description": "Requires contacts:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "tags", ":tagId" ], "variable": [ { "key": "id", "value": "" }, { "key": "tagId", "value": "" } ], "query": [] } } }, { "name": "Remove a tag from a contact", "request": { "method": "DELETE", "description": "Requires contacts:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "tags", ":tagId" ], "variable": [ { "key": "id", "value": "" }, { "key": "tagId", "value": "" } ], "query": [] } } }, { "name": "List tags", "request": { "method": "GET", "description": "Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/tags/all", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "tags", "all" ], "variable": [], "query": [] } } }, { "name": "Create a tag", "request": { "method": "POST", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "tags" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP\",\n \"color\": \"#3bc1a8\"\n}" } } }, { "name": "Update a tag", "request": { "method": "PUT", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "tags", ":tagId" ], "variable": [ { "key": "tagId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"color\": \"color\"\n}" } } }, { "name": "Delete a tag", "request": { "method": "DELETE", "description": "Requires contacts:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "tags", ":tagId" ], "variable": [ { "key": "tagId", "value": "" } ], "query": [] } } }, { "name": "Set contact status", "request": { "method": "PATCH", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}" } } }, { "name": "Set contact lifecycle stage", "request": { "method": "PATCH", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/stage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "stage" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"lifecycleStage\": \"CUSTOMER\"\n}" } } }, { "name": "Assign a contact to an agent", "request": { "method": "PATCH", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "assign" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"agentId\": \"agentId\"\n}" } } }, { "name": "Add a note to a contact", "request": { "method": "POST", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/note", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "note" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"note\": \"note\"\n}" } } }, { "name": "Get a contact timeline", "request": { "method": "GET", "description": "Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/contacts/:id/timeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", ":id", "timeline" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true }, { "key": "types", "value": "", "description": "Comma-separated activity types, e.g. MESSAGE_SENT,TAG_ADDED.", "disabled": true } ] } } }, { "name": "Tag many contacts", "request": { "method": "POST", "description": "Requires contacts:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contacts/bulk/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contacts", "bulk", "tags" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"contactIds\": [\n \"contactIds\"\n ],\n \"tagIds\": [\n \"tagIds\"\n ],\n \"action\": \"add\"\n}" } } }, { "name": "List contacts", "request": { "method": "GET", "description": "Get a paginated list of contacts. Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "contacts" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Search by name, phone, or email", "disabled": true }, { "key": "tagIds", "value": "", "description": "Comma-separated tag IDs", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "createdAfter", "value": "", "disabled": true }, { "key": "createdBefore", "value": "", "disabled": true } ] } } }, { "name": "Get contact by ID", "request": { "method": "GET", "description": "Get a single contact with tags and conversation count. Requires contacts:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "contacts", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [] } } } ] }, { "name": "Messages", "item": [ { "name": "Send an Inboxy product or service card", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/catalog-card", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "catalog-card" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"conversationId\",\n \"itemType\": \"product\",\n \"itemId\": \"itemId\",\n \"language\": \"ar\"\n}" } } }, { "name": "Upload media to WhatsApp and get a media id for sends", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/media/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "media", "upload" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"mediaType\": \"image\",\n \"mediaUrl\": \"mediaUrl\",\n \"base64\": \"base64\",\n \"filename\": \"filename\",\n \"mimeType\": \"mimeType\"\n}" } } }, { "name": "Send a WhatsApp text message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/text", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "text" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"body\": \"body\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send an approved WhatsApp template", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "template" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"templateName\": \"templateName\",\n \"languageCode\": \"languageCode\",\n \"components\": [],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a WhatsApp reply-buttons message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/buttons", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "buttons" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"body\": \"body\",\n \"buttons\": [\n {\n \"id\": \"id\",\n \"title\": \"title\"\n }\n ],\n \"header\": \"header\",\n \"headerImage\": \"headerImage\",\n \"footer\": \"footer\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a WhatsApp list message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/list", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "list" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"body\": \"body\",\n \"buttonText\": \"buttonText\",\n \"sections\": [],\n \"header\": \"header\",\n \"footer\": \"footer\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a WhatsApp call-to-action URL button", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/cta-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "cta-url" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"body\": \"body\",\n \"displayText\": \"displayText\",\n \"url\": \"url\",\n \"header\": \"header\",\n \"headerImage\": \"headerImage\",\n \"footer\": \"footer\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Ask the customer to share their location", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/location-request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "location-request" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"body\": \"body\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send the WhatsApp catalog", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/catalog", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "catalog" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"body\": \"body\",\n \"footer\": \"footer\",\n \"thumbnailProductRetailerId\": \"thumbnailProductRetailerId\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send one catalog product", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/product", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "product" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"catalogId\": \"catalogId\",\n \"productRetailerId\": \"productRetailerId\",\n \"body\": \"body\",\n \"footer\": \"footer\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a multi-product message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/product-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "product-list" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"header\": \"header\",\n \"body\": \"body\",\n \"catalogId\": \"catalogId\",\n \"sections\": [\n {\n \"title\": \"title\",\n \"productRetailerIds\": [\n \"productRetailerIds\"\n ]\n }\n ],\n \"footer\": \"footer\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send WhatsApp media (image, video, audio, document)", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/media", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "media" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"mediaType\": \"image\",\n \"mediaUrl\": \"mediaUrl\",\n \"caption\": \"caption\",\n \"filename\": \"filename\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a location pin", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/location", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "location" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"latitude\": 1,\n \"longitude\": 1,\n \"name\": \"name\",\n \"address\": \"address\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send contact cards", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "contacts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"contacts\": [],\n \"contact\": {},\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send one contact card", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", "contact" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"contacts\": [],\n \"contact\": {},\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Mark an inbound WhatsApp message as read", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/messages/:messageId/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "messages", ":messageId", "read" ], "variable": [ { "key": "messageId", "value": "" } ], "query": [] } } }, { "name": "Reply in a conversation on any channel", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"مرحباً، كيف يمكنني مساعدتك؟\",\n \"type\": \"text\",\n \"fileData\": \"fileData\",\n \"fileName\": \"invoice.pdf\",\n \"mimeType\": \"image/jpeg\"\n}" } } }, { "name": "Send a saved interactive message into a conversation", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/send-saved", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", "send-saved" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"conversationId\",\n \"messageId\": \"messageId\",\n \"channel\": \"WHATSAPP\"\n}" } } }, { "name": "List messages in a conversation", "request": { "method": "GET", "description": "Get paginated messages for a conversation in chronological order. Requires messages:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/conversations/:id/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "conversations", ":id", "messages" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "before", "value": "", "description": "Fetch messages before this date (cursor pagination)", "disabled": true } ] } } } ] }, { "name": "Templates", "item": [ { "name": "Upload a template header file and get its media handle", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/media/upload-for-template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "media", "upload-for-template" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"mediaType\": \"image\",\n \"mediaUrl\": \"https://cdn.example.com/banner.jpg\",\n \"base64\": \"base64\",\n \"filename\": \"banner.jpg\",\n \"mimeType\": \"image/jpeg\"\n}" } } }, { "name": "List WhatsApp templates", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true } ] } } }, { "name": "Create a WhatsApp template and submit it to Meta for review", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"order_shipped\",\n \"category\": \"UTILITY\",\n \"language\": \"ar\",\n \"templateType\": \"STANDARD\",\n \"headerType\": \"TEXT\",\n \"headerText\": \"Your order is on its way\",\n \"headerExample\": \"headerExample\",\n \"headerMediaUrl\": \"headerMediaUrl\",\n \"bodyText\": \"مرحباً {{1}}، طلبك رقم {{2}} في الطريق إليك.\",\n \"bodyExamples\": [\n \"سارة\",\n \"10234\"\n ],\n \"footerText\": \"Inboxy Store\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Track order\",\n \"url\": \"https://shop.example.com/orders/{{1}}\",\n \"urlExample\": \"urlExample\",\n \"phoneNumber\": \"+966500000000\",\n \"couponCode\": \"couponCode\",\n \"otpType\": \"COPY_CODE\",\n \"flowId\": \"flowId\",\n \"flowAction\": \"navigate\"\n }\n ],\n \"carouselCards\": [\n {\n \"headerMediaHandle\": \"headerMediaHandle\",\n \"headerMediaUrl\": \"headerMediaUrl\",\n \"headerFormat\": \"IMAGE\",\n \"bodyText\": \"bodyText\",\n \"bodyExamples\": [\n \"bodyExamples\"\n ],\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Track order\",\n \"url\": \"https://shop.example.com/orders/{{1}}\",\n \"urlExample\": \"urlExample\",\n \"phoneNumber\": \"+966500000000\",\n \"couponCode\": \"couponCode\",\n \"otpType\": \"COPY_CODE\",\n \"flowId\": \"flowId\",\n \"flowAction\": \"navigate\"\n }\n ]\n }\n ],\n \"ltoText\": \"ltoText\",\n \"ltoExpiration\": \"2026-01-01T00:00:00.000Z\",\n \"ltoCouponCode\": \"ltoCouponCode\",\n \"authSecurityDisclaimer\": true,\n \"authExpirationMinutes\": 1,\n \"variableMapping\": {\n \"1\": {\n \"type\": \"contact_field\",\n \"value\": \"firstName\"\n },\n \"2\": {\n \"type\": \"order_field\",\n \"value\": \"last.order.tracking_number\"\n }\n }\n}" } } }, { "name": "Get a WhatsApp template", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates", ":templateId" ], "variable": [ { "key": "templateId", "value": "" } ], "query": [] } } }, { "name": "Attach the media every send of this template uses", "request": { "method": "PATCH", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates/:templateId/media", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates", ":templateId", "media" ], "variable": [ { "key": "templateId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"headerMediaId\": \"headerMediaId\",\n \"carouselCards\": [\n {\n \"index\": 1,\n \"mediaId\": \"mediaId\"\n }\n ]\n}" } } }, { "name": "Sync templates and their approval status from Meta", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates", "sync" ], "variable": [], "query": [] } } }, { "name": "Delete a WhatsApp template (all languages) from Meta and Inboxy", "request": { "method": "DELETE", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates", ":templateName" ], "variable": [ { "key": "templateName", "value": "" } ], "query": [] } } }, { "name": "Delivery ledger for a template", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates/:templateName/usage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates", ":templateName", "usage" ], "variable": [ { "key": "templateName", "value": "" } ], "query": [ { "key": "language", "value": "", "description": "One language variant of the template.", "disabled": true } ] } } }, { "name": "Change where template variables get their values", "request": { "method": "PATCH", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/templates/:templateName/mapping", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "templates", ":templateName", "mapping" ], "variable": [ { "key": "templateName", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"variableMapping\": {\n \"1\": {\n \"type\": \"contact_field\",\n \"value\": \"firstName\"\n }\n }\n}" } } } ] }, { "name": "WhatsApp analytics", "item": [ { "name": "WhatsApp message and conversation totals", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "stats" ], "variable": [], "query": [] } } }, { "name": "WhatsApp analytics summary", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "summary" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true } ] } } }, { "name": "Message volume", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "messages" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true } ] } } }, { "name": "Message trends", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/messages/trends", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "messages", "trends" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true } ] } } }, { "name": "Response times", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/response-times", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "response-times" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true } ] } } }, { "name": "Template performance", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "templates" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true }, { "key": "limit", "value": "", "description": "Max templates (default 10).", "disabled": true } ] } } }, { "name": "Conversation metrics", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "conversations" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true } ] } } }, { "name": "Agent performance", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "agents" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true }, { "key": "limit", "value": "", "description": "Max agents (default 10).", "disabled": true } ] } } }, { "name": "Channel breakdown", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/analytics/channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "analytics", "channels" ], "variable": [], "query": [ { "key": "startDate", "value": "", "description": "ISO date; use with endDate for an explicit range.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date; use with startDate.", "disabled": true }, { "key": "days", "value": "", "description": "Trailing N-day range, ignored when startDate and endDate are given. No range = all time.", "disabled": true } ] } } } ] }, { "name": "Campaigns", "item": [ { "name": "List WhatsApp campaigns", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns" ], "variable": [], "query": [ { "key": "status", "value": "", "description": "Must be one of the listed values.", "disabled": true }, { "key": "search", "value": "", "description": "Campaign name.", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Create a campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ramadan offer\",\n \"templateId\": \"templateId\",\n \"audience\": {\n \"type\": \"TAGS\",\n \"tagIds\": [\n \"tagIds\"\n ],\n \"contactIds\": [\n \"contactIds\"\n ],\n \"batchId\": \"batchId\"\n },\n \"templateComponents\": [\n {}\n ],\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\",\n \"messagesPerSecond\": 10,\n \"messagesPerDay\": 1,\n \"aiEnabled\": true\n}" } } }, { "name": "Get a campaign", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a draft or scheduled campaign", "request": { "method": "PUT", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"templateId\": \"templateId\",\n \"audience\": {\n \"type\": \"TAGS\",\n \"tagIds\": [\n \"tagIds\"\n ],\n \"contactIds\": [\n \"contactIds\"\n ],\n \"batchId\": \"batchId\"\n },\n \"templateComponents\": [\n {}\n ],\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\",\n \"autoRetry\": true,\n \"maxRetries\": 1\n}" } } }, { "name": "Delete a campaign", "request": { "method": "DELETE", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Start sending a campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "run" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Cancel a campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Pause a running campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Resume a paused campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "resume" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List campaign recipients", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "recipients" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "status", "value": "", "description": "Must be one of the listed values.", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get campaign details and counts", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "details" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Preview audience size and cost without creating", "request": { "method": "POST", "description": "Requires campaigns:read permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", "preview" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"templateId\",\n \"audience\": {\n \"type\": \"TAGS\",\n \"tagIds\": [\n \"tagIds\"\n ],\n \"contactIds\": [\n \"contactIds\"\n ],\n \"batchId\": \"batchId\"\n }\n}" } } }, { "name": "Import an audience (matches or creates contacts)", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/import-audience", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", "import-audience" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"name\": \"Sara\",\n \"phone\": \"966500000000\",\n \"email\": \"customer@example.com\",\n \"tags\": \"tags\"\n }\n ],\n \"createMissing\": true,\n \"defaultCountryCode\": \"966\"\n}" } } }, { "name": "Retry failed recipients", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "retry" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientIds\": [\n \"recipientIds\"\n ],\n \"failureCategories\": [\n \"failureCategories\"\n ]\n}" } } }, { "name": "Get campaign link clicks", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/analytics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "analytics" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Get deliveries over time", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/campaigns/:id/timeseries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "campaigns", ":id", "timeseries" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Instagram", "item": [ { "name": "Send an Instagram DM", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "send" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"content\": \"content\",\n \"conversationId\": \"conversationId\",\n \"mediaType\": \"image\",\n \"mediaUrl\": \"mediaUrl\"\n}" } } }, { "name": "Send Instagram quick replies", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/send/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "send", "quick-replies" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"text\": \"text\",\n \"quickReplies\": [\n {\n \"title\": \"title\",\n \"payload\": \"payload\"\n }\n ],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send an Instagram carousel", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/send/carousel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "send", "carousel" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"elements\": [\n {\n \"title\": \"title\",\n \"subtitle\": \"subtitle\",\n \"image_url\": \"image_url\",\n \"default_action\": {\n \"type\": \"type\",\n \"url\": \"url\"\n },\n \"buttons\": []\n }\n ],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send an Instagram DM with buttons", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/send/buttons", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "send", "buttons" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"text\": \"text\",\n \"buttons\": [\n {\n \"type\": \"type\",\n \"title\": \"title\",\n \"url\": \"url\",\n \"payload\": \"payload\"\n }\n ],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send an Instagram media template", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/send/media-template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "send", "media-template" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966500000000\",\n \"mediaType\": \"image\",\n \"mediaUrl\": \"mediaUrl\",\n \"buttons\": [],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Check the Instagram messaging window", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/conversations/:conversationId/window", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "conversations", ":conversationId", "window" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] } } }, { "name": "Instagram message totals", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "stats" ], "variable": [], "query": [ { "key": "period", "value": "", "description": "Reporting window (default month).", "disabled": true } ] } } }, { "name": "List Instagram interactive messages", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/interactive-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "interactive-messages" ], "variable": [], "query": [] } } }, { "name": "Save an Instagram interactive message", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/interactive-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "interactive-messages" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"type\": \"buttons\",\n \"config\": {}\n}" } } }, { "name": "Get an Instagram interactive message", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update an Instagram interactive message", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"type\": \"buttons\",\n \"config\": {}\n}" } } }, { "name": "Delete an Instagram interactive message", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Remaining Instagram send quota", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/rate-limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "rate-limit" ], "variable": [], "query": [] } } }, { "name": "List saved Instagram templates", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true } ] } } }, { "name": "Save an Instagram template", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"cards\": [\n {\n \"title\": \"title\",\n \"subtitle\": \"subtitle\",\n \"imageUrl\": \"imageUrl\",\n \"defaultActionUrl\": \"defaultActionUrl\",\n \"buttons\": [\n {\n \"type\": \"web_url\",\n \"title\": \"title\",\n \"url\": \"url\",\n \"payload\": \"payload\"\n }\n ]\n }\n ]\n}" } } }, { "name": "Get a saved Instagram template", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a saved Instagram template", "request": { "method": "PUT", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"isActive\": true,\n \"cards\": [\n {\n \"title\": \"title\",\n \"subtitle\": \"subtitle\",\n \"imageUrl\": \"imageUrl\",\n \"defaultActionUrl\": \"defaultActionUrl\",\n \"buttons\": [\n {\n \"type\": \"web_url\",\n \"title\": \"title\",\n \"url\": \"url\",\n \"payload\": \"payload\"\n }\n ]\n }\n ]\n}" } } }, { "name": "Delete a saved Instagram template", "request": { "method": "DELETE", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Get template detail and usage", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates/:id/detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates", ":id", "detail" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Send a saved Instagram template", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/templates/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "templates", ":id", "send" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "List Instagram quick replies", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "quick-replies" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "category", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true } ] } } }, { "name": "Create an Instagram quick reply", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "quick-replies" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"message\": \"message\",\n \"quickReplies\": [\n {\n \"title\": \"title\",\n \"payload\": \"payload\",\n \"imageUrl\": \"imageUrl\"\n }\n ],\n \"category\": \"category\"\n}" } } }, { "name": "List quick reply categories", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/quick-replies/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "quick-replies", "categories" ], "variable": [], "query": [] } } }, { "name": "Get an Instagram quick reply", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update an Instagram quick reply", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"message\": \"message\",\n \"quickReplies\": [\n {\n \"title\": \"title\",\n \"payload\": \"payload\",\n \"imageUrl\": \"imageUrl\"\n }\n ],\n \"category\": \"category\",\n \"isActive\": true\n}" } } }, { "name": "Delete an Instagram quick reply", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List Instagram ice breakers", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers" ], "variable": [], "query": [] } } }, { "name": "Replace Instagram ice breakers", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"iceBreakers\": [\n {\n \"question\": \"question\",\n \"payload\": \"payload\"\n }\n ]\n}" } } }, { "name": "Remove all ice breakers", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers" ], "variable": [], "query": [] } } }, { "name": "Add an ice breaker", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers", "add" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"question\": \"question\",\n \"payload\": \"payload\"\n}" } } }, { "name": "Update an ice breaker", "request": { "method": "PUT", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers/:index", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers", ":index" ], "variable": [ { "key": "index", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"question\": \"question\",\n \"payload\": \"payload\"\n}" } } }, { "name": "Delete an ice breaker", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers/:index", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers", ":index" ], "variable": [ { "key": "index", "value": "" } ], "query": [] } } }, { "name": "Reorder ice breakers", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/ice-breakers/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "ice-breakers", "reorder" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"newOrder\": [\n 0\n ]\n}" } } }, { "name": "Story mention auto-reply settings", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/story-mentions/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "story-mentions", "config" ], "variable": [], "query": [] } } }, { "name": "Change story mention auto-reply settings", "request": { "method": "PUT", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/story-mentions/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "story-mentions", "config" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"autoReplyEnabled\": true,\n \"autoReplyMessage\": \"autoReplyMessage\",\n \"autoReplyDelay\": 0,\n \"trackMentions\": true,\n \"notifyOnMention\": true\n}" } } }, { "name": "Story mention stats", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/story-mentions/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "story-mentions", "stats" ], "variable": [], "query": [] } } }, { "name": "Add a story mention reply", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/story-mentions/responses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "story-mentions", "responses" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"condition\": \"follower\",\n \"message\": \"message\",\n \"isActive\": true\n}" } } }, { "name": "Update a story mention reply", "request": { "method": "PUT", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/story-mentions/responses/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "story-mentions", "responses", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"condition\": \"follower\",\n \"message\": \"message\",\n \"isActive\": true\n}" } } }, { "name": "Delete a story mention reply", "request": { "method": "DELETE", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/story-mentions/responses/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "story-mentions", "responses", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List Instagram campaigns", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true } ] } } }, { "name": "Create an Instagram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"messageType\": \"TEXT\",\n \"messageText\": \"messageText\",\n \"messageContent\": \"messageContent\",\n \"templateId\": \"templateId\",\n \"imageUrl\": \"imageUrl\",\n \"messageConfig\": {},\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\",\n \"messagesPerSecond\": 1,\n \"recipientContactIds\": [\n \"recipientContactIds\"\n ],\n \"recipientIds\": [\n \"recipientIds\"\n ],\n \"recipientIGSIDs\": [\n \"recipientIGSIDs\"\n ],\n \"filters\": {\n \"tags\": [\n \"tags\"\n ],\n \"lifecycleStage\": \"lifecycleStage\",\n \"source\": \"source\"\n }\n}" } } }, { "name": "Get an Instagram campaign", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update an Instagram campaign", "request": { "method": "PUT", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"messageType\": \"TEXT\",\n \"messageText\": \"messageText\",\n \"messageContent\": \"messageContent\",\n \"templateId\": \"templateId\",\n \"imageUrl\": \"imageUrl\",\n \"messageConfig\": {},\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\",\n \"messagesPerSecond\": 1\n}" } } }, { "name": "Delete an Instagram campaign", "request": { "method": "DELETE", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Start an Instagram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "run" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Cancel an Instagram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Pause an Instagram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Resume an Instagram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "resume" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Campaign delivery stats", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "stats" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List campaign recipients", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "recipients" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true } ] } } }, { "name": "Add campaign recipients", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "recipients" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"contactIds\": [\n \"contactIds\"\n ],\n \"igsids\": [\n \"igsids\"\n ],\n \"filters\": {\n \"tags\": [\n \"tags\"\n ],\n \"lifecycleStage\": \"lifecycleStage\",\n \"source\": \"source\"\n }\n}" } } }, { "name": "Duplicate an Instagram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/campaigns/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "campaigns", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Send an Instagram marketing message to opted-in users", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/marketing/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "marketing", "send" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"tag\": \"tag\",\n \"text\": \"text\",\n \"attachment\": {\n \"type\": \"type\",\n \"payload\": {}\n }\n}" } } }, { "name": "List comment-to-DM automations", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations" ], "variable": [], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Rows per page, max 50 (default 20).", "disabled": true } ] } } }, { "name": "Auto-reply to comments on a post (public reply and/or DM)", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"channelId\": \"channelId\",\n \"mediaId\": \"mediaId\",\n \"postCaption\": \"postCaption\",\n \"postThumbnail\": \"postThumbnail\",\n \"postPermalink\": \"postPermalink\",\n \"keywords\": [\n \"price\",\n \"السعر\"\n ],\n \"publicReplies\": [\n \"Sent you a DM 📩\"\n ],\n \"dmMessage\": \"dmMessage\",\n \"dmConfig\": {\n \"type\": \"buttons\",\n \"text\": \"Here is the price list\",\n \"buttons\": [\n {\n \"title\": \"Open\",\n \"url\": \"https://example.com/prices\"\n }\n ]\n },\n \"hideComment\": true\n}" } } }, { "name": "List your Instagram posts", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations", "posts" ], "variable": [], "query": [ { "key": "after", "value": "", "description": "Pagination cursor from the previous page of posts.", "disabled": true } ] } } }, { "name": "List comments on an Instagram post", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations/posts/:mediaId/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations", "posts", ":mediaId", "comments" ], "variable": [ { "key": "mediaId", "value": "" } ], "query": [] } } }, { "name": "Get a comment-to-DM automation", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a comment-to-DM automation", "request": { "method": "PUT", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"channelId\": \"channelId\",\n \"mediaId\": \"mediaId\",\n \"postCaption\": \"postCaption\",\n \"postThumbnail\": \"postThumbnail\",\n \"postPermalink\": \"postPermalink\",\n \"keywords\": [\n \"price\",\n \"السعر\"\n ],\n \"publicReplies\": [\n \"Sent you a DM 📩\"\n ],\n \"dmMessage\": \"dmMessage\",\n \"dmConfig\": {\n \"type\": \"buttons\",\n \"text\": \"Here is the price list\",\n \"buttons\": [\n {\n \"title\": \"Open\",\n \"url\": \"https://example.com/prices\"\n }\n ]\n },\n \"hideComment\": true\n}" } } }, { "name": "Delete a comment-to-DM automation", "request": { "method": "DELETE", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Turn a comment-to-DM automation on or off", "request": { "method": "PATCH", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/comment-automations/:id/toggle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "comment-automations", ":id", "toggle" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Top Instagram templates and replies", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/top-performers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "top-performers" ], "variable": [], "query": [ { "key": "window", "value": "", "description": "Lookback window as \"d\", 1–90 days (default 7d).", "disabled": true } ] } } }, { "name": "Instagram message volume over time", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/instagram/volume-timeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instagram", "volume-timeline" ], "variable": [], "query": [ { "key": "window", "value": "", "description": "Lookback window as \"d\", 1–90 days (default 7d).", "disabled": true } ] } } } ] }, { "name": "Messenger", "item": [ { "name": "Send a Messenger message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"text\": \"text\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send outside the 24-hour window with a message tag", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/tag", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "tag" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"text\": \"text\",\n \"tag\": \"HUMAN_AGENT\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send Messenger quick replies", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "quick-replies" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"text\": \"text\",\n \"quickReplies\": [],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a Messenger button template", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/buttons", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "buttons" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"text\": \"text\",\n \"buttons\": [],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send Messenger media", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/media", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "media" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"mediaType\": \"image\",\n \"mediaUrl\": \"mediaUrl\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a Messenger carousel", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/carousel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "carousel" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"elements\": [\n {\n \"title\": \"title\",\n \"subtitle\": \"subtitle\",\n \"image_url\": \"image_url\",\n \"default_action\": {\n \"type\": \"type\",\n \"url\": \"url\"\n },\n \"buttons\": []\n }\n ],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a Messenger media template", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/media-template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "media-template" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"mediaType\": \"image\",\n \"mediaUrl\": \"mediaUrl\",\n \"buttons\": [],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a Messenger order receipt", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/send/receipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "send", "receipt" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"recipientName\": \"recipientName\",\n \"orderNumber\": \"orderNumber\",\n \"currency\": \"currency\",\n \"paymentMethod\": \"paymentMethod\",\n \"orderUrl\": \"orderUrl\",\n \"timestamp\": \"timestamp\",\n \"summary\": {\n \"subtotal\": 1,\n \"shipping_cost\": 1,\n \"total_tax\": 1,\n \"total_cost\": 1\n },\n \"elements\": [\n {\n \"title\": \"title\",\n \"subtitle\": \"subtitle\",\n \"quantity\": 1,\n \"price\": 1,\n \"currency\": \"currency\",\n \"image_url\": \"image_url\"\n }\n ],\n \"address\": {\n \"street_1\": \"street_1\",\n \"street_2\": \"street_2\",\n \"city\": \"city\",\n \"postal_code\": \"postal_code\",\n \"state\": \"state\",\n \"country\": \"country\"\n },\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Check the Messenger messaging window", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/window/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "window", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] } } }, { "name": "Messenger message totals", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "stats" ], "variable": [], "query": [ { "key": "period", "value": "", "description": "Reporting window (default month).", "disabled": true } ] } } }, { "name": "Messenger analytics summary", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/analytics/summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "analytics", "summary" ], "variable": [], "query": [ { "key": "days", "value": "", "description": "Days to analyze, 1–365 (default 30).", "disabled": true } ] } } }, { "name": "Remaining Messenger send quota", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/rate-limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "rate-limit" ], "variable": [], "query": [] } } }, { "name": "List Messenger interactive messages", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/interactive-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "interactive-messages" ], "variable": [], "query": [] } } }, { "name": "Save a Messenger interactive message", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/interactive-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "interactive-messages" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"type\": \"buttons\",\n \"config\": {}\n}" } } }, { "name": "Get a Messenger interactive message", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a Messenger interactive message", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"type\": \"buttons\",\n \"config\": {}\n}" } } }, { "name": "Delete a Messenger interactive message", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List saved Messenger templates", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates" ], "variable": [], "query": [ { "key": "type", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true } ] } } }, { "name": "Save a Messenger template", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"type\": \"BUTTON\",\n \"config\": {}\n}" } } }, { "name": "Get a saved Messenger template", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a saved Messenger template", "request": { "method": "PUT", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"type\": \"BUTTON\",\n \"config\": {},\n \"isActive\": true\n}" } } }, { "name": "Delete a saved Messenger template", "request": { "method": "DELETE", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Send a saved Messenger template", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates", ":id", "send" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"recipientId\",\n \"variables\": {},\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Get template detail and usage", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates/:id/detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates", ":id", "detail" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Duplicate a Messenger template", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/templates/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "templates", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List Messenger quick replies", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies" ], "variable": [], "query": [ { "key": "category", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true } ] } } }, { "name": "Create a Messenger quick reply", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"quickReplies\": [\n {\n \"content_type\": \"text\",\n \"title\": \"title\",\n \"payload\": \"payload\",\n \"image_url\": \"image_url\"\n }\n ],\n \"category\": \"category\"\n}" } } }, { "name": "List quick reply categories", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies", "categories" ], "variable": [], "query": [] } } }, { "name": "Get a Messenger quick reply", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a Messenger quick reply", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"quickReplies\": [\n {\n \"content_type\": \"text\",\n \"title\": \"title\",\n \"payload\": \"payload\",\n \"image_url\": \"image_url\"\n }\n ],\n \"category\": \"category\",\n \"isActive\": true\n}" } } }, { "name": "Delete a Messenger quick reply", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Duplicate a Messenger quick reply", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/quick-replies/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "quick-replies", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Messenger profile (greeting, menu, ice breakers)", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile" ], "variable": [], "query": [] } } }, { "name": "Persistent menu", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/persistent-menu", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "persistent-menu" ], "variable": [], "query": [] } } }, { "name": "Set the persistent menu", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/persistent-menu", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "persistent-menu" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"locale\": \"locale\",\n \"composer_input_disabled\": true,\n \"call_to_actions\": [\n {\n \"id\": \"id\",\n \"type\": \"postback\",\n \"title\": \"title\",\n \"payload\": \"payload\",\n \"url\": \"url\",\n \"webview_height_ratio\": \"compact\",\n \"call_to_actions\": []\n }\n ]\n}" } } }, { "name": "Remove the persistent menu", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/persistent-menu", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "persistent-menu" ], "variable": [], "query": [] } } }, { "name": "Greeting text", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/greeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "greeting" ], "variable": [], "query": [] } } }, { "name": "Set the greeting text", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/greeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "greeting" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"getStartedPayload\": \"getStartedPayload\",\n \"greetings\": [\n {\n \"locale\": \"locale\",\n \"text\": \"text\"\n }\n ]\n}" } } }, { "name": "Remove the greeting text", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/greeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "greeting" ], "variable": [], "query": [] } } }, { "name": "Get Started button", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/get-started", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "get-started" ], "variable": [], "query": [] } } }, { "name": "Set the Get Started button", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/get-started", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "get-started" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"payload\": \"payload\"\n}" } } }, { "name": "Remove the Get Started button", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/get-started", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "get-started" ], "variable": [], "query": [] } } }, { "name": "Ice breakers", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "ice-breakers" ], "variable": [], "query": [] } } }, { "name": "Set ice breakers", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "ice-breakers" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"ice_breakers\": [\n {\n \"id\": \"id\",\n \"question\": \"question\",\n \"payload\": \"payload\"\n }\n ]\n}" } } }, { "name": "Remove ice breakers", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/profile/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "profile", "ice-breakers" ], "variable": [], "query": [] } } }, { "name": "List Messenger campaigns", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true } ] } } }, { "name": "Create a Messenger campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"messageType\": \"TEXT\",\n \"messageText\": \"messageText\",\n \"templateId\": \"templateId\",\n \"quickReplySetId\": \"quickReplySetId\",\n \"messageConfig\": {},\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\",\n \"messagesPerSecond\": 1,\n \"recipientContactIds\": [\n \"recipientContactIds\"\n ],\n \"recipientPSIDs\": [\n \"recipientPSIDs\"\n ],\n \"filters\": {\n \"tags\": [\n \"tags\"\n ],\n \"lifecycleStage\": \"lifecycleStage\",\n \"source\": \"source\"\n }\n}" } } }, { "name": "Get a Messenger campaign", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a Messenger campaign", "request": { "method": "PUT", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"messageType\": \"TEXT\",\n \"messageText\": \"messageText\",\n \"templateId\": \"templateId\",\n \"quickReplySetId\": \"quickReplySetId\",\n \"messageConfig\": {},\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\",\n \"messagesPerSecond\": 1,\n \"messageTag\": null\n}" } } }, { "name": "Delete a Messenger campaign", "request": { "method": "DELETE", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Start a Messenger campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "run" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Cancel a Messenger campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Pause a Messenger campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Resume a Messenger campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "resume" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Campaign delivery stats", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "stats" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List campaign recipients", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "recipients" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "status", "value": "", "description": "Delivery status, e.g. SENT.", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows (default 20).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Add campaign recipients", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "recipients" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"contactIds\": [\n \"contactIds\"\n ],\n \"psids\": [\n \"psids\"\n ],\n \"filters\": {\n \"tags\": [\n \"tags\"\n ],\n \"lifecycleStage\": \"lifecycleStage\",\n \"source\": \"source\"\n }\n}" } } }, { "name": "Duplicate a Messenger campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/campaigns/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "campaigns", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List comment-to-DM automations", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations" ], "variable": [], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Rows per page, max 50 (default 20).", "disabled": true } ] } } }, { "name": "Auto-reply to comments on a Page post (public reply and/or DM)", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"channelId\": \"channelId\",\n \"mediaId\": \"mediaId\",\n \"postCaption\": \"postCaption\",\n \"postThumbnail\": \"postThumbnail\",\n \"postPermalink\": \"postPermalink\",\n \"keywords\": [\n \"price\",\n \"السعر\"\n ],\n \"publicReplies\": [\n \"Sent you a DM 📩\"\n ],\n \"dmMessage\": \"dmMessage\",\n \"dmConfig\": {\n \"type\": \"buttons\",\n \"text\": \"Here is the price list\",\n \"buttons\": [\n {\n \"title\": \"Open\",\n \"url\": \"https://example.com/prices\"\n }\n ]\n },\n \"hideComment\": true\n}" } } }, { "name": "List your Facebook Page posts", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations", "posts" ], "variable": [], "query": [ { "key": "after", "value": "", "description": "Pagination cursor from the previous page of posts.", "disabled": true } ] } } }, { "name": "List comments on a Page post", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations/posts/:mediaId/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations", "posts", ":mediaId", "comments" ], "variable": [ { "key": "mediaId", "value": "" } ], "query": [] } } }, { "name": "Get a comment-to-DM automation", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a comment-to-DM automation", "request": { "method": "PUT", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"channelId\": \"channelId\",\n \"mediaId\": \"mediaId\",\n \"postCaption\": \"postCaption\",\n \"postThumbnail\": \"postThumbnail\",\n \"postPermalink\": \"postPermalink\",\n \"keywords\": [\n \"price\",\n \"السعر\"\n ],\n \"publicReplies\": [\n \"Sent you a DM 📩\"\n ],\n \"dmMessage\": \"dmMessage\",\n \"dmConfig\": {\n \"type\": \"buttons\",\n \"text\": \"Here is the price list\",\n \"buttons\": [\n {\n \"title\": \"Open\",\n \"url\": \"https://example.com/prices\"\n }\n ]\n },\n \"hideComment\": true\n}" } } }, { "name": "Delete a comment-to-DM automation", "request": { "method": "DELETE", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Turn a comment-to-DM automation on or off", "request": { "method": "PATCH", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/comment-automations/:id/toggle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "comment-automations", ":id", "toggle" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Top Messenger templates and replies", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/top-performers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "top-performers" ], "variable": [], "query": [ { "key": "window", "value": "", "description": "Lookback window as \"d\", 1–90 days (default 7d).", "disabled": true } ] } } }, { "name": "Messenger message volume over time", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/messenger/volume-timeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messenger", "volume-timeline" ], "variable": [], "query": [ { "key": "window", "value": "", "description": "Lookback window as \"d\", 1–90 days (default 7d).", "disabled": true } ] } } } ] }, { "name": "Telegram", "item": [ { "name": "Send a Telegram message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"content\": \"content\",\n \"conversationId\": \"conversationId\",\n \"mediaType\": \"photo\",\n \"mediaUrl\": \"mediaUrl\",\n \"caption\": \"caption\",\n \"parseMode\": \"HTML\"\n}" } } }, { "name": "Send a message with inline buttons", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/inline-keyboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "inline-keyboard" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"text\": \"text\",\n \"buttons\": [\n [\n {\n \"text\": \"text\",\n \"url\": \"url\",\n \"callback_data\": \"callback_data\"\n }\n ]\n ],\n \"inlineKeyboard\": [\n [\n {\n \"text\": \"text\",\n \"url\": \"url\",\n \"callback_data\": \"callback_data\"\n }\n ]\n ],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a message with a reply keyboard", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/reply-keyboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "reply-keyboard" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"text\": \"text\",\n \"keyboard\": [\n [\n {\n \"text\": \"text\",\n \"request_contact\": true,\n \"request_location\": true\n }\n ]\n ],\n \"conversationId\": \"conversationId\",\n \"resize_keyboard\": true,\n \"one_time_keyboard\": true,\n \"input_field_placeholder\": \"input_field_placeholder\",\n \"is_persistent\": true\n}" } } }, { "name": "Remove the reply keyboard", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/remove-keyboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "remove-keyboard" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"text\": \"text\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a sticker", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/sticker", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "sticker" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"sticker\": \"sticker\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a location", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/location", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "location" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"latitude\": 1,\n \"longitude\": 1,\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a contact", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "contact" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"phoneNumber\": \"966500000000\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a poll", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/poll", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "poll" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"question\": \"question\",\n \"options\": [\n \"options\"\n ],\n \"conversationId\": \"conversationId\",\n \"is_anonymous\": true,\n \"isAnonymous\": true,\n \"type\": \"regular\",\n \"allows_multiple_answers\": true,\n \"allowsMultipleAnswers\": true,\n \"correct_option_id\": 1,\n \"correctOptionId\": 1,\n \"explanation\": \"explanation\",\n \"open_period\": 1\n}" } } }, { "name": "Send a venue", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/venue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "venue" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"latitude\": 1,\n \"longitude\": 1,\n \"title\": \"title\",\n \"address\": \"address\",\n \"foursquareId\": \"foursquareId\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send an animated dice", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/dice", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "dice" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"emoji\": \"🎲\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a GIF / animation", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/animation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "animation" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"animation\": \"animation\",\n \"caption\": \"caption\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a round video note", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/video-note", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "video-note" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"videoNote\": \"videoNote\",\n \"duration\": 1,\n \"length\": 1,\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send an invoice", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/invoice", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "invoice" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"title\": \"title\",\n \"description\": \"description\",\n \"payload\": \"payload\",\n \"currency\": \"XTR\",\n \"prices\": [\n {\n \"label\": \"label\",\n \"amount\": 1\n }\n ],\n \"providerToken\": \"providerToken\",\n \"startParameter\": \"startParameter\",\n \"photoUrl\": \"photoUrl\"\n}" } } }, { "name": "Create a payment link", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/create-invoice-link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "create-invoice-link" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"title\",\n \"description\": \"description\",\n \"payload\": \"payload\",\n \"currency\": \"XTR\",\n \"prices\": [\n {\n \"label\": \"label\",\n \"amount\": 1\n }\n ]\n}" } } }, { "name": "Forward a message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/forward", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "forward" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"fromChatId\": \"fromChatId\",\n \"messageId\": 1\n}" } } }, { "name": "Copy a message to another chat", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/copy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "copy" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"fromChatId\": \"fromChatId\",\n \"messageId\": 1,\n \"caption\": \"caption\"\n}" } } }, { "name": "Edit a sent message", "request": { "method": "PUT", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/message", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "message" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"messageId\": 1,\n \"text\": \"text\"\n}" } } }, { "name": "Delete a message", "request": { "method": "DELETE", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/message", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "message" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"messageId\": 1\n}" } } }, { "name": "Send an album", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/send/media-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "send", "media-group" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"media\": [\n {\n \"type\": \"photo\",\n \"media\": \"media\",\n \"caption\": \"caption\"\n }\n ],\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Get chat info", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/chat/:chatId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "chat", ":chatId" ], "variable": [ { "key": "chatId", "value": "" } ], "query": [] } } }, { "name": "Get group member count", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/chat/:chatId/member-count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "chat", ":chatId", "member-count" ], "variable": [ { "key": "chatId", "value": "" } ], "query": [] } } }, { "name": "Ban a user from a group", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/chat/ban", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "chat", "ban" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"userId\": 1,\n \"untilDate\": 1\n}" } } }, { "name": "Unban a user", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/chat/unban", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "chat", "unban" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"userId\": 1\n}" } } }, { "name": "Pin a message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/message/pin", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "message", "pin" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"messageId\": 1,\n \"disableNotification\": true\n}" } } }, { "name": "Unpin a message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/message/unpin", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "message", "unpin" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"messageId\": 1\n}" } } }, { "name": "Create a group invite link", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/chat/invite-link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "chat", "invite-link" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": \"chatId\",\n \"name\": \"name\",\n \"expireDate\": 1,\n \"memberLimit\": 1\n}" } } }, { "name": "Bot name, description and about text", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/bot/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "bot", "profile" ], "variable": [], "query": [] } } }, { "name": "Change the bot name, description and about text", "request": { "method": "PUT", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/bot/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "bot", "profile" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"shortDescription\": \"shortDescription\"\n}" } } }, { "name": "List bot commands", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/commands", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "commands" ], "variable": [], "query": [ { "key": "languageCode", "value": "", "description": "Command set for this language (omit for the default).", "disabled": true } ] } } }, { "name": "Set bot commands", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/commands", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "commands" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"commands\": [\n {\n \"command\": \"command\",\n \"description\": \"description\"\n }\n ],\n \"languageCode\": \"languageCode\"\n}" } } }, { "name": "Remove bot commands", "request": { "method": "DELETE", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/commands", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "commands" ], "variable": [], "query": [] } } }, { "name": "Telegram message totals", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "stats" ], "variable": [], "query": [] } } }, { "name": "List Telegram campaigns", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns" ], "variable": [], "query": [ { "key": "status", "value": "", "description": "\"all\" or omitted returns every status.", "disabled": true } ] } } }, { "name": "Create a Telegram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"New arrivals\",\n \"messageType\": \"TEXT\",\n \"messageContent\": \"messageContent\",\n \"templateId\": \"templateId\",\n \"recipientIds\": [\n \"recipientIds\"\n ],\n \"scheduledAt\": \"2026-01-01T00:00:00.000Z\"\n}" } } }, { "name": "Get a Telegram campaign", "request": { "method": "GET", "description": "Requires campaigns:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Delete a Telegram campaign", "request": { "method": "DELETE", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Start a Telegram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns", ":id", "send" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Cancel a Telegram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Pause a Telegram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Resume a Telegram campaign", "request": { "method": "POST", "description": "Requires campaigns:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/campaigns/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "campaigns", ":id", "resume" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List Telegram templates", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates" ], "variable": [], "query": [ { "key": "isActive", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Name or content.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true } ] } } }, { "name": "Save a Telegram template", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome\",\n \"type\": \"TEXT\",\n \"content\": \"Welcome to our store 👋\",\n \"config\": {},\n \"description\": \"description\",\n \"clientId\": \"clientId\"\n}" } } }, { "name": "Get a Telegram template", "request": { "method": "GET", "description": "Requires templates:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a Telegram template", "request": { "method": "PUT", "description": "Requires templates:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome\",\n \"type\": \"TEXT\",\n \"content\": \"Welcome to our store 👋\",\n \"config\": {},\n \"description\": \"description\",\n \"clientId\": \"clientId\"\n}" } } }, { "name": "Delete a Telegram template", "request": { "method": "DELETE", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Duplicate a Telegram template", "request": { "method": "POST", "description": "Requires templates:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Record a Telegram template use", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/templates/:id/use", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "templates", ":id", "use" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Top Telegram templates", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/top-performers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "top-performers" ], "variable": [], "query": [ { "key": "window", "value": "", "description": "Lookback window as \"d\", 1–90 days (default 7d).", "disabled": true } ] } } }, { "name": "Telegram message volume over time", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/telegram/volume-timeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "telegram", "volume-timeline" ], "variable": [], "query": [ { "key": "window", "value": "", "description": "Lookback window as \"d\", 1–90 days (default 7d).", "disabled": true } ] } } } ] }, { "name": "AI Agents", "item": [ { "name": "List channels available for agent assignment", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "channels" ], "variable": [], "query": [] } } }, { "name": "List agent personality presets", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/presets/personalities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "presets", "personalities" ], "variable": [], "query": [] } } }, { "name": "List agent type presets", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/presets/agent-types", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "presets", "agent-types" ], "variable": [], "query": [] } } }, { "name": "List AI agents", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents" ], "variable": [], "query": [ { "key": "includeInactive", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Default 50.", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Create an AI agent", "request": { "method": "POST", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Layla\",\n \"mission\": \"Answer product questions and qualify leads.\",\n \"avatar\": \"avatar\",\n \"gender\": \"MALE\",\n \"personalityType\": \"personalityType\",\n \"personality\": \"personality\",\n \"agentType\": \"GENERAL\",\n \"instructions\": \"instructions\",\n \"primaryLanguage\": \"ar\",\n \"responseStyle\": \"CONCISE\",\n \"maxTokens\": 1,\n \"temperature\": 1,\n \"isDefault\": true,\n \"assignedChannels\": [\n \"assignedChannels\"\n ],\n \"transferStrategy\": \"LEAST_BUSY\",\n \"transferAgentId\": \"transferAgentId\",\n \"sendProductImages\": true\n}" } } }, { "name": "Get AI agent stats", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "stats" ], "variable": [], "query": [] } } }, { "name": "Get the conversation insights schedule", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/insights/schedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "insights", "schedule" ], "variable": [], "query": [] } } }, { "name": "Set the conversation insights schedule", "request": { "method": "PUT", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/insights/schedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "insights", "schedule" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"cadence\": \"WEEKLY\",\n \"intervalDays\": 1,\n \"dayOfWeek\": 1,\n \"dayOfMonth\": 1,\n \"scheduleHour\": 1,\n \"timezone\": \"Asia/Riyadh\"\n}" } } }, { "name": "List conversation insight reports", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/insights/reports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "insights", "reports" ], "variable": [], "query": [ { "key": "limit", "value": "", "description": "Default 20.", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get a conversation insight report", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/insights/reports/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "insights", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "" } ], "query": [] } } }, { "name": "Queue a manual conversation insight report", "request": { "method": "POST", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/insights/run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "insights", "run" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"lookbackDays\": 7,\n \"mode\": \"QUICK_SAMPLE\"\n}" } } }, { "name": "List historical learning profiles", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/historical-learning", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "historical-learning" ], "variable": [], "query": [] } } }, { "name": "Enable or disable historical learning for an agent", "request": { "method": "PUT", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/historical-learning", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "historical-learning" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}" } } }, { "name": "Run historical learning analysis for an agent", "request": { "method": "POST", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/historical-learning/run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "historical-learning", "run" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"lookbackDays\": 90\n}" } } }, { "name": "Get an AI agent", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] } } }, { "name": "Update an AI agent", "request": { "method": "PUT", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"mission\": \"mission\",\n \"avatar\": \"avatar\",\n \"gender\": \"MALE\",\n \"personalityType\": \"personalityType\",\n \"personality\": \"personality\",\n \"agentType\": \"GENERAL\",\n \"instructions\": \"instructions\",\n \"primaryLanguage\": \"ar\",\n \"responseStyle\": \"CONCISE\",\n \"maxTokens\": 1,\n \"temperature\": 1,\n \"isDefault\": true,\n \"assignedChannels\": [\n \"assignedChannels\"\n ],\n \"transferStrategy\": \"LEAST_BUSY\",\n \"transferAgentId\": \"transferAgentId\",\n \"sendProductImages\": true,\n \"isActive\": true\n}" } } }, { "name": "Delete an AI agent", "request": { "method": "DELETE", "description": "Requires ai:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] } } }, { "name": "List agent knowledge entries", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/knowledge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "knowledge" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [ { "key": "category", "value": "", "disabled": true }, { "key": "includeInactive", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Default 50.", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "List agent knowledge categories", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/knowledge/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "knowledge", "categories" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] } } }, { "name": "Get an agent knowledge entry", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/knowledge/:knowledgeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "knowledge", ":knowledgeId" ], "variable": [ { "key": "agentId", "value": "" }, { "key": "knowledgeId", "value": "" } ], "query": [] } } }, { "name": "Delete an agent knowledge entry", "request": { "method": "DELETE", "description": "Requires ai:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/knowledge/:knowledgeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "knowledge", ":knowledgeId" ], "variable": [ { "key": "agentId", "value": "" }, { "key": "knowledgeId", "value": "" } ], "query": [] } } }, { "name": "Get supported knowledge upload file types", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/upload/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "upload", "info" ], "variable": [], "query": [] } } }, { "name": "List agent event logs", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "logs" ], "variable": [], "query": [ { "key": "agentId", "value": "", "disabled": true }, { "key": "eventType", "value": "", "description": "Must be one of the listed values.", "disabled": true }, { "key": "startDate", "value": "", "description": "ISO date.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date.", "disabled": true }, { "key": "limit", "value": "", "description": "Default 50.", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get agent log stats", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/logs/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "logs", "stats" ], "variable": [], "query": [ { "key": "agentId", "value": "", "description": "One agent instead of all.", "disabled": true } ] } } }, { "name": "List built-in agent functions", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/functions/builtin", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "functions", "builtin" ], "variable": [], "query": [] } } }, { "name": "List agent functions", "request": { "method": "GET", "description": "Requires ai:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/functions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "functions" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [ { "key": "includeDisabled", "value": "", "disabled": true } ] } } }, { "name": "Create an agent function", "request": { "method": "POST", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/functions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "functions" ], "variable": [ { "key": "agentId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"check_order_status\",\n \"displayName\": \"Check order status\",\n \"description\": \"description\",\n \"parameters\": {},\n \"executorType\": \"INTERNAL\",\n \"executorConfig\": {}\n}" } } }, { "name": "Update an agent function", "request": { "method": "PUT", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/functions/:functionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "functions", ":functionId" ], "variable": [ { "key": "agentId", "value": "" }, { "key": "functionId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"check_order_status\",\n \"displayName\": \"Check order status\",\n \"description\": \"description\",\n \"parameters\": {},\n \"executorType\": \"INTERNAL\",\n \"executorConfig\": {},\n \"isEnabled\": true\n}" } } }, { "name": "Delete an agent function", "request": { "method": "DELETE", "description": "Requires ai:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/functions/:functionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "functions", ":functionId" ], "variable": [ { "key": "agentId", "value": "" }, { "key": "functionId", "value": "" } ], "query": [] } } }, { "name": "Enable or disable an agent function", "request": { "method": "PATCH", "description": "Requires ai:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/:agentId/functions/:functionId/toggle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", ":agentId", "functions", ":functionId", "toggle" ], "variable": [ { "key": "agentId", "value": "" }, { "key": "functionId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"isEnabled\": true\n}" } } }, { "name": "Sync built-in functions to all agents", "request": { "method": "POST", "description": "Requires ai:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ai-agents/functions/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ai-agents", "functions", "sync" ], "variable": [], "query": [] } } } ] }, { "name": "CSAT", "item": [ { "name": "Get the CSAT survey config", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/csat/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "csat", "config" ], "variable": [], "query": [] } } }, { "name": "Get CSAT analytics for a period", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/csat/analytics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "csat", "analytics" ], "variable": [], "query": [ { "key": "period", "value": "", "description": "Reporting window (default 30d).", "disabled": true } ] } } } ] }, { "name": "Team", "item": [ { "name": "List team members", "request": { "method": "GET", "description": "Requires team:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/team", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "team" ], "variable": [], "query": [ { "key": "search", "value": "", "description": "Name or email.", "disabled": true }, { "key": "role", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get a team member", "request": { "method": "GET", "description": "Requires team:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/team/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "team", ":userId" ], "variable": [ { "key": "userId", "value": "" } ], "query": [] } } }, { "name": "Get team headcount and role breakdown", "request": { "method": "GET", "description": "Requires team:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/team/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "team", "stats" ], "variable": [], "query": [] } } }, { "name": "Get company profile and settings", "request": { "method": "GET", "description": "Requires team:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/company", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company" ], "variable": [], "query": [] } } } ] }, { "name": "Conversations", "item": [ { "name": "List inbox conversations", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations" ], "variable": [], "query": [ { "key": "status", "value": "", "description": "Conversation status, e.g. OPEN or CLOSED.", "disabled": true }, { "key": "channelType", "value": "", "description": "Channel type, e.g. WHATSAPP or INSTAGRAM.", "disabled": true }, { "key": "assignedToId", "value": "", "description": "Only conversations assigned to this user.", "disabled": true }, { "key": "unassigned", "value": "", "description": "Only unassigned conversations (overrides assignedToId).", "disabled": true }, { "key": "unread", "value": "", "description": "Only conversations with unread messages.", "disabled": true }, { "key": "aiEnabled", "value": "", "description": "Filter by whether the AI agent is on.", "disabled": true }, { "key": "search", "value": "", "description": "Contact name or phone.", "disabled": true }, { "key": "tagIds", "value": "", "description": "Comma-separated contact tag ids.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "ISO date; last message on or after.", "disabled": true }, { "key": "dateTo", "value": "", "description": "ISO date; last message on or before.", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows, up to 1000 (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get a conversation", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] } } }, { "name": "List messages in a conversation", "request": { "method": "GET", "description": "Requires messages:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [ { "key": "limit", "value": "", "description": "Max messages, up to 200 (default 100).", "disabled": true }, { "key": "before", "value": "", "description": "ISO date cursor: messages older than this (scroll back).", "disabled": true }, { "key": "after", "value": "", "description": "ISO date cursor: messages newer than this. Wins over before.", "disabled": true } ] } } }, { "name": "Check the 24-hour messaging window", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/window", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "window" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] } } }, { "name": "Assign a conversation to an agent", "request": { "method": "PATCH", "description": "Requires conversations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "assign" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"assignedToId\": \"usr_2n4k1x9p0q\"\n}" } } }, { "name": "Change conversation status", "request": { "method": "PATCH", "description": "Requires conversations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "status" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"resolved\"\n}" } } }, { "name": "Set conversation labels", "request": { "method": "PATCH", "description": "Requires conversations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "labels" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"vip\",\n \"needs-followup\"\n ]\n}" } } }, { "name": "List internal notes", "request": { "method": "GET", "description": "Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/notes/list", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "notes", "list" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] } } }, { "name": "Add an internal note", "request": { "method": "POST", "description": "Requires conversations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/inbox/conversations/:conversationId/notes/list", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inbox", "conversations", ":conversationId", "notes", "list" ], "variable": [ { "key": "conversationId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"Customer asked about bulk pricing — follow up Thursday.\"\n}" } } }, { "name": "List conversations", "request": { "method": "GET", "description": "Get a paginated list of conversations with filters. Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "conversations" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status (open, closed, pending)", "disabled": true }, { "key": "channelType", "value": "", "description": "Filter by channel type (whatsapp, instagram, messenger, widget)", "disabled": true }, { "key": "assignedToId", "value": "", "description": "Filter by assigned agent ID", "disabled": true }, { "key": "unread", "value": "", "description": "Filter to only unread conversations", "disabled": true }, { "key": "search", "value": "", "description": "Search by contact name or phone", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Filter messages from this date", "disabled": true }, { "key": "dateTo", "value": "", "description": "Filter messages to this date", "disabled": true } ] } } }, { "name": "Get conversation by ID", "request": { "method": "GET", "description": "Get a single conversation with contact, channel, and assigned agent details. Requires conversations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/conversations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "conversations", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [] } } } ] }, { "name": "Automations", "item": [ { "name": "List workflows", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "channelType", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Name or description.", "disabled": true }, { "key": "limit", "value": "", "description": "1–100 (default 20).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Create a workflow", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Cart recovery on WhatsApp\",\n \"description\": \"description\",\n \"channelType\": \"WHATSAPP\"\n}" } } }, { "name": "Import a workflow document", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", "import" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"formatVersion\": \"formatVersion\",\n \"name\": \"name\",\n \"description\": \"description\",\n \"channelType\": \"WHATSAPP\",\n \"triggerType\": \"ecommerce.cart.abandoned\",\n \"triggerConfig\": {},\n \"nodes\": [\n {}\n ],\n \"edges\": [\n {}\n ]\n}" } } }, { "name": "Get a workflow", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] } } }, { "name": "Delete a workflow", "request": { "method": "DELETE", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] } } }, { "name": "Get a workflow with its nodes and edges", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/graph", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "graph" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] } } }, { "name": "Export a workflow as a portable document", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/export", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "export" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] } } }, { "name": "Turn a workflow on, pause or archive it", "request": { "method": "PATCH", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "status" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}" } } }, { "name": "Validate and publish a workflow graph", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "publish" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"triggerType\": \"ecommerce.cart.abandoned\",\n \"triggerConfig\": {},\n \"nodes\": [\n {}\n ],\n \"edges\": [\n {}\n ]\n}" } } }, { "name": "List runs (execution history)", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "runs" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "1–100 (default 20).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get one run with its steps", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "runs", ":runId" ], "variable": [ { "key": "workflowId", "value": "" }, { "key": "runId", "value": "" } ], "query": [] } } }, { "name": "Run statistics for a workflow", "request": { "method": "GET", "description": "Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "stats" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] } } }, { "name": "Recent real events this workflow’s trigger would receive", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/sample-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "sample-events" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [ { "key": "type", "value": "", "description": "Event type to sample (default: the workflow's trigger), e.g. whatsapp.message.received.", "disabled": true }, { "key": "limit", "value": "", "description": "1–10 (default 5).", "disabled": true } ] } } }, { "name": "Dry-run a workflow on a sample event (nothing is sent)", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/test-run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "test-run" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"conversationId\",\n \"sampleMessage\": \"do you ship to Jeddah?\"\n}" } } }, { "name": "Capture the next real trigger event as a sample (60 seconds)", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/automations-v2/:workflowId/test-arm", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automations-v2", ":workflowId", "test-arm" ], "variable": [ { "key": "workflowId", "value": "" } ], "query": [] } } } ] }, { "name": "Interactive messages", "item": [ { "name": "List saved interactive messages", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages" ], "variable": [], "query": [ { "key": "type", "value": "", "disabled": true }, { "key": "category", "value": "", "disabled": true }, { "key": "isActive", "value": "", "description": "Defaults to active only.", "disabled": true }, { "key": "search", "value": "", "description": "Name, description or tags.", "disabled": true } ] } } }, { "name": "Save an interactive message", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Main menu\",\n \"description\": \"description\",\n \"type\": \"BUTTONS\",\n \"config\": {\n \"body\": \"How can we help?\",\n \"buttons\": [\n {\n \"id\": \"orders\",\n \"title\": \"My orders\"\n },\n {\n \"id\": \"agent\",\n \"title\": \"Talk to us\"\n }\n ]\n },\n \"category\": \"category\",\n \"tags\": [\n \"tags\"\n ]\n}" } } }, { "name": "Saved interactive message stats", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", "stats" ], "variable": [], "query": [] } } }, { "name": "List library categories", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", "categories" ], "variable": [], "query": [] } } }, { "name": "Get a saved interactive message", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a saved interactive message", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"config\": {},\n \"category\": \"category\",\n \"tags\": [\n \"tags\"\n ],\n \"isActive\": true\n}" } } }, { "name": "Delete a saved interactive message", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Duplicate a saved interactive message", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/interactive-messages/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "interactive-messages", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Main menu (copy)\"\n}" } } } ] }, { "name": "Quick Replies", "item": [ { "name": "List quick replies", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies" ], "variable": [], "query": [ { "key": "category", "value": "", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active state.", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] } } }, { "name": "Create a quick reply", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"shortcut\": \"/refund\",\n \"label\": \"Refund policy\",\n \"text\": \"text\",\n \"category\": \"category\"\n}" } } }, { "name": "List quick reply categories", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies", "categories" ], "variable": [], "query": [] } } }, { "name": "Get a quick reply", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a quick reply", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"shortcut\": \"shortcut\",\n \"label\": \"label\",\n \"text\": \"text\",\n \"category\": \"category\",\n \"isActive\": true\n}" } } }, { "name": "Delete a quick reply", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Record quick reply usage", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/quick-replies/:id/use", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quick-replies", ":id", "use" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Saved Contacts", "item": [ { "name": "List saved contacts", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts" ], "variable": [], "query": [ { "key": "category", "value": "", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active state.", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] } } }, { "name": "Create a saved contact", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Al-Otaibi\",\n \"formattedName\": \"Ahmed Al-Otaibi - Sales\",\n \"phones\": [\n {\n \"type\": \"WORK\",\n \"phone\": \"966500000000\"\n }\n ],\n \"emails\": [\n {\n \"type\": \"WORK\",\n \"email\": \"customer@example.com\"\n }\n ],\n \"organization\": \"organization\",\n \"title\": \"title\",\n \"addresses\": [\n {\n \"type\": \"WORK\",\n \"street\": \"street\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"country\": \"country\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"WORK\",\n \"url\": \"url\"\n }\n ],\n \"category\": \"category\"\n}" } } }, { "name": "List saved contact categories", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts", "categories" ], "variable": [], "query": [] } } }, { "name": "Get a saved contact", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a saved contact", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"formattedName\": \"formattedName\",\n \"phones\": [\n {\n \"type\": \"WORK\",\n \"phone\": \"966500000000\"\n }\n ],\n \"emails\": [\n {\n \"type\": \"WORK\",\n \"email\": \"customer@example.com\"\n }\n ],\n \"organization\": \"organization\",\n \"title\": \"title\",\n \"addresses\": [\n {\n \"type\": \"WORK\",\n \"street\": \"street\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"country\": \"country\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"WORK\",\n \"url\": \"url\"\n }\n ],\n \"category\": \"category\",\n \"isActive\": true\n}" } } }, { "name": "Delete a saved contact", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Get a saved contact in WhatsApp vCard format", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts/:id/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts", ":id", "whatsapp" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Record saved contact usage", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-contacts/:id/use", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-contacts", ":id", "use" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Saved Locations", "item": [ { "name": "List saved locations", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations" ], "variable": [], "query": [ { "key": "category", "value": "", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active state.", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] } } }, { "name": "Create a saved location", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Main Warehouse\",\n \"address\": \"address\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"category\": \"category\",\n \"isActive\": true\n}" } } }, { "name": "List saved location categories", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations", "categories" ], "variable": [], "query": [] } } }, { "name": "Get a saved location", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a saved location", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"address\": \"address\",\n \"latitude\": 1,\n \"longitude\": 1,\n \"category\": \"category\",\n \"isActive\": true\n}" } } }, { "name": "Delete a saved location", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Get a saved location in WhatsApp location format", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations/:id/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations", ":id", "whatsapp" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Record saved location usage", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/saved-locations/:id/use", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "saved-locations", ":id", "use" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Stores", "item": [ { "name": "Sync from WooCommerce (?full=true for a full reconcile)", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "sync" ], "variable": [], "query": [] } } }, { "name": "Sync WooCommerce customers", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/sync/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "sync", "customers" ], "variable": [], "query": [] } } }, { "name": "Sync WooCommerce orders", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/sync/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "sync", "orders" ], "variable": [], "query": [] } } }, { "name": "Sync WooCommerce products", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/sync/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "sync", "products" ], "variable": [], "query": [] } } }, { "name": "WooCommerce abandoned carts", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/abandoned-carts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "abandoned-carts" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Up to 100 (default 20).", "disabled": true } ] } } }, { "name": "WooCommerce cart recovery stats", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/abandoned-carts/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "abandoned-carts", "stats" ], "variable": [], "query": [] } } }, { "name": "Mark a WooCommerce cart recovered", "request": { "method": "PATCH", "description": "Requires ecommerce:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/woocommerce/abandoned-carts/:id/recover", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "woocommerce", "abandoned-carts", ":id", "recover" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": 1\n}" } } }, { "name": "Shopify connection status (no secrets)", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/shopify/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shopify", "config" ], "variable": [], "query": [] } } }, { "name": "Sync everything from Shopify", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/shopify/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shopify", "sync" ], "variable": [], "query": [] } } }, { "name": "Sync Shopify customers", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/shopify/sync/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shopify", "sync", "customers" ], "variable": [], "query": [] } } }, { "name": "Sync Shopify orders", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/shopify/sync/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shopify", "sync", "orders" ], "variable": [], "query": [] } } }, { "name": "Sync Shopify products", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/shopify/sync/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "shopify", "sync", "products" ], "variable": [], "query": [] } } }, { "name": "Salla connection status (no secrets)", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/salla/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "salla", "config" ], "variable": [], "query": [] } } }, { "name": "Salla abandoned carts", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/salla/abandoned-carts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "salla", "abandoned-carts" ], "variable": [], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Up to 100 (default 20).", "disabled": true }, { "key": "status", "value": "", "disabled": true } ] } } }, { "name": "Salla cart recovery stats", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/salla/abandoned-carts/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "salla", "abandoned-carts", "stats" ], "variable": [], "query": [] } } }, { "name": "Mark a Salla cart recovered", "request": { "method": "PATCH", "description": "Requires ecommerce:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/salla/abandoned-carts/:id/recover", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "salla", "abandoned-carts", ":id", "recover" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": 1\n}" } } }, { "name": "Sync from Salla", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/salla/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "salla", "sync" ], "variable": [], "query": [] } } }, { "name": "Zid connection status (no secrets)", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/zid/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "zid", "config" ], "variable": [], "query": [] } } }, { "name": "Sync orders from Zid", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/zid/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "zid", "sync" ], "variable": [], "query": [] } } }, { "name": "Zid abandoned carts", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/zid/abandoned-carts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "zid", "abandoned-carts" ], "variable": [], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Up to 100 (default 20).", "disabled": true }, { "key": "status", "value": "", "disabled": true } ] } } }, { "name": "EasyOrders connection status (no secrets)", "request": { "method": "GET", "description": "Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/easy-orders/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "easy-orders", "config" ], "variable": [], "query": [] } } }, { "name": "Sync from EasyOrders", "request": { "method": "POST", "description": "Requires channels:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/easy-orders/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "easy-orders", "sync" ], "variable": [], "query": [] } } }, { "name": "Store KPIs: orders, revenue, store connectivity", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ecommerce/overview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ecommerce", "overview" ], "variable": [], "query": [] } } }, { "name": "List store customers across platforms", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ecommerce/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ecommerce", "customers" ], "variable": [], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "pageSize", "value": "", "description": "Up to 100 (default 25).", "disabled": true }, { "key": "search", "value": "", "description": "Name, email or phone.", "disabled": true }, { "key": "platform", "value": "", "description": "Comma-separated: SHOPIFY, SALLA, WOOCOMMERCE, ZID, EASYORDERS.", "disabled": true } ] } } }, { "name": "Get a store customer with orders", "request": { "method": "GET", "description": "Requires ecommerce:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ecommerce/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ecommerce", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook event types", "request": { "method": "GET", "description": "Requires webhooks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", "events" ], "variable": [], "query": [] } } }, { "name": "List webhooks", "request": { "method": "GET", "description": "Requires webhooks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks" ], "variable": [], "query": [] } } }, { "name": "Register a webhook", "request": { "method": "POST", "description": "Requires webhooks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Order sync\",\n \"url\": \"https://example.com/webhooks/inboxy\",\n \"events\": [\n \"message.received\",\n \"ecommerce.order.*\",\n \"ticket.created\"\n ],\n \"maxRetries\": 1,\n \"fieldExclusions\": [\n \"fieldExclusions\"\n ],\n \"consecutiveFailureThreshold\": 1\n}" } } }, { "name": "Get a webhook", "request": { "method": "GET", "description": "Requires webhooks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] } } }, { "name": "Update a webhook", "request": { "method": "PUT", "description": "Requires webhooks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"url\": \"url\",\n \"events\": [\n \"message.received\",\n \"ecommerce.order.*\",\n \"ticket.created\"\n ],\n \"status\": \"ACTIVE\",\n \"maxRetries\": 1,\n \"fieldExclusions\": [\n \"fieldExclusions\"\n ],\n \"consecutiveFailureThreshold\": 1\n}" } } }, { "name": "Delete a webhook", "request": { "method": "DELETE", "description": "Requires webhooks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] } } }, { "name": "Send a test delivery", "request": { "method": "POST", "description": "Requires webhooks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] } } }, { "name": "List webhook deliveries", "request": { "method": "GET", "description": "Requires webhooks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId", "logs" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [ { "key": "limit", "value": "", "description": "Max deliveries (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Reveal the signing secret (to verify X-Inboxy-Signature)", "request": { "method": "GET", "description": "Requires webhooks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId/secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId", "secret" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] } } }, { "name": "Rotate the signing secret", "request": { "method": "POST", "description": "Requires webhooks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId/regenerate-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId", "regenerate-secret" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] } } }, { "name": "Redeliver the failed deliveries of the last 7 days", "request": { "method": "POST", "description": "Requires webhooks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/webhooks/:webhookId/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhooks", ":webhookId", "replay" ], "variable": [ { "key": "webhookId", "value": "" } ], "query": [] } } } ] }, { "name": "Orders", "item": [ { "name": "List orders", "request": { "method": "GET", "description": "Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [], "query": [ { "key": "contactId", "value": "", "disabled": true }, { "key": "status", "value": "", "description": "Comma-separated: PENDING, CONFIRMED, PROCESSING, COMPLETED, CANCELLED, REFUNDED.", "disabled": true }, { "key": "paymentStatus", "value": "", "description": "Comma-separated: UNPAID, PARTIALLY_PAID, PAID, REFUNDED.", "disabled": true }, { "key": "fulfillmentStatus", "value": "", "description": "Comma-separated: UNFULFILLED, PARTIALLY_FULFILLED, SHIPPED, DELIVERED, FULFILLED, RETURNED.", "disabled": true }, { "key": "externalSource", "value": "", "description": "Comma-separated: WHATSAPP_COMMERCE, WOOCOMMERCE, SHOPIFY, SALLA, ZID, EASY_ORDERS, MANUAL, AI_AGENT, WEB_EVENT.", "disabled": true }, { "key": "minTotal", "value": "", "disabled": true }, { "key": "maxTotal", "value": "", "disabled": true }, { "key": "dateAfter", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "dateBefore", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "search", "value": "", "description": "Order number or customer.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "sortBy", "value": "", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sort direction.", "disabled": true } ] } } }, { "name": "Create an order", "request": { "method": "POST", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"contactId\": \"contactId\",\n \"externalId\": \"externalId\",\n \"externalSource\": \"MANUAL\",\n \"orderNumber\": \"ORD-1042\",\n \"status\": \"PENDING\",\n \"subtotal\": 199,\n \"tax\": 1,\n \"shipping\": 1,\n \"discount\": 1,\n \"total\": 199,\n \"currency\": \"SAR\",\n \"paymentMethod\": \"cod\",\n \"paymentStatus\": \"UNPAID\",\n \"fulfillmentStatus\": \"UNFULFILLED\",\n \"billingAddress\": {},\n \"shippingAddress\": {},\n \"customerNote\": \"customerNote\",\n \"internalNote\": \"internalNote\",\n \"orderDate\": \"orderDate\",\n \"metadata\": {},\n \"items\": []\n}" } } }, { "name": "Order statistics", "request": { "method": "GET", "description": "Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", "stats" ], "variable": [], "query": [] } } }, { "name": "Get an order", "request": { "method": "GET", "description": "Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update an order", "request": { "method": "PUT", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PENDING\",\n \"paymentStatus\": \"UNPAID\",\n \"paymentMethod\": \"paymentMethod\",\n \"fulfillmentStatus\": \"UNFULFILLED\",\n \"shippingAddress\": {},\n \"billingAddress\": {},\n \"customerNote\": \"customerNote\",\n \"internalNote\": \"internalNote\",\n \"metadata\": {},\n \"confirmationStatus\": \"UNCONFIRMED\",\n \"confirmationChannel\": \"confirmationChannel\",\n \"trackingNumber\": \"trackingNumber\",\n \"trackingCarrier\": \"trackingCarrier\",\n \"trackingUrl\": \"trackingUrl\",\n \"cancellationReason\": \"cancellationReason\",\n \"refundReason\": \"refundReason\",\n \"refundAmount\": 1\n}" } } }, { "name": "Delete an order", "request": { "method": "DELETE", "description": "Requires orders:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Change order status", "request": { "method": "PATCH", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"CONFIRMED\",\n \"cancellationReason\": \"cancellationReason\"\n}" } } }, { "name": "Change payment status", "request": { "method": "PATCH", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/payment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "payment" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"paymentStatus\": \"PAID\",\n \"paymentMethod\": \"card\"\n}" } } }, { "name": "Change fulfillment status", "request": { "method": "PATCH", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/fulfillment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "fulfillment" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"fulfillmentStatus\": \"SHIPPED\",\n \"trackingNumber\": \"trackingNumber\",\n \"trackingCarrier\": \"Aramex\",\n \"trackingUrl\": \"trackingUrl\"\n}" } } }, { "name": "Set the order confirmation status", "request": { "method": "PATCH", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "confirmation" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"confirmationStatus\": \"CONFIRMED\",\n \"confirmationChannel\": \"whatsapp\",\n \"confirmationMessageId\": \"confirmationMessageId\"\n}" } } }, { "name": "Push an Inboxy-created order to the connected store (Shopify, Salla, WooCommerce)", "request": { "method": "POST", "description": "Requires orders:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/push-to-platform", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "push-to-platform" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Messages linked to an order", "request": { "method": "GET", "description": "Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "messages" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Link a message to an order", "request": { "method": "POST", "description": "Requires orders:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "messages" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"messageId\": \"messageId\",\n \"type\": \"SHIPPING_UPDATE\",\n \"metadata\": {}\n}" } } }, { "name": "The WhatsApp confirmation exchange for an order", "request": { "method": "GET", "description": "Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/confirmation-thread", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "confirmation-thread" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List orders", "request": { "method": "GET", "description": "Get a paginated list of orders with filters. Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "orders" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "status", "value": "", "description": "Filter by order status", "disabled": true }, { "key": "dateAfter", "value": "", "description": "Orders created after this date", "disabled": true }, { "key": "dateBefore", "value": "", "description": "Orders created before this date", "disabled": true }, { "key": "search", "value": "", "description": "Search by order number or customer name", "disabled": true } ] } } }, { "name": "Get order by ID", "request": { "method": "GET", "description": "Get a single order with line items. Requires orders:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "orders", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [] } } } ] }, { "name": "Products and services", "item": [ { "name": "List catalog cards (products and services ready to send)", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards" ], "variable": [], "query": [ { "key": "itemType", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "page", "value": "", "description": "Page number (24 cards per page).", "disabled": true }, { "key": "language", "value": "", "disabled": true } ] } } }, { "name": "Store sync state and card readiness", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "status" ], "variable": [], "query": [ { "key": "itemType", "value": "", "disabled": true } ] } } }, { "name": "Sync the catalog from a connected store", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "sync" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"platform\": \"shopify\"\n}" } } }, { "name": "Preview one catalog card", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/:itemType/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", ":itemType", ":itemId" ], "variable": [ { "key": "itemType", "value": "" }, { "key": "itemId", "value": "" } ], "query": [ { "key": "language", "value": "", "disabled": true } ] } } }, { "name": "Send a catalog card on WhatsApp", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/send/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "send", "whatsapp" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"itemType\": \"product\",\n \"itemId\": \"itemId\",\n \"language\": \"ar\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a catalog card on Messenger", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/send/messenger", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "send", "messenger" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"itemType\": \"product\",\n \"itemId\": \"itemId\",\n \"language\": \"ar\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a catalog card on Instagram", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/send/instagram", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "send", "instagram" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"itemType\": \"product\",\n \"itemId\": \"itemId\",\n \"language\": \"ar\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a catalog card in the website chat", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/send/web", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "send", "web" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"itemType\": \"product\",\n \"itemId\": \"itemId\",\n \"language\": \"ar\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Send a catalog card on Telegram", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/catalog-cards/send/telegram", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "catalog-cards", "send", "telegram" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"itemType\": \"product\",\n \"itemId\": \"itemId\",\n \"language\": \"ar\",\n \"conversationId\": \"conversationId\"\n}" } } }, { "name": "Product statistics", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "stats" ], "variable": [], "query": [] } } }, { "name": "Merge a duplicate product into another", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/merge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "merge" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"keepId\": \"keepId\",\n \"deleteId\": \"deleteId\"\n}" } } }, { "name": "Save extracted products", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/import-from-url/save", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "import-from-url", "save" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"name\": \"Wireless charger\",\n \"description\": \"description\",\n \"price\": 129.99,\n \"currency\": \"SAR\",\n \"imageUrl\": \"imageUrl\"\n }\n ],\n \"defaultCurrency\": \"SAR\"\n}" } } }, { "name": "Update a product category", "request": { "method": "PUT", "description": "Requires products:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Delete a product category", "request": { "method": "DELETE", "description": "Requires products:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List products", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [], "query": [ { "key": "search", "value": "", "description": "Name or SKU.", "disabled": true }, { "key": "categoryId", "value": "", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active state.", "disabled": true }, { "key": "externalSource", "value": "", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "sortBy", "value": "", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sort direction.", "disabled": true } ] } } }, { "name": "Get a product", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Service statistics", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/services/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", "stats" ], "variable": [], "query": [] } } }, { "name": "List service categories", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/services/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", "categories" ], "variable": [], "query": [] } } }, { "name": "Create a service category", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/services/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", "categories" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"sortOrder\": 1\n}" } } }, { "name": "Update a service category", "request": { "method": "PUT", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/services/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"sortOrder\": 1\n}" } } }, { "name": "Delete a service category", "request": { "method": "DELETE", "description": "Requires products:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/services/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List services", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services" ], "variable": [], "query": [ { "key": "search", "value": "", "disabled": true }, { "key": "categoryId", "value": "", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active state.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "sortBy", "value": "", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sort direction.", "disabled": true } ] } } }, { "name": "Create a service", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Home cleaning (2h)\",\n \"price\": 199,\n \"description\": \"description\",\n \"currency\": \"SAR\",\n \"images\": [\n \"images\"\n ],\n \"isActive\": true,\n \"duration\": 1,\n \"categoryId\": \"categoryId\",\n \"newCategoryName\": \"newCategoryName\",\n \"metadata\": {}\n}" } } }, { "name": "Get a service", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/services/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a service", "request": { "method": "PUT", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/services/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Home cleaning (2h)\",\n \"price\": 199,\n \"description\": \"description\",\n \"currency\": \"SAR\",\n \"images\": [\n \"images\"\n ],\n \"isActive\": true,\n \"duration\": 1,\n \"categoryId\": \"categoryId\",\n \"newCategoryName\": \"newCategoryName\",\n \"metadata\": {}\n}" } } }, { "name": "Delete a service", "request": { "method": "DELETE", "description": "Requires products:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/services/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "services", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Products", "item": [ { "name": "List product categories", "request": { "method": "GET", "description": "Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "categories" ], "variable": [], "query": [] } } }, { "name": "Create a product category", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "categories" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"description\": \"description\",\n \"sortOrder\": 1\n}" } } }, { "name": "Create a product", "request": { "method": "POST", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Wireless Charger\",\n \"price\": 129.99,\n \"description\": \"description\",\n \"sku\": \"sku\",\n \"currency\": \"SAR\",\n \"images\": [\n \"images\"\n ],\n \"isActive\": true,\n \"stockQuantity\": 1,\n \"categoryId\": \"categoryId\",\n \"newCategoryName\": \"newCategoryName\"\n}" } } }, { "name": "Update a product", "request": { "method": "PUT", "description": "Requires products:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Wireless Charger\",\n \"price\": 129.99,\n \"description\": \"description\",\n \"sku\": \"sku\",\n \"currency\": \"SAR\",\n \"images\": [\n \"images\"\n ],\n \"isActive\": true,\n \"stockQuantity\": 1,\n \"categoryId\": \"categoryId\",\n \"newCategoryName\": \"newCategoryName\"\n}" } } }, { "name": "Delete a product", "request": { "method": "DELETE", "description": "Requires products:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List products", "request": { "method": "GET", "description": "Get a paginated list of products from the catalog. Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "products" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Search by product name or SKU", "disabled": true }, { "key": "categoryId", "value": "", "description": "Filter by category ID", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active status", "disabled": true } ] } } }, { "name": "Get product by ID", "request": { "method": "GET", "description": "Get a single product with full details. Requires products:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "products", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [] } } } ] }, { "name": "Web events", "item": [ { "name": "List web event integrations", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events" ], "variable": [], "query": [] } } }, { "name": "Create an integration your website posts events to", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/web-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Landing page form\",\n \"description\": \"description\",\n \"authType\": \"HMAC_SHA256\",\n \"autoCreateContact\": true,\n \"contactMapping\": {\n \"phoneField\": \"customer.phone\",\n \"emailField\": \"customer.email\",\n \"nameField\": \"customer.name\",\n \"autoCreate\": true\n },\n \"isEnabled\": true\n}" } } }, { "name": "Get a web event integration", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update an integration", "request": { "method": "PUT", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Landing page form\",\n \"description\": \"description\",\n \"authType\": \"HMAC_SHA256\",\n \"autoCreateContact\": true,\n \"contactMapping\": {\n \"phoneField\": \"customer.phone\",\n \"emailField\": \"customer.email\",\n \"nameField\": \"customer.name\",\n \"autoCreate\": true\n },\n \"isEnabled\": true\n}" } } }, { "name": "Delete an integration", "request": { "method": "DELETE", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Enable or disable an integration", "request": { "method": "PATCH", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/toggle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "toggle" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Declare an event type", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/event-types", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "event-types" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"signup_completed\",\n \"description\": \"description\",\n \"fieldSchema\": {}\n}" } } }, { "name": "Remove an event type", "request": { "method": "DELETE", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/event-types/:typeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "event-types", ":typeId" ], "variable": [ { "key": "id", "value": "" }, { "key": "typeId", "value": "" } ], "query": [] } } }, { "name": "List received events", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "logs" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Up to 100 (default 50).", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "startDate", "value": "", "description": "ISO date.", "disabled": true }, { "key": "endDate", "value": "", "description": "ISO date.", "disabled": true } ] } } }, { "name": "Get one received event", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/logs/:logId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "logs", ":logId" ], "variable": [ { "key": "id", "value": "" }, { "key": "logId", "value": "" } ], "query": [] } } }, { "name": "Variables this integration exposes to automations and templates", "request": { "method": "GET", "description": "Requires automations:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/variables", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "variables" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Send a test event through the integration", "request": { "method": "POST", "description": "Requires automations:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/web-events/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "web-events", ":id", "test" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Leads", "item": [ { "name": "Get lead pipeline stats", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "stats" ], "variable": [], "query": [] } } }, { "name": "Get the lead pipeline", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/pipeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "pipeline" ], "variable": [], "query": [ { "key": "search", "value": "", "disabled": true }, { "key": "label", "value": "", "disabled": true }, { "key": "assignedAgentId", "value": "", "disabled": true } ] } } }, { "name": "List leads (paginated table view)", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/list", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "list" ], "variable": [], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Name, email, company or phone.", "disabled": true }, { "key": "statusId", "value": "", "description": "Lead status id (GET /leads/statuses).", "disabled": true }, { "key": "priority", "value": "", "description": "0 low … 3 urgent.", "disabled": true }, { "key": "assignedAgentId", "value": "", "disabled": true }, { "key": "source", "value": "", "disabled": true } ] } } }, { "name": "AI-suggest lead fields from a conversation", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/suggest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "suggest" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"conversationId\",\n \"contactId\": \"contactId\"\n}" } } }, { "name": "Move a lead to a stage", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/move", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "move" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"stage\": \"QUALIFIED\"\n}" } } }, { "name": "Mark a lead won", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/win", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "win" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Mark a lead lost", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/lose", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "lose" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"reason\"\n}" } } }, { "name": "Assign a lead", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "assign" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"userId\": \"userId\"\n}" } } }, { "name": "List lead statuses", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/statuses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "statuses" ], "variable": [], "query": [ { "key": "includeInactive", "value": "", "description": "Include disabled statuses.", "disabled": true } ] } } }, { "name": "Create a lead status", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/statuses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "statuses" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"label\": \"Negotiating\",\n \"labelAr\": \"labelAr\",\n \"color\": \"#3bc1a8\",\n \"bgColor\": \"#dbeafe\",\n \"icon\": \"icon\",\n \"isQualified\": true,\n \"isFinal\": true\n}" } } }, { "name": "Reorder lead statuses", "request": { "method": "PATCH", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/statuses/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "statuses", "reorder" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"orderedIds\": [\n \"orderedIds\"\n ]\n}" } } }, { "name": "Update a lead status", "request": { "method": "PATCH", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/statuses/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "statuses", ":statusId" ], "variable": [ { "key": "statusId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"label\": \"label\",\n \"labelAr\": \"labelAr\",\n \"color\": \"color\",\n \"bgColor\": \"bgColor\",\n \"icon\": \"icon\",\n \"isQualified\": true,\n \"isFinal\": true,\n \"isActive\": true\n}" } } }, { "name": "Delete a lead status", "request": { "method": "DELETE", "description": "Requires leads:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/statuses/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", "statuses", ":statusId" ], "variable": [ { "key": "statusId", "value": "" } ], "query": [] } } }, { "name": "Set lead status", "request": { "method": "PATCH", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"statusId\": \"statusId\"\n}" } } }, { "name": "Set lead star rating", "request": { "method": "PATCH", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/rating", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "rating" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"rating\": 5\n}" } } }, { "name": "Set lead priority", "request": { "method": "PATCH", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/priority", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "priority" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"priority\": 2\n}" } } }, { "name": "List the feedback thread on a lead", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "feedback" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Add a lead feedback entry", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "feedback" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Very responsive, asked for a discount.\",\n \"rating\": 1,\n \"type\": \"POSITIVE\"\n}" } } }, { "name": "Schedule a lead follow-up task", "request": { "method": "POST", "description": "Requires leads:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/follow-up", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "follow-up" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Call back about pricing\",\n \"dueDate\": \"dueDate\",\n \"description\": \"description\"\n}" } } }, { "name": "List lead follow-up tasks", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id/follow-ups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id", "follow-ups" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Get a lead", "request": { "method": "GET", "description": "Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "leads", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List leads", "request": { "method": "GET", "description": "Get a paginated list of leads (contacts in LEAD lifecycle stage). Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/leads", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "leads" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "stage", "value": "", "description": "Filter by pipeline stage (e.g., NEW, QUALIFIED, PROPOSAL)", "disabled": true }, { "key": "search", "value": "", "description": "Search by name, phone, or email", "disabled": true } ] } } }, { "name": "Get lead by ID", "request": { "method": "GET", "description": "Get a single lead with assigned agent, follow-up tasks, and counts. Requires leads:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "leads", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [] } } } ] }, { "name": "Media", "item": [ { "name": "List media library files", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/media", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media" ], "variable": [], "query": [ { "key": "type", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "File name.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "description": "Sort direction.", "disabled": true } ] } } }, { "name": "Get media library stats", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/media/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", "stats" ], "variable": [], "query": [] } } }, { "name": "Get a media file", "request": { "method": "GET", "description": "Requires library:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/media/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Rename a media file or set its AI-accessibility", "request": { "method": "PUT", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/media/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"aiAccessible\": true,\n \"aiDescription\": \"aiDescription\"\n}" } } }, { "name": "Delete a media file", "request": { "method": "DELETE", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/media/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Bulk delete media files", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/media/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", "bulk-delete" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"ids\"\n ]\n}" } } }, { "name": "Record media file usage", "request": { "method": "POST", "description": "Requires library:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/media/:id/use", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", ":id", "use" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Tasks", "item": [ { "name": "List tasks", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "priority", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true }, { "key": "assignedToId", "value": "", "disabled": true }, { "key": "contactId", "value": "", "disabled": true }, { "key": "conversationId", "value": "", "disabled": true }, { "key": "source", "value": "", "disabled": true }, { "key": "dueDateFrom", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "dueDateTo", "value": "", "description": "ISO date-time.", "disabled": true }, { "key": "search", "value": "", "description": "Title.", "disabled": true } ] } } }, { "name": "Create a task", "request": { "method": "POST", "description": "Requires tasks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on invoice #4521\",\n \"description\": \"description\",\n \"type\": \"FOLLOW_UP\",\n \"priority\": \"NORMAL\",\n \"contactId\": \"contactId\",\n \"conversationId\": \"conversationId\",\n \"assignedToId\": \"assignedToId\",\n \"dueDate\": \"dueDate\",\n \"reminderAt\": \"reminderAt\",\n \"recurrence\": \"NONE\",\n \"source\": \"MANUAL\"\n}" } } }, { "name": "Get task stats", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", "stats" ], "variable": [], "query": [] } } }, { "name": "List tasks assigned to the token owner", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/my", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", "my" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "priority", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "List tasks for a contact", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/contact/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", "contact", ":contactId" ], "variable": [ { "key": "contactId", "value": "" } ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "priority", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 50).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Get a task", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a task", "request": { "method": "PUT", "description": "Requires tasks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"title\",\n \"description\": \"description\",\n \"type\": \"FOLLOW_UP\",\n \"priority\": \"NORMAL\",\n \"contactId\": \"contactId\",\n \"conversationId\": \"conversationId\",\n \"assignedToId\": \"assignedToId\",\n \"dueDate\": \"dueDate\",\n \"reminderAt\": \"reminderAt\",\n \"recurrence\": \"NONE\",\n \"status\": \"IN_PROGRESS\"\n}" } } }, { "name": "Delete a task", "request": { "method": "DELETE", "description": "Requires tasks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Mark a task complete", "request": { "method": "POST", "description": "Requires tasks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id/complete", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id", "complete" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Assign a task", "request": { "method": "POST", "description": "Requires tasks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id", "assign" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"assignedToId\": \"assignedToId\"\n}" } } }, { "name": "List checklist items on a task", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id/subtasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id", "subtasks" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Add a checklist item to a task", "request": { "method": "POST", "description": "Requires tasks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id/subtasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id", "subtasks" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Confirm shipping address\"\n}" } } }, { "name": "Toggle a checklist item", "request": { "method": "PATCH", "description": "Requires tasks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tasks/subtasks/:subtaskId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", "subtasks", ":subtaskId" ], "variable": [ { "key": "subtaskId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"done\": true\n}" } } }, { "name": "Delete a checklist item", "request": { "method": "DELETE", "description": "Requires tasks:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/subtasks/:subtaskId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", "subtasks", ":subtaskId" ], "variable": [ { "key": "subtaskId", "value": "" } ], "query": [] } } }, { "name": "List task comments", "request": { "method": "GET", "description": "Requires tasks:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id", "comments" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Add a task comment", "request": { "method": "POST", "description": "Requires tasks:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tasks/:id/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tasks", ":id", "comments" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"Called the client, waiting on approval.\"\n}" } } } ] }, { "name": "Tickets", "item": [ { "name": "List tickets", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "priority", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 20).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true }, { "key": "type", "value": "", "description": "Ticket type (GET /tickets/types).", "disabled": true }, { "key": "assignedToId", "value": "", "disabled": true }, { "key": "contactId", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Subject.", "disabled": true } ] } } }, { "name": "Create a ticket", "request": { "method": "POST", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Order #1042 arrived damaged\",\n \"description\": \"description\",\n \"type\": \"order\",\n \"typeId\": \"typeId\",\n \"priority\": \"NORMAL\",\n \"contactId\": \"contactId\",\n \"assignedToId\": \"assignedToId\",\n \"conversationId\": \"conversationId\",\n \"dueDate\": \"dueDate\",\n \"source\": \"source\",\n \"tags\": [\n \"tags\"\n ],\n \"phone\": \"966500000000\"\n}" } } }, { "name": "Get ticket stats", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "stats" ], "variable": [], "query": [] } } }, { "name": "List tickets assigned to the token owner", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/my", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "my" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "priority", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 20).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "List tickets for a contact", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/contact/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "contact", ":contactId" ], "variable": [ { "key": "contactId", "value": "" } ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "priority", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 20).", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "List ticket types", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/types", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "types" ], "variable": [], "query": [] } } }, { "name": "Create a ticket type", "request": { "method": "POST", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/types", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "types" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Warranty claim\",\n \"color\": \"color\",\n \"icon\": \"icon\",\n \"isActive\": true\n}" } } }, { "name": "Update a ticket type", "request": { "method": "PUT", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/types/:typeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "types", ":typeId" ], "variable": [ { "key": "typeId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"color\": \"color\",\n \"icon\": \"icon\",\n \"isActive\": true,\n \"order\": 1\n}" } } }, { "name": "Delete a ticket type", "request": { "method": "DELETE", "description": "Requires tickets:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/types/:typeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "types", ":typeId" ], "variable": [ { "key": "typeId", "value": "" } ], "query": [] } } }, { "name": "Get a ticket", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a ticket", "request": { "method": "PUT", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Order #1042 arrived damaged\",\n \"description\": \"description\",\n \"type\": \"order\",\n \"typeId\": \"typeId\",\n \"priority\": \"NORMAL\",\n \"contactId\": \"contactId\",\n \"assignedToId\": \"assignedToId\",\n \"conversationId\": \"conversationId\",\n \"dueDate\": \"dueDate\",\n \"source\": \"source\",\n \"tags\": [\n \"tags\"\n ],\n \"status\": \"OPEN\"\n}" } } }, { "name": "Delete a ticket", "request": { "method": "DELETE", "description": "Requires tickets:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Change ticket status", "request": { "method": "PATCH", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"IN_PROGRESS\"\n}" } } }, { "name": "Assign a ticket", "request": { "method": "POST", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "assign" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"assignedToId\": \"assignedToId\"\n}" } } }, { "name": "Close a ticket", "request": { "method": "POST", "description": "Requires tickets:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/close", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "close" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List ticket comments", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "comments" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Comment on a ticket", "request": { "method": "POST", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "comments" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"content\",\n \"isInternal\": true\n}" } } }, { "name": "List ticket attachments", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "attachments" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Add a ticket attachment (URL reference, not an upload)", "request": { "method": "POST", "description": "Requires tickets:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "attachments" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://cdn.inboxy.chat/files/invoice.pdf\",\n \"name\": \"invoice.pdf\",\n \"mimeType\": \"application/pdf\",\n \"size\": 1\n}" } } }, { "name": "Delete a ticket attachment", "request": { "method": "DELETE", "description": "Requires tickets:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", "attachments", ":attachmentId" ], "variable": [ { "key": "attachmentId", "value": "" } ], "query": [] } } }, { "name": "Get the ticket audit trail", "request": { "method": "GET", "description": "Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/tickets/:id/activity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tickets", ":id", "activity" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "List tickets", "request": { "method": "GET", "description": "Get a paginated list of support tickets with filters. Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/tickets", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "tickets" ], "variable": [], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "pageSize", "value": "", "disabled": true }, { "key": "status", "value": "", "description": "Filter by ticket status (open, in_progress, resolved, closed)", "disabled": true }, { "key": "type", "value": "", "description": "Filter by ticket type", "disabled": true }, { "key": "priority", "value": "", "description": "Filter by priority (low, medium, high, urgent)", "disabled": true }, { "key": "assignedToId", "value": "", "description": "Filter by assigned agent ID", "disabled": true } ] } } }, { "name": "Get ticket by ID", "request": { "method": "GET", "description": "Get a single support ticket with comments. Requires tickets:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "tickets", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Resource ID" } ], "query": [] } } } ] }, { "name": "Meetings", "item": [ { "name": "Create a meeting", "request": { "method": "POST", "description": "Requires meetings:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/meetings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Product demo\",\n \"type\": \"ONLINE\",\n \"startTime\": \"2026-09-20T10:00:00.000Z\",\n \"startTimeLocal\": \"2026-09-20T13:00:00\",\n \"timezone\": \"Asia/Riyadh\",\n \"durationMinutes\": 30,\n \"contactId\": \"contactId\",\n \"link\": \"link\",\n \"location\": \"location\",\n \"notes\": \"notes\",\n \"attendees\": [\n {\n \"type\": \"TEAM\",\n \"userId\": \"userId\",\n \"name\": \"name\",\n \"email\": \"customer@example.com\",\n \"phone\": \"966500000000\"\n }\n ]\n}" } } }, { "name": "List meetings in a calendar week", "request": { "method": "GET", "description": "Requires meetings:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/meetings/week", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", "week" ], "variable": [], "query": [ { "key": "date", "value": "", "description": "Any date in the week to return (ISO date).", "disabled": false } ] } } }, { "name": "List meetings for a contact", "request": { "method": "GET", "description": "Requires meetings:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/meetings/contact/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", "contact", ":contactId" ], "variable": [ { "key": "contactId", "value": "" } ], "query": [] } } }, { "name": "Get a meeting", "request": { "method": "GET", "description": "Requires meetings:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/meetings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a meeting", "request": { "method": "PUT", "description": "Requires meetings:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/meetings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"reason\",\n \"type\": \"ONLINE\",\n \"startTime\": \"startTime\",\n \"startTimeLocal\": \"startTimeLocal\",\n \"timezone\": \"timezone\",\n \"durationMinutes\": 1,\n \"contactId\": \"contactId\",\n \"link\": \"link\",\n \"location\": \"location\",\n \"notes\": \"notes\",\n \"attendees\": [\n {\n \"type\": \"TEAM\",\n \"userId\": \"userId\",\n \"name\": \"name\",\n \"email\": \"customer@example.com\",\n \"phone\": \"966500000000\"\n }\n ]\n}" } } }, { "name": "Delete a meeting", "request": { "method": "DELETE", "description": "Requires meetings:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/meetings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Mark a meeting completed", "request": { "method": "POST", "description": "Requires meetings:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/meetings/:id/complete", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", ":id", "complete" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Mark a meeting cancelled", "request": { "method": "POST", "description": "Requires meetings:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/meetings/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "meetings", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] }, { "name": "Analytics", "item": [ { "name": "Get dashboard analytics", "request": { "method": "GET", "description": "Get aggregated dashboard statistics (conversations, messages, contacts, etc.). Requires analytics:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/analytics/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "analytics", "dashboard" ], "variable": [], "query": [] } } } ] }, { "name": "Knowledge Center", "item": [ { "name": "List knowledge categories", "request": { "method": "GET", "description": "Requires knowledge:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "categories" ], "variable": [], "query": [] } } }, { "name": "Create a knowledge category", "request": { "method": "POST", "description": "Requires knowledge:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "categories" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Shipping and returns\",\n \"description\": \"description\",\n \"icon\": \"icon\",\n \"color\": \"#3bc1a8\",\n \"parentId\": \"parentId\",\n \"sortOrder\": 1\n}" } } }, { "name": "Update a knowledge category", "request": { "method": "PUT", "description": "Requires knowledge:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"icon\": \"icon\",\n \"color\": \"color\",\n \"parentId\": \"parentId\",\n \"sortOrder\": 1\n}" } } }, { "name": "Delete a knowledge category", "request": { "method": "DELETE", "description": "Requires knowledge:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Reorder knowledge categories", "request": { "method": "PUT", "description": "Requires knowledge:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/categories/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "categories", "reorder" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"order\": [\n {\n \"id\": \"id\",\n \"sortOrder\": 1\n }\n ]\n}" } } }, { "name": "List knowledge articles", "request": { "method": "GET", "description": "Requires knowledge:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles" ], "variable": [], "query": [ { "key": "categoryId", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "tag", "value": "", "disabled": true }, { "key": "search", "value": "", "description": "Title or content.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "limit", "value": "", "description": "Page size (default 20).", "disabled": true } ] } } }, { "name": "Create a knowledge article", "request": { "method": "POST", "description": "Requires knowledge:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"How to reset your password\",\n \"content\": \"content\",\n \"categoryId\": \"categoryId\",\n \"excerpt\": \"excerpt\",\n \"tags\": [\n \"tags\"\n ],\n \"status\": \"DRAFT\"\n}" } } }, { "name": "Get a knowledge article", "request": { "method": "GET", "description": "Requires knowledge:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Update a knowledge article", "request": { "method": "PUT", "description": "Requires knowledge:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"title\",\n \"content\": \"content\",\n \"categoryId\": \"categoryId\",\n \"excerpt\": \"excerpt\",\n \"tags\": [\n \"tags\"\n ],\n \"status\": \"DRAFT\"\n}" } } }, { "name": "Delete a knowledge article", "request": { "method": "DELETE", "description": "Requires knowledge:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Publish a knowledge article", "request": { "method": "POST", "description": "Requires knowledge:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles/:id/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles", ":id", "publish" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Archive a knowledge article", "request": { "method": "POST", "description": "Requires knowledge:write permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles", ":id", "archive" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Search knowledge articles", "request": { "method": "GET", "description": "Requires knowledge:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "search" ], "variable": [], "query": [ { "key": "q", "value": "", "description": "Search text; empty returns nothing.", "disabled": true }, { "key": "limit", "value": "", "description": "Max results (default 20).", "disabled": true } ] } } }, { "name": "Quick-search knowledge articles", "request": { "method": "GET", "description": "Requires knowledge:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/quick-search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "quick-search" ], "variable": [], "query": [ { "key": "q", "value": "", "description": "Search text; empty returns nothing.", "disabled": true }, { "key": "limit", "value": "", "description": "Max results (default 5).", "disabled": true } ] } } }, { "name": "Submit article feedback", "request": { "method": "POST", "description": "Requires knowledge:write permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/knowledge-center/articles/:id/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "knowledge-center", "articles", ":id", "feedback" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"isHelpful\": true,\n \"comment\": \"comment\"\n}" } } } ] }, { "name": "Channels", "item": [ { "name": "Connection status of every channel (WhatsApp, Instagram, Messenger, Telegram, website chat)", "request": { "method": "GET", "description": "Aggregate connection state for all channels (WhatsApp, Instagram, Messenger, Telegram, Widget). One request, parallel-fetched. Requires channels:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/me/channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "me", "channels" ], "variable": [], "query": [] } } } ] }, { "name": "Scheduled messages", "item": [ { "name": "List scheduled messages", "request": { "method": "GET", "description": "Requires messages:read permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages" ], "variable": [], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "channel", "value": "", "disabled": true }, { "key": "limit", "value": "", "description": "1–200 (default 50); out of range is a 400.", "disabled": true }, { "key": "offset", "value": "", "description": "Rows to skip (default 0).", "disabled": true } ] } } }, { "name": "Schedule a message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"channel\": \"WHATSAPP\",\n \"recipientRef\": \"966500000000\",\n \"scheduledFor\": \"2026-09-20T09:00:00Z\",\n \"conversationId\": \"conversationId\",\n \"recurrence\": \"NONE\",\n \"payload\": {\n \"kind\": \"template\",\n \"templateName\": \"order_shipped\",\n \"languageCode\": \"ar\",\n \"bodyVariables\": {\n \"1\": \"Sara\"\n }\n }\n}" } } }, { "name": "Cancel a scheduled message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Pause a recurring message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Resume a paused message", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages", ":id", "resume" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Send a scheduled message now", "request": { "method": "POST", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages/:id/send-now", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages", ":id", "send-now" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "Delete a scheduled message", "request": { "method": "DELETE", "description": "Requires messages:send permission.", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/scheduled-messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "scheduled-messages", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } } ] } ] }