{"info":{"name":"WAQueen API","description":"Generated from the WAQueen OpenAPI 3.1 source-of-truth.","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://0.0.0.0:3010","type":"string"},{"key":"apiKey","value":"wsk_live_replace_me","type":"string"},{"key":"sessionId","value":"s_replace_me","type":"string"},{"key":"messageId","value":"msg_replace_me","type":"string"},{"key":"contactId","value":"ct_replace_me","type":"string"},{"key":"tagId","value":"tag_replace_me","type":"string"},{"key":"segmentId","value":"seg_replace_me","type":"string"},{"key":"knowledgeSourceId","value":"ks_replace_me","type":"string"},{"key":"serviceId","value":"svc_replace_me","type":"string"},{"key":"faqId","value":"faq_replace_me","type":"string"},{"key":"policyId","value":"pol_replace_me","type":"string"},{"key":"chatJid","value":"15551234567@s.whatsapp.net","type":"string"},{"key":"webhookDeliveryId","value":"whd_replace_me","type":"string"},{"key":"notificationReceiptId","value":"ntf_replace_me","type":"string"}],"item":[{"name":"WhatsApp","item":[{"name":"Check whether a phone number has WhatsApp","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/whatsapp/check-number","host":["{{baseUrl}}"],"path":["api","v1","whatsapp","check-number"]},"body":{"mode":"raw","raw":"{\n  \"phoneNumber\": \"+923001234567\"\n}","options":{"raw":{"language":"json"}}},"description":"Checks a direct phone number through a linked WhatsApp session. If sessionId is omitted, WAQueen selects the best connected or recoverable session for the API key's business."},"response":[]}]},{"name":"Messages","item":[{"name":"Queue a text, media, poll, or quick-reply message","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/messages","host":["{{baseUrl}}"],"path":["api","v1","messages"]},"body":{"mode":"raw","raw":"{\n  \"to\": \"+15551234567\",\n  \"interactive\": {\n    \"type\": \"poll\",\n    \"question\": \"Which delivery slot works best?\",\n    \"options\": [\n      \"Morning\",\n      \"Afternoon\",\n      \"Evening\"\n    ]\n  },\n  \"idempotencyKey\": \"order-4821-shipped\",\n  \"allowFallback\": true\n}","options":{"raw":{"language":"json"}}},"description":"Accepts a text, single media, poll, or quick-reply message into the durable per-session FIFO queue. Quick replies are sent as a single-answer WhatsApp poll for reliability. If sessionId is omitted, WAQueen selects the best send-ready session. If sessionId is provided with allowFallback=true, WAQueen may use another send-ready session only when the requested session is temporarily restoring. The response confirms queue acceptance; final delivery arrives through webhook status events."},"response":[]},{"name":"Upload media for a later message send","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/media/upload","host":["{{baseUrl}}"],"path":["api","v1","media","upload"]},"description":"Stores one media file in WAQueen-controlled storage and returns a mediaId. Use that mediaId in POST /api/v1/messages to avoid depending on an external public media URL."},"response":[]}]},{"name":"Business","item":[{"name":"Create business workspace and AI brain profile","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses","host":["{{baseUrl}}"],"path":["api","businesses"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"ABC Restaurant\",\n  \"slug\": \"abc-restaurant\",\n  \"category\": \"Restaurant\",\n  \"country\": \"Pakistan\",\n  \"city\": \"Lahore\",\n  \"timezone\": \"Asia/Karachi\",\n  \"phoneE164\": \"+923001234567\",\n  \"websiteUrl\": \"https://example.com\",\n  \"description\": \"We sell pizza, burgers and biryani.\",\n  \"brain\": {\n    \"goals\": [\n      \"support\",\n      \"sales\"\n    ],\n    \"languages\": [\n      \"English\",\n      \"Roman Urdu\"\n    ],\n    \"tone\": \"friendly\",\n    \"replyLength\": \"balanced\",\n    \"products\": [\n      {\n        \"name\": \"Pizza deal\",\n        \"description\": \"Large pizza with drink\",\n        \"price\": \"Rs 1800\"\n      }\n    ],\n    \"serviceArea\": \"5km around Gulberg Lahore\",\n    \"openingHours\": {\n      \"summary\": \"Mon-Sun 12pm to 1am\",\n      \"timezone\": \"Asia/Karachi\"\n    },\n    \"faqs\": [\n      {\n        \"question\": \"Do you deliver?\",\n        \"answer\": \"Yes, within 5km.\"\n      }\n    ],\n    \"policies\": {\n      \"refundPolicy\": \"Refunds are reviewed by support.\",\n      \"deliveryPolicy\": \"35 to 45 minutes.\"\n    },\n    \"handoffRules\": [\n      \"Refund disputes\",\n      \"Payment issues\"\n    ],\n    \"blockedTopics\": [\n      \"Legal advice\"\n    ],\n    \"allowedActions\": [\n      \"answer questions\",\n      \"collect lead details\",\n      \"handoff to human\"\n    ],\n    \"whatsappDefaults\": {\n      \"numberUse\": \"dedicated\",\n      \"dmPolicy\": \"pairing\",\n      \"groupPolicy\": \"disabled\",\n      \"groupRequireMention\": true,\n      \"delaySendMessagesMilliseconds\": 1000\n    }\n  }\n}","options":{"raw":{"language":"json"}}},"description":"Completes first-run onboarding. The `brain` object is optional for backward compatibility, but the dashboard wizard sends it to create structured AI context."},"response":[]},{"name":"Read current business workspace","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/businesses/current","host":["{{baseUrl}}"],"path":["api","businesses","current"]}},"response":[]},{"name":"Update current business profile","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/current","host":["{{baseUrl}}"],"path":["api","businesses","current"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"ABC Restaurant\",\n  \"timezone\": \"Asia/Karachi\",\n  \"category\": \"Restaurant\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Read AI Business Brain profile","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/businesses/brain","host":["{{baseUrl}}"],"path":["api","businesses","brain"]}},"response":[]},{"name":"Update AI Business Brain profile","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/brain","host":["{{baseUrl}}"],"path":["api","businesses","brain"]},"body":{"mode":"raw","raw":"{\n  \"goals\": [\n    \"support\",\n    \"bookings\"\n  ],\n  \"languages\": [\n    \"English\",\n    \"Roman Urdu\"\n  ],\n  \"tone\": \"supportive\",\n  \"replyLength\": \"balanced\",\n  \"handoffRules\": [\n    \"Payment issue\",\n    \"Angry customer\"\n  ],\n  \"whatsappDefaults\": {\n    \"numberUse\": \"dedicated\",\n    \"dmPolicy\": \"pairing\",\n    \"groupPolicy\": \"disabled\",\n    \"groupRequireMention\": true\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Preview generated AI business prompt summary","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/businesses/brain/generate-summary","host":["{{baseUrl}}"],"path":["api","businesses","brain","generate-summary"]}},"response":[]}]},{"name":"Knowledge","item":[{"name":"List knowledge sources","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge-sources","host":["{{baseUrl}}"],"path":["api","businesses","knowledge-sources"],"query":[{"key":"q","value":"","description":"Search title, description, or URL.","disabled":true},{"key":"type","value":"","description":"Filter by source type.","disabled":true},{"key":"status","value":"","description":"Filter by source status.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived sources.","disabled":false},{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]},{"name":"Create and optionally index a knowledge source","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge-sources","host":["{{baseUrl}}"],"path":["api","businesses","knowledge-sources"]},"body":{"mode":"raw","raw":"{\n  \"type\": \"faq\",\n  \"title\": \"Refund policy\",\n  \"content\": \"Refunds are reviewed by support. Wrong item refunds are eligible within 24 hours.\",\n  \"ingestNow\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Read a knowledge source","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge-sources/:id","host":["{{baseUrl}}"],"path":["api","businesses","knowledge-sources",":id"],"variable":[{"key":"id","value":"{{knowledgeSourceId}}"}]}},"response":[]},{"name":"Update a knowledge source","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge-sources/:id","host":["{{baseUrl}}"],"path":["api","businesses","knowledge-sources",":id"],"variable":[{"key":"id","value":"{{knowledgeSourceId}}"}]},"body":{"mode":"raw","raw":"{\n  \"title\": \"Updated refund policy\",\n  \"description\": \"Operator-reviewed policy text\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a knowledge source","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge-sources/:id","host":["{{baseUrl}}"],"path":["api","businesses","knowledge-sources",":id"],"variable":[{"key":"id","value":"{{knowledgeSourceId}}"}]}},"response":[]},{"name":"Reindex a knowledge source","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge-sources/:id/reindex","host":["{{baseUrl}}"],"path":["api","businesses","knowledge-sources",":id","reindex"],"variable":[{"key":"id","value":"{{knowledgeSourceId}}"}]},"body":{"mode":"raw","raw":"{\n  \"content\": \"Replacement verified policy text.\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Search indexed knowledge chunks","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/knowledge/search","host":["{{baseUrl}}"],"path":["api","businesses","knowledge","search"]},"body":{"mode":"raw","raw":"{\n  \"query\": \"refund policy\",\n  \"limit\": 5,\n  \"source\": \"crm_bot\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Preview AI reply context","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/ai-context/preview","host":["{{baseUrl}}"],"path":["api","businesses","ai-context","preview"]},"body":{"mode":"raw","raw":"{\n  \"messageText\": \"Large pizza kitny ki hai aur delivery Gulberg mein hoti hai?\",\n  \"sessionId\": \"{{sessionId}}\",\n  \"chatJid\": \"{{chatJid}}\",\n  \"knowledgeLimit\": 6,\n  \"messageLimit\": 12,\n  \"tokenBudget\": 6000\n}","options":{"raw":{"language":"json"}}},"description":"Builds the same compact context pack the AI reply pipeline will use: business profile, contact/conversation state, approved KB chunks, source IDs, and safety/handoff decision flags."},"response":[]},{"name":"List governed services and pricing","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services","host":["{{baseUrl}}"],"path":["api","businesses","services"],"query":[{"key":"q","value":"","description":"Search name, description, or category.","disabled":true},{"key":"status","value":"","description":"Filter by governance status.","disabled":true},{"key":"availability","value":"","description":"Filter by availability.","disabled":true},{"key":"category","value":"","description":"Filter by category.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived services.","disabled":false},{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]},{"name":"Create a governed service or priced catalog item","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services","host":["{{baseUrl}}"],"path":["api","businesses","services"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"Large Pizza\",\n  \"description\": \"Large chicken fajita pizza\",\n  \"category\": \"Pizza\",\n  \"availability\": \"available\",\n  \"tags\": [\n    \"menu\",\n    \"popular\"\n  ],\n  \"price\": {\n    \"priceType\": \"fixed\",\n    \"amountMinor\": 180000,\n    \"currency\": \"PKR\",\n    \"unit\": \"item\",\n    \"displayPrice\": \"Rs. 1800\"\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Read a governed service","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services/:id","host":["{{baseUrl}}"],"path":["api","businesses","services",":id"],"variable":[{"key":"id","value":"{{serviceId}}"}]}},"response":[]},{"name":"Update a governed service","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services/:id","host":["{{baseUrl}}"],"path":["api","businesses","services",":id"],"variable":[{"key":"id","value":"{{serviceId}}"}]},"body":{"mode":"raw","raw":"{\n  \"price\": {\n    \"priceType\": \"from\",\n    \"amountMinor\": 150000,\n    \"currency\": \"PKR\",\n    \"displayPrice\": \"From Rs. 1500\"\n  },\n  \"changeReason\": \"Menu price changed\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a governed service","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services/:id","host":["{{baseUrl}}"],"path":["api","businesses","services",":id"],"variable":[{"key":"id","value":"{{serviceId}}"}]}},"response":[]},{"name":"Publish a governed service and index it","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services/:id/publish","host":["{{baseUrl}}"],"path":["api","businesses","services",":id","publish"],"variable":[{"key":"id","value":"{{serviceId}}"}]},"body":{"mode":"raw","raw":"{\n  \"changeReason\": \"Approved by catalog owner\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a governed service","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services/:id/archive","host":["{{baseUrl}}"],"path":["api","businesses","services",":id","archive"],"variable":[{"key":"id","value":"{{serviceId}}"}]},"body":{"mode":"raw","raw":"{\n  \"changeReason\": \"Removed from menu\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List service revisions","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/services/:id/revisions","host":["{{baseUrl}}"],"path":["api","businesses","services",":id","revisions"],"variable":[{"key":"id","value":"{{serviceId}}"}],"query":[{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]},{"name":"List governed FAQs","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs","host":["{{baseUrl}}"],"path":["api","businesses","faqs"],"query":[{"key":"q","value":"","description":"Search question, answer, or category.","disabled":true},{"key":"status","value":"","description":"Filter by governance status.","disabled":true},{"key":"category","value":"","description":"Filter by category.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived FAQs.","disabled":false},{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]},{"name":"Create a governed FAQ","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs","host":["{{baseUrl}}"],"path":["api","businesses","faqs"]},"body":{"mode":"raw","raw":"{\n  \"question\": \"Delivery area kya hai?\",\n  \"answer\": \"Hum Gulberg Lahore ke 5km radius mein delivery karte hain.\",\n  \"category\": \"delivery\",\n  \"tags\": [\n    \"delivery\",\n    \"support\"\n  ],\n  \"handoffRequired\": false\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Read a governed FAQ","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs/:id","host":["{{baseUrl}}"],"path":["api","businesses","faqs",":id"],"variable":[{"key":"id","value":"{{faqId}}"}]}},"response":[]},{"name":"Update a governed FAQ","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs/:id","host":["{{baseUrl}}"],"path":["api","businesses","faqs",":id"],"variable":[{"key":"id","value":"{{faqId}}"}]},"body":{"mode":"raw","raw":"{\n  \"answer\": \"Updated verified delivery answer.\",\n  \"changeReason\": \"Policy changed\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a governed FAQ","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs/:id","host":["{{baseUrl}}"],"path":["api","businesses","faqs",":id"],"variable":[{"key":"id","value":"{{faqId}}"}]}},"response":[]},{"name":"Publish a governed FAQ","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs/:id/publish","host":["{{baseUrl}}"],"path":["api","businesses","faqs",":id","publish"],"variable":[{"key":"id","value":"{{faqId}}"}]},"body":{"mode":"raw","raw":"{\n  \"changeReason\": \"Approved by support lead\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List FAQ revisions","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/faqs/:id/revisions","host":["{{baseUrl}}"],"path":["api","businesses","faqs",":id","revisions"],"variable":[{"key":"id","value":"{{faqId}}"}],"query":[{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]},{"name":"List governed policies","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies","host":["{{baseUrl}}"],"path":["api","businesses","policies"],"query":[{"key":"q","value":"","description":"Search title, body, or category.","disabled":true},{"key":"status","value":"","description":"Filter by governance status.","disabled":true},{"key":"type","value":"","description":"Filter by policy type.","disabled":true},{"key":"severity","value":"","description":"Filter by severity.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived policies.","disabled":false},{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]},{"name":"Create a governed policy","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies","host":["{{baseUrl}}"],"path":["api","businesses","policies"]},"body":{"mode":"raw","raw":"{\n  \"type\": \"refund\",\n  \"title\": \"Refund policy\",\n  \"body\": \"Wrong item refund is eligible within 24 hours after support review.\",\n  \"severity\": \"sensitive\",\n  \"handoffRequired\": true,\n  \"blockedIfUnclear\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Read a governed policy","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies/:id","host":["{{baseUrl}}"],"path":["api","businesses","policies",":id"],"variable":[{"key":"id","value":"{{policyId}}"}]}},"response":[]},{"name":"Update a governed policy","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies/:id","host":["{{baseUrl}}"],"path":["api","businesses","policies",":id"],"variable":[{"key":"id","value":"{{policyId}}"}]},"body":{"mode":"raw","raw":"{\n  \"body\": \"Updated verified policy text.\",\n  \"changeReason\": \"Operations update\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a governed policy","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies/:id","host":["{{baseUrl}}"],"path":["api","businesses","policies",":id"],"variable":[{"key":"id","value":"{{policyId}}"}]}},"response":[]},{"name":"Publish a governed policy","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies/:id/publish","host":["{{baseUrl}}"],"path":["api","businesses","policies",":id","publish"],"variable":[{"key":"id","value":"{{policyId}}"}]},"body":{"mode":"raw","raw":"{\n  \"changeReason\": \"Approved by policy owner\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List policy revisions","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/businesses/policies/:id/revisions","host":["{{baseUrl}}"],"path":["api","businesses","policies",":id","revisions"],"variable":[{"key":"id","value":"{{policyId}}"}],"query":[{"key":"limit","value":"100","description":"Maximum rows to return.","disabled":false}]}},"response":[]}]},{"name":"Sessions","item":[{"name":"List WhatsApp sessions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions","host":["{{baseUrl}}"],"path":["api","sessions"]}},"response":[]},{"name":"Create a WhatsApp session","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/sessions","host":["{{baseUrl}}"],"path":["api","sessions"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"support-line\",\n  \"webhookUrl\": \"https://example.com/wa\",\n  \"dmPolicy\": \"pairing\",\n  \"settings\": {\n    \"delaySendMessagesMilliseconds\": 1000,\n    \"outgoingAPIMessageWebhook\": true,\n    \"stateWebhook\": true\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Get one WhatsApp session","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id","host":["{{baseUrl}}"],"path":["api","sessions",":id"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Update session settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/sessions/:id","host":["{{baseUrl}}"],"path":["api","sessions",":id"],"variable":[{"key":"id","value":"{{sessionId}}"}]},"body":{"mode":"raw","raw":"{\n  \"webhookUrl\": \"https://example.com/wa\",\n  \"settings\": {\n    \"delaySendMessagesMilliseconds\": 1500\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete a WhatsApp session","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id","host":["{{baseUrl}}"],"path":["api","sessions",":id"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Read QR pairing state","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/qr","host":["{{baseUrl}}"],"path":["api","sessions",":id","qr"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Start or refresh QR pairing","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/qr","host":["{{baseUrl}}"],"path":["api","sessions",":id","qr"],"variable":[{"key":"id","value":"{{sessionId}}"}],"query":[{"key":"refresh","value":"","description":"Use 1 to force a fresh pairing socket when possible.","disabled":true}]}},"response":[]},{"name":"Read connection status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/status","host":["{{baseUrl}}"],"path":["api","sessions",":id","status"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Read persisted auth health","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/persistence","host":["{{baseUrl}}"],"path":["api","sessions",":id","persistence"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Read deep session diagnostics","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/diagnostics","host":["{{baseUrl}}"],"path":["api","sessions",":id","diagnostics"],"variable":[{"key":"id","value":"{{sessionId}}"}],"query":[{"key":"warmup","value":"","description":"Use 1 to attempt persisted-session warmup before returning diagnostics.","disabled":true}]}},"response":[]},{"name":"List recent session events","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/events","host":["{{baseUrl}}"],"path":["api","sessions",":id","events"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Restart a WhatsApp session socket","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/restart","host":["{{baseUrl}}"],"path":["api","sessions",":id","restart"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Logout a WhatsApp session","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/sessions/:id/logout","host":["{{baseUrl}}"],"path":["api","sessions",":id","logout"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]}]},{"name":"Queue","item":[{"name":"Inspect a session outbound queue","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/sessions/:id/queue","host":["{{baseUrl}}"],"path":["api","sessions",":id","queue"],"variable":[{"key":"id","value":"{{sessionId}}"}],"query":[{"key":"status","value":"queued","description":"queued, all, terminal, or a comma-separated list of statuses.","disabled":false},{"key":"limit","value":"50","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Cancel all unlocked queued messages for one session","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/sessions/:id/queue/clear","host":["{{baseUrl}}"],"path":["api","sessions",":id","queue","clear"],"variable":[{"key":"id","value":"{{sessionId}}"}]},"body":{"mode":"raw","raw":"{\n  \"reason\": \"Number changed\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Read one outbound message lifecycle record","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/messages/:id","host":["{{baseUrl}}"],"path":["api","messages",":id"],"variable":[{"key":"id","value":"{{messageId}}"}]}},"response":[]},{"name":"Cancel one queued outbound message","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/messages/:id/cancel","host":["{{baseUrl}}"],"path":["api","messages",":id","cancel"],"variable":[{"key":"id","value":"{{messageId}}"}]},"body":{"mode":"raw","raw":"{\n  \"reason\": \"Customer opted out\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Move a failed or cancelled message back to the queue","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/messages/:id/retry","host":["{{baseUrl}}"],"path":["api","messages",":id","retry"],"variable":[{"key":"id","value":"{{messageId}}"}]},"body":{"mode":"raw","raw":"{\n  \"delayMs\": 0\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Inbox","item":[{"name":"Stream inbox snapshots","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/events","host":["{{baseUrl}}"],"path":["api","inbox","events"],"query":[{"key":"sessionId","value":"","description":"Filter to one WhatsApp session.","disabled":true},{"key":"chatJid","value":"","description":"Selected chat JID. Requires sessionId and includes thread messages in snapshot events.","disabled":true},{"key":"q","value":"","description":"Search chat JID, display name, or last message preview.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived conversations.","disabled":false},{"key":"limit","value":"50","description":"Maximum conversation rows per snapshot.","disabled":false},{"key":"messageLimit","value":"50","description":"Maximum selected-thread messages per snapshot.","disabled":false}]},"description":"Server-sent event stream for dashboard-style realtime inbox refresh. Emits `snapshot` events with the current conversation list and, when `sessionId` plus `chatJid` are provided, the selected thread messages. Clients should keep ordinary REST polling as a fallback."},"response":[]},{"name":"List inbox conversations","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations","host":["{{baseUrl}}"],"path":["api","inbox","conversations"],"query":[{"key":"sessionId","value":"","description":"Filter to one WhatsApp session.","disabled":true},{"key":"q","value":"","description":"Search chat JID, display name, or last message preview.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived conversations.","disabled":false},{"key":"limit","value":"50","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Create or find an inbox conversation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations","host":["{{baseUrl}}"],"path":["api","inbox","conversations"]},"body":{"mode":"raw","raw":"{\n  \"sessionId\": \"s_abc123\",\n  \"chatJid\": \"15551234567@s.whatsapp.net\",\n  \"displayName\": \"Ali Khan\"\n}","options":{"raw":{"language":"json"}}},"description":"Bootstraps an empty conversation from a contact, phone number, or chat JID so operators can open the thread and send the first message."},"response":[]},{"name":"Get one inbox conversation","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations/:chatJid","host":["{{baseUrl}}"],"path":["api","inbox","conversations",":chatJid"],"variable":[{"key":"chatJid","value":"{{chatJid}}"}],"query":[{"key":"sessionId","value":"","description":"Owning WhatsApp session id.","disabled":true}]}},"response":[]},{"name":"Update inbox conversation metadata","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations/:chatJid","host":["{{baseUrl}}"],"path":["api","inbox","conversations",":chatJid"],"variable":[{"key":"chatJid","value":"{{chatJid}}"}]},"body":{"mode":"raw","raw":"{\n  \"sessionId\": \"s_abc123\",\n  \"archived\": true,\n  \"tags\": [\n    \"vip\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List messages in one conversation","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations/:chatJid/messages","host":["{{baseUrl}}"],"path":["api","inbox","conversations",":chatJid","messages"],"variable":[{"key":"chatJid","value":"{{chatJid}}"}],"query":[{"key":"sessionId","value":"","description":"Owning WhatsApp session id.","disabled":true},{"key":"before","value":"","description":"Return messages before this Unix timestamp in milliseconds.","disabled":true},{"key":"limit","value":"50","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Request WhatsApp history resync","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations/:chatJid/resync","host":["{{baseUrl}}"],"path":["api","inbox","conversations",":chatJid","resync"],"variable":[{"key":"chatJid","value":"{{chatJid}}"}]},"body":{"mode":"raw","raw":"{\n  \"sessionId\": \"s_abc123\",\n  \"count\": 50,\n  \"fallbackFullSync\": true\n}","options":{"raw":{"language":"json"}}},"description":"Requests more WhatsApp history for a conversation. If an oldest stored WhatsApp message exists, WAQueen asks Baileys for older messages for that chat. If no anchor exists and fallbackFullSync is true, WAQueen requests a full session history sync restart."},"response":[]},{"name":"Mark one conversation read","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations/:chatJid/read","host":["{{baseUrl}}"],"path":["api","inbox","conversations",":chatJid","read"],"variable":[{"key":"chatJid","value":"{{chatJid}}"}]},"body":{"mode":"raw","raw":"{\n  \"sessionId\": \"s_abc123\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Reply to a conversation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/inbox/conversations/:chatJid/reply","host":["{{baseUrl}}"],"path":["api","inbox","conversations",":chatJid","reply"],"variable":[{"key":"chatJid","value":"{{chatJid}}"}]},"body":{"mode":"raw","raw":"{\n  \"sessionId\": \"s_abc123\",\n  \"text\": \"Your order is out for delivery.\",\n  \"replyToMessageId\": \"msg_inbound_123\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Contacts","item":[{"name":"List contacts","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts","host":["{{baseUrl}}"],"path":["api","contacts"],"query":[{"key":"q","value":"","description":"Search phone, JID, name, display name, or notes.","disabled":true},{"key":"tag","value":"","description":"Filter by one normalized tag.","disabled":true},{"key":"type","value":"all","description":"Filter by contact type.","disabled":false},{"key":"status","value":"all","description":"Filter by policy status.","disabled":false},{"key":"limit","value":"50","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Create or upsert a contact","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts","host":["{{baseUrl}}"],"path":["api","contacts"]},"body":{"mode":"raw","raw":"{\n  \"phoneE164\": \"+15551234567\",\n  \"displayName\": \"Ali Khan\",\n  \"tags\": [\n    \"vip\",\n    \"refund\"\n  ],\n  \"notes\": \"Invoice dispute customer\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Get one contact","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/:id","host":["{{baseUrl}}"],"path":["api","contacts",":id"],"variable":[{"key":"id","value":"{{contactId}}"}]}},"response":[]},{"name":"Update a contact","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/:id","host":["{{baseUrl}}"],"path":["api","contacts",":id"],"variable":[{"key":"id","value":"{{contactId}}"}]},"body":{"mode":"raw","raw":"{\n  \"displayName\": \"Ali Khan\",\n  \"tags\": [\n    \"vip\"\n  ],\n  \"notes\": \"Prefers WhatsApp updates\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete a contact","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/:id","host":["{{baseUrl}}"],"path":["api","contacts",":id"],"variable":[{"key":"id","value":"{{contactId}}"}]}},"response":[]},{"name":"Update persisted lead state for one contact","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/:id/lead","host":["{{baseUrl}}"],"path":["api","contacts",":id","lead"],"variable":[{"key":"id","value":"{{contactId}}"}]},"body":{"mode":"raw","raw":"{\n  \"action\": \"update_details\",\n  \"capturedDetails\": {\n    \"name\": \"Ali Khan\",\n    \"phone\": \"+15551234567\",\n    \"serviceInterest\": \"website design\",\n    \"budget\": \"PKR 50000\"\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Block or unblock a contact","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/:id/block","host":["{{baseUrl}}"],"path":["api","contacts",":id","block"],"variable":[{"key":"id","value":"{{contactId}}"}]},"body":{"mode":"raw","raw":"{\n  \"blocked\": true,\n  \"reason\": \"Support blocklist\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Opt a contact out or back in","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/:id/opt-out","host":["{{baseUrl}}"],"path":["api","contacts",":id","opt-out"],"variable":[{"key":"id","value":"{{contactId}}"}]},"body":{"mode":"raw","raw":"{\n  \"optedOut\": true,\n  \"reason\": \"STOP\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Check WhatsApp account availability","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/check-whatsapp","host":["{{baseUrl}}"],"path":["api","contacts","check-whatsapp"]},"body":{"mode":"raw","raw":"{\n  \"sessionId\": \"s_abc123\",\n  \"phoneNumber\": \"+15551234567\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Bulk add or remove contact tags","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/contacts/bulk-tags","host":["{{baseUrl}}"],"path":["api","contacts","bulk-tags"]},"body":{"mode":"raw","raw":"{\n  \"contactIds\": [\n    \"ct_123\",\n    \"ct_456\"\n  ],\n  \"addTags\": [\n    \"vip\"\n  ],\n  \"removeTags\": [\n    \"cold-lead\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Tags","item":[{"name":"List tags","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/tags","host":["{{baseUrl}}"],"path":["api","tags"],"query":[{"key":"q","value":"","description":"Search by slug, name, or description.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived tags.","disabled":false},{"key":"limit","value":"100","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Create or restore a tag","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/tags","host":["{{baseUrl}}"],"path":["api","tags"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"VIP\",\n  \"color\": \"violet\",\n  \"description\": \"Priority support customers\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Get one tag","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/tags/:id","host":["{{baseUrl}}"],"path":["api","tags",":id"],"variable":[{"key":"id","value":"{{tagId}}"}]}},"response":[]},{"name":"Update a tag","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/tags/:id","host":["{{baseUrl}}"],"path":["api","tags",":id"],"variable":[{"key":"id","value":"{{tagId}}"}]},"body":{"mode":"raw","raw":"{\n  \"name\": \"VIP\",\n  \"color\": \"amber\",\n  \"description\": \"High-priority customers\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a tag","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/tags/:id","host":["{{baseUrl}}"],"path":["api","tags",":id"],"variable":[{"key":"id","value":"{{tagId}}"}]}},"response":[]}]},{"name":"Segments","item":[{"name":"List segments","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments","host":["{{baseUrl}}"],"path":["api","segments"],"query":[{"key":"q","value":"","description":"Search by slug, name, or description.","disabled":true},{"key":"includeArchived","value":"false","description":"Include archived segments.","disabled":false},{"key":"limit","value":"100","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Create a segment","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments","host":["{{baseUrl}}"],"path":["api","segments"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"VIP active customers\",\n  \"type\": \"dynamic\",\n  \"defaultExcludesBlocked\": true,\n  \"defaultExcludesOptedOut\": true,\n  \"rules\": {\n    \"all\": [\n      {\n        \"field\": \"tags\",\n        \"op\": \"has\",\n        \"value\": \"vip\"\n      },\n      {\n        \"field\": \"lastInboundAt\",\n        \"op\": \"afterDaysAgo\",\n        \"value\": 30\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Preview unsaved segment rules","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/preview","host":["{{baseUrl}}"],"path":["api","segments","preview"]},"body":{"mode":"raw","raw":"{\n  \"defaultExcludesBlocked\": true,\n  \"defaultExcludesOptedOut\": true,\n  \"limit\": 50,\n  \"rules\": {\n    \"all\": [\n      {\n        \"field\": \"tags\",\n        \"op\": \"has\",\n        \"value\": \"vip\"\n      },\n      {\n        \"field\": \"lastInboundAt\",\n        \"op\": \"afterDaysAgo\",\n        \"value\": 30\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Get one segment","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/:id","host":["{{baseUrl}}"],"path":["api","segments",":id"],"variable":[{"key":"id","value":"{{segmentId}}"}]}},"response":[]},{"name":"Update a segment","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/:id","host":["{{baseUrl}}"],"path":["api","segments",":id"],"variable":[{"key":"id","value":"{{segmentId}}"}]},"body":{"mode":"raw","raw":"{\n  \"description\": \"Priority support segment\",\n  \"defaultExcludesOptedOut\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive a segment","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/:id","host":["{{baseUrl}}"],"path":["api","segments",":id"],"variable":[{"key":"id","value":"{{segmentId}}"}]}},"response":[]},{"name":"List contacts in a segment","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/:id/contacts","host":["{{baseUrl}}"],"path":["api","segments",":id","contacts"],"variable":[{"key":"id","value":"{{segmentId}}"}],"query":[{"key":"limit","value":"100","description":"Maximum number of contacts to return.","disabled":false}]}},"response":[]},{"name":"Preview one saved segment","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/:id/preview","host":["{{baseUrl}}"],"path":["api","segments",":id","preview"],"variable":[{"key":"id","value":"{{segmentId}}"}]}},"response":[]},{"name":"Recalculate segment membership cache","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/segments/:id/recalculate","host":["{{baseUrl}}"],"path":["api","segments",":id","recalculate"],"variable":[{"key":"id","value":"{{segmentId}}"}]}},"response":[]}]},{"name":"Webhooks","item":[{"name":"List webhook delivery attempts","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/webhook-deliveries","host":["{{baseUrl}}"],"path":["api","webhook-deliveries"],"query":[{"key":"status","value":"all","description":"pending, delivering, delivered, failed, or all.","disabled":false},{"key":"sessionId","value":"","description":"Filter to one WhatsApp session.","disabled":true},{"key":"limit","value":"50","description":"Maximum number of rows to return.","disabled":false}]}},"response":[]},{"name":"Replay a delivered or failed webhook delivery","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/webhook-deliveries/:id/replay","host":["{{baseUrl}}"],"path":["api","webhook-deliveries",":id","replay"],"variable":[{"key":"id","value":"{{webhookDeliveryId}}"}]},"body":{"mode":"raw","raw":"{\n  \"delayMs\": 0\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Queue a signed test webhook","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/sessions/:id/webhook/test","host":["{{baseUrl}}"],"path":["api","sessions",":id","webhook","test"],"variable":[{"key":"id","value":"{{sessionId}}"}]}},"response":[]},{"name":"Receive the next webhook notification","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/notifications/receive","host":["{{baseUrl}}"],"path":["api","v1","notifications","receive"],"query":[{"key":"sessionId","value":"","description":"Filter to one WhatsApp session.","disabled":true},{"key":"leaseMs","value":"300000","description":"How long to hide this receipt before it can be received again if not deleted.","disabled":false}]},"description":"GreenAPI-style polling fallback for customers without a public webhook endpoint. Returns the oldest available event notification, then the client confirms processing with DELETE /api/v1/notifications/{id}."},"response":[]},{"name":"Delete a processed webhook notification","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/notifications/:id","host":["{{baseUrl}}"],"path":["api","v1","notifications",":id"],"variable":[{"key":"id","value":"{{notificationReceiptId}}"}]}},"response":[]}]},{"name":"API Keys","item":[{"name":"List API keys","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/api-keys","host":["{{baseUrl}}"],"path":["api","api-keys"],"query":[{"key":"status","value":"active","description":"Filter by key lifecycle state.","disabled":false},{"key":"q","value":"","description":"Search API key labels.","disabled":true},{"key":"limit","value":"25","description":"Maximum keys to return, from 1 to 50.","disabled":false},{"key":"cursor","value":"","description":"Cursor returned by the previous list response.","disabled":true}]}},"response":[]},{"name":"Create an API key","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/api-keys","host":["{{baseUrl}}"],"path":["api","api-keys"]},"body":{"mode":"raw","raw":"{\n  \"label\": \"production\",\n  \"environment\": \"live\",\n  \"scopes\": [\n    \"messages:send\",\n    \"messages:read\"\n  ],\n  \"rateLimitPerMinute\": 60\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Revoke an API key","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/api/api-keys","host":["{{baseUrl}}"],"path":["api","api-keys"],"query":[{"key":"id","value":"","description":"API key id to revoke.","disabled":true}]}},"response":[]},{"name":"Rotate an API key","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/api-keys/:id/rotate","host":["{{baseUrl}}"],"path":["api","api-keys",":id","rotate"],"variable":[{"key":"id","value":"{{id}}"}]}},"response":[]}]},{"name":"Developer","item":[{"name":"Download OpenAPI specification","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/openapi","host":["{{baseUrl}}"],"path":["api","openapi"]}},"response":[]},{"name":"Download OpenAPI specification as JSON","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/openapi.json","host":["{{baseUrl}}"],"path":["api","openapi.json"]}},"response":[]},{"name":"Download Postman collection","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/postman","host":["{{baseUrl}}"],"path":["api","postman"]}},"response":[]}]}]}