# Go-live checklist Source: https://docs.wapitick.com/go-live 1. **Live key, least privilege.** Create a `wk_live_` key with only the scopes you use, bound to one Business if you have several, with an IP allow-list for your servers. Keep it in a secret store, never in a browser or an app. 2. **WhatsApp number connected** in Wapitick and in good quality; templates you send outside the 24-hour window are **approved** (`GET /v1/templates`). 3. **Consent.** Only message people who agreed to hear from you; record it (`contacts_record_consent`) and honour `STOP` (`contact.opted_out`). 4. **Idempotency.** Every write carries an `Idempotency-Key` (the SDKs do this). Retries never double-send. 5. **Webhooks.** A live endpoint (test endpoints never get live events), signature verified on the raw body, answers within 10 s, de-duplicates on the event `id`. 6. **Errors.** Handle `422 window_closed` (send a template), `429` (wait `Retry-After`), `402 entitlement_required` (plan), `insufficient_balance` (top up). See [Errors](/errors). 7. **Limits.** Check `GET /v1/api-usage` against `api.requests_per_min` and `api.requests.day` for your plan. 8. **Monitoring.** Watch `GET /v1/request-logs?status=error` and the webhook delivery log for a week. --- # Reply with the AI Assistant Source: https://docs.wapitick.com/guides/ai-assistant The AI Assistant is set up by the business in Wapitick (what it may answer, its knowledge, when it hands over to a person). From your code you decide **which chats** it handles: `POST /v1/conversations/{id}/ai/resume` hands a chat to it, `.../ai/pause` takes it back, `GET .../ai` shows who is answering. Replies use the business's AI credits, so this works with **live keys only** (a test key answers `403 test_mode_unsupported`). **cURL** ```bash title="curl.sh" #!/usr/bin/env bash # Reply with the AI Assistant (live keys only: uses AI credits): conversations_list, conversations_ai_get, conversations_ai_resume (runs in test mode) set -euo pipefail API="${WAPITICK_API_URL:-https://api.wapitick.com}" AUTH="Authorization: Bearer $WAPITICK_API_KEY" # Hand an open chat to your AI Assistant (it answers from your knowledge and hands back to a person when unsure) CONV=$(curl -sf "$API/v1/conversations?status=open&limit=1" -H "$AUTH" | jq -r '.data[0].id') curl -sf "$API/v1/conversations/$CONV/ai" -H "$AUTH" | jq '{handled_by, paused}' curl -sf -X POST "$API/v1/conversations/$CONV/ai/resume" -H "$AUTH" -H "Idempotency-Key: ai-$CONV" | jq . ``` **Node** ```js title="node.mjs" // biome-ignore-all lint/suspicious/noConsole: a docs sample prints its result // Reply with the AI Assistant (live keys only): conversations_list, conversations_ai_resume import { Wapitick } from "@wapitick/node"; const wapitick = new Wapitick({ apiKey: process.env.WAPITICK_API_KEY, baseUrl: process.env.WAPITICK_API_URL, }); const [chat] = (await wapitick.conversations.list({ status: "open", limit: 1 })).data; const r = await wapitick.request("POST", `/v1/conversations/${chat.id}/ai/resume`); console.log(JSON.stringify(r)); ``` **Python** ```python title="python.py" # Reply with the AI Assistant (live keys only): conversations_list, conversations_ai_resume import json import os from wapitick import Wapitick w = Wapitick(api_key=os.environ["WAPITICK_API_KEY"], base_url=os.environ.get("WAPITICK_API_URL", "https://api.wapitick.com")) chat = w.call("conversations_list", query={"status": "open", "limit": 1})["data"][0] print(json.dumps(w.call("conversations_ai_resume", {"conversation_id": chat["id"]}))) ``` **PHP** ```php title="php.php" call('conversations_list', [], ['status' => 'open', 'limit' => 1])['data'][0]; echo json_encode($w->call('conversations_ai_resume', ['conversation_id' => $chat['id']])), "\n"; ``` Operations: `conversations_list`, `conversations_ai_get`, `conversations_ai_resume`, `conversations_ai_pause`. --- # Capture a lead into the inbox Source: https://docs.wapitick.com/guides/capture-lead `POST /v1/contacts:upsert` with a tag (`website-lead`) and `source`. The business sees the lead in Customers; the moment the person writes on WhatsApp the chat opens in the inbox with that history. Do not message a lead first unless they agreed to it: record consent with `POST /v1/contacts/{id}/consents`, or use a Wapitick [lead form](/website), which records the exact wording they agreed to. **cURL** ```bash title="curl.sh" #!/usr/bin/env bash # Capture a lead into the inbox: contacts_upsert, test_inbound_create, conversations_list (runs in test mode) set -euo pipefail API="${WAPITICK_API_URL:-https://api.wapitick.com}" AUTH="Authorization: Bearer $WAPITICK_API_KEY" # From your own form: save the lead with a tag curl -sf "$API/v1/contacts:upsert" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: lead-$(date +%s)" \ -d '{"match":{"kind":"phone","value":"+15550100007"},"create_if_missing":true,"data":{"name":"Ravi","phones":["+15550100007"],"tags":["website-lead"],"source":"lead"}}' | jq '{id: .contact.id, created}' # In test mode, simulate the lead messaging you; the chat opens in the inbox curl -sf "$API/v1/test/inbound" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: lead-in-$(date +%s)" \ -d '{"from":"+15550100007","text":"I filled your form, please call me","name":"Ravi"}' >/dev/null sleep 3 curl -sf "$API/v1/conversations?limit=3" -H "$AUTH" | jq '[.data[] | {id, status}]' ``` **Node** ```js title="node.mjs" // biome-ignore-all lint/suspicious/noConsole: a docs sample prints its result // Capture a lead into the inbox: contacts_upsert, test_inbound_create, conversations_list import { Wapitick } from "@wapitick/node"; const wapitick = new Wapitick({ apiKey: process.env.WAPITICK_API_KEY, baseUrl: process.env.WAPITICK_API_URL, }); const lead = await wapitick.contacts.upsert({ phone: "+15550100007", name: "Ravi", tags: ["website-lead"] }); if (wapitick.testMode) await wapitick.test.inbound({ from: "+15550100007", text: "I filled your form, please call me", name: "Ravi", }); await new Promise((r) => setTimeout(r, 3000)); const chats = await wapitick.conversations.list({ limit: 3 }); console.log(JSON.stringify({ lead: lead.contact.id, conversations: chats.data.length })); ``` **Python** ```python title="python.py" # Capture a lead into the inbox: contacts_upsert, test_inbound_create, conversations_list import json import os import time from wapitick import Wapitick w = Wapitick(api_key=os.environ["WAPITICK_API_KEY"], base_url=os.environ.get("WAPITICK_API_URL", "https://api.wapitick.com")) lead = w.contacts.upsert("+15550100007", name="Ravi", tags=["website-lead"]) if w.test_mode: w.test.inbound("+15550100007", "I filled your form, please call me", name="Ravi") time.sleep(3) chats = w.call("conversations_list", query={"limit": 3}) print(json.dumps({"lead": lead["contact"]["id"], "conversations": len(chats["data"])})) ``` **PHP** ```php title="php.php" upsertContact('+15550100007', 'Ravi', null, ['website-lead']); if ($w->isTestMode()) { $w->simulateInbound('+15550100007', 'I filled your form, please call me'); } sleep(3); $chats = $w->call('conversations_list', [], ['limit' => 3]); echo json_encode(['lead' => $lead['contact']['id'], 'conversations' => count($chats['data'])]), "\n"; ``` **Google Apps Script** ```js title="apps-script.gs" // biome-ignore-all lint/correctness/noUnusedVariables: Apps Script runs these functions by name // Google Forms -> Wapitick lead: install as an onFormSubmit trigger. contacts_upsert. // Script properties: WAPITICK_API_KEY (wk_test_...), optional WAPITICK_API_URL. function wapitick_(method, path, body) { const props = PropertiesService.getScriptProperties(); const base = props.getProperty("WAPITICK_API_URL") || "https://api.wapitick.com"; const res = UrlFetchApp.fetch(base + path, { method: method, contentType: "application/json", headers: { Authorization: `Bearer ${props.getProperty("WAPITICK_API_KEY")}`, "Idempotency-Key": Utilities.getUuid(), }, payload: body ? JSON.stringify(body) : undefined, muteHttpExceptions: true, }); const json = JSON.parse(res.getContentText() || "null"); if (res.getResponseCode() >= 300) throw new Error(`${json.code}: ${json.detail}`); return json; } function onFormSubmit(e) { const r = e.namedValues; // form questions "Name" and "WhatsApp number" const phone = String(r["WhatsApp number"][0]).replace(/[^0-9+]/g, ""); wapitick_("post", "/v1/contacts:upsert", { match: { kind: "phone", value: phone }, create_if_missing: true, data: { name: r.Name[0], phones: [phone], tags: ["google-form-lead"], source: "lead" }, }); } ``` Operations: `contacts_upsert`, `test_inbound_create` (test mode only), `conversations_list`. --- # Order and shipping updates Source: https://docs.wapitick.com/guides/order-updates 1. `POST /v1/contacts:upsert` finds the customer by phone or creates them, so every update lands in one chat. 2. Send a **utility** template with the order details. Put your order id in `client_ref`: sending the same `client_ref` again returns the first message instead of sending twice. 3. Follow delivery with `message.status_updated` webhooks (opt in with `+message.status_updated`), or read `GET /v1/messages/{id}`. **cURL** ```bash title="curl.sh" #!/usr/bin/env bash # Order and shipping updates: contacts_upsert, channels_list, messages_send, messages_get (runs in test mode) set -euo pipefail API="${WAPITICK_API_URL:-https://api.wapitick.com}" AUTH="Authorization: Bearer $WAPITICK_API_KEY" # Keep the customer in Wapitick (find by phone or create) curl -sf "$API/v1/contacts:upsert" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: ctc-1042" \ -d '{"match":{"kind":"phone","value":"+15550100001"},"create_if_missing":true,"data":{"name":"Asha","phones":["+15550100001"],"tags":["customer"]}}' >/dev/null CHANNEL=$(curl -sf "$API/v1/channels" -H "$AUTH" | jq -r '.data[0].id') # client_ref ties the message to your order: sending the same client_ref twice returns the first message MSG=$(curl -sf "$API/v1/messages" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: order-1042-shipped" \ -d "{\"channel_id\":\"$CHANNEL\",\"to\":{\"phone\":\"+15550100001\"},\"client_ref\":\"order-1042-shipped\",\"type\":\"template\",\"template\":{\"name\":\"order_update\",\"language\":\"en\",\"components\":[{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"Asha\"},{\"type\":\"text\",\"text\":\"#1042\"}]}]}}" | jq -r .id) sleep 3 curl -sf "$API/v1/messages/$MSG" -H "$AUTH" | jq '{id, status}' ``` **Node** ```js title="node.mjs" // biome-ignore-all lint/suspicious/noConsole: a docs sample prints its result // Order and shipping updates: contacts_upsert, messages_send, messages_get import { Wapitick } from "@wapitick/node"; const wapitick = new Wapitick({ apiKey: process.env.WAPITICK_API_KEY, baseUrl: process.env.WAPITICK_API_URL, }); await wapitick.contacts.upsert({ phone: "+15550100001", name: "Asha", tags: ["customer"] }); const msg = await wapitick.messages.sendTemplate({ to: "+15550100001", name: "order_update", variables: ["Asha", "#1042"], clientRef: "order-1042-shipped", // the same client_ref twice returns the first message }); await new Promise((r) => setTimeout(r, 3000)); const now = await wapitick.messages.get(msg.id); console.log(JSON.stringify({ id: now.id, status: now.status })); ``` **Python** ```python title="python.py" # Order and shipping updates: contacts_upsert, messages_send, messages_get import json import os import time from wapitick import Wapitick w = Wapitick(api_key=os.environ["WAPITICK_API_KEY"], base_url=os.environ.get("WAPITICK_API_URL", "https://api.wapitick.com")) w.contacts.upsert("+15550100001", name="Asha", tags=["customer"]) msg = w.messages.send_template("+15550100001", "order_update", variables=["Asha", "#1042"], client_ref="order-1042-shipped") time.sleep(3) now = w.messages.get(msg["id"]) print(json.dumps({"id": now["id"], "status": now["status"]})) ``` **PHP** ```php title="php.php" upsertContact('+15550100001', 'Asha', null, ['customer']); $msg = $w->sendTemplate('+15550100001', 'order_update', 'en', ['Asha', '#1042']); sleep(3); $now = $w->call('messages_get', ['message_id' => $msg['id']]); echo json_encode(['id' => $now['id'], 'status' => $now['status']]), "\n"; ``` **Google Apps Script** ```js title="apps-script.gs" // biome-ignore-all lint/correctness/noUnusedVariables: Apps Script runs these functions by name // Order updates from a Google Sheet: contacts_upsert, messages_send. // Sheet columns: A phone (+E.164), B name, C order number, D status (the script writes it). // Script properties: WAPITICK_API_KEY (wk_test_...), optional WAPITICK_API_URL. function wapitick_(method, path, body) { const props = PropertiesService.getScriptProperties(); const base = props.getProperty("WAPITICK_API_URL") || "https://api.wapitick.com"; const res = UrlFetchApp.fetch(base + path, { method: method, contentType: "application/json", headers: { Authorization: `Bearer ${props.getProperty("WAPITICK_API_KEY")}`, "Idempotency-Key": Utilities.getUuid(), }, payload: body ? JSON.stringify(body) : undefined, muteHttpExceptions: true, }); const json = JSON.parse(res.getContentText() || "null"); if (res.getResponseCode() >= 300) throw new Error(`${json.code}: ${json.detail}`); return json; } function sendOrderUpdates() { const sheet = SpreadsheetApp.getActiveSheet(); const rows = sheet.getDataRange().getValues(); const channel = wapitick_("get", "/v1/channels").data[0].id; for (let i = 1; i < rows.length; i++) { const phone = String(rows[i][0]), name = String(rows[i][1]), order = String(rows[i][2]); if (!phone || rows[i][3]) continue; // skip empty rows and rows already sent wapitick_("post", "/v1/contacts:upsert", { match: { kind: "phone", value: phone }, create_if_missing: true, data: { name: name, phones: [phone] }, }); const msg = wapitick_("post", "/v1/messages", { channel_id: channel, to: { phone: phone }, client_ref: `order-${order}`, type: "template", template: { name: "order_update", language: "en", components: [ { type: "body", parameters: [ { type: "text", text: name }, { type: "text", text: order }, ], }, ], }, }); sheet.getRange(i + 1, 4).setValue(`${msg.status} ${msg.id}`); } } ``` The Google Apps Script version sends one update per row of a sheet ("send from a sheet") and writes the status back. Operations: `contacts_upsert`, `channels_list`, `messages_send`, `messages_get`. --- # Receive messages by webhook Source: https://docs.wapitick.com/guides/receive-webhooks 1. Register your endpoint (or use `npx wapitick listen` while you build). 2. Verify the signature on the **raw** body before you parse it. 3. Answer `200` within 10 seconds and do slow work afterwards; de-duplicate on the event `id`. **cURL** ```bash title="curl.sh" #!/usr/bin/env bash # Receive messages by webhook: webhook_endpoints_create, test_inbound_create (runs in test mode) set -euo pipefail API="${WAPITICK_API_URL:-https://api.wapitick.com}" AUTH="Authorization: Bearer $WAPITICK_API_KEY" # Register your HTTPS endpoint for incoming messages. The secret is shown ONCE: store it. curl -sf "$API/v1/webhook-endpoints" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: wh-$(date +%s)" \ -d "{\"url\":\"${WEBHOOK_URL:-https://example.com/wapitick/webhooks}\",\"events\":[\"message.received\",\"message.status_updated\"]}" \ | jq '{id: .endpoint.id, livemode: .endpoint.livemode, secret_starts: (.secret[0:6])}' # Fire one (test mode) curl -sf "$API/v1/test/inbound" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: wh-in-$(date +%s)" \ -d '{"from":"+15550100001","text":"Hello webhook"}' | jq '{status}' # No public URL yet? `npx wapitick listen --forward-to http://localhost:3000/webhooks` streams the same events. ``` **Node** ```js title="node.mjs" // biome-ignore-all lint/suspicious/noConsole: a docs sample prints its result // Receive messages by webhook: a tiny server that verifies every delivery (verifyWebhook) and answers 200 fast. import { createServer } from "node:http"; import { verifyWebhook } from "@wapitick/node"; const secret = process.env.WAPITICK_WEBHOOK_SECRET ?? "whsec_test"; const server = createServer((req, res) => { const chunks = []; req.on("data", (c) => chunks.push(c)); req.on("end", () => { try { const event = verifyWebhook(Buffer.concat(chunks), req.headers, secret); // the RAW body if (event.type === "message.received") console.log("from", event.data.object.contact_id); res.writeHead(200).end(); // answer within 10 s; do slow work after } catch { res.writeHead(400).end(); } }); }); if (process.env.CI_SAMPLE !== "1") server.listen(Number(process.env.PORT ?? 3000)); else console.log(JSON.stringify({ ok: true })); ``` **Python** ```python title="python.py" # Receive messages by webhook (Flask): verify every delivery, answer 200 fast. import json import os from wapitick import verify_webhook SECRET = os.environ.get("WAPITICK_WEBHOOK_SECRET", "whsec_test") def handle(raw_body: bytes, headers: dict) -> int: event = verify_webhook(raw_body, headers, SECRET) # the RAW body if event["type"] == "message.received": print("from", event["data"]["object"].get("contact_id")) return 200 if os.environ.get("CI_SAMPLE") == "1": print(json.dumps({"ok": True})) else: from flask import Flask, request # pip install flask app = Flask(__name__) @app.post("/webhooks") def webhooks(): try: return "", handle(request.get_data(), dict(request.headers)) except Exception: return "", 400 app.run(port=int(os.environ.get("PORT", 3000))) ``` **PHP** ```php title="php.php" sendTemplate('+15550100002', 'order_update', 'en', ['Asha', $code]); echo json_encode(['id' => $msg['id'], 'status' => $msg['status']]), "\n"; ``` **Google Apps Script** ```js title="apps-script.gs" // biome-ignore-all lint/correctness/noUnusedVariables: Apps Script runs these functions by name // Send an OTP from Google Apps Script: channels_list, messages_send // Script properties: WAPITICK_API_KEY (wk_test_...), optional WAPITICK_API_URL. function wapitick_(method, path, body) { const props = PropertiesService.getScriptProperties(); const base = props.getProperty("WAPITICK_API_URL") || "https://api.wapitick.com"; const res = UrlFetchApp.fetch(base + path, { method: method, contentType: "application/json", headers: { Authorization: `Bearer ${props.getProperty("WAPITICK_API_KEY")}`, "Idempotency-Key": Utilities.getUuid(), }, payload: body ? JSON.stringify(body) : undefined, muteHttpExceptions: true, }); const json = JSON.parse(res.getContentText() || "null"); if (res.getResponseCode() >= 300) throw new Error(`${json.code}: ${json.detail}`); return json; } function sendOtp() { const code = String(Math.floor(100000 + Math.random() * 900000)); const channel = wapitick_("get", "/v1/channels").data[0].id; const msg = wapitick_("post", "/v1/messages", { channel_id: channel, to: { phone: "+15550100002" }, type: "template", template: { name: "order_update", language: "en", components: [ { type: "body", parameters: [ { type: "text", text: "Asha" }, { type: "text", text: code }, ], }, ], }, }); Logger.log(JSON.stringify({ id: msg.id, status: msg.status })); } ``` Operations: `channels_list`, `messages_send`. --- # Guides Source: https://docs.wapitick.com/guides - [Reply with the AI Assistant](/guides/ai-assistant): Hand a chat to the business's AI Assistant, and take it back. - [Capture a lead into the inbox](/guides/capture-lead): Save leads from your own forms, tag them, and have the chat waiting in the Wapitick inbox. - [Order and shipping updates](/guides/order-updates): Keep customers in the CRM and send order updates with a utility template. - [Receive messages by webhook](/guides/receive-webhooks): Register an endpoint, verify every delivery, and answer fast. - [Send an OTP](/guides/send-otp): One-time codes on WhatsApp with an authentication template, safely retried. --- # Wapitick for developers Source: https://docs.wapitick.com Wapitick puts WhatsApp, Instagram and Messenger behind one API. Your code sends messages, keeps customers in the CRM, and gets every reply by webhook, while the business still sees every chat in the Wapitick inbox. - **Start in test mode.** A `wk_test_` key works in a separate test workspace with a sandbox WhatsApp number. Nothing reaches a real customer, nothing costs money, and no Meta account or approval is needed. - **One request per job.** Send an OTP, an order update or a reply with one call. The SDKs add idempotency keys and retries for you. - **Webhooks you can trust.** Every delivery is signed (`Wapitick-Signature` and Standard Webhooks headers), retried for three days and visible in the delivery log. Next: the [5-minute quickstart](/quickstart). | You want to | Read | |---|---| | Send your first message | [Quickstart](/quickstart) | | Send OTPs, order updates | [Send an OTP](/guides/send-otp), [Order updates](/guides/order-updates) | | Get replies into your system | [Receive messages by webhook](/guides/receive-webhooks) | | Put a WhatsApp button or chat on a website | [Add to your website](/website) | | Use Zapier, Make, n8n or Google Sheets | [No-code](/no-code) | | Look up an endpoint | [API reference](/reference) | | Understand an error | [Errors](/errors) | The API and webhooks are included on every paid plan. Machine-readable versions of these docs: [`/llms.txt`](/llms.txt), [`/llms-full.txt`](/llms-full.txt), and every page as Markdown at `/md/.md`. --- # Use from ChatGPT or Claude (MCP) Source: https://docs.wapitick.com/mcp Wapitick runs a remote [Model Context Protocol](https://modelcontextprotocol.io) server. An AI tool connected to it can look things up and do work in one Wapitick business: the same tools as Ask Wapitick, with the same limits. ## Connect The connector address is `https://mcp.wapitick.com/mcp` (Streamable HTTP, stateless). It is also shown in Wapitick under **Settings, Developers, Use from ChatGPT or Claude**. - **ChatGPT:** Settings, then Connectors, then Add. Paste the address. - **Claude:** Settings, then Connectors, then Add custom connector. Paste the address. - **Cursor, Codex and other clients:** add a remote MCP server with that address. The tool then opens a Wapitick sign-in page. Sign in, pick the business, and choose what it may do. Each connection appears in that Settings page, where you can disconnect it at any time. ## What it may do Tools are grouped by risk. Which ones are offered depends on your plan and your role in the business. | Risk | Examples | What happens | |---|---|---| | Look up | customers, chats, orders, reports | runs straight away; nothing changes | | Change | drafts, labels, tasks | runs straight away; can be undone | | Message customers | send a template, reply | shown to you as a preview first | | Spend money | broadcasts, top-ups | always needs your confirmation, inside the daily spend limit | | Delete or stop | delete a draft, stop a broadcast | always needs your confirmation | Anything that needs a confirmation waits in the Wapitick dashboard until you tap it. A second confirmation is only ever accepted from the dashboard, never from the AI tool. Text that comes from customers is marked as untrusted when it is passed back to the AI tool. ## Sign-in details - `/mcp` uses OAuth 2.1 ([OAuth](/oauth)): the client discovers the authorization server from `/.well-known/oauth-protected-resource` (RFC 9728), registers itself, and uses PKCE. Tokens are issued for the MCP resource only and are limited by the scopes you allowed and your current role. - `/mcp-key` accepts a Wapitick API key (`Authorization: Bearer wk_live_...` or `wk_test_...`) for scripts and self-hosted agents. A `wk_test_` key works only in the test workspace. Errors are [problem codes](/errors), the same as the REST API. --- # No-code (n8n, Zapier, Make, Google Sheets) Source: https://docs.wapitick.com/no-code - **n8n:** the community node `n8n-nodes-wapitick` (source in `plugins/n8n`) adds a Wapitick trigger (any event) and actions (send a message, send a template, upsert a contact). Credentials: an API key. - **Google Sheets:** the Apps Script sample in [Order updates](/guides/order-updates) sends one message per row and writes the status back. Paste it in Extensions > Apps Script and set the `WAPITICK_API_KEY` script property. - **Zapier, Make, Pabbly:** built on the REST-hook endpoints (`POST /v1/webhook-subscriptions`) and `GET /v1/automation/catalog`; the directory apps are coming. --- # OAuth Source: https://docs.wapitick.com/oauth Use OAuth when your app acts for someone else's Wapitick business (a marketplace app, an AI tool, a plugin). For your own business, an [API key](/quickstart) is simpler. ## Endpoints The authorization server is the API host, `https://api.wapitick.com`. Its metadata is at `/.well-known/oauth-authorization-server` (also `/.well-known/openid-configuration`). | Endpoint | Path | |---|---| | Authorize | `GET /oauth/authorize` | | Token | `POST /oauth/token` | | Register a client (RFC 7591) | `POST /oauth/register` | | Revoke | `POST /oauth/revoke` | | Introspect | `POST /oauth/introspect` | | Signing keys | `GET /oauth/jwks.json` | ## Flow 1. Send the user to `/oauth/authorize` with `response_type=code`, your `client_id`, `redirect_uri`, `scope`, `state`, `code_challenge` and `code_challenge_method=S256`. PKCE is required. Add `resource` (RFC 8707) to choose what the token is for: the API (`https://api.wapitick.com`) or the [MCP server](/mcp). 2. The user signs in to Wapitick, picks a business, and approves. They can only grant what their role allows. 3. Exchange the `code` at `/oauth/token`. You get an access token (`wko_...`, about an hour) and a refresh token. 4. Call the API with `Authorization: Bearer wko_...`. Refresh tokens rotate on every use. If an old refresh token is used again, the whole grant is revoked, so store the new one each time. Grants also include `client_credentials` for confidential clients. ## Scopes Scopes are the same as API key scopes, listed per operation in the [API reference](/reference). One token covers one business. Every request is checked against the grant and the user's current role, so removing someone's access takes effect within 30 seconds. Errors are [problem codes](/errors), for example [`invalid_token`](/errors/invalid_token) and [`insufficient_scope`](/errors/insufficient_scope). --- # Quickstart (5 minutes) Source: https://docs.wapitick.com/quickstart ## 1. Get a test key In Wapitick, open **Settings > Developers > API keys**, press **Create key**, choose **Test** and copy the key (`wk_test_...`). It is shown once. ```bash export WAPITICK_API_KEY=wk_test_... ``` A test key works only in your **test workspace**: a separate copy of your business with one sandbox WhatsApp number. It never reaches a real customer and never spends wallet balance, AI credits or plan quota. See [Test mode](/test-mode). ## 2. Send, receive, and see the events The sample sends the sample template `hello_world` to the magic number `+15550100001` (simulated as delivered; a template can start a conversation, plain text needs the customer to have written in the last 24 hours), then pretends a customer replied with `POST /v1/test/inbound`, then lists the events your webhooks would receive. **cURL** ```bash title="curl.sh" #!/usr/bin/env bash # Quickstart: channels_list -> messages_send -> test_inbound_create -> events_list (test mode) set -euo pipefail API="${WAPITICK_API_URL:-https://api.wapitick.com}" AUTH="Authorization: Bearer $WAPITICK_API_KEY" # 1. Your test workspace has one sandbox WhatsApp channel CHANNEL=$(curl -sf "$API/v1/channels" -H "$AUTH" | jq -r '.data[0].id') # 2. Send the sample template to a magic number: "delivered" without reaching a real phone. A template can # start a conversation; plain text needs the customer to have written in the last 24 hours. curl -sf "$API/v1/messages" -H "$AUTH" -H "Content-Type: application/json" \ -H "Idempotency-Key: quickstart-$(date +%s)" \ -d "{\"channel_id\":\"$CHANNEL\",\"to\":{\"phone\":\"+15550100001\"},\"type\":\"template\",\"template\":{\"name\":\"hello_world\",\"language\":\"en\"}}" # 3. Pretend a customer wrote back curl -sf "$API/v1/test/inbound" -H "$AUTH" -H "Content-Type: application/json" \ -H "Idempotency-Key: quickstart-in-$(date +%s)" \ -d '{"from":"+15550100001","text":"Hi! Is this open on Sunday?"}' # 4. Both show up as events (and at your webhook, if you added one) sleep 3 curl -sf "$API/v1/events?type=message.*&limit=5" -H "$AUTH" | jq '[.data[] | {type, id}]' ``` **Node** ```js title="node.mjs" // biome-ignore-all lint/suspicious/noConsole: a docs sample prints its result // Quickstart: channels_list -> messages_send -> test_inbound_create -> events_list (test mode) import { Wapitick } from "@wapitick/node"; const wapitick = new Wapitick({ apiKey: process.env.WAPITICK_API_KEY, baseUrl: process.env.WAPITICK_API_URL, }); // 1 + 2. Send the sample template to a magic number (the SDK picks your sandbox channel): "delivered", no real // phone involved. A template can start a conversation; plain text needs the customer to have written in 24 hours. const sent = await wapitick.messages.sendTemplate({ to: "+15550100001", name: "hello_world" }); // 3. Pretend a customer wrote back await wapitick.test.inbound({ from: "+15550100001", text: "Hi! Is this open on Sunday?" }); // 4. Both show up as events await new Promise((r) => setTimeout(r, 3000)); const events = await wapitick.events.list({ type: "message.*", limit: 5 }); console.log(JSON.stringify({ sent: sent.id, events: events.data.map((e) => e.type) })); ``` **Python** ```python title="python.py" # Quickstart: channels_list -> messages_send -> test_inbound_create -> events_list (test mode) import json import os import time from wapitick import Wapitick w = Wapitick(api_key=os.environ["WAPITICK_API_KEY"], base_url=os.environ.get("WAPITICK_API_URL", "https://api.wapitick.com")) # 1 + 2. Send the sample template to a magic number (the SDK picks your sandbox channel). A template can start a # conversation; plain text needs the customer to have written in the last 24 hours. sent = w.messages.send_template("+15550100001", "hello_world") # 3. Pretend a customer wrote back w.test.inbound("+15550100001", "Hi! Is this open on Sunday?") # 4. Both show up as events time.sleep(3) events = w.call("events_list", query={"type": "message.*", "limit": 5}) print(json.dumps({"sent": sent["id"], "events": [e["type"] for e in events["data"]]})) ``` **PHP** ```php title="php.php" messages_send -> test_inbound_create -> events_list (test mode) require __DIR__ . '/vendor/autoload.php'; $w = new Wapitick\Client(getenv('WAPITICK_API_KEY'), getenv('WAPITICK_API_URL') ?: 'https://api.wapitick.com'); // 1 + 2. Send the sample template to a magic number (the SDK picks your sandbox channel). A template can start a // conversation; plain text needs the customer to have written in the last 24 hours. $sent = $w->sendTemplate('+15550100001', 'hello_world'); // 3. Pretend a customer wrote back $w->simulateInbound('+15550100001', 'Hi! Is this open on Sunday?'); // 4. Both show up as events sleep(3); $events = $w->call('events_list', [], ['type' => 'message.*', 'limit' => 5]); echo json_encode(['sent' => $sent['id'], 'events' => array_column($events['data'], 'type')]), "\n"; ``` **Google Apps Script** ```js title="apps-script.gs" // biome-ignore-all lint/correctness/noUnusedVariables: Apps Script runs these functions by name // Quickstart in Google Apps Script: channels_list -> messages_send -> test_inbound_create (test mode) // Script properties: WAPITICK_API_KEY (wk_test_...), optional WAPITICK_API_URL. function wapitick_(method, path, body) { const props = PropertiesService.getScriptProperties(); const base = props.getProperty("WAPITICK_API_URL") || "https://api.wapitick.com"; const res = UrlFetchApp.fetch(base + path, { method: method, contentType: "application/json", headers: { Authorization: `Bearer ${props.getProperty("WAPITICK_API_KEY")}`, "Idempotency-Key": Utilities.getUuid(), }, payload: body ? JSON.stringify(body) : undefined, muteHttpExceptions: true, }); const json = JSON.parse(res.getContentText() || "null"); if (res.getResponseCode() >= 300) throw new Error(`${json.code}: ${json.detail}`); return json; } function quickstart() { const channel = wapitick_("get", "/v1/channels").data[0].id; const sent = wapitick_("post", "/v1/messages", { channel_id: channel, to: { phone: "+15550100001" }, type: "template", template: { name: "hello_world", language: "en" }, }); wapitick_("post", "/v1/test/inbound", { from: "+15550100001", text: "Hi! Is this open on Sunday?" }); Logger.log(JSON.stringify({ sent: sent.id })); } ``` Operations used: `channels_list`, `messages_send`, `test_inbound_create`, `events_list`. ## 3. Get events on your own machine No public server yet? The CLI streams your events and forwards each one, signed, to a local URL: ```bash npx wapitick login --key $WAPITICK_API_KEY npx wapitick listen --forward-to http://localhost:3000/webhooks npx wapitick trigger message.received ``` ## 4. Going live Create a live key (`wk_live_...`), connect your real WhatsApp number in Wapitick, and use approved templates for messages outside the 24-hour window. Read the [go-live checklist](/go-live) first. --- # Rate limits and usage Source: https://docs.wapitick.com/rate-limits | Limit | Plan key | Applies to | |---|---|---| | Reads per minute, per key | `api.requests_per_min` (alias `api.rpm`) | API keys and OAuth apps | | Writes / sends per minute | half of the read limit | API keys and OAuth apps | | Requests per day, per organisation | `api.requests.day` | live API-key and OAuth requests (UTC day) | A key's own `rate_limit.rpm` replaces the plan's read figure. Limits are counted across all our servers. Test mode has its own per-minute counters and no daily limit. Every response carries `RateLimit-Policy`, `RateLimit` and `X-RateLimit-Limit/Remaining/Reset`. Over a limit you get `429 rate_limited` with `Retry-After` and `bucket` (`read`, `write`, `send`, ..., or `day`). The SDKs wait and retry. Your traffic: `GET /v1/api-usage` (`api_usage_get`) for daily and per-key counts and today's remaining daily requests; `GET /v1/request-logs` (`request_logs_list`) for each request of the last 30 days with redacted bodies (secrets removed, message text replaced by its length, phone numbers and e-mails hidden). Live events: `GET /v1/events/stream` (`events_stream`, Server-Sent Events). --- # SDKs, CLI and Postman Source: https://docs.wapitick.com/sdks | | Install | Source | |---|---|---| | Node / TypeScript | `npm i @wapitick/node` | `sdks/node` | | Python | `pip install wapitick` | `sdks/python` | | PHP / Laravel | `composer require wapitick/wapitick-php` | `sdks/php` | | CLI | `npx wapitick` | `sdks/cli` | | Postman | import `wapitick.postman_collection.json` | `docs/api` | All three libraries: helpers for the common jobs (send text and templates, upsert contacts, webhook endpoints, test mode), any other operation by its operationId, automatic `Idempotency-Key` on writes, retries on 429 and 5xx with backoff, typed errors carrying the problem `code`, and `verifyWebhook()` for both signature styles. They are generated from the OpenAPI document (operation tables and Node types) with a hand-written layer on top. ```ts import { Wapitick } from "@wapitick/node"; const wapitick = new Wapitick(); // reads WAPITICK_API_KEY await wapitick.request("GET", "/v1/contacts", { query: { limit: 10 } }); ``` CLI: ```bash npx wapitick login --key wk_test_... npx wapitick listen --forward-to http://localhost:3000/webhooks npx wapitick trigger message.received npx wapitick logs tail --errors npx wapitick send --to +15550100001 --text "Hello" ``` ## OAuth for partners Apps that act for many businesses use OAuth 2.1 (`/oauth/authorize`, `/oauth/token`, PKCE). Server-to-server partners with a **confidential** app can use `grant_type=client_credentials`: the token acts as the member who created the app, limited to the app's scopes and that member's role, and stops working if the member leaves. --- # Test mode and magic numbers Source: https://docs.wapitick.com/test-mode ## What a test key can and cannot do A `wk_test_` key works in your organisation's **test workspace**, created the first time you use the key. It holds its own contacts, chats, messages, webhook endpoints and events; your live workspace never sees them, and live keys never see test data. - Messages from the test workspace **never go through your real WhatsApp number** and never reach Meta with your credentials. They are simulated, or delivered from the shared Wapitick test number to phones you verified. - Wallet, AI credits, ads, voice, billing, exports and channel connection are **not available** with a test key: those requests answer `403 test_mode_unsupported`. Messages, contacts, conversations, templates (read), webhooks, events, the request log and usage are. - Every event and webhook delivery carries `"livemode": false`. Test webhook endpoints receive only test events. - Test traffic has its own per-minute rate limits and does not count toward `api.requests.day`. The test workspace has three sample templates: `hello_world`, `order_update` (`{{1}}` name, `{{2}}` order) and `test_rejected` (always refused, to see `template_not_approved`). ## Magic numbers Send to these numbers to get a fixed outcome. Any other number is simulated as delivered. | Number | Outcome | Meta code | |---|---|---| | `+15550100001` | Sent, then delivered. | - | | `+15550100002` | Sent, delivered, then read. | - | | `+15550100003` | Fails: the number cannot receive WhatsApp messages (Meta 131026). | 131026 | | `+15550100004` | Fails: the template was rejected or paused (Meta 132015). | 132015 | | `+15550100005` | Fails: the person stopped marketing messages (Meta 131050). | 131050 | | `+15550100006` | Fails: too many messages to this number (Meta 131056 pair rate limit). | 131056 | Failures carry the Meta error code in `message.failed` and `GET /v1/messages/{id}` (`error.code`). The list is also at `GET /v1/test/magic-numbers` (`test_magic_numbers_list`). ## Test recipients: get test messages on your own phone Up to 5 phones per workspace. `POST /v1/test/recipients` (`test_recipients_create`) with `{"phone": "+91..."}` returns `join_text` (`START ABC123`) and a `join_link`. Send that text from the phone to the shared Wapitick test number on WhatsApp within 24 hours. Or send a bare `START`: the number replies with a 6-digit code you enter with `POST /v1/test/recipients/{id}/verify`. After that, test sends to that phone arrive for real, as text. ## Simulate a customer writing to you ```bash curl https://api.wapitick.com/v1/test/inbound -H "Authorization: Bearer $WAPITICK_API_KEY" \ -H "Content-Type: application/json" -d '{"from":"+15550100009","text":"Is this in stock?","name":"Ravi"}' ``` `test_inbound_create` goes through the normal pipeline: the contact and conversation are created and `message.received` reaches your test webhook endpoints within a couple of seconds. --- # Versioning and changelog Source: https://docs.wapitick.com/versioning - `/v1` only grows: new endpoints, new optional fields and new enum values are not breaking. Ignore fields you do not know and treat enums as open. - Breaking changes come as a new dated version or `/v2`. A deprecated endpoint answers with `Deprecation` and `Sunset` headers at least 6 months ahead (12 for fields that Zapier, Make, n8n, Slack or MCP integrations use). - Webhook payloads follow the `api_version` pinned on each endpoint. ## Changelog **2026-11-20** - Test mode: `wk_test_` keys work in a separate test workspace with a sandbox WhatsApp number, magic numbers, test recipients and `POST /v1/test/inbound`. - Request log (`GET /v1/request-logs`), usage (`GET /v1/api-usage`), live event stream (`GET /v1/events/stream`). - `api.requests.day` is enforced; rate limits now hold across servers. - Webhooks: Standard Webhooks headers; every event type documented with its payload; new events for bookings, orders, payments, `widget.chat_started` and `form.submitted`. - OAuth `client_credentials` for confidential apps. - Website: one loader script for the WhatsApp button, chat, forms, booking and catalogue; platform detection; install checks; QR codes and a printable counter kit. - SDKs for Node, Python and PHP (Laravel), the `wapitick` CLI and a Postman collection. --- # Webhooks Source: https://docs.wapitick.com/webhooks Create an endpoint with `POST /v1/webhook-endpoints` (`webhook_endpoints_create`): an `https` URL on a public host and the events you want (`["message.received"]`, `["message.*"]`, or `["*"]`). The answer contains the signing **secret, shown once**. Endpoints created with a test key get only test events. Every event type and its payload schema is in the [API reference](/reference/webhooks) (the OpenAPI document's `webhooks` section). `data.object` is the same JSON as the resource's GET endpoint. ## Delivery - `POST` with `Content-Type: application/json`, the event envelope as the body. - Answer any `2xx` within 10 seconds. Anything else is retried after 10 s, 1 min, 5 min, 30 min, 2 h, 6 h, 12 h and 3 x 24 h (11 attempts, about 3 days). An endpoint that fails for 3 days is disabled (`webhook_endpoint.disabled`). - Ordering is not guaranteed: use `sequence` and `created_at`. Deliveries can repeat: de-duplicate on the event `id` (also the `webhook-id` header). - See every attempt in `GET /v1/webhook-deliveries`; replay with `POST /v1/webhook-deliveries/{id}/replay`. ## Headers | Header | Meaning | |---|---| | `Wapitick-Signature` | `t=,v1=.")>`; during a secret rotation one `v1` per active secret | | `webhook-id`, `webhook-timestamp`, `webhook-signature` | [Standard Webhooks](https://www.standardwebhooks.com): `v1,..")>` | | `Wapitick-Event-Id`, `Wapitick-Event-Type`, `Wapitick-Delivery-Id`, `Wapitick-Attempt` | for logs | The HMAC key is your secret exactly as shown (`whsec_...`, its UTF-8 bytes). A Standard Webhooks library base64-decodes the secret you give it, so pass it `base64(secret)`. ## Verify (always use the raw body) **cURL** ```bash title="curl.sh" #!/usr/bin/env bash # Receive messages by webhook: webhook_endpoints_create, test_inbound_create (runs in test mode) set -euo pipefail API="${WAPITICK_API_URL:-https://api.wapitick.com}" AUTH="Authorization: Bearer $WAPITICK_API_KEY" # Register your HTTPS endpoint for incoming messages. The secret is shown ONCE: store it. curl -sf "$API/v1/webhook-endpoints" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: wh-$(date +%s)" \ -d "{\"url\":\"${WEBHOOK_URL:-https://example.com/wapitick/webhooks}\",\"events\":[\"message.received\",\"message.status_updated\"]}" \ | jq '{id: .endpoint.id, livemode: .endpoint.livemode, secret_starts: (.secret[0:6])}' # Fire one (test mode) curl -sf "$API/v1/test/inbound" -H "$AUTH" -H "Content-Type: application/json" -H "Idempotency-Key: wh-in-$(date +%s)" \ -d '{"from":"+15550100001","text":"Hello webhook"}' | jq '{status}' # No public URL yet? `npx wapitick listen --forward-to http://localhost:3000/webhooks` streams the same events. ``` **Node** ```js title="node.mjs" // biome-ignore-all lint/suspicious/noConsole: a docs sample prints its result // Receive messages by webhook: a tiny server that verifies every delivery (verifyWebhook) and answers 200 fast. import { createServer } from "node:http"; import { verifyWebhook } from "@wapitick/node"; const secret = process.env.WAPITICK_WEBHOOK_SECRET ?? "whsec_test"; const server = createServer((req, res) => { const chunks = []; req.on("data", (c) => chunks.push(c)); req.on("end", () => { try { const event = verifyWebhook(Buffer.concat(chunks), req.headers, secret); // the RAW body if (event.type === "message.received") console.log("from", event.data.object.contact_id); res.writeHead(200).end(); // answer within 10 s; do slow work after } catch { res.writeHead(400).end(); } }); }); if (process.env.CI_SAMPLE !== "1") server.listen(Number(process.env.PORT ?? 3000)); else console.log(JSON.stringify({ ok: true })); ``` **Python** ```python title="python.py" # Receive messages by webhook (Flask): verify every delivery, answer 200 fast. import json import os from wapitick import verify_webhook SECRET = os.environ.get("WAPITICK_WEBHOOK_SECRET", "whsec_test") def handle(raw_body: bytes, headers: dict) -> int: event = verify_webhook(raw_body, headers, SECRET) # the RAW body if event["type"] == "message.received": print("from", event["data"]["object"].get("contact_id")) return 200 if os.environ.get("CI_SAMPLE") == "1": print(json.dumps({"ok": True})) else: from flask import Flask, request # pip install flask app = Flask(__name__) @app.post("/webhooks") def webhooks(): try: return "", handle(request.get_data(), dict(request.headers)) except Exception: return "", 400 app.run(port=int(os.environ.get("PORT", 3000))) ``` **PHP** ```php title="php.php" `: ```html ``` The loader is one small file (under 30 KB) with your settings inside. It sets no cookies, stores nothing in the browser and makes no request to Wapitick until the visitor clicks, except a single install check while your site is not verified. The website chat (the larger part) loads only when someone opens it. ## Embeddables | What | How | |---|---| | Floating WhatsApp button (greeting, message with the page title, QR code on desktop, Instagram / Messenger / call links) | on by default | | Website chat answered by the AI Assistant, continues on WhatsApp | `embeds.chat.enabled` | | Ask on WhatsApp for a product or service | `` | | Booking (inline, pop-up, floating) | `
` | | Opt-in box ("Get updates on WhatsApp") | `
` | | Lead / contact form that continues on WhatsApp | `
` | | Catalogue or menu | `
` | JavaScript: `WapitickSite.open()`, `.chat()`, `.book()`, `.ask("item")`, `.scan()` (after you add elements later). Forms record the exact consent wording, time and page; they have a hidden honeypot field, optional Cloudflare Turnstile and per-IP limits. Look: every embeddable is styled only by design tokens (`embeds.theme`: accent, text colour, radius, position, light/dark), so it can be restyled without code. ## Allowed sites Browser calls are accepted only from the exact origins in `allowed_origins` (filled from your site address and its `www` twin). Add staging or other domains there. ## Platforms `POST /v1/sites:detect-platform` (`websites_detect_platform`) tells WordPress, Shopify, Wix, Squarespace, Blogger, Google Sites, Nuvemshop, Salla, Zid and Webflow apart and returns the steps. On WordPress, install the **Wapitick** plugin instead of pasting code. ## Check the install, send to your developer - `POST /v1/sites/{id}/verify` fetches your page and looks for the code; the loader also reports in from the browser. - `POST /v1/sites/{id}/developer-links` e-mails your developer the code and steps, with a read-only link valid 7 days. - `GET /v1/sites/{id}/qr.svg` and `GET /v1/sites/{id}/counter-kit.pdf`: a QR code and a printable A4 sign. No website? Share your Wapitick page link instead. --- # API reference Source: https://docs.wapitick.com/reference Base URL `https://api.wapitick.com`. Authenticate with `Authorization: Bearer `. JSON in, JSON out; errors are RFC 9457 problem+json ([Errors](/errors)); lists use `limit` + `cursor`; send `Idempotency-Key` on writes. - [ad-accounts](/reference/ad-accounts): Connect and monitor the customer's Meta ad account: health, pages, budgets, spend. - [ads](/reference/ads): Simple Ads: campaign wizard, targeting, estimates, publish, budgets, insights, attribution. - [agency](/reference/agency): Client approvals, handover and per-client billing for agencies. - [ai-assistants](/reference/ai-assistants): Customer-facing AI Assistants: business-scoped, disclosed, with human handoff. - [ai-disclosure](/reference/ai-disclosure): Telling customers they are talking to an AI, per workspace and per language. - [ai-provenance](/reference/ai-provenance): Synthetic-content labels and provenance, AI image generation, AI disclosure texts. - [analytics](/reference/analytics): Funnels and outcome metrics. - [api-keys](/reference/api-keys): Create, rotate, revoke and inspect API keys. - [approvals](/reference/approvals): Approval rules and requests. - [asset-safety](/reference/asset-safety): Health card that shows whether the Business can be locked out or hijacked. - [assistant-facts](/reference/assistant-facts): Structured facts with expiry, season rollover and assistant routing. - [audit-log](/reference/audit-log): Who did what, when: actor, action, resource, IP and diff. - [auth](/reference/auth): Sign-in, sessions, step-up and the current caller. - [automation-apps](/reference/automation-apps): Zapier, Make and n8n trigger/action mapping. - [billing](/reference/billing): Spend forecast, thresholds and caps. - [bookings](/reference/bookings): Bookings. - [business-hours](/reference/business-hours): Working hours, holidays, quiet hours and what happens outside them. - [calls](/reference/calls): Call log, transcripts, recordings, transfers and call permissions. - [capi](/reference/capi): Conversions API events for click-to-message ads. - [carts](/reference/carts): Abandoned carts and checkouts, recovery sequences and what the recovery actually earned. - [catalog-sync](/reference/catalog-sync): Shopify / WooCommerce to our catalog to the Meta catalog. - [catalogs](/reference/catalogs): Product catalogs (manual, CSV, Shopify, WooCommerce, Meta) and collections. - [channels](/reference/channels): Connected channels: WhatsApp, Instagram, Messenger, Pages, Threads, voice numbers. - [client-errors](/reference/client-errors): Web client error reports (feeds the staff issue tracker). - [client-portal](/reference/client-portal): Public, token-based client approval pages. - [comments](/reference/comments): Comments and replies on Instagram, Facebook Page and Threads posts. - [connectors](/reference/connectors): Connector packages and their health. - [consent-forms](/reference/consent-forms): Opt-in widgets, QR codes and web forms. - [consent-ledger](/reference/consent-ledger): Proof of marketing consent per contact and channel, and do-not-contact lists. - [contact-exports](/reference/contact-exports): Owner-only, step-up, watermarked exports. - [contact-imports](/reference/contact-imports): CSV imports with opt-in attestation. - [contacts](/reference/contacts): Customers: identities, consent, tags, stages, merge, erase. - [conversations](/reference/conversations): Inbox conversations: assignment, status, notes, labels, AI mode. - [copilot](/reference/copilot): AI Copilot: runs (WCP/1 SSE), previews, confirmations, approvals tray, limits. - [copilot-parity](/reference/copilot-parity): Operations behind Copilot tools: SLA views, auto-replies, post repurposing, reach estimates, analytics comparisons, scheduled reports, tool search. - [csat](/reference/csat): Satisfaction surveys, responses and reports. - [custom-fields](/reference/custom-fields): Custom contact field definitions. - [developers](/reference/developers): Request log, usage and limits, live event stream. - [discounts](/reference/discounts): Discount codes in the connected store. - [documents](/reference/documents): Private document delivery and structured document intake. - [dues](/reference/dues): Scheduled dues. - [events](/reference/events): Event log (30-day polling fallback), event types and samples. - [exports](/reference/exports): Bulk exports (contacts, conversations, audit log, leads, orders, all data) behind step-up. - [flows](/reference/flows): WhatsApp Flows library: install, map, publish, preview. - [helper-runs](/reference/helper-runs): Executions of helpers with per-step input, output, error and duration. - [helpers](/reference/helpers): Automations: triggers, steps, versions, test mode and go-live. - [home](/reference/home): The Home briefing, navigation counts, realtime topics and the Settings overview. - [inbox](/reference/inbox): Saved views: order and per-role defaults. - [integrations](/reference/integrations): Connected apps. - [invites](/reference/invites): Invite staff by phone or email. - [invoices](/reference/invoices): GST invoices, PDFs and credit notes. - [ivr](/reference/ivr): Visual IVR menus, versions, simulation and activation. - [knowledge](/reference/knowledge): Knowledge sources for AI Assistants: websites, pages, files, FAQs, catalogs; hybrid retrieval. - [labels](/reference/labels): Conversation labels. - [lead-forms](/reference/lead-forms): Meta instant forms for lead ads. - [leads](/reference/leads): Lead Ads leads: list, qualify, convert into a WhatsApp chat. - [library](/reference/library): Curated library items you can copy into a Business as editable drafts. - [links](/reference/links): Tracked short links: make a link, share it, see its clicks. - [marketing](/reference/marketing): Pause and resume all scheduled marketing in one tap. - [media](/reference/media): Media library: signed uploads, scan, renditions, signed read URLs. - [members](/reference/members): Organisation members, roles and permissions. - [messages](/reference/messages): Send and read messages on every channel through one policy-checked pipeline. - [misc](/reference/misc): Changelog, feedback and locales. - [modules](/reference/modules): Module and connector on/off toggles per Business. - [notifications](/reference/notifications): In-app notifications, unread badge and delivery preferences. - [oauth](/reference/oauth): OAuth 2.1 authorization server for the public API and the MCP server. - [oauth-apps](/reference/oauth-apps): Register and manage the OAuth clients your organisation owns. - [offers](/reference/offers): Broadcast offers: test to self, 60 s undo, throttled sending, reports. - [onboarding](/reference/onboarding): Service-selection onboarding, checklist, trial and readiness. - [orders](/reference/orders): Chat, assistant, WhatsApp-cart and store orders with totals computed server-side, COD confirmation and prepaid conversion. - [orgs](/reference/orgs): Accounts, agency client orgs and access grants. - [owner-companion](/reference/owner-companion): Owner briefing and anomaly alerts. - [packs](/reference/packs): Vertical packs: ready messages, helpers, AI preset, pipeline and dashboard in one install. - [partners](/reference/partners): Partner profile, referrals, commissions and payouts. - [payments](/reference/payments): Payment links, UPI QR, evidence (claimed vs verified), refunds, settlements. - [pipeline-stages](/reference/pipeline-stages): Sales pipeline stages. - [plans](/reference/plans): Plans, regional prices, entitlements and add-ons. - [post-targets](/reference/post-targets): Per-channel status of a post, retry and cancel. - [posts](/reference/posts): Compose, schedule and publish posts to Instagram, Facebook Pages and Threads. - [privacy](/reference/privacy): Opt-out keywords, data requests (DSR) and the public privacy page. - [products](/reference/products): Catalog products: price, stock, bulk upsert and product messages. - [public](/reference/public): Endpoints the website visitor's browser calls directly. - [public-pages](/reference/public-pages): Your public booking, catalogue and review pages. - [quick-replies](/reference/quick-replies): Saved replies with shortcuts. - [recovery](/reference/recovery): Lost SIM / phone change recovery with a cooling-off period. - [review-requests](/reference/review-requests): Ask customers for a Google review, the compliant way. - [search](/reference/search): Search contacts, conversations, messages, templates, helpers, posts, offers and products. - [segments](/reference/segments): Dynamic (rule) and static (list) segments. - [shopify-app](/reference/shopify-app): Shopify App Store install, webhooks and billing. - [sla](/reference/sla): Reply-time commitments, the breach queue and response-time reports. - [sla-policies](/reference/sla-policies): First-response and resolution targets. - [slack](/reference/slack): Slack interactivity and slash commands. - [social-channels](/reference/social-channels): Instagram, Facebook Page and Threads channels. - [staff-sessions](/reference/staff-sessions): Wapitick support access to your account: see, approve, end. - [status](/reference/status): Public system status, incidents, banner and per-organisation health. - [subscriptions](/reference/subscriptions): Current subscription, plan changes with proration, cancel/resume, add-ons, coupons. - [support](/reference/support): Talk to a person, assisted setup, callbacks and the reply thread. - [suppressions](/reference/suppressions): Opt-out / suppression list. - [switching](/reference/switching): Move in from another WhatsApp provider: import your data, then move the number. - [system](/reference/system): Liveness, readiness and version. - [tags](/reference/tags): Contact tags. - [tasks](/reference/tasks): Staff follow-ups and 'My day' (open, overdue, snoozed, done, cancelled). - [teams](/reference/teams): Routing teams. - [templates](/reference/templates): Message templates: draft, lint, pre-submission check, submit, sync. - [test-mode](/reference/test-mode): Test mode: magic numbers, simulated inbound messages and test recipients. - [trust](/reference/trust): Your account's trust level, sending limits, policy notices and appeals. - [usage](/reference/usage): Usage summaries and raw usage events. - [verification](/reference/verification): Business verification, outbound link scanning and the domain allowlist (anti-scam). - [voice](/reference/voice): Call answering: voices, previews and draft settings. - [wa-accounts](/reference/wa-accounts): WhatsApp accounts: billing route, estimated Meta balance, payment health. - [wallets](/reference/wallets): Prepaid wallets, ledger, top-ups, auto top-up and low-balance alerts. - [webhook-deliveries](/reference/webhook-deliveries): Delivery log and redelivery. - [webhook-endpoints](/reference/webhook-endpoints): Outbound webhook endpoints, secrets, test and replay. - [webhooks-inbound](/reference/webhooks-inbound): Inbound provider webhooks captured by the API. - [websites](/reference/websites): Put Wapitick on a website: installs, embeddables, install checks, QR codes. - [whatsapp-calling](/reference/whatsapp-calling): Voice calls inside WhatsApp: settings, call permission, starting a call. - [whatsapp-groups](/reference/whatsapp-groups): WhatsApp groups: create, manage, invite link, join requests, participants. - [whatsapp-identity](/reference/whatsapp-identity): The business's WhatsApp username and the verified-badge application. - [widgets](/reference/widgets): Website chat widgets and their embed snippet. - [workspaces](/reference/workspaces): Businesses: profile, settings, business hours and limits. - [Webhooks](/reference/webhooks): every event and its payload --- # ad-accounts Source: https://docs.wapitick.com/reference/ad-accounts Connect and monitor the customer's Meta ad account: health, pages, budgets, spend. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ad-accounts` | `ad_accounts_list`: List connected ad accounts | `ads:read` | - | | POST | `/v1/ad-accounts` | `ad_accounts_connect`: Select the ad account, Page, Instagram account and WhatsApp number for this workspace | `ads:write` | - | | DELETE | `/v1/ad-accounts/{ad_account_id}` | `ad_accounts_disconnect`: Disconnect (campaigns stay at Meta) | `ads:write` | - | | GET | `/v1/ad-accounts/{ad_account_id}` | `ad_accounts_get`: Get an ad account with live health | `ads:read` | - | | GET | `/v1/ad-accounts/{ad_account_id}/health` | `ad_accounts_health`: Billing gates: payment method, status, terms, balance | `ads:read` | - | | GET | `/v1/ad-accounts/{ad_account_id}/minimum-budgets` | `ad_accounts_minimum_budgets`: Minimum daily budgets | `ads:read` | - | | GET | `/v1/ad-accounts/{ad_account_id}/pages` | `ad_accounts_pages`: Pages usable for ads | `ads:read` | - | | GET | `/v1/ad-accounts/{ad_account_id}/promotable-posts` | `ad_accounts_promotable_posts`: Posts to boost (Facebook promotable posts, Instagram media) | `ads:read` | - | | GET | `/v1/ad-accounts/{ad_account_id}/spend` | `ad_accounts_spend`: Spend against caps today and this month; low-balance warnings | `ads:read` | - | | POST | `/v1/ad-accounts/connect-sessions` | `ad_accounts_connect_session_create`: Start Facebook Login for Business for ads | `ads:write` | - | | POST | `/v1/ad-accounts/connect-sessions/{session_id}/callback` | `ad_accounts_connect_session_callback`: Finalise the login and list the ad accounts to pick | `ads:write` | - | | GET | `/v1/ads/meta-requirements` | `ads_meta_requirements`: Ads readiness checklist | `ads:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # ads Source: https://docs.wapitick.com/reference/ads Simple Ads: campaign wizard, targeting, estimates, publish, budgets, insights, attribution. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ad-campaigns` | `ad_campaigns_list`: List ad campaigns | `ads:read` | - | | POST | `/v1/ad-campaigns` | `ad_campaigns_create`: Create a campaign draft with the Simple Ads wizard | `ads:write` | - | | DELETE | `/v1/ad-campaigns/{campaign_id}` | `ad_campaigns_delete`: Delete a draft (or mark an archived campaign deleted at Meta) | `ads:write` | - | | GET | `/v1/ad-campaigns/{campaign_id}` | `ad_campaigns_get`: Get a campaign with ad sets, ads, review feedback and an insights snapshot | `ads:read` | - | | PATCH | `/v1/ad-campaigns/{campaign_id}` | `ad_campaigns_update`: Edit a draft, or schedule/audience of a live campaign | `ads:write` | - | | GET | `/v1/ad-campaigns/{campaign_id}/ad-sets` | `ad_campaigns_list_ad_sets`: List the ad sets of a campaign | `ads:read` | - | | POST | `/v1/ad-campaigns/{campaign_id}/archive` | `ad_campaigns_archive`: Archive a campaign | `ads:write` | - | | POST | `/v1/ad-campaigns/{campaign_id}/budget` | `ad_campaigns_change_budget`: Change budget or end time (rate-limit aware) | `ads:spend` | - | | POST | `/v1/ad-campaigns/{campaign_id}/duplicate` | `ad_campaigns_duplicate`: Duplicate as a draft | `ads:write` | - | | POST | `/v1/ad-campaigns/{campaign_id}/pause` | `ad_campaigns_pause`: Pause a campaign | `ads:spend` | - | | GET | `/v1/ad-campaigns/{campaign_id}/preview` | `ad_campaigns_preview`: Ad previews per placement | `ads:read` | - | | POST | `/v1/ad-campaigns/{campaign_id}/publish` | `ad_campaigns_publish`: Publish: create the Meta objects paused, then activate (spend confirmation required) | `ads:spend` | - | | POST | `/v1/ad-campaigns/{campaign_id}/resume` | `ad_campaigns_resume`: Resume a campaign | `ads:spend` | - | | POST | `/v1/ad-campaigns/{campaign_id}/validate` | `ad_campaigns_validate`: Dry-run the campaign (local checks plus Meta validate_only) | `ads:read` | - | | GET | `/v1/ad-changes` | `ad_changes_list`: Changes waiting at Facebook, across all ads | `ads:read` | - | | GET | `/v1/ad-creatives` | `ad_creatives_list`: Creative library | `ads:read` | - | | POST | `/v1/ad-creatives` | `ad_creatives_create`: Create a creative from the media library and copy | `ads:write` | - | | POST | `/v1/ad-creatives:generate-copy` | `ad_creatives_generate_copy`: AI headline and text variants (English, Hindi, Hinglish) | `ai:read` | - | | GET | `/v1/ad-sets/{ad_set_id}` | `ad_sets_get`: Get one ad set | `ads:read` | - | | PATCH | `/v1/ad-sets/{ad_set_id}` | `ad_sets_update`: Update targeting or budget on one ad set | `ads:spend` | - | | GET | `/v1/ad-sets/{ad_set_id}/ads` | `ad_sets_list_ads`: List the ads of an ad set | `ads:read` | - | | GET | `/v1/ads/{ad_id}` | `ads_get`: Get an ad with effective status, review feedback and issues | `ads:read` | - | | PATCH | `/v1/ads/{ad_id}/creative` | `ads_replace_creative`: Replace the creative (new creative id; the ad goes back to review) | `ads:write` | - | | POST | `/v1/ads/{ad_id}/pause` | `ads_pause`: Pause one ad | `ads:spend` | - | | POST | `/v1/ads/{ad_id}/resume` | `ads_resume`: Resume one ad | `ads:spend` | - | | GET | `/v1/ads/attribution` | `ads_attribution`: Ad to chat to sale funnel per campaign | `ads:read` | - | | POST | `/v1/ads/boost` | `ads_boost`: Boost a published post or Reel in 3 taps (creates a draft campaign) | `ads:write` | - | | POST | `/v1/ads/estimates` | `ads_estimates`: Audience estimate (a range, never a promise) | `ads:read` | - | | GET | `/v1/ads/insights` | `ads_insights`: Insights: stored daily rows (default) or live from Meta, joined with our conversations, sales and revenue | `ads:read` | - | | POST | `/v1/ads/insights/reports` | `ads_insights_reports_create`: Start an async insights report (large ranges) | `ads:read` | - | | GET | `/v1/ads/insights/reports/{report_id}` | `ads_insights_reports_get`: Poll or fetch an insights report | `ads:read` | - | | GET | `/v1/ads/targeting/presets` | `ads_targeting_presets`: Plain-language audience presets | `ads:read` | - | | GET | `/v1/ads/targeting/search` | `ads_targeting_search`: Targeting search proxy (cached 24 h, interests revalidated) | `ads:read` | - | | POST | `/v1/ads/targeting/validate` | `ads_targeting_validate`: Validate targeting including special-category constraints | `ads:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # agency Source: https://docs.wapitick.com/reference/agency Client approvals, handover and per-client billing for agencies. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/handover/accept` | `agency_handover_accept`: Client owner accepts the handover | `any` | - | | GET | `/v1/orgs/{org_id}/client-approvals` | `agency_approvals_list`: List client approvals | `org:read` | - | | POST | `/v1/orgs/{org_id}/client-approvals` | `agency_approvals_request`: Request client approval of a post, offer, ad campaign or template | `org:write` | - | | POST | `/v1/orgs/{org_id}/clients/{client_org_id}/access-grants/{grant_id}/revoke` | `agency_access_grant_revoke`: Revoke an agency staff member's access to a client organisation | `members:write` | - | | GET | `/v1/orgs/{org_id}/clients/{client_org_id}/billing` | `agency_client_billing_get`: Per-client billing view | `billing:read` | - | | PUT | `/v1/orgs/{org_id}/clients/{client_org_id}/billing` | `agency_client_billing_put`: Set per-client price and who pays | `billing:write` | - | | GET | `/v1/orgs/{org_id}/handover` | `agency_handover_status`: Handover status | `org:write` | - | | POST | `/v1/orgs/{org_id}/handover` | `agency_handover_start`: Start a client handover | `org:write` | - | | POST | `/v1/orgs/{org_id}/handover/{handover_id}/cancel` | `agency_handover_cancel`: Cancel a handover before it is accepted | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # ai-assistants Source: https://docs.wapitick.com/reference/ai-assistants Customer-facing AI Assistants: business-scoped, disclosed, with human handoff. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ai-assistants` | `ai_assistant_list`: List assistants | `ai:read` | - | | POST | `/v1/ai-assistants` | `ai_assistant_create`: Create an assistant (several per workspace, plan-limited) | `ai:write` | - | | DELETE | `/v1/ai-assistants/{assistant_id}` | `ai_assistant_delete`: Delete an assistant | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}` | `ai_assistant_get`: Get an assistant | `ai:read` | - | | PATCH | `/v1/ai-assistants/{assistant_id}` | `ai_assistants_update`: Update an assistant | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/activate` | `ai_assistant_activate`: Go live (readiness checks) | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}/analytics` | `analytics_ai_assistant_report`: Resolution, handoffs, credits, thumbs, unanswered | `analytics:read` | - | | GET | `/v1/ai-assistants/{assistant_id}/benchmarks` | `ai_assistant_benchmarks_list`: Per-language scorecards over time | `ai:read` | - | | GET | `/v1/ai-assistants/{assistant_id}/benchmarks/{run_id}` | `ai_assistant_benchmarks_get`: One per-language scorecard with every item | `ai:read` | - | | POST | `/v1/ai-assistants/{assistant_id}/benchmarks/run` | `ai_assistant_benchmark_run`: Run the per-language quality scoreboard (queued) | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}/conversations` | `ai_assistant_conversations_list`: AI-handled chats with resolution/handoff | `ai:read` | - | | POST | `/v1/ai-assistants/{assistant_id}/deactivate` | `ai_assistant_pause`: Turn off (kill switch) | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}/evals` | `ai_assistant_evals_list`: Eval results | `ai:read` | - | | GET | `/v1/ai-assistants/{assistant_id}/evals/{run_id}` | `ai_assistant_evals_get`: One eval run with per-scenario verdicts, transcripts and the diff | `ai:read` | - | | POST | `/v1/ai-assistants/{assistant_id}/evals/run` | `ai_assistant_evals_run`: Run golden conversations (queued) | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/feedback` | `ai_assistant_review_answer`: Thumb or flag an AI reply | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/publish` | `ai_assistant_publish`: Publish an assistant change behind the evaluation gate | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}/runs` | `ai_assistant_runs_list`: AI runs with status, credits, reasons | `ai:read` | - | | GET | `/v1/ai-assistants/{assistant_id}/scenarios` | `ai_assistant_scenarios_list`: Saved evaluation scenarios | `ai:read` | - | | POST | `/v1/ai-assistants/{assistant_id}/scenarios` | `ai_assistant_scenarios_create`: Save an evaluation scenario | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/scenarios:generate` | `ai_assistant_scenarios_generate`: Generate scenarios from the knowledge base or a real conversation | `ai:write` | - | | DELETE | `/v1/ai-assistants/{assistant_id}/scenarios/{scenario_id}` | `ai_assistant_scenarios_delete`: Delete an evaluation scenario | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}/scenarios/{scenario_id}` | `ai_assistant_scenarios_get`: Get one evaluation scenario | `ai:read` | - | | PATCH | `/v1/ai-assistants/{assistant_id}/scenarios/{scenario_id}` | `ai_assistant_scenarios_update`: Update an evaluation scenario | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/test-chat` | `ai_assistant_test_reply`: Test chat (same harness, tools dry-run) | `ai:read` | - | | GET | `/v1/ai-assistants/{assistant_id}/test-chat/{session_id}` | `ai_assistant_test_sessions_get`: Replay a test session | `ai:read` | - | | GET | `/v1/ai-eval-settings` | `ai_eval_settings_get`: Pre-publish gate and eval budget | `ai:read` | - | | PUT | `/v1/ai-eval-settings` | `ai_eval_settings_update`: Update the pre-publish gate and eval budget | `ai:write` | - | | GET | `/v1/ai-quality/report` | `ai_quality_report`: Quality by assistant, by agent or over time, worst first | `analytics:read` | - | | GET | `/v1/ai-quality/scores` | `ai_quality_scores_list`: Conversation quality scores | `ai:read` | - | | POST | `/v1/ai-quality/scores` | `ai_quality_score_request`: Score one conversation now (queued) | `ai:write` | - | | GET | `/v1/ai-quality/settings` | `ai_quality_settings_get`: Conversation quality rubric and sampling | `ai:read` | - | | PUT | `/v1/ai-quality/settings` | `ai_quality_settings_update`: Update conversation quality scoring | `ai:write` | - | | GET | `/v1/ai-usage` | `ai_usage_get`: AI credit consumption by feature | `billing:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # ai-disclosure Source: https://docs.wapitick.com/reference/ai-disclosure Telling customers they are talking to an AI, per workspace and per language. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/ai-disclosure/disclosed` | `ai_disclosure_mark`: Record that the disclosure was shown | `ai:write` | - | | GET | `/v1/ai-disclosure/resolve` | `ai_disclosure_resolve`: What the AI must say before its first reply | `ai:read` | - | | GET | `/v1/workspaces/{workspace_id}/ai-disclosure` | `ai_disclosure_get`: AI disclosure settings | `ai:read` | - | | PUT | `/v1/workspaces/{workspace_id}/ai-disclosure` | `ai_disclosure_update`: Change the disclosure wording or turn it off | `ai:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # ai-provenance Source: https://docs.wapitick.com/reference/ai-provenance Synthetic-content labels and provenance, AI image generation, AI disclosure texts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ai-disclosures` | `ai_disclosures_list`: AI disclosure texts per surface and language | `org:read` | - | | POST | `/v1/media:generate` | `media_generate`: Generate an AI image (labelled, with provenance) | `ai:read` | - | | GET | `/v1/media/{media_id}/provenance` | `media_provenance_get`: Get the AI provenance of a media file | `media:write` | - | | POST | `/v1/media/{media_id}/provenance` | `media_provenance_set`: Set or override the AI provenance of a media file | `media:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # analytics Source: https://docs.wapitick.com/reference/analytics Funnels and outcome metrics. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/analytics/channels/{channel_id}` | `analytics_channel`: Quality rating, limits and template quality for a channel | `analytics:read` | - | | GET | `/v1/analytics/contacts` | `analytics_contacts`: Contact growth, sources and stages | `analytics:read` | - | | GET | `/v1/analytics/conversations` | `analytics_conversations`: Conversation volume, response times, per agent and channel | `analytics:read` | - | | GET | `/v1/analytics/funnel` | `analytics_funnel`: Stage funnel, conversion and time in stage, from retained stage history | `analytics:read` | - | | GET | `/v1/analytics/home` | `analytics_home`: Home dashboard | `analytics:read` | - | | GET | `/v1/analytics/inbox` | `analytics_inbox`: Inbox quality in one answer | `analytics:read` | - | | GET | `/v1/analytics/offers` | `analytics_offers`: One table over all broadcasts | `analytics:read` | - | | GET | `/v1/analytics/revenue` | `analytics_revenue`: Attributed sales | `analytics:read` | - | | GET | `/v1/analytics/sales` | `analytics_sales`: Sales and payments per day | `analytics:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # api-keys Source: https://docs.wapitick.com/reference/api-keys Create, rotate, revoke and inspect API keys. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/api-keys` | `api_keys_list`: List API keys | `api_keys:write` | - | | POST | `/v1/api-keys` | `api_keys_create`: Create an API key | `api_keys:write` | - | | DELETE | `/v1/api-keys/{key_id}` | `api_keys_revoke`: Revoke a key | `api_keys:write` | - | | GET | `/v1/api-keys/{key_id}` | `api_keys_get`: Get one API key | `api_keys:write` | - | | PATCH | `/v1/api-keys/{key_id}` | `api_keys_update`: Rename or change scopes / allow-list / rate limit | `api_keys:write` | - | | POST | `/v1/api-keys/{key_id}/rotate` | `api_keys_rotate`: Rotate a key | `api_keys:write` | - | | GET | `/v1/api-keys/{key_id}/usage` | `api_keys_usage`: Key usage and recent errors | `api_keys:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # approvals Source: https://docs.wapitick.com/reference/approvals Approval rules and requests. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/approval-rules` | `approval_rules_list`: Approval rules | `members:read` | - | | PUT | `/v1/approval-rules` | `approval_rules_replace`: Replace approval rules | `members:write` | - | | GET | `/v1/approvals` | `approvals_list`: Approval requests (default: pending) | `members:read` | - | | POST | `/v1/approvals/{approval_id}/decision` | `approvals_decide`: Approve or reject | `members:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # asset-safety Source: https://docs.wapitick.com/reference/asset-safety Health card that shows whether the Business can be locked out or hijacked. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/asset-safety` | `asset_safety_get`: Asset safety health card for this Business | `org:read` | - | | POST | `/v1/asset-safety/checks/{check_key}/acknowledge` | `asset_safety_acknowledge`: Owner accepts a risk (for example a personal SIM) | `org:write` | - | | POST | `/v1/asset-safety/refresh` | `asset_safety_refresh`: Re-run the checks (reads Meta admins via business_management) | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # assistant-facts Source: https://docs.wapitick.com/reference/assistant-facts Structured facts with expiry, season rollover and assistant routing. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ai-assistants/{assistant_id}/facts` | `facts_list`: List facts (status active / expiring / expired) | `ai:read` | - | | POST | `/v1/ai-assistants/{assistant_id}/facts` | `facts_create`: Create a fact (needs an expiry or review date) | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/facts:import` | `facts_import`: Bulk import facts (CSV: kind,key,label,value,currency,valid_from,expires_at) | `ai:write` | - | | GET | `/v1/ai-assistants/{assistant_id}/facts/expiring` | `facts_list_stale`: Facts expiring within N days (or expired) | `ai:read` | - | | POST | `/v1/ai-assistants/{assistant_id}/season-rollover` | `facts_start_season_rollover`: Start the season rollover (copies facts as DRAFT) | `ai:write` | - | | POST | `/v1/ai-assistants/{assistant_id}/season-rollover/{rollover_id}/confirm` | `facts_apply_season_rollover`: Confirm facts of a rollover (activate new, archive old) | `ai:write` | - | | DELETE | `/v1/ai-facts/{fact_id}` | `facts_delete`: Delete a fact (archived; stage history keeps it) | `ai:write` | - | | GET | `/v1/ai-facts/{fact_id}` | `facts_get`: Get one fact | `ai:read` | - | | PATCH | `/v1/ai-facts/{fact_id}` | `facts_update`: Edit a fact | `ai:write` | - | | GET | `/v1/workspaces/{workspace_id}/assistant-routing` | `ai_assistant_routing_get`: Assistant routing rules | `ai:read` | - | | PUT | `/v1/workspaces/{workspace_id}/assistant-routing` | `ai_assistant_set_routing`: Set assistant routing (first match wins) | `ai:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # audit-log Source: https://docs.wapitick.com/reference/audit-log Who did what, when: actor, action, resource, IP and diff. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/audit-log` | `audit_log_list`: Audit entries | `audit:read` | - | | GET | `/v1/audit-log/{entry_id}` | `audit_log_get`: One audit entry | `audit:read` | - | | GET | `/v1/audit-log/actions` | `audit_log_actions`: Action catalogue | `audit:read` | - | | POST | `/v1/audit-log/exports` | `audit_log_export`: Export the audit log (CSV or JSON) | `audit:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # auth Source: https://docs.wapitick.com/reference/auth Sign-in, sessions, step-up and the current caller. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/auth/email-otp/start` | `auth_email_otp_start`: Start e-mail sign-in (a 6-digit code by e-mail) | public | - | | POST | `/v1/auth/email-otp/verify` | `auth_email_otp_verify`: Verify the e-mailed code and sign in | public | - | | POST | `/v1/auth/logout` | `auth_logout`: Sign out the current or all sessions | `any` | - | | GET | `/v1/auth/mfa/factors` | `auth_mfa_factors_list`: List my sign-in factors | `any` | - | | DELETE | `/v1/auth/mfa/totp/{factor_id}` | `auth_totp_delete`: Remove TOTP (step-up required) | `any` | - | | POST | `/v1/auth/mfa/totp/{factor_id}/replace` | `auth_totp_replace`: Replace the authenticator app (step-up required) | `any` | - | | POST | `/v1/auth/mfa/totp/enroll` | `auth_totp_enroll`: Start TOTP enrolment | `any` | - | | POST | `/v1/auth/mfa/totp/verify` | `auth_totp_verify`: Activate TOTP and get recovery codes | `any` | - | | GET | `/v1/auth/oauth/google/callback` | `auth_google_callback`: Google redirect target | public | - | | POST | `/v1/auth/oauth/google/start` | `auth_google_start`: Google sign-in URL (state + PKCE) | public | - | | POST | `/v1/auth/otp/{challenge_id}/resend` | `auth_otp_resend`: Resend the code (30 s cooldown, 3 resends) | public | - | | POST | `/v1/auth/otp/start` | `auth_otp_start`: Start phone OTP (login, signup, step-up, recovery) | public | - | | POST | `/v1/auth/otp/verify` | `auth_otp_verify`: Verify the code and sign in | public | - | | GET | `/v1/auth/passkeys` | `auth_passkeys_list`: List passkeys | `any` | - | | DELETE | `/v1/auth/passkeys/{passkey_id}` | `auth_passkeys_delete`: Remove a passkey | `any` | - | | GET | `/v1/auth/passkeys/{passkey_id}` | `auth_passkeys_get`: Get one passkey | `any` | - | | POST | `/v1/auth/passkeys/authenticate/options` | `auth_passkey_authenticate_options`: Passkey sign-in or step-up challenge | public | - | | POST | `/v1/auth/passkeys/authenticate/verify` | `auth_passkey_authenticate_verify`: Verify a passkey assertion (session or step-up token) | public | - | | POST | `/v1/auth/passkeys/register/options` | `auth_passkey_register_options`: WebAuthn registration options | `any` | - | | POST | `/v1/auth/passkeys/register/verify` | `auth_passkey_register_verify`: Finish passkey registration | `any` | - | | GET | `/v1/auth/policy` | `auth_policy_get`: Which second factors this user must have | `any` | - | | GET | `/v1/auth/sessions` | `auth_sessions_list`: Sessions and devices | `any` | - | | DELETE | `/v1/auth/sessions/{session_id}` | `auth_sessions_revoke`: Revoke one session | `any` | - | | GET | `/v1/auth/sessions/{session_id}` | `auth_sessions_get`: Get one session | `any` | - | | POST | `/v1/auth/step-up` | `auth_step_up`: Get a 5-minute step-up token | `any` | - | | POST | `/v1/auth/token/refresh` | `auth_token_refresh`: Refresh the session | public | - | | GET | `/v1/me` | `me_get`: Current caller: user, memberships, workspaces, permissions, plan summary, MFA | `any` | - | | PATCH | `/v1/me` | `me_update`: Update my profile | `any` | - | | POST | `/v1/me/data-export` | `me_data_export`: Export my own data (DSR access) | `any` | - | | POST | `/v1/me/delete-request` | `me_delete_request`: Request account erasure (DPDP/GDPR) | `any` | - | | POST | `/v1/me/devices` | `me_devices_register`: Register a push device | `any` | - | | DELETE | `/v1/me/devices/{device_id}` | `me_devices_unregister`: Unregister a push device | `any` | - | | GET | `/v1/me/devices/{device_id}` | `me_devices_get`: Get one push device | `any` | - | | POST | `/v1/me/phone/change` | `me_phone_change`: Change my login phone | `any` | - | | POST | `/v1/me/phone/verify` | `me_phone_verify`: Verify my mobile number (Google sign-ups) | `any` | - | | POST | `/v1/me/switch-org` | `me_switch_org`: Switch the active organisation / workspace | `any` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # automation-apps Source: https://docs.wapitick.com/reference/automation-apps Zapier, Make and n8n trigger/action mapping. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/automation/catalog` | `automation_catalog`: Trigger / action / dropdown mapping for Zapier, Make and n8n | `integrations:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # billing Source: https://docs.wapitick.com/reference/billing Spend forecast, thresholds and caps. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/billing/bsp-routing` | `billing_bsp_routing_set`: Easy billing (BSP routing) contingency switch | `billing:write` | - | | POST | `/v1/billing/checkout` | `billing_checkout_create`: Create a hosted checkout (plan, add-on or top-up) | `billing:write` | - | | GET | `/v1/billing/checkout/{checkout_id}` | `billing_checkout_get`: Checkout status | `billing:read` | - | | POST | `/v1/billing/checkout/{checkout_id}/confirm` | `billing_checkout_confirm`: Client confirmation of a checkout | `billing:write` | - | | PUT | `/v1/billing/country` | `billing_country_set`: Confirm billing country and address | `billing:write` | - | | GET | `/v1/billing/country-detection` | `billing_country_detection`: Detect the billing country (pre-login: IP only, display) | public | - | | GET | `/v1/billing/country-detection/current` | `billing_country_detection_current`: Detect the billing country inside checkout (payment method, tax ID, address) | `billing:read` | - | | GET | `/v1/billing/disputes` | `billing_disputes_list`: Chargebacks and disputes | `billing:read` | - | | GET | `/v1/billing/meta-cost-estimator` | `billing_meta_cost_estimate`: Meta per-message cost ESTIMATE | `billing:read` | - | | GET | `/v1/billing/meta-rates` | `billing_meta_rates`: The Meta per-message rate card in force | `billing:read` | - | | GET | `/v1/billing/meta-service-usage` | `billing_meta_service_usage`: Meta service replies this month against the free allowance | `billing:read` | - | | GET | `/v1/billing/meta-spend` | `billing_meta_spend`: Reconciled Meta spend ESTIMATE per WABA | `billing:read` | - | | GET | `/v1/billing/payment-methods` | `billing_payment_methods_list`: Saved payment methods and mandates | `billing:read` | - | | DELETE | `/v1/billing/payment-methods/{pm_id}` | `billing_payment_methods_delete`: Remove a payment method | `billing:write` | - | | GET | `/v1/billing/payment-methods/{pm_id}` | `billing_payment_methods_get`: One saved payment method | `billing:read` | - | | POST | `/v1/billing/payment-methods/setup` | `billing_payment_methods_setup`: Add a payment method or UPI AutoPay mandate (hosted) | `billing:write` | - | | GET | `/v1/billing/profile` | `billing_profile_get`: Billing profile | `billing:read` | - | | PATCH | `/v1/billing/profile` | `billing_profile_update`: Update the billing identity | `billing:write` | - | | GET | `/v1/billing/spend-caps` | `billing_spend_caps_list`: Spend caps and warning thresholds | `billing:read` | - | | PUT | `/v1/billing/spend-caps` | `billing_spend_cap_set`: Set a spend cap for a category | `billing:write` | - | | GET | `/v1/billing/spend-forecast` | `billing_spend_forecast`: Running and projected spend for the period | `billing:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # bookings Source: https://docs.wapitick.com/reference/bookings Bookings. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/availability` | `availability_get`: Weekly availability + blackout dates (per staff, service or workspace) | `bookings:read` | - | | PUT | `/v1/availability` | `availability_set`: Replace weekly hours and blackout dates | `bookings:write` | - | | GET | `/v1/booking-reminders` | `booking_reminders_get`: Reminder schedule (T-24h, T-2h; template ids) | `bookings:read` | - | | PUT | `/v1/booking-reminders` | `booking_reminders_set`: Replace the reminder schedule | `bookings:write` | - | | GET | `/v1/booking-services` | `booking_services_list`: Services (counselling, site visit, demo class) | `bookings:read` | - | | POST | `/v1/booking-services` | `booking_services_create`: Create a service | `bookings:write` | - | | DELETE | `/v1/booking-services/{service_id}` | `booking_services_delete`: Delete a service that was never booked | `bookings:write` | - | | GET | `/v1/booking-services/{service_id}` | `booking_services_get`: Get one service | `bookings:read` | - | | PATCH | `/v1/booking-services/{service_id}` | `booking_services_update`: Update a service | `bookings:write` | - | | GET | `/v1/booking-services/{service_id}/sessions` | `booking_services_sessions`: Group sessions of a service and their seats | `bookings:read` | - | | GET | `/v1/bookings` | `bookings_list`: List bookings | `bookings:read` | - | | POST | `/v1/bookings` | `bookings_create`: Create a booking | `bookings:write` | - | | GET | `/v1/bookings/{booking_id}` | `bookings_get`: Get a booking | `bookings:read` | - | | PATCH | `/v1/bookings/{booking_id}` | `bookings_update`: Edit notes, assignee or location | `bookings:write` | - | | POST | `/v1/bookings/{booking_id}/attendance` | `bookings_attendance`: Mark attended or no-show | `bookings:write` | - | | POST | `/v1/bookings/{booking_id}/cancel` | `bookings_cancel`: Cancel a booking | `bookings:write` | - | | POST | `/v1/bookings/{booking_id}/confirm` | `bookings_confirm`: Accept a booking request | `bookings:write` | - | | GET | `/v1/bookings/{booking_id}/deposit` | `bookings_deposit_get`: The advance on a booking | `bookings:read` | - | | POST | `/v1/bookings/{booking_id}/deposit` | `bookings_deposit_request`: Ask for an advance to hold the slot | `bookings:write` | - | | POST | `/v1/bookings/{booking_id}/deposit/resolve` | `bookings_deposit_resolve`: Adjust, refund or forfeit a paid advance | `bookings:write` | - | | POST | `/v1/bookings/{booking_id}/reschedule` | `bookings_reschedule`: Reschedule (new row, calendar re-sync, reminders reset) | `bookings:write` | - | | POST | `/v1/bookings/availability:check` | `bookings_check_availability`: Free slots from services, hours, bookings and connected calendars | `bookings:read` | - | | GET | `/v1/integrations/calendars/availability` | `calendars_availability`: Free slots from the connected Google Calendar / Calendly (compatibility alias of bookings availability) | `integrations:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # business-hours Source: https://docs.wapitick.com/reference/business-hours Working hours, holidays, quiet hours and what happens outside them. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/business-hours/holidays` | `business_hours_holidays_list`: Holiday calendar | `conversations:read` | - | | POST | `/v1/business-hours/holidays` | `business_hours_holidays_create`: Add a holiday (or a working exception) | `conversations:write` | - | | DELETE | `/v1/business-hours/holidays/{holiday_id}` | `business_hours_holidays_delete`: Remove a holiday | `conversations:write` | - | | GET | `/v1/business-hours/holidays/{holiday_id}` | `business_hours_holidays_get`: Get a holiday | `conversations:read` | - | | POST | `/v1/business-hours/holidays/import` | `business_hours_holidays_import`: Import the festival calendar for a year | `conversations:write` | - | | GET | `/v1/business-hours/schedules` | `business_hours_schedules_list`: Working hours schedules | `conversations:read` | - | | POST | `/v1/business-hours/schedules` | `business_hours_schedules_create`: Create a working hours schedule | `conversations:write` | - | | DELETE | `/v1/business-hours/schedules/{schedule_id}` | `business_hours_schedules_delete`: Delete a working hours schedule | `conversations:write` | - | | GET | `/v1/business-hours/schedules/{schedule_id}` | `business_hours_schedules_get`: Get a working hours schedule | `conversations:read` | - | | PATCH | `/v1/business-hours/schedules/{schedule_id}` | `business_hours_schedules_update`: Update a working hours schedule | `conversations:write` | - | | GET | `/v1/business-hours/status` | `business_hours_status`: Are we open now? | `conversations:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # calls Source: https://docs.wapitick.com/reference/calls Call log, transcripts, recordings, transfers and call permissions. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/calls` | `calls_list`: Call log | `calls:read` | - | | POST | `/v1/calls` | `calls_place`: Place an outbound call | `calls:write` | - | | GET | `/v1/calls/{call_id}` | `calls_get`: Call detail | `calls:read` | - | | POST | `/v1/calls/{call_id}/apply-crm` | `calls_apply_crm`: Write this call back to the CRM now | `calls:write` | - | | GET | `/v1/calls/{call_id}/commands` | `calls_commands_list`: Steps a flow is waiting for this call to carry out | `calls:read` | - | | POST | `/v1/calls/{call_id}/create-contact` | `calls_create_contact`: Create or merge a contact from the caller | `calls:write` | - | | POST | `/v1/calls/{call_id}/hangup` | `calls_hangup`: End a call | `calls:write` | - | | POST | `/v1/calls/{call_id}/outcome` | `calls_record_outcome`: Record the call outcome (disposition) | `calls:write` | - | | DELETE | `/v1/calls/{call_id}/recording` | `calls_recording_delete`: Delete the recording | `calls:write` | - | | GET | `/v1/calls/{call_id}/recording` | `calls_recording`: Signed recording URL (15 min) | `calls:read` | - | | POST | `/v1/calls/{call_id}/summarize` | `calls_summarize`: Generate the call summary and action items | `ai:read` | - | | GET | `/v1/calls/{call_id}/transcript` | `calls_transcript`: Transcript segments | `calls:read` | - | | POST | `/v1/calls/{call_id}/transfer` | `calls_transfer`: Warm-transfer to a human | `calls:write` | - | | GET | `/v1/calls/summary` | `calls_summary`: Call counts for a period | `calls:read` | - | | POST | `/v1/contacts/{contact_id}/call-permission-request` | `calls_permission_request`: Ask the contact for WhatsApp call permission | `messages:send` | - | | POST | `/v1/voice/call-commands/{command_id}/complete` | `calls_command_complete`: Report what the caller pressed or said | `calls:write` | - | | GET | `/v1/voice/crm-rules` | `calls_crm_rules_get`: How finished calls write back to the CRM | `calls:read` | - | | PUT | `/v1/voice/crm-rules` | `calls_crm_rules_put`: Set how finished calls write back to the CRM | `calls:write` | - | | GET | `/v1/voice/messages` | `voice_messages_list`: Messages taken by the AI receptionist | `calls:read` | - | | POST | `/wh/livekit/{provider}` | `livekit_webhook`: LiveKit server webhook (internal) | public | - | | POST | `/wh/telephony/{provider}` | `telephony_webhook`: Telephony CPaaS call status callback (internal) | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # capi Source: https://docs.wapitick.com/reference/capi Conversions API events for click-to-message ads. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ads/capi-events` | `capi_events_list`: Conversions API event log with delivery status | `ads:read` | - | | POST | `/v1/ads/capi-events` | `capi_events_send`: Send a Conversions API event for a contact (normally automatic from stage changes) | `ads:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # carts Source: https://docs.wapitick.com/reference/carts Abandoned carts and checkouts, recovery sequences and what the recovery actually earned. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/cart-recovery/attributions` | `cart_recovery_list_attributions`: Every order we considered, and why it did or did not count | `analytics:read` | - | | GET | `/v1/cart-recovery/report` | `cart_recovery_report`: Recovery report: messages, orders, revenue and what we can actually prove | `analytics:read` | - | | GET | `/v1/cart-recovery/settings` | `cart_recovery_get_settings`: Cart recovery settings | `orders:read` | - | | PUT | `/v1/cart-recovery/settings` | `cart_recovery_put_settings`: Save cart recovery settings | `orders:write` | - | | GET | `/v1/carts` | `carts_list`: List carts | `orders:read` | - | | POST | `/v1/carts` | `carts_upsert`: Record or update a cart, checkout or browsing session | `orders:write` | - | | GET | `/v1/carts/{cart_id}` | `carts_get`: Get one cart | `orders:read` | - | | POST | `/v1/carts/{cart_id}/abandon` | `carts_abandon`: Mark a cart abandoned now and start recovery | `orders:write` | - | | POST | `/v1/carts/{cart_id}/cancel` | `carts_cancel`: Stop recovering a cart | `orders:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # catalog-sync Source: https://docs.wapitick.com/reference/catalog-sync Shopify / WooCommerce to our catalog to the Meta catalog. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/catalog-sync-runs/{run_id}` | `catalog_sync_runs_get`: One run with item errors | `catalogs:read` | - | | POST | `/v1/catalog-sync-runs/{run_id}/cancel` | `catalog_sync_runs_cancel`: Cancel a queued or running run | `catalogs:write` | - | | POST | `/v1/catalog-sync-runs/{run_id}/retry` | `catalog_sync_runs_retry`: Retry a finished run | `catalogs:write` | - | | POST | `/v1/catalogs/{catalog_id}/import-csv` | `catalog_import_csv`: CSV import by media_id | `catalogs:write` | - | | POST | `/v1/catalogs/{catalog_id}/price-stock:update` | `catalog_price_stock_update`: Fast-path bulk price / stock update | `catalogs:write` | - | | GET | `/v1/catalogs/{catalog_id}/sync-runs` | `catalog_sync_runs_list`: Sync runs of a catalog | `catalogs:read` | - | | POST | `/v1/catalogs/{catalog_id}/sync-runs` | `catalog_sync_runs_start`: Start a sync run | `catalogs:write` | - | | PUT | `/v1/catalogs/{catalog_id}/sync-schedule` | `catalog_sync_schedule_put`: Auto-sync cadence and conflict policy | `catalogs:write` | - | | POST | `/v1/products/{product_id}/publish-to-whatsapp` | `catalog_product_publish_whatsapp`: Make a product visible in the WhatsApp catalog | `catalogs:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # catalogs Source: https://docs.wapitick.com/reference/catalogs Product catalogs (manual, CSV, Shopify, WooCommerce, Meta) and collections. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/catalogs` | `catalogs_list`: Catalogs | `catalogs:read` | - | | POST | `/v1/catalogs` | `catalogs_create`: Create a local catalog, link a Meta catalog, or connect Shopify/WooCommerce | `catalogs:write` | - | | DELETE | `/v1/catalogs/{catalog_id}` | `catalogs_delete`: Delete a local catalog (unlinks the Meta catalog) | `catalogs:write` | - | | GET | `/v1/catalogs/{catalog_id}` | `catalogs_get`: Get a catalog (sync status, WhatsApp link state) | `catalogs:read` | - | | PATCH | `/v1/catalogs/{catalog_id}` | `catalogs_update`: Update a catalog | `catalogs:write` | - | | POST | `/v1/catalogs/{catalog_id}/link-whatsapp` | `catalogs_link_whatsapp`: Connect the catalog to the WhatsApp number (cart / catalog button) | `catalogs:write` | - | | POST | `/v1/catalogs/{catalog_id}/sync` | `catalogs_sync`: Pull from Shopify/WooCommerce or push to Meta | `catalogs:write` | - | | GET | `/v1/collections` | `collections_list`: Product collections (sets) of a catalog | `catalogs:read` | - | | POST | `/v1/collections` | `collections_create`: Create a collection | `catalogs:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # channels Source: https://docs.wapitick.com/reference/channels Connected channels: WhatsApp, Instagram, Messenger, Pages, Threads, voice numbers. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/channels` | `channels_list`: List channels | `channels:read` | yes | | DELETE | `/v1/channels/{channel_id}` | `channels_disconnect`: Disconnect a channel | `channels:write` | - | | GET | `/v1/channels/{channel_id}` | `channels_get`: Get a channel | `channels:read` | yes | | PATCH | `/v1/channels/{channel_id}` | `channels_update`: Update channel settings | `channels:write` | - | | GET | `/v1/channels/{channel_id}/block-list` | `channels_block_list`: Blocked users | `channels:read` | - | | POST | `/v1/channels/{channel_id}/block-list` | `channels_block_users`: Block users on WhatsApp | `channels:write` | - | | DELETE | `/v1/channels/{channel_id}/block-list/{contact_id}` | `channels_unblock_user`: Unblock a user | `channels:write` | - | | GET | `/v1/channels/{channel_id}/call-settings` | `channels_call_settings_get`: WhatsApp Calling settings | `calls:read` | - | | PUT | `/v1/channels/{channel_id}/call-settings` | `channels_call_settings_put`: Update WhatsApp Calling settings | `calls:write` | - | | GET | `/v1/channels/{channel_id}/capabilities` | `channels_capabilities_get`: Connector capabilities | `channels:read` | - | | GET | `/v1/channels/{channel_id}/coexistence` | `channels_coexistence_get`: Coexistence sync state | `channels:read` | - | | POST | `/v1/channels/{channel_id}/coexistence/restart` | `channels_coexistence_restart`: Restart the coexistence sync | `channels:write` | - | | GET | `/v1/channels/{channel_id}/health` | `channels_health_get`: Channel health | `channels:read` | - | | POST | `/v1/channels/{channel_id}/health/refresh` | `channels_health_refresh`: Re-check health against Meta | `channels:write` | - | | GET | `/v1/channels/{channel_id}/ice-breakers` | `channels_ice_breakers_get`: Ice breakers / conversation starters | `channels:read` | - | | PUT | `/v1/channels/{channel_id}/ice-breakers` | `channels_ice_breakers_put`: Set ice breakers | `channels:write` | - | | GET | `/v1/channels/{channel_id}/levels` | `channels_levels_get`: Connection levels | `channels:read` | - | | GET | `/v1/channels/{channel_id}/limits` | `channels_limits_get`: Messaging limits and throughput | `channels:read` | - | | GET | `/v1/channels/{channel_id}/payment-status` | `channels_payment_status_get`: Meta payment-method health | `channels:read` | - | | POST | `/v1/channels/{channel_id}/private-lane/release` | `channels_private_lane_release`: Mark synced chats as business (owner only) | `channels:write` | - | | GET | `/v1/channels/{channel_id}/profile` | `channels_profile_get`: WhatsApp business profile | `channels:read` | - | | PATCH | `/v1/channels/{channel_id}/profile` | `channels_profile_update`: Update the WhatsApp business profile on Meta | `channels:write` | - | | POST | `/v1/channels/{channel_id}/reconnect` | `channels_reconnect`: Re-authenticate a channel | `channels:write` | - | | GET | `/v1/channels/{channel_id}/routing` | `channels_routing_get`: Routing / standby state | `channels:read` | - | | PUT | `/v1/channels/{channel_id}/routing` | `channels_routing_put`: Set FAQ mode and in-app AI declaration | `channels:write` | - | | GET | `/v1/channels/{channel_id}/usernames` | `channels_username_get`: WhatsApp business username | `channels:read` | - | | POST | `/v1/channels/{channel_id}/usernames` | `channels_username_claim`: Claim or change the business username | `channels:write` | - | | GET | `/v1/channels/available-services` | `channels_available_services`: What each channel type can do on this plan | `channels:read` | - | | POST | `/v1/channels/connect-sessions` | `channels_connect_session_create`: Start connecting a channel | `channels:write` | - | | GET | `/v1/channels/connect-sessions/{id}` | `channels_connect_session_get`: Poll connect progress | `channels:write` | - | | POST | `/v1/channels/connect-sessions/{id}/callback` | `channels_connect_session_callback`: Finalise a connection | `channels:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # client-errors Source: https://docs.wapitick.com/reference/client-errors Web client error reports (feeds the staff issue tracker). | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/client-errors` | `client_errors_report`: Report a web client error | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # client-portal Source: https://docs.wapitick.com/reference/client-portal Public, token-based client approval pages. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/public/client-approvals/{token}` | `client_portal_get`: Client approval page data (no login) | public | - | | POST | `/v1/public/client-approvals/{token}/decision` | `client_portal_decide`: Approve, request changes or reject (no login) | public | - | | POST | `/v1/public/client-approvals/{token}/otp` | `client_portal_otp_send`: Send the portal passcode to the approver (no login) | public | - | | POST | `/v1/public/client-approvals/{token}/otp/verify` | `client_portal_otp_verify`: Verify the portal passcode (no login) | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # comments Source: https://docs.wapitick.com/reference/comments Comments and replies on Instagram, Facebook Page and Threads posts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/comment-dm-rules` | `comment_dm_rules_list`: List comment-to-DM rules | `posts:read` | - | | POST | `/v1/comment-dm-rules` | `comment_dm_rules_create`: Create a comment-to-DM rule | `posts:write` | - | | DELETE | `/v1/comment-dm-rules/{rule_id}` | `comment_dm_rules_delete`: Delete (archive) a comment-to-DM rule | `posts:write` | - | | GET | `/v1/comment-dm-rules/{rule_id}` | `comment_dm_rules_get`: Get a comment-to-DM rule | `posts:read` | - | | PATCH | `/v1/comment-dm-rules/{rule_id}` | `comment_dm_rules_update`: Edit, pause or resume a comment-to-DM rule | `posts:write` | - | | GET | `/v1/comments` | `comments_list`: Comment inbox (all channels) | `conversations:read` | - | | DELETE | `/v1/comments/{comment_id}` | `comments_delete`: Delete a comment | `conversations:write` | - | | GET | `/v1/comments/{comment_id}` | `comments_get`: Get a comment | `conversations:read` | - | | POST | `/v1/comments/{comment_id}/done` | `comments_done`: Mark a comment as dealt with | `conversations:write` | - | | POST | `/v1/comments/{comment_id}/hide` | `comments_hide`: Hide or unhide a comment | `conversations:write` | - | | POST | `/v1/comments/{comment_id}/private-reply` | `comments_private_reply`: Comment-to-DM: private reply (7 days, one per comment) | `messages:send` | - | | POST | `/v1/comments/{comment_id}/reply` | `comments_reply`: Reply to a comment (public) | `conversations:write` | - | | POST | `/v1/comments/{comment_id}/undone` | `comments_undone`: Put a comment back in the queue | `conversations:write` | - | | GET | `/v1/posts/{post_id}/comments` | `posts_comments`: Comments on a published post | `posts:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # connectors Source: https://docs.wapitick.com/reference/connectors Connector packages and their health. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/connectors` | `connectors_list`: Connector packages | `channels:read` | - | | GET | `/v1/connectors/{connector_key}/health` | `connectors_health`: Connector health incl. Meta app state | `channels:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # consent-forms Source: https://docs.wapitick.com/reference/consent-forms Opt-in widgets, QR codes and web forms. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/consent-forms` | `consent_forms_list`: List opt-in forms | `contacts:read` | - | | POST | `/v1/consent-forms` | `consent_forms_create`: Create an opt-in widget, QR code or web form | `contacts:write` | - | | GET | `/v1/consent-forms/{form_id}` | `consent_forms_get`: Get one opt-in or contact form | `contacts:read` | - | | PATCH | `/v1/consent-forms/{form_id}` | `consent_forms_update`: Change a form (questions, wording, status) | `contacts:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # consent-ledger Source: https://docs.wapitick.com/reference/consent-ledger Proof of marketing consent per contact and channel, and do-not-contact lists. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/consent-ledger` | `consent_ledger_list`: The consent ledger | `contacts:read` | - | | POST | `/v1/consent-ledger` | `consent_ledger_record`: Record consent, with proof | `contacts:write` | - | | POST | `/v1/consent-ledger/{entry_id}/confirm` | `consent_ledger_confirm`: Record the double opt-in confirmation | `contacts:write` | - | | GET | `/v1/consent-ledger/evidence` | `consent_evidence_export`: Export the evidence for one person | `contacts:read` | - | | GET | `/v1/consent-ledger/state` | `consent_state_get`: May this contact receive marketing? | `contacts:read` | - | | POST | `/v1/consent-ledger/withdraw` | `consent_ledger_withdraw`: Withdraw consent | `contacts:write` | - | | GET | `/v1/suppression-lists` | `suppression_lists_list`: Do-not-contact lists | `contacts:read` | - | | POST | `/v1/suppression-lists` | `suppression_lists_create`: Add a do-not-contact list | `contacts:write` | - | | POST | `/v1/suppression-lists/{list_id}/entries` | `suppression_entries_add`: Add numbers to a list | `contacts:write` | - | | POST | `/v1/suppression-lists/{list_id}/sync` | `suppression_lists_sync`: Sync a do-not-contact list | `contacts:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # contact-exports Source: https://docs.wapitick.com/reference/contact-exports Owner-only, step-up, watermarked exports. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/contact-exports` | `contact_exports_create`: Export contacts (owner only, step-up, watermarked, audit-logged) | `contacts:read` | - | | GET | `/v1/contact-exports/{export_id}` | `contact_exports_get`: Export status and a single-use signed download link (24 h) | `contacts:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # contact-imports Source: https://docs.wapitick.com/reference/contact-imports CSV imports with opt-in attestation. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/contact-imports` | `contact_imports_create`: Start a CSV import (needs the opt-in attestation) | `contacts:write` | - | | GET | `/v1/contact-imports/{import_id}` | `contact_imports_get`: Import status and error report | `contacts:read` | - | | POST | `/v1/contact-imports/{import_id}/cancel` | `contact_imports_cancel`: Cancel a running import (rows already imported stay) | `contacts:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # contacts Source: https://docs.wapitick.com/reference/contacts Customers: identities, consent, tags, stages, merge, erase. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/contacts` | `contacts_list`: List and filter contacts | `contacts:read` | yes | | POST | `/v1/contacts` | `contacts_create`: Create a contact | `contacts:write` | yes | | POST | `/v1/contacts:bulk-assign` | `contacts_bulk_assign`: Give many customers to one staff member | `contacts:write` | - | | POST | `/v1/contacts:upsert` | `contacts_upsert`: Create or update a contact by identity (idempotent) | `contacts:write` | yes | | DELETE | `/v1/contacts/{contact_id}` | `contacts_delete`: Erase a contact (DSR: tombstone content, keep billing metadata) | `contacts:delete` | yes | | GET | `/v1/contacts/{contact_id}` | `contacts_get`: Get a contact | `contacts:read` | yes | | PATCH | `/v1/contacts/{contact_id}` | `contacts_update`: Update a contact (JSON Merge Patch) | `contacts:write` | yes | | GET | `/v1/contacts/{contact_id}/attribution` | `contacts_get_attribution`: Click-to-WhatsApp / lead-ad attribution | `contacts:read` | - | | GET | `/v1/contacts/{contact_id}/consents` | `contacts_list_consents`: Consent records | `contacts:read` | yes | | POST | `/v1/contacts/{contact_id}/consents` | `contacts_record_consent`: Record an opt-in or opt-out with proof | `contacts:write` | yes | | GET | `/v1/contacts/{contact_id}/identities` | `contacts_list_identities`: List a contact's identities | `contacts:read` | - | | POST | `/v1/contacts/{contact_id}/identities` | `contacts_add_identity`: Add an identity (phone, email, BSUID, IG/Messenger id) | `contacts:write` | - | | DELETE | `/v1/contacts/{contact_id}/identities/{identity_id}` | `contacts_remove_identity`: Remove an identity | `contacts:write` | - | | POST | `/v1/contacts/{contact_id}/merge` | `contacts_merge`: Merge duplicates into this contact | `contacts:write` | - | | POST | `/v1/contacts/{contact_id}/opt-out` | `contacts_opt_out`: Record a staff opt-out (marketing) and request the confirmation message | `contacts:write` | yes | | POST | `/v1/contacts/{contact_id}/stage` | `contacts_set_stage`: Move the contact to a pipeline stage (writes stage history) | `contacts:write` | - | | GET | `/v1/contacts/{contact_id}/stage-history` | `contacts_stage_history`: All stage transitions (retained for the life of the contact) | `contacts:read` | - | | GET | `/v1/contacts/{contact_id}/summary` | `contacts_summary`: What a customer owes, has paid, ordered and booked, and what is next | `contacts:read` | - | | POST | `/v1/contacts/{contact_id}/tags` | `contacts_add_tags`: Add tags (by id or name; missing names are created) | `contacts:write` | yes | | DELETE | `/v1/contacts/{contact_id}/tags/{tag_id}` | `contacts_remove_tag`: Remove a tag from a contact | `contacts:write` | yes | | GET | `/v1/contacts/{contact_id}/timeline` | `contacts_timeline`: Activity timeline (notes, stage changes, consent, opt-outs, conversations, orders, payments, bookings, calls, automations) | `contacts:read` | yes | | POST | `/v1/contacts/bulk` | `contacts_bulk_upsert`: Bulk create/update contacts (up to 1,000) | `contacts:write` | yes | | POST | `/v1/contacts/bulk-delete` | `contacts_bulk_delete`: Erase many contacts by ids or segment (second confirmation required) | `contacts:delete` | - | | GET | `/v1/contacts/duplicates` | `contacts_find_duplicates`: Duplicate candidates (same phone, same email, same name) | `contacts:read` | - | | POST | `/v1/contacts/merge-preview` | `contacts_merge_preview`: Preview a merge without changing anything | `contacts:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # conversations Source: https://docs.wapitick.com/reference/conversations Inbox conversations: assignment, status, notes, labels, AI mode. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/conversations` | `conversations_list`: List and filter conversations | `conversations:read` | yes | | POST | `/v1/conversations` | `conversations_create`: Open a conversation with a contact on a channel | `conversations:write` | - | | GET | `/v1/conversations/{conversation_id}` | `conversations_get`: Get a conversation | `conversations:read` | yes | | PATCH | `/v1/conversations/{conversation_id}` | `conversations_update`: Update priority, subject and custom attributes | `conversations:write` | yes | | GET | `/v1/conversations/{conversation_id}/ai` | `conversations_ai_get`: AI state of a conversation | `conversations:read` | - | | POST | `/v1/conversations/{conversation_id}/ai/pause` | `conversations_ai_pause`: Pause the bot for this chat (human takeover) | `conversations:write` | - | | POST | `/v1/conversations/{conversation_id}/ai/resume` | `conversations_ai_resume`: Resume the bot | `conversations:write` | - | | POST | `/v1/conversations/{conversation_id}/ai/suggest-replies` | `conversations_ai_suggest_replies`: Suggested replies | `ai:read` | - | | POST | `/v1/conversations/{conversation_id}/ai/summarize` | `conversations_ai_summarize`: Summarise the conversation | `ai:read` | - | | POST | `/v1/conversations/{conversation_id}/ai/translate` | `conversations_ai_translate`: Translate messages | `ai:read` | - | | POST | `/v1/conversations/{conversation_id}/assign` | `conversations_assign`: Assign to a user or team (or unassign) | `conversations:write` | - | | POST | `/v1/conversations/{conversation_id}/auto-assign` | `conversations_auto_assign`: Apply the routing rule | `conversations:write` | - | | POST | `/v1/conversations/{conversation_id}/close` | `conversations_close`: Resolve or close | `conversations:write` | yes | | POST | `/v1/conversations/{conversation_id}/labels` | `conversations_labels_add`: Add labels | `conversations:write` | - | | DELETE | `/v1/conversations/{conversation_id}/labels/{label_id}` | `conversations_labels_remove`: Remove a label | `conversations:write` | - | | POST | `/v1/conversations/{conversation_id}/lane` | `conversations_set_lane`: Mark a chat private or business (owner only) | `conversations:write` | - | | GET | `/v1/conversations/{conversation_id}/notes` | `conversations_notes_list`: Internal notes | `conversations:read` | yes | | POST | `/v1/conversations/{conversation_id}/notes` | `conversations_notes_create`: Add an internal note | `conversations:write` | yes | | DELETE | `/v1/conversations/{conversation_id}/notes/{note_id}` | `conversations_notes_delete`: Delete a note | `conversations:write` | yes | | GET | `/v1/conversations/{conversation_id}/notes/{note_id}` | `conversations_notes_get`: Get an internal note | `conversations:read` | yes | | PATCH | `/v1/conversations/{conversation_id}/notes/{note_id}` | `conversations_notes_update`: Edit a note | `conversations:write` | yes | | GET | `/v1/conversations/{conversation_id}/participants` | `conversations_participants_list`: Agents who handled the chat, and watchers | `conversations:read` | - | | POST | `/v1/conversations/{conversation_id}/read` | `conversations_mark_read`: Mark as read | `conversations:write` | yes | | POST | `/v1/conversations/{conversation_id}/reopen` | `conversations_reopen`: Reopen a resolved conversation | `conversations:write` | yes | | DELETE | `/v1/conversations/{conversation_id}/snooze` | `conversations_unsnooze`: Unsnooze | `conversations:write` | yes | | POST | `/v1/conversations/{conversation_id}/snooze` | `conversations_snooze`: Snooze until a time | `conversations:write` | yes | | POST | `/v1/conversations/{conversation_id}/transfer-to-meta-agent` | `conversations_transfer_to_meta_agent`: Pass thread control to Meta's agent or a partner app | `conversations:write` | - | | POST | `/v1/conversations/{conversation_id}/typing` | `conversations_typing`: Typing indicator | `messages:send` | - | | POST | `/v1/conversations/{conversation_id}/watchers` | `conversations_watchers_add`: Follow a conversation | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # copilot Source: https://docs.wapitick.com/reference/copilot AI Copilot: runs (WCP/1 SSE), previews, confirmations, approvals tray, limits. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/copilot/actions` | `copilot_actions_list`: Approvals tray (incl. MCP/API/companion-originated) | `copilot:use` | - | | GET | `/v1/copilot/actions/{action_id}` | `copilot_actions_get`: Preview-card data (+ an approval token for the caller) | `copilot:use` | - | | POST | `/v1/copilot/actions/{action_id}/confirm` | `copilot_actions_confirm`: Confirm an action (step 2 of spend/double = on-screen tap) | `copilot:use` | - | | POST | `/v1/copilot/actions/{action_id}/reject` | `copilot_actions_reject`: Reject an action | `copilot:use` | - | | POST | `/v1/copilot/actions/{action_id}/undo` | `copilot_actions_undo`: Undo a reversible action (new action with undo_of) | `copilot:use` | - | | GET | `/v1/copilot/briefing` | `copilot_briefing_get`: Today's briefing as a Briefing card | `copilot:use` | - | | GET | `/v1/copilot/limits` | `copilot_limits_get`: Effective spend/send limits | `copilot:use` | - | | PUT | `/v1/copilot/limits` | `copilot_limits_set`: Set per-role spend limits (owner only; raising needs step-up) | `org:write` | - | | GET | `/v1/copilot/mcp-connections` | `copilot_mcp_connections_list`: MCP clients connected to this org | `copilot:use` | - | | DELETE | `/v1/copilot/mcp-connections/{grant_id}` | `copilot_mcp_connections_revoke`: Revoke an MCP connection | `copilot:use` | - | | GET | `/v1/copilot/mcp-connections/{grant_id}` | `copilot_mcp_connections_get`: One MCP connection | `copilot:use` | - | | GET | `/v1/copilot/memory` | `copilot_memory_list`: Copilot memory items | `copilot:use` | - | | DELETE | `/v1/copilot/memory/{item_id}` | `copilot_memory_delete`: Forget a memory item | `copilot:use` | - | | GET | `/v1/copilot/memory/{item_id}` | `copilot_memory_get`: One memory item | `copilot:use` | - | | POST | `/v1/copilot/runs/{run_id}/cancel` | `copilot_runs_cancel`: Stop text generation (never an executing action) | `copilot:use` | - | | GET | `/v1/copilot/runs/{run_id}/events` | `copilot_run_events_list`: Replay / resume WCP/1 events after seq | `copilot:use` | - | | GET | `/v1/copilot/settings` | `copilot_settings_get`: Copilot mode and preferences | `copilot:use` | - | | PATCH | `/v1/copilot/settings` | `copilot_settings_update`: Change Copilot mode (careful / balanced) - owner only | `org:write` | - | | GET | `/v1/copilot/speech` | `copilot_speech_get`: Which voice services are available | `copilot:use` | - | | GET | `/v1/copilot/stt` | `copilot_stt_connect`: Streaming speech-to-text (WebSocket upgrade) | `copilot:use` | - | | GET | `/v1/copilot/suggestions` | `copilot_suggestions_list`: Next best actions for Home | `copilot:use` | - | | GET | `/v1/copilot/threads` | `copilot_threads_list`: List my Copilot threads | `copilot:use` | - | | POST | `/v1/copilot/threads` | `copilot_threads_create`: New Copilot thread | `copilot:use` | - | | DELETE | `/v1/copilot/threads/{thread_id}` | `copilot_threads_delete`: Delete a thread | `copilot:use` | - | | GET | `/v1/copilot/threads/{thread_id}` | `copilot_threads_get`: Thread with messages and open actions | `copilot:use` | - | | PATCH | `/v1/copilot/threads/{thread_id}` | `copilot_threads_update`: Rename, pin or archive a thread | `copilot:use` | - | | GET | `/v1/copilot/threads/{thread_id}/messages` | `copilot_messages_list`: Thread history | `copilot:use` | - | | POST | `/v1/copilot/threads/{thread_id}/runs` | `copilot_runs_create`: Submit input; streams WCP/1 events (SSE) | `copilot:use` | - | | GET | `/v1/copilot/tools` | `copilot_tools_list`: Tools visible to the caller (locked ones explain the plan) | `copilot:use` | - | | POST | `/v1/copilot/transcripts` | `copilot_transcripts_create`: Sign words heard on the device for review before sending | `copilot:use` | - | | POST | `/v1/copilot/transcripts/audio` | `copilot_audio_transcripts_create`: Turn a short recording into words for review before sending | `copilot:use` | - | | POST | `/v1/copilot/tts` | `copilot_tts_create`: Sentence TTS for read-aloud | `copilot:use` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # copilot-parity Source: https://docs.wapitick.com/reference/copilot-parity Operations behind Copilot tools: SLA views, auto-replies, post repurposing, reach estimates, analytics comparisons, scheduled reports, tool search. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | PUT | `/v1/ad-accounts/{ad_account_id}/spend-cap` | `ad_accounts_spend_cap_set`: Workspace spend cap + daily Copilot budget cap | `ads:spend` | - | | POST | `/v1/ad-creatives:generate-variants` | `ad_creatives_generate_variants`: AI ad copy variants (text only) | `ai:read` | - | | POST | `/v1/ads/reach-estimate` | `ads_reach_estimate`: Estimate audience and daily reach | `ads:read` | - | | PUT | `/v1/ai-assistants/{assistant_id}/settings/{setting}` | `ai_assistant_settings_set`: Set one assistant setting | `ai:write` | - | | GET | `/v1/analytics/compare` | `analytics_compare`: Compare a metric across two periods | `analytics:read` | - | | GET | `/v1/analytics/response-times` | `analytics_response_times_get`: First-response time distribution | `analytics:read` | - | | GET | `/v1/analytics/team-performance` | `analytics_team_performance_get`: Per-agent KPIs | `analytics:read` | - | | GET | `/v1/billing/meta-payment-health` | `billing_meta_payment_health_get`: Meta payment health of the workspace's primary WhatsApp account | `billing:read` | - | | POST | `/v1/bookings/{booking_id}/reminders:send` | `bookings_send_reminder`: Send a booking reminder now | `bookings:write` | - | | GET | `/v1/comments/backlog` | `comments_backlog_get`: Viral-comment backlog (pending private replies) | `conversations:read` | - | | POST | `/v1/contacts:bulk-tag` | `contacts_bulk_tag`: Add tags to many contacts | `contacts:write` | - | | POST | `/v1/conversations:bulk-assign` | `conversations_bulk_assign`: Assign (or unassign) many conversations | `conversations:write` | - | | POST | `/v1/conversations:bulk-close` | `conversations_bulk_close`: Close many conversations | `conversations:write` | - | | GET | `/v1/inbox/unanswered` | `inbox_unanswered_list`: Conversations waiting on us longer than N minutes | `conversations:read` | - | | GET | `/v1/integrations/mcp-connections` | `integrations_mcp_connections_list`: MCP clients connected to this organisation | `integrations:read` | - | | GET | `/v1/meta-graph` | `meta_graph_get`: Read an allow-listed Meta Graph object of one of your channels | `channels:read` | - | | PUT | `/v1/posts/{post_id}/comment-to-dm-rule` | `posts_comment_to_dm_rule_set`: Comment keyword to DM rule on a post | `posts:write` | - | | POST | `/v1/posts/{post_id}/repurpose` | `posts_repurpose`: Add sibling targets for other channels | `posts:write` | - | | GET | `/v1/posts/best-times` | `posts_best_times_get`: Suggested posting times | `posts:read` | - | | GET | `/v1/scheduled-reports` | `scheduled_reports_list`: List scheduled reports | `analytics:read` | - | | POST | `/v1/scheduled-reports` | `scheduled_reports_create`: Schedule a digest report (email / WhatsApp) | `analytics:read` | - | | DELETE | `/v1/scheduled-reports/{report_id}` | `scheduled_reports_delete`: Delete a scheduled report | `analytics:read` | - | | GET | `/v1/scheduled-reports/{report_id}` | `scheduled_reports_get`: Get a scheduled report | `analytics:read` | - | | GET | `/v1/tools/registry/search` | `tools_registry_search`: Hybrid tool search (vector + FTS + RRF) over the caller's tools | `copilot:use` | - | | GET | `/v1/workspaces/{workspace_id}/auto-replies` | `workspace_auto_replies_get`: Away and greeting messages | `org:read` | - | | PUT | `/v1/workspaces/{workspace_id}/auto-replies` | `workspace_auto_replies_set`: Set away and greeting messages | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # csat Source: https://docs.wapitick.com/reference/csat Satisfaction surveys, responses and reports. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/csat/report` | `csat_report`: Satisfaction by agent, team and period | `analytics:read` | - | | GET | `/v1/csat/settings` | `csat_settings_get`: Satisfaction survey settings | `conversations:read` | - | | PATCH | `/v1/csat/settings` | `csat_settings_update`: Change satisfaction survey settings | `conversations:write` | - | | GET | `/v1/csat/surveys` | `csat_surveys_list`: Satisfaction responses | `conversations:read` | - | | POST | `/v1/csat/surveys` | `csat_surveys_create`: Ask one conversation for a rating | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # custom-fields Source: https://docs.wapitick.com/reference/custom-fields Custom contact field definitions. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/custom-fields` | `custom_fields_list`: Custom field definitions | `contacts:read` | - | | POST | `/v1/custom-fields` | `custom_fields_create`: Define a custom field | `contacts:write` | - | | DELETE | `/v1/custom-fields/{field_id}` | `custom_fields_delete`: Delete a custom field (values stay in contacts until overwritten) | `contacts:write` | - | | GET | `/v1/custom-fields/{field_id}` | `custom_fields_get`: Get a custom field | `contacts:read` | - | | PATCH | `/v1/custom-fields/{field_id}` | `custom_fields_update`: Update a custom field (label, options, PII flag) | `contacts:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # developers Source: https://docs.wapitick.com/reference/developers Request log, usage and limits, live event stream. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/api-usage` | `api_usage_get`: API usage and limits | `api_keys:write` | yes | | GET | `/v1/events/stream` | `events_stream`: Live event stream (Server-Sent Events) | `webhooks:read` | yes | | GET | `/v1/request-logs` | `request_logs_list`: Request log (API keys and OAuth apps, last 30 days) | `api_keys:write` | yes | | GET | `/v1/request-logs/{log_id}` | `request_logs_get`: One logged request with its redacted bodies | `api_keys:write` | yes | | GET | `/v1/request-logs/{log_id}/events` | `request_logs_events`: Events a logged request caused | `api_keys:write` | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # discounts Source: https://docs.wapitick.com/reference/discounts Discount codes in the connected store. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/discounts` | `discounts_list`: Discount codes | `catalogs:read` | - | | POST | `/v1/discounts` | `discounts_create`: Create a discount code in the connected store | `catalogs:write` | - | | GET | `/v1/discounts/{discount_id}` | `discounts_get`: One discount code | `catalogs:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # documents Source: https://docs.wapitick.com/reference/documents Private document delivery and structured document intake. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/d/{token}` | `documents_public_view`: What is waiting behind this link (no file yet) | public | - | | POST | `/d/{token}/code` | `documents_public_request_code`: Send me the one-time code | public | - | | GET | `/d/{token}/file` | `documents_public_download`: Download the document (redirect to a 5-minute signed URL) | public | - | | POST | `/d/{token}/verify` | `documents_public_verify`: Enter the one-time code | public | - | | GET | `/v1/documents/checklists` | `document_checklists_list`: Saved document checklists | `contacts:read` | - | | POST | `/v1/documents/checklists` | `document_checklists_create`: Save a reusable document checklist | `contacts:write` | - | | DELETE | `/v1/documents/checklists/{checklist_id}` | `document_checklists_delete`: Delete a checklist | `contacts:write` | - | | GET | `/v1/documents/checklists/{checklist_id}` | `document_checklists_get`: One saved checklist | `contacts:read` | - | | PATCH | `/v1/documents/checklists/{checklist_id}` | `document_checklists_update`: Change, archive or restore a checklist | `contacts:write` | - | | POST | `/v1/documents/checklists/{checklist_id}/send` | `document_checklists_send`: Ask one or many customers for the documents on a checklist | `messages:send` | - | | GET | `/v1/documents/deliveries` | `documents_list_deliveries`: List document deliveries | `messages:read` | - | | POST | `/v1/documents/deliveries` | `documents_create_delivery`: Send one document to one verified person | `messages:send` | - | | GET | `/v1/documents/deliveries/{delivery_id}` | `documents_get_delivery`: Get one delivery | `messages:read` | - | | GET | `/v1/documents/deliveries/{delivery_id}/accesses` | `documents_delivery_accesses`: Who tried to open this document, and when | `messages:read` | - | | POST | `/v1/documents/deliveries/{delivery_id}/resend` | `documents_resend_delivery`: Send the link again | `messages:send` | - | | POST | `/v1/documents/deliveries/{delivery_id}/revoke` | `documents_revoke_delivery`: Revoke a delivery | `messages:send` | - | | GET | `/v1/documents/requests` | `documents_list_requests`: List document checklists | `contacts:read` | - | | POST | `/v1/documents/requests` | `documents_create_request`: Create a document checklist for one customer | `contacts:write` | - | | GET | `/v1/documents/requests/{request_id}` | `documents_get_request`: Get one checklist with its lines | `contacts:read` | - | | POST | `/v1/documents/requests/{request_id}/attach` | `documents_attach_request_file`: Attach a received file to a checklist line | `contacts:write` | - | | POST | `/v1/documents/requests/{request_id}/cancel` | `documents_cancel_request`: Cancel a checklist | `contacts:write` | - | | POST | `/v1/documents/requests/{request_id}/items/{item_id}/review` | `documents_review_request_item`: Accept a line, or reject it with a reason | `contacts:write` | - | | POST | `/v1/documents/requests/{request_id}/remind` | `documents_remind_request`: Chase the missing lines now | `messages:send` | - | | POST | `/v1/documents/requests/{request_id}/send` | `documents_send_request`: Send the checklist to the customer | `messages:send` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # dues Source: https://docs.wapitick.com/reference/dues Scheduled dues. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/due-schedules` | `due_schedules_list`: Due schedules | `orders:read` | - | | POST | `/v1/due-schedules` | `due_schedules_create`: Create a due schedule and its instalments | `orders:write` | - | | GET | `/v1/due-schedules/{schedule_id}` | `due_schedules_get`: One due schedule | `orders:read` | - | | PATCH | `/v1/due-schedules/{schedule_id}` | `due_schedules_update`: Change a fee plan | `orders:write` | - | | POST | `/v1/due-schedules/{schedule_id}/cancel` | `due_schedules_cancel`: Cancel a schedule and its unpaid dues | `orders:write` | - | | GET | `/v1/dues` | `dues_list`: Dues | `orders:read` | - | | POST | `/v1/dues` | `dues_create`: Create a one-off due | `orders:write` | - | | POST | `/v1/dues:bulk-remind` | `dues_bulk_remind`: Send a reminder for many dues at once | `messages:send` | - | | GET | `/v1/dues/{due_id}` | `dues_get`: One due | `orders:read` | - | | POST | `/v1/dues/{due_id}/adjust` | `dues_adjust`: Adjust the amount, date or description of a due | `orders:write` | - | | POST | `/v1/dues/{due_id}/cancel` | `dues_cancel`: Cancel a due | `orders:write` | - | | POST | `/v1/dues/{due_id}/payment-link` | `dues_payment_link`: Payment link for a due (part payment allowed) | `orders:write` | - | | GET | `/v1/dues/{due_id}/payments` | `dues_payments_list`: What has been received against a due | `orders:read` | - | | POST | `/v1/dues/{due_id}/payments` | `dues_payments_record`: Mark a due as received (cash, bank transfer, cheque, UPI to a personal account) | `payments:write` | - | | POST | `/v1/dues/{due_id}/payments/{payment_id}/reverse` | `dues_payments_reverse`: Reverse a payment marked by staff | `payments:write` | - | | POST | `/v1/dues/{due_id}/remind` | `dues_remind`: Send a reminder now | `messages:send` | - | | GET | `/v1/dues/{due_id}/reminders` | `dues_reminders_list`: The reminder ladder of a due | `orders:read` | - | | POST | `/v1/dues/{due_id}/waive` | `dues_waive`: Waive all or part of a due | `orders:write` | - | | GET | `/v1/dues/defaulters` | `dues_defaulters`: Defaulter list | `orders:read` | - | | GET | `/v1/dues/defaulters/export` | `dues_defaulters_export`: Export the defaulter list as CSV | `orders:read` | - | | GET | `/v1/dues/summary` | `dues_summary`: Money owed, per currency | `orders:read` | - | | GET | `/v1/payments/received` | `payments_received_list`: Everything received: gateway payments and payments marked by staff | `payments:read` | - | | GET | `/v1/payments/received/summary` | `payments_received_summary`: Money received by kind and method | `payments:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # events Source: https://docs.wapitick.com/reference/events Event log (30-day polling fallback), event types and samples. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/events` | `events_list`: Event log (polling fallback, 30-day retention) | `webhooks:read` | yes | | GET | `/v1/events/{event_id}` | `events_get`: One event | `webhooks:read` | yes | | GET | `/v1/events/types` | `events_types_list`: Event catalogue with a JSON schema per type and version | public | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # exports Source: https://docs.wapitick.com/reference/exports Bulk exports (contacts, conversations, audit log, leads, orders, all data) behind step-up. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/exports` | `exports_list`: List exports | `contacts:read` | - | | POST | `/v1/exports` | `exports_create`: Create an export (owner only, step-up, watermarked, audit-logged) | `contacts:read` | - | | GET | `/v1/exports/{export_id}` | `exports_get`: Export status and a single-use signed download link (24 h) | `contacts:read` | - | | POST | `/v1/exports/{export_id}/revoke` | `exports_revoke`: Revoke the link early | `contacts:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # flows Source: https://docs.wapitick.com/reference/flows WhatsApp Flows library: install, map, publish, preview. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/flow-components` | `flow_components_list`: Flow components | `templates:read` | - | | GET | `/v1/flow-library` | `flow_library_list`: Flow library | `templates:read` | - | | GET | `/v1/flows` | `flows_list`: Installed flows | `templates:read` | - | | POST | `/v1/flows` | `flows_install`: Install a flow from the library | `templates:write` | - | | DELETE | `/v1/flows/{flow_id}` | `flows_delete`: Delete a draft flow | `templates:write` | - | | GET | `/v1/flows/{flow_id}` | `flows_get`: Get a flow | `templates:read` | - | | PATCH | `/v1/flows/{flow_id}` | `flows_update`: Rename a form | `templates:write` | - | | GET | `/v1/flows/{flow_id}/definition` | `flows_definition_get`: A form's screens and questions | `templates:read` | - | | PUT | `/v1/flows/{flow_id}/definition` | `flows_definition_put`: Save a form's screens and questions | `templates:write` | - | | POST | `/v1/flows/{flow_id}/deprecate` | `flows_deprecate`: Deprecate a published flow | `templates:write` | - | | DELETE | `/v1/flows/{flow_id}/draft` | `flows_draft_discard`: Throw away the unpublished edit of a published form | `templates:write` | - | | PUT | `/v1/flows/{flow_id}/mapping` | `flows_mapping_put`: Map response fields | `templates:write` | - | | POST | `/v1/flows/{flow_id}/preview` | `flows_preview`: Send the flow to a phone for testing | `templates:read` | - | | POST | `/v1/flows/{flow_id}/publish` | `flows_publish`: Publish a flow at Meta | `templates:write` | - | | GET | `/v1/flows/{flow_id}/responses` | `flows_responses_list`: Submitted responses | `conversations:read` | - | | GET | `/v1/flows/{flow_id}/versions` | `flows_versions_list`: A form's versions | `templates:read` | - | | POST | `/v1/flows/custom` | `flows_create`: Create a form from scratch | `templates:write` | - | | POST | `/v1/flows/validate` | `flows_definition_validate`: Check a form definition without saving it | `templates:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # helper-runs Source: https://docs.wapitick.com/reference/helper-runs Executions of helpers with per-step input, output, error and duration. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/helper-runs` | `helper_runs_list`: All runs | `helpers:read` | - | | GET | `/v1/helper-runs/{run_id}` | `helper_runs_get`: A run with its step records (input, output, error, duration) | `helpers:read` | - | | POST | `/v1/helper-runs/{run_id}/cancel` | `helper_runs_cancel`: Cancel a running or waiting run | `helpers:run` | - | | POST | `/v1/helper-runs/{run_id}/retry` | `helper_runs_retry`: Retry a failed run from the failed step (or `from_step`) | `helpers:run` | - | | GET | `/v1/helpers/{helper_id}/runs` | `helper_runs_list_for_helper`: Runs of one helper | `helpers:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # helpers Source: https://docs.wapitick.com/reference/helpers Automations: triggers, steps, versions, test mode and go-live. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/helper-pauses` | `helper_pauses_list`: Bulk pauses of automations | `helpers:read` | - | | GET | `/v1/helper-pauses/{pause_id}` | `helper_pauses_get`: One bulk pause | `helpers:read` | - | | POST | `/v1/helper-pauses/{pause_id}/resume` | `helper_pauses_resume`: Resume: turn back on exactly what this pause turned off | `helpers:run` | - | | GET | `/v1/helpers` | `helpers_list`: List helpers | `helpers:read` | - | | POST | `/v1/helpers` | `helpers_create`: Create a helper from scratch or from a recipe | `helpers:write` | - | | POST | `/v1/helpers:bulk-deactivate` | `helpers_bulk_deactivate`: Pause chosen automations in one step (reversible) | `helpers:run` | - | | POST | `/v1/helpers:generate` | `helpers_generate`: Say it and AI builds it | `helpers:write` | - | | DELETE | `/v1/helpers/{helper_id}` | `helpers_delete`: Delete a helper (runs are retained for 30 days) | `helpers:write` | - | | GET | `/v1/helpers/{helper_id}` | `helpers_get`: Get a helper with its current and draft version | `helpers:read` | - | | PATCH | `/v1/helpers/{helper_id}` | `helpers_update`: Update name, description, folder, channel scope and guards | `helpers:write` | - | | POST | `/v1/helpers/{helper_id}/activate` | `helpers_activate`: Publish a version and turn the helper on | `helpers:run` | - | | POST | `/v1/helpers/{helper_id}/deactivate` | `helpers_deactivate`: Turn the helper off; waiting runs are cancelled or drained | `helpers:run` | - | | GET | `/v1/helpers/{helper_id}/stats` | `helpers_stats`: Runs, success rate, average time, top failing step (last 30 days) | `helpers:read` | - | | POST | `/v1/helpers/{helper_id}/test` | `helpers_test`: Dry-run against a sample contact or event | `helpers:run` | - | | POST | `/v1/helpers/{helper_id}/trigger` | `helpers_trigger`: Start the helper for a contact (API / Zapier action) | `helpers:run` | - | | POST | `/v1/helpers/{helper_id}/validate` | `helpers_validate`: Static check: unreachable steps, loops, missing ready messages, window risks, step cap | `helpers:read` | - | | GET | `/v1/helpers/{helper_id}/versions` | `helpers_list_versions`: List versions (newest first) | `helpers:read` | - | | POST | `/v1/helpers/{helper_id}/versions` | `helpers_save_version`: Save the draft version (validated against the graph schema) | `helpers:write` | - | | GET | `/v1/helpers/{helper_id}/versions/{a}/diff/{b}` | `helpers_diff_versions`: Plain-language diff between two versions | `helpers:read` | - | | GET | `/v1/helpers/{helper_id}/versions/{version_id}` | `helpers_get_version`: Get one version with its graph | `helpers:read` | - | | POST | `/v1/helpers/{helper_id}/versions/{version_id}/restore` | `helpers_restore_version`: Restore a version as the new draft | `helpers:write` | - | | GET | `/v1/helpers/linked` | `helpers_list_linked`: Automations edited elsewhere (fee-plan reminders, comment auto-replies) | `helpers:read` | - | | GET | `/v1/helpers/recipes` | `helpers_list_recipes`: Ready-made recipes with their required inputs | `helpers:read` | - | | POST | `/v1/helpers/recipes/{recipe_id}/preview` | `helpers_preview_recipe`: See exactly what a recipe will do, before anything is created | `helpers:read` | - | | GET | `/v1/helpers/steps` | `helpers_list_steps`: Step types catalogue | `helpers:read` | - | | GET | `/v1/helpers/triggers` | `helpers_list_triggers`: Trigger types catalogue | `helpers:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # home Source: https://docs.wapitick.com/reference/home The Home briefing, navigation counts, realtime topics and the Settings overview. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/counts` | `counts_get`: Counts for navigation badges and page tabs | `any` | - | | GET | `/v1/home` | `home_get`: The Home briefing | `any` | - | | GET | `/v1/realtime` | `realtime_get`: Every realtime topic and the events published on it | `any` | - | | GET | `/v1/settings/orders` | `settings_orders_get`: Order steps and cash-on-delivery rules | `orders:read` | - | | PUT | `/v1/settings/orders` | `settings_orders_put`: Change the cash-on-delivery rules | `org:write` | - | | GET | `/v1/settings/overview` | `settings_overview_get`: The Settings home page | `any` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # inbox Source: https://docs.wapitick.com/reference/inbox Saved views: order and per-role defaults. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/inbox/counts` | `inbox_counts_get`: Unread and unassigned counters (badges) | `conversations:read` | - | | GET | `/v1/inbox/realtime` | `inbox_realtime_get`: Realtime channels for the live inbox | `conversations:read` | - | | GET | `/v1/inbox/views` | `inbox_views_list`: Saved inbox views | `conversations:read` | - | | POST | `/v1/inbox/views` | `inbox_views_create`: Create an inbox view | `conversations:write` | - | | DELETE | `/v1/inbox/views/{view_id}` | `inbox_views_delete`: Delete an inbox view | `conversations:write` | - | | GET | `/v1/inbox/views/{view_id}` | `inbox_views_get`: Get one saved inbox view | `conversations:read` | - | | PATCH | `/v1/inbox/views/{view_id}` | `inbox_views_update`: Update an inbox view | `conversations:write` | - | | GET | `/v1/inbox/views/default` | `inbox_views_default`: The view I land on | `conversations:read` | - | | PUT | `/v1/inbox/views/order` | `inbox_views_reorder`: Reorder saved views | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # integrations Source: https://docs.wapitick.com/reference/integrations Connected apps. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/oauth/callback/{provider}` | `integrations_oauth_callback`: OAuth redirect target for connected apps | public | - | | GET | `/v1/integrations` | `integrations_list`: List connected apps | `integrations:read` | - | | DELETE | `/v1/integrations/{integration_id}` | `integrations_disconnect`: Disconnect (revoke tokens, remove webhooks) | `integrations:write` | - | | GET | `/v1/integrations/{integration_id}` | `integrations_get`: Get a connected app | `integrations:read` | - | | PATCH | `/v1/integrations/{integration_id}` | `integrations_update`: Update settings, pause or resume | `integrations:write` | - | | GET | `/v1/integrations/{integration_id}/calendars` | `integrations_calendars_list`: Calendars of a Google Calendar connection | `integrations:read` | - | | POST | `/v1/integrations/{integration_id}/sync` | `integrations_sync`: Manual sync | `integrations:write` | - | | POST | `/v1/integrations/{integration_id}/test` | `integrations_test`: Connectivity test | `integrations:write` | - | | POST | `/v1/integrations/{provider}/callback` | `integrations_callback`: Finalise the OAuth connect | `integrations:write` | - | | POST | `/v1/integrations/{provider}/connect` | `integrations_connect`: Start OAuth / key connect | `integrations:write` | - | | GET | `/v1/integrations/calendars/provider-availability` | `integrations_provider_availability`: Free slots (Google Calendar / Calendly) | `integrations:read` | - | | GET | `/v1/integrations/google/sheets` | `integrations_google_sheets`: Picker-selected spreadsheets | `integrations:read` | - | | GET | `/v1/integrations/providers` | `integrations_providers`: Available providers | `integrations:read` | - | | POST | `/v1/integrations/razorpay/keys` | `integrations_razorpay_connect`: Connect a Razorpay account with API keys | `integrations:write` | - | | POST | `/v1/integrations/shopify/webhooks/verify` | `integrations_shopify_webhooks_verify`: Verify / re-register Shopify webhooks | `integrations:write` | - | | POST | `/v1/integrations/woocommerce/keys` | `integrations_woocommerce_connect`: Connect a WooCommerce store with REST API keys | `integrations:write` | - | | GET | `/v1/oauth/grants` | `oauth_grants_list`: Third-party apps authorised for this org | `integrations:read` | - | | DELETE | `/v1/oauth/grants/{grant_id}` | `oauth_grants_revoke`: Revoke app access | `integrations:write` | - | | GET | `/v1/oauth/grants/{grant_id}` | `oauth_grants_get`: One authorised third-party app | `integrations:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # invites Source: https://docs.wapitick.com/reference/invites Invite staff by phone or email. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/invites` | `invites_list`: Pending invites | `members:read` | - | | POST | `/v1/invites` | `invites_create`: Invite a member by phone or email | `members:write` | - | | DELETE | `/v1/invites/{invite_id}` | `invites_revoke`: Revoke an invite | `members:write` | - | | GET | `/v1/invites/{invite_id}` | `invites_get`: Get an invite | `members:read` | - | | POST | `/v1/invites/{invite_id}/resend` | `invites_resend`: Resend an invite (extends expiry) | `members:write` | - | | POST | `/v1/invites/accept` | `invites_accept`: Accept an invite token | `any` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # invoices Source: https://docs.wapitick.com/reference/invoices GST invoices, PDFs and credit notes. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/billing/credit-notes` | `invoices_credit_notes_list`: GST credit notes (refunds issued) | `billing:read` | - | | GET | `/v1/billing/invoices` | `invoices_list`: Invoices | `billing:read` | - | | GET | `/v1/billing/invoices/{invoice_id}` | `invoices_get`: One invoice | `billing:read` | - | | GET | `/v1/billing/invoices/{invoice_id}/pdf` | `invoices_pdf`: Signed PDF URL | `billing:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # ivr Source: https://docs.wapitick.com/reference/ivr Visual IVR menus, versions, simulation and activation. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ivr-menus` | `ivr_list`: List IVR menus | `calls:read` | - | | POST | `/v1/ivr-menus` | `ivr_create`: Create an IVR menu | `calls:write` | - | | DELETE | `/v1/ivr-menus/{ivr_id}` | `ivr_delete`: Delete an IVR menu | `calls:write` | - | | GET | `/v1/ivr-menus/{ivr_id}` | `ivr_get`: Get an IVR menu | `calls:read` | - | | PATCH | `/v1/ivr-menus/{ivr_id}` | `ivr_update`: Edit menu metadata | `calls:write` | - | | POST | `/v1/ivr-menus/{ivr_id}/activate` | `ivr_activate`: Publish and bind to numbers | `calls:write` | - | | POST | `/v1/ivr-menus/{ivr_id}/deactivate` | `ivr_deactivate`: Unbind from numbers | `calls:write` | - | | POST | `/v1/ivr-menus/{ivr_id}/simulate` | `ivr_simulate`: Simulate a DTMF path without a call | `calls:read` | - | | GET | `/v1/ivr-menus/{ivr_id}/stats` | `ivr_stats`: Path usage, drop-offs, forwards | `analytics:read` | - | | GET | `/v1/ivr-menus/{ivr_id}/versions` | `ivr_versions_list`: List saved versions | `calls:read` | - | | POST | `/v1/ivr-menus/{ivr_id}/versions` | `ivr_versions_create`: Save a version (graph is validated) | `calls:write` | - | | GET | `/v1/ivr-menus/node-kinds` | `ivr_node_kinds_list`: The kinds of step a call menu can have | `calls:read` | - | | POST | `/v1/voice/calls/{call_id}/ivr` | `ivr_advance`: Advance a live call through its IVR | `calls:write` | - | | GET | `/v1/voice/ivr` | `voice_ivr_get`: Active IVR menu for a number | `calls:read` | - | | PUT | `/v1/voice/ivr` | `voice_ivr_put`: Bind or unbind the IVR of a number | `calls:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # knowledge Source: https://docs.wapitick.com/reference/knowledge Knowledge sources for AI Assistants: websites, pages, files, FAQs, catalogs; hybrid retrieval. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/knowledge-sources` | `ai_kb_list_sources`: List knowledge sources | `ai:read` | - | | POST | `/v1/knowledge-sources` | `knowledge_sources_create`: Add a knowledge source (text, FAQ, URL, website crawl, file, catalog, Google Sheet) | `ai:write` | - | | DELETE | `/v1/knowledge-sources/{source_id}` | `ai_kb_delete_source`: Delete a knowledge source and purge its chunks and embeddings | `ai:write` | - | | GET | `/v1/knowledge-sources/{source_id}` | `knowledge_sources_get`: Get a knowledge source (chunk count, last sync, errors) | `ai:read` | - | | PATCH | `/v1/knowledge-sources/{source_id}` | `knowledge_sources_update`: Update a knowledge source (assistants, title, re-crawl schedule) | `ai:write` | - | | GET | `/v1/knowledge-sources/{source_id}/documents` | `knowledge_documents_list`: Documents under a source (pages, files, FAQ blocks) | `ai:read` | - | | DELETE | `/v1/knowledge-sources/{source_id}/documents/{document_id}` | `knowledge_documents_delete`: Remove one document (its chunks are purged) | `ai:write` | - | | GET | `/v1/knowledge-sources/{source_id}/documents/{document_id}` | `knowledge_documents_get`: Get one document under a source | `ai:read` | - | | POST | `/v1/knowledge-sources/{source_id}/resync` | `ai_kb_resync_source`: Re-crawl / re-ingest a source (only changed pages are re-embedded and charged) | `ai:write` | - | | POST | `/v1/knowledge-sources/uploads` | `knowledge_sources_upload_create`: Get a signed upload URL for a knowledge file (PDF, DOCX, CSV, text, or a spoken recording) | `ai:write` | - | | POST | `/v1/knowledge:search` | `ai_kb_search`: Debug retrieval: top-k chunks with scores for a query | `ai:read` | - | | GET | `/v1/knowledge/gap-clusters` | `knowledge_gap_clusters_list`: Clustered gaps with drafted articles | `ai:read` | - | | POST | `/v1/knowledge/gap-clusters/{cluster_id}/approve` | `knowledge_gap_cluster_approve`: Approve the drafted article (one tap) and add it to the knowledge base | `ai:write` | - | | POST | `/v1/knowledge/gap-clusters/{cluster_id}/dismiss` | `knowledge_gap_cluster_dismiss`: Dismiss a gap cluster | `ai:write` | - | | GET | `/v1/knowledge/gaps` | `knowledge_gaps_list`: Questions the assistant could not answer | `ai:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # labels Source: https://docs.wapitick.com/reference/labels Conversation labels. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/labels` | `labels_list`: List labels | `conversations:read` | - | | POST | `/v1/labels` | `labels_create`: Create a label | `conversations:write` | - | | DELETE | `/v1/labels/{label_id}` | `labels_delete`: Delete a label | `conversations:write` | - | | GET | `/v1/labels/{label_id}` | `labels_get`: Get a label | `conversations:read` | - | | PATCH | `/v1/labels/{label_id}` | `labels_update`: Update a label | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # lead-forms Source: https://docs.wapitick.com/reference/lead-forms Meta instant forms for lead ads. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/lead-forms` | `lead_forms_list`: List lead forms | `leads:read` | - | | POST | `/v1/lead-forms` | `lead_forms_create`: Create an instant form on a Page | `leads:write` | - | | POST | `/v1/lead-forms/{form_id}/archive` | `lead_forms_archive`: Archive a form (Meta cannot delete forms) | `leads:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # leads Source: https://docs.wapitick.com/reference/leads Lead Ads leads: list, qualify, convert into a WhatsApp chat. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/leads` | `leads_list`: List leads | `leads:read` | - | | GET | `/v1/leads/{lead_id}` | `leads_get`: Get a lead | `leads:read` | - | | PATCH | `/v1/leads/{lead_id}` | `leads_update`: Update status, owner or notes | `leads:write` | - | | POST | `/v1/leads/{lead_id}/convert` | `leads_convert`: Create or merge the contact and open a WhatsApp chat (template message) | `leads:write` | - | | POST | `/v1/leads/sync` | `leads_sync`: Backfill leads for a form (reads Meta in bulk) | `leads:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # library Source: https://docs.wapitick.com/reference/library Curated library items you can copy into a Business as editable drafts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/library` | `library_list`: Library items | `templates:read` | - | | GET | `/v1/library/{item_id}` | `library_get`: Library item with localizations | `templates:read` | - | | POST | `/v1/library/{item_id}/copy` | `library_copy`: Install a library item as an editable draft | `templates:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # links Source: https://docs.wapitick.com/reference/links Tracked short links: make a link, share it, see its clicks. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/links` | `links_list`: Tracked links, with their click counts | `offers:read` | - | | POST | `/v1/links` | `links_create`: Create a tracked link | `offers:write` | - | | DELETE | `/v1/links/{link_id}` | `links_delete`: Delete a link and its click history | `offers:write` | - | | GET | `/v1/links/{link_id}` | `links_get`: One tracked link | `offers:read` | - | | PATCH | `/v1/links/{link_id}` | `links_update`: Rename, retarget, archive or restore a link | `offers:write` | - | | GET | `/v1/links/{link_id}/clicks` | `links_clicks`: Clicks on a link: totals, per day and the newest clicks | `offers:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # marketing Source: https://docs.wapitick.com/reference/marketing Pause and resume all scheduled marketing in one tap. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/marketing/pause` | `marketing_pause_get`: Current pause state and what it affects | `org:read` | - | | POST | `/v1/marketing/pause` | `marketing_pause_start`: Pause all scheduled marketing (reversible) | `offers:send` | - | | POST | `/v1/marketing/pause/{pause_id}/keep` | `marketing_pause_keep`: Keep items paused while resuming the rest | `offers:send` | - | | POST | `/v1/marketing/resume` | `marketing_pause_resume`: Resume: restores exactly what was paused | `offers:send` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # media Source: https://docs.wapitick.com/reference/media Media library: signed uploads, scan, renditions, signed read URLs. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/media` | `media_list`: Media library | `media:write` | - | | POST | `/v1/media:from-url` | `media_from_url`: Fetch a public URL into the library | `media:write` | - | | DELETE | `/v1/media/{media_id}` | `media_delete`: Delete media | `media:write` | - | | GET | `/v1/media/{media_id}` | `media_get`: Get media | `media:write` | - | | PATCH | `/v1/media/{media_id}` | `media_update`: Rename, alt text, tags, move into the library | `media:write` | - | | POST | `/v1/media/{media_id}/complete` | `media_upload_complete`: Finish an upload | `media:write` | - | | POST | `/v1/media/{media_id}/transcode` | `media_transcode`: Request a rendition | `media:write` | - | | GET | `/v1/media/{media_id}/url` | `media_url_get`: Signed read URL (up to 1 hour) | `media:write` | - | | GET | `/v1/media/{media_id}/usages` | `media_usages_list`: Where a file is used | `media:write` | - | | POST | `/v1/media/uploads` | `media_upload_create`: Create an upload | `media:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # members Source: https://docs.wapitick.com/reference/members Organisation members, roles and permissions. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/me/access` | `me_access_get`: What the caller may open and see | `any` | - | | GET | `/v1/members` | `members_list`: List org members | `members:read` | - | | DELETE | `/v1/members/{user_id}` | `members_remove`: Remove a member (reassign open chats) | `members:write` | - | | GET | `/v1/members/{user_id}` | `members_get`: Get a member | `members:read` | - | | PATCH | `/v1/members/{user_id}` | `members_update`: Change role, workspace roles, availability or capacity | `members:write` | - | | GET | `/v1/members/{user_id}/access` | `members_access_get`: What one staff member may open and see | `members:read` | - | | PUT | `/v1/members/{user_id}/access` | `members_access_put`: Choose what one staff member may open and see | `members:write` | - | | GET | `/v1/old-chats-access` | `old_chats_access_get`: Who may see the old synced chats | `members:read` | - | | PUT | `/v1/old-chats-access` | `old_chats_access_put`: Decide who may see the old synced chats (owner only) | `members:write` | - | | GET | `/v1/permissions` | `permissions_list`: Permission catalogue | `members:read` | - | | GET | `/v1/roles` | `roles_list`: System roles and the permission matrix | `members:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # messages Source: https://docs.wapitick.com/reference/messages Send and read messages on every channel through one policy-checked pipeline. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/conversations/{conversation_id}/messages` | `messages_list`: List a conversation's messages | `messages:read` | yes | | POST | `/v1/conversations/{conversation_id}/messages` | `messages_send_in_conversation`: Send a message in a conversation | `messages:send` | yes | | POST | `/v1/conversations/{conversation_id}/messages/interactive` | `messages_send_interactive`: Send an interactive message | `messages:send` | yes | | POST | `/v1/conversations/{conversation_id}/messages/media` | `messages_send_media`: Send media by media_id | `messages:send` | - | | POST | `/v1/conversations/{conversation_id}/messages/template` | `messages_send_template`: Send a template | `messages:send` | yes | | POST | `/v1/conversations/{conversation_id}/messages/text` | `messages_send_text`: Send a text message | `messages:send` | yes | | POST | `/v1/messages` | `messages_send`: Send a message (policy engine, then queued) | `messages:send` | yes | | POST | `/v1/messages:estimate` | `messages_estimate`: Pre-flight check for a send | `messages:read` | yes | | DELETE | `/v1/messages/{message_id}` | `messages_delete`: Delete / revoke a message | `messages:send` | - | | GET | `/v1/messages/{message_id}` | `messages_get`: Get a message | `messages:read` | yes | | GET | `/v1/messages/{message_id}/media` | `messages_media_get`: Short-lived signed URL for a message's media | `messages:read` | - | | DELETE | `/v1/messages/{message_id}/reactions` | `messages_unreact`: Remove our reaction | `messages:send` | yes | | POST | `/v1/messages/{message_id}/reactions` | `messages_react`: React to a message | `messages:send` | yes | | POST | `/v1/messages/{message_id}/retry` | `messages_retry`: Retry a failed send | `messages:send` | yes | | POST | `/v1/messages/{message_id}/transcribe` | `messages_transcribe`: Transcribe a voice note | `ai:read` | - | | POST | `/v1/messages/{message_id}/translate` | `messages_translate`: Translate a message | `ai:read` | - | | POST | `/v1/messages/batch` | `messages_batch`: Send up to 100 messages | `messages:send` | yes | | GET | `/v1/messages/search` | `messages_search`: Full-text message search | `messages:read` | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # misc Source: https://docs.wapitick.com/reference/misc Changelog, feedback and locales. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/changelog` | `misc_changelog`: API changelog feed | public | - | | POST | `/v1/feedback` | `misc_feedback`: In-app feedback or bug report | `any` | - | | GET | `/v1/locales` | `misc_locales`: Supported UI languages and glossary | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # modules Source: https://docs.wapitick.com/reference/modules Module and connector on/off toggles per Business. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/modules` | `modules_list`: Modules and connectors for the Business | `org:read` | - | | GET | `/v1/modules/{module_key}` | `modules_get`: Module detail (what turns on and off) | `org:read` | - | | PUT | `/v1/modules/{module_key}` | `modules_toggle`: Turn a module or connector on or off (data is kept) | `org:write` | - | | GET | `/v1/modules/{module_key}/onboarding` | `modules_onboarding`: Onboarding branch checklist | `org:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # notifications Source: https://docs.wapitick.com/reference/notifications In-app notifications, unread badge and delivery preferences. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/notifications` | `notifications_list`: My notifications | `notifications:read` | - | | POST | `/v1/notifications/{notification_id}/read` | `notifications_mark_read`: Mark a notification as read | `notifications:write` | - | | GET | `/v1/notifications/preferences` | `notifications_get_preferences`: Notification preferences (event x channel, quiet hours, digest) | `notifications:read` | - | | PUT | `/v1/notifications/preferences` | `notifications_update_preferences`: Update notification preferences | `notifications:write` | - | | POST | `/v1/notifications/read-all` | `notifications_mark_all_read`: Mark all my notifications as read | `notifications:write` | - | | GET | `/v1/notifications/unread-count` | `notifications_unread_count`: Unread badge count | `notifications:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # oauth Source: https://docs.wapitick.com/reference/oauth OAuth 2.1 authorization server for the public API and the MCP server. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/.well-known/jwks.json` | `oauth_jwks_well_known`: Public signing keys (JWKS) | public | - | | GET | `/.well-known/oauth-authorization-server` | `oauth_server_metadata`: Authorization server metadata (RFC 8414) | public | - | | GET | `/.well-known/openid-configuration` | `oauth_openid_configuration`: OpenID-style discovery document | public | - | | GET | `/oauth/authorize` | `oauth_authorize`: Authorization endpoint (browser) | public | - | | POST | `/oauth/introspect` | `oauth_introspect`: Introspect a token (RFC 7662) | public | - | | GET | `/oauth/jwks.json` | `oauth_jwks`: Public signing keys (JWKS) | public | - | | POST | `/oauth/register` | `oauth_register`: Dynamic client registration (RFC 7591) | public | - | | POST | `/oauth/revoke` | `oauth_revoke`: Revoke a token (RFC 7009) | public | - | | POST | `/oauth/token` | `oauth_token`: Token endpoint | public | - | | GET | `/v1/oauth/consent` | `oauth_consent_get`: Consent screen data | `any` | - | | POST | `/v1/oauth/consent` | `oauth_consent_decide`: Approve or deny an application | `any` | - | | GET | `/v1/whoami` | `whoami_get`: Who is calling | `any` | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # oauth-apps Source: https://docs.wapitick.com/reference/oauth-apps Register and manage the OAuth clients your organisation owns. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/oauth-apps` | `oauth_apps_list`: OAuth apps your organisation owns | `api_keys:write` | - | | POST | `/v1/oauth-apps` | `oauth_apps_create`: Register an OAuth app | `api_keys:write` | - | | DELETE | `/v1/oauth-apps/{client_id}` | `oauth_apps_delete`: Delete an OAuth app | `api_keys:write` | - | | GET | `/v1/oauth-apps/{client_id}` | `oauth_apps_get`: Get one OAuth app | `api_keys:write` | - | | PATCH | `/v1/oauth-apps/{client_id}` | `oauth_apps_update`: Update an OAuth app | `api_keys:write` | - | | POST | `/v1/oauth-apps/{client_id}/secrets` | `oauth_apps_secret_new`: Issue a new client secret | `api_keys:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # offers Source: https://docs.wapitick.com/reference/offers Broadcast offers: test to self, 60 s undo, throttled sending, reports. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/r/{code}` | `offers_tracked_link_redirect`: Tracked offer link (redirect) | public | - | | GET | `/v1/offers` | `offers_list`: List offers | `offers:read` | - | | POST | `/v1/offers` | `offers_create`: Create an offer draft | `offers:write` | - | | POST | `/v1/offers:audience-check` | `offers_audience_check`: Who can and cannot get a broadcast, before a draft exists | `offers:read` | - | | POST | `/v1/offers:suggest` | `offers_suggest`: AI: suggest audience, copy and send time from a goal | `ai:read` | - | | DELETE | `/v1/offers/{offer_id}` | `offers_delete`: Delete a draft offer | `offers:write` | - | | GET | `/v1/offers/{offer_id}` | `offers_get`: Get an offer with estimate, audience count and blocked counts | `offers:read` | - | | PATCH | `/v1/offers/{offer_id}` | `offers_update`: Edit a draft or scheduled offer | `offers:write` | - | | POST | `/v1/offers/{offer_id}/cancel` | `offers_cancel`: Cancel the remaining recipients | `offers:send` | - | | POST | `/v1/offers/{offer_id}/duplicate` | `offers_duplicate`: Duplicate an offer as a new draft | `offers:write` | - | | POST | `/v1/offers/{offer_id}/estimate` | `offers_estimate`: Cost estimate, billable count and messaging-limit check | `offers:read` | - | | POST | `/v1/offers/{offer_id}/funding-check` | `offers_funding_check`: Do you have about Rs X at Meta? (estimated balance vs cost) | `offers:read` | - | | POST | `/v1/offers/{offer_id}/pause` | `offers_pause`: Pause a sending offer | `offers:send` | - | | GET | `/v1/offers/{offer_id}/recipients` | `offers_list_recipients`: Per-recipient status | `offers:read` | - | | GET | `/v1/offers/{offer_id}/replies` | `offers_list_replies`: Replies attributed to this offer (within 7 days of sending) | `offers:read` | - | | GET | `/v1/offers/{offer_id}/report` | `offers_report`: Sent, delivered, read, replied, failed, cost estimate, replies to sales, by hour | `offers:read` | - | | POST | `/v1/offers/{offer_id}/resume` | `offers_resume`: Resume a paused offer | `offers:send` | - | | POST | `/v1/offers/{offer_id}/retry-failed` | `offers_retry_failed`: Retry eligible failures in a new child offer | `offers:send` | - | | POST | `/v1/offers/{offer_id}/schedule` | `offers_schedule`: Schedule, or send now with a 60-second undo window | `offers:send` | - | | GET | `/v1/offers/{offer_id}/status-history` | `offers_status_history`: Status transitions, including pauses with their reason | `offers:read` | - | | POST | `/v1/offers/{offer_id}/test` | `offers_test`: Send a test to yourself (up to 5 numbers) | `offers:send` | - | | POST | `/v1/offers/{offer_id}/undo` | `offers_undo`: Undo within the 60-second window, or cancel a scheduled offer before dispatch | `offers:send` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # onboarding Source: https://docs.wapitick.com/reference/onboarding Service-selection onboarding, checklist, trial and readiness. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/onboarding` | `onboarding_get`: Onboarding progress and next step | `org:read` | - | | PATCH | `/v1/onboarding` | `onboarding_update`: Save the goal and where the wizard stopped | `org:write` | - | | POST | `/v1/onboarding/business-profile` | `onboarding_business_profile`: Set the business type (and optional basics) and run the restricted-category gate | `org:write` | - | | GET | `/v1/onboarding/business-types` | `onboarding_business_types`: The business types the wizard offers, with the restricted ones marked | `org:read` | - | | DELETE | `/v1/onboarding/demo-chat` | `onboarding_demo_chat_reset`: Start the demo chat again | `org:write` | - | | GET | `/v1/onboarding/demo-chat` | `onboarding_demo_chat_get`: The labelled demo customer chat for the "Try it" step | `org:read` | - | | POST | `/v1/onboarding/demo-chat/reply` | `onboarding_demo_chat_reply`: Send the reply to the demo customer | `org:write` | - | | GET | `/v1/onboarding/features` | `onboarding_features_get`: The features this business shows in the sidebar | `org:read` | - | | PUT | `/v1/onboarding/features` | `onboarding_features_set`: Choose the features this business shows in the sidebar | `org:write` | - | | POST | `/v1/onboarding/import-website` | `onboarding_import_website`: Crawl a website into a knowledge draft | `org:write` | - | | GET | `/v1/onboarding/readiness` | `onboarding_readiness`: Setup health checklist | `org:read` | - | | GET | `/v1/onboarding/reminders` | `onboarding_reminders_list`: My onboarding reminders | `org:read` | - | | POST | `/v1/onboarding/reminders` | `onboarding_reminders_create`: Remind me to finish setup | `org:write` | - | | DELETE | `/v1/onboarding/reminders/{reminder_id}` | `onboarding_reminders_cancel`: Cancel a reminder | `org:write` | - | | POST | `/v1/onboarding/resume-link` | `onboarding_resume_link`: Send myself a link to continue setup on a computer | `org:write` | - | | POST | `/v1/onboarding/sample-data` | `onboarding_sample_data`: Seed sample contacts for a demo | `org:write` | - | | PUT | `/v1/onboarding/services` | `onboarding_set_services`: Set the selected services | `org:write` | - | | POST | `/v1/onboarding/signup-simulation` | `onboarding_simulate_signup`: Development only: simulate the Facebook sign-up window | `channels:write` | - | | GET | `/v1/onboarding/starter-pack` | `onboarding_starter_pack`: What the starter pack for a business type will load, all switched off | `org:read` | - | | POST | `/v1/onboarding/steps/{step_key}/complete` | `onboarding_complete_step`: Mark a step done or skipped | `org:write` | - | | POST | `/v1/onboarding/trial/start` | `onboarding_trial_start`: Start the 14-day Growth trial | `billing:write` | - | | GET | `/v1/onboarding/tutorials` | `onboarding_tutorials`: Tutorials per service | `org:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # orders Source: https://docs.wapitick.com/reference/orders Chat, assistant, WhatsApp-cart and store orders with totals computed server-side, COD confirmation and prepaid conversion. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/orders` | `orders_list`: Orders (manual, assistant, WhatsApp cart, Shopify, WooCommerce) | `orders:read` | - | | POST | `/v1/orders` | `orders_create`: Create a draft or confirmed order | `orders:write` | - | | GET | `/v1/orders/{order_id}` | `orders_get`: Get an order (status, items, evidence level) | `orders:read` | - | | PATCH | `/v1/orders/{order_id}` | `orders_update`: Edit a draft order | `orders:write` | - | | POST | `/v1/orders/{order_id}/cancel` | `orders_cancel`: Cancel an order | `orders:write` | - | | GET | `/v1/orders/{order_id}/cod-confirmation` | `orders_cod_get`: The COD confirmation state of an order | `orders:read` | - | | POST | `/v1/orders/{order_id}/cod-confirmation` | `orders_cod_request`: Ask the customer to confirm a COD order | `messages:send` | - | | POST | `/v1/orders/{order_id}/cod-confirmation/respond` | `orders_cod_respond`: Record the customer's answer | `orders:write` | - | | POST | `/v1/orders/{order_id}/notify` | `orders_notify`: Send an order status template to the customer | `messages:send` | - | | POST | `/v1/orders/{order_id}/payment-link` | `orders_create_payment`: Create a payment link or UPI QR for the order amount | `payments:write` | - | | POST | `/v1/orders/{order_id}/status` | `orders_update_status`: Update order status | `orders:write` | - | | GET | `/v1/orders/{order_id}/timeline` | `orders_timeline`: Status and payment evidence timeline | `orders:read` | - | | GET | `/v1/orders/cod-stats` | `orders_cod_stats`: COD confirmation and prepaid conversion rate | `orders:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # orgs Source: https://docs.wapitick.com/reference/orgs Accounts, agency client orgs and access grants. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/orgs` | `orgs_create`: Create an org (account) or, for agencies, a child client org | `any` | - | | DELETE | `/v1/orgs/{org_id}` | `orgs_close`: Close the account (30-day grace, then crypto-shred) | `org:write` | - | | GET | `/v1/orgs/{org_id}` | `orgs_get`: Get an org (the caller's own org, or one of an agency's client orgs) | `org:read` | yes | | PATCH | `/v1/orgs/{org_id}` | `orgs_update`: Update the org (name, billing identity, address, white-label branding) | `org:write` | - | | GET | `/v1/orgs/{org_id}/access-grants` | `orgs_list_access_grants`: Agency: list client-org access grants | `members:read` | - | | POST | `/v1/orgs/{org_id}/access-grants` | `orgs_create_access_grant`: Agency: grant a staff member access to a client org | `members:write` | - | | DELETE | `/v1/orgs/{org_id}/access-grants/{grant_id}` | `orgs_revoke_access_grant`: Agency: revoke a client-org access grant | `members:write` | - | | GET | `/v1/orgs/{org_id}/clients` | `orgs_list_clients`: Agency: list client orgs | `org:read` | - | | POST | `/v1/orgs/{org_id}/clients` | `orgs_create_client`: Agency: create a client org with its first workspace | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # owner-companion Source: https://docs.wapitick.com/reference/owner-companion Owner briefing and anomaly alerts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ai-anomalies` | `ai_anomalies_list`: Anomalies worth waking someone for | `ai:read` | - | | POST | `/v1/ai-anomalies/{anomaly_id}/acknowledge` | `ai_anomaly_acknowledge`: Acknowledge an anomaly | `ai:write` | - | | GET | `/v1/owner-companion` | `owner_companion_get`: Companion settings | `org:read` | - | | PUT | `/v1/owner-companion` | `owner_companion_update`: Set digest time/language, alerts, quiet hours, approvals, voice commands | `org:write` | - | | GET | `/v1/owner-companion/approvals` | `owner_companion_approvals_list`: Non-spend approvals offered on WhatsApp | `org:read` | - | | GET | `/v1/owner-companion/briefing` | `owner_companion_briefing_get`: Briefing schedule and anomaly alert settings | `org:read` | - | | PUT | `/v1/owner-companion/briefing` | `owner_companion_briefing_update`: Set when and how the briefing arrives | `org:write` | - | | POST | `/v1/owner-companion/briefing:preview` | `owner_companion_briefing_preview`: Build the briefing now without sending it | `org:read` | - | | GET | `/v1/owner-companion/briefings` | `owner_companion_briefings_list`: Briefings that were built and sent | `org:read` | - | | POST | `/v1/owner-companion/digest:send-now` | `owner_companion_digest_send_now`: Send the digest now (test) | `org:write` | - | | DELETE | `/v1/owner-companion/link` | `owner_companion_unlink`: Unlink my phone | `org:write` | - | | POST | `/v1/owner-companion/link` | `owner_companion_link_start`: Start linking (one-time code from our companion number) | `org:write` | - | | POST | `/v1/owner-companion/link/verify` | `owner_companion_link_verify`: Verify the code | `org:write` | - | | GET | `/v1/owner-companion/links` | `owner_companion_links_list`: Companion links of this workspace | `org:read` | - | | DELETE | `/v1/owner-companion/links/{link_id}` | `owner_companion_links_revoke`: Revoke a link (owner, step-up) | `org:write` | - | | GET | `/v1/owner-companion/links/{link_id}` | `owner_companion_links_get`: One companion link | `org:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # packs Source: https://docs.wapitick.com/reference/packs Vertical packs: ready messages, helpers, AI preset, pipeline and dashboard in one install. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/packs` | `packs_list`: Browse packs | `org:read` | - | | GET | `/v1/packs/{pack_id}` | `packs_get`: Pack detail | `org:read` | - | | GET | `/v1/workspaces/{workspace_id}/packs` | `packs_installed_list`: Installed packs | `org:read` | - | | POST | `/v1/workspaces/{workspace_id}/packs` | `packs_install`: Install a pack (idempotent per pack version) | `org:write` | - | | DELETE | `/v1/workspaces/{workspace_id}/packs/{pack_id}` | `packs_uninstall`: Uninstall a pack (keeps created objects) | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # partners Source: https://docs.wapitick.com/reference/partners Partner profile, referrals, commissions and payouts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/partners/apply` | `partners_apply`: Apply to the partner program | `org:write` | - | | GET | `/v1/partners/me` | `partners_me_get`: My partner profile | `org:read` | - | | PATCH | `/v1/partners/me` | `partners_me_update`: Update display name or payout details | `org:write` | - | | GET | `/v1/partners/me/commissions` | `partners_commissions_list`: Commission ledger | `org:read` | - | | GET | `/v1/partners/me/payouts` | `partners_payouts_list`: Payouts | `org:read` | - | | GET | `/v1/partners/me/payouts/{payout_id}` | `partners_payouts_get`: One payout | `org:read` | - | | POST | `/v1/partners/me/payouts/request` | `partners_payouts_request`: Request a payout | `org:write` | - | | GET | `/v1/partners/me/referrals` | `partners_referrals_list`: Referred accounts | `org:read` | - | | POST | `/v1/referrals/attribute` | `referrals_attribute`: Attribute this signup to a referral code | `any` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # payments Source: https://docs.wapitick.com/reference/payments Payment links, UPI QR, evidence (claimed vs verified), refunds, settlements. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/payment-links` | `payment_links_list`: Payment links | `catalogs:read` | - | | POST | `/v1/payment-links` | `payment_links_create`: Create a payment link through the connected Razorpay account | `payments:write` | - | | GET | `/v1/payment-links/{link_id}` | `payment_links_get`: Get a payment link (status) | `catalogs:read` | - | | POST | `/v1/payment-links/{link_id}/cancel` | `payment_links_cancel`: Cancel a payment link | `payments:write` | - | | POST | `/v1/payment-links/{link_id}/resend` | `payment_links_resend`: Resend a payment link in a conversation | `payments:write` | - | | GET | `/v1/payments` | `payments_list`: Gateway payments (links and UPI QR) | `payments:read` | - | | GET | `/v1/payments/{payment_id}` | `payments_get`: Get a gateway payment | `payments:read` | - | | POST | `/v1/payments/{payment_id}/mark-paid` | `payments_mark_paid`: Manual mark paid (claimed evidence only) | `payments:write` | - | | POST | `/v1/payments/{payment_id}/refund` | `payments_refund`: Refund through the tenant gateway | `payments:write` | - | | GET | `/v1/payments/evidence` | `payment_evidence_list`: Evidence log (claimed / verified / rejected) | `payments:read` | - | | POST | `/v1/payments/evidence` | `payment_evidence_record`: Record a CLAIMED payment (screenshot or manual mark) | `payments:write` | - | | POST | `/v1/payments/evidence/{evidence_id}/verify` | `payment_evidence_verify`: Verify claimed evidence against a gateway payment, or reject it | `payments:write` | - | | GET | `/v1/payments/settlements` | `payments_settlements`: Settlement summary per gateway day | `payments:read` | - | | POST | `/v1/payments/upi-qr` | `payments_create_upi_qr`: Create a dynamic single-use UPI QR (amount, reference, expiry) | `payments:write` | - | | GET | `/v1/payments/upi-qr/{qr_id}` | `payments_get_upi_qr`: UPI QR status | `payments:read` | - | | POST | `/v1/payments/upi-qr/{qr_id}/cancel` | `payments_cancel_upi_qr`: Close a UPI QR | `payments:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # pipeline-stages Source: https://docs.wapitick.com/reference/pipeline-stages Sales pipeline stages. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/pipeline-board` | `pipeline_board_get`: The enquiries board: every stage with its count, value and first cards | `contacts:read` | - | | GET | `/v1/pipeline-stages` | `pipeline_stages_list`: Pipeline stages of the default pipeline | `contacts:read` | - | | PUT | `/v1/pipeline-stages` | `pipeline_stages_replace`: Replace the stage list (by key: existing keys keep their contacts, removed keys clear them) | `contacts:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # plans Source: https://docs.wapitick.com/reference/plans Plans, regional prices, entitlements and add-ons. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/billing/addons` | `plans_addons_list`: Add-ons for the billing country | `billing:read` | - | | GET | `/v1/billing/entitlements` | `plans_entitlements_list`: Resolved entitlements with usage | `billing:read` | - | | GET | `/v1/billing/plans` | `plans_list`: Plans and regional prices for the billing country | `billing:read` | - | | GET | `/v1/entitlements/{key}/check` | `plans_entitlement_check`: Is this feature allowed now? | `org:read` | - | | GET | `/v1/public/plans` | `plans_list_public`: Public plans and prices (no auth) | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # post-targets Source: https://docs.wapitick.com/reference/post-targets Per-channel status of a post, retry and cancel. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/posts/{post_id}/targets` | `post_targets_list`: Per-target status of a post | `posts:read` | - | | POST | `/v1/posts/{post_id}/targets/{target_id}/cancel` | `post_targets_cancel`: Cancel one target | `posts:write` | - | | POST | `/v1/posts/{post_id}/targets/{target_id}/retry` | `post_targets_retry`: Retry a failed or blocked target | `posts:publish` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # posts Source: https://docs.wapitick.com/reference/posts Compose, schedule and publish posts to Instagram, Facebook Pages and Threads. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/content-calendar` | `posts_calendar`: Calendar feed: posts, offers and ad schedule | `posts:read` | - | | GET | `/v1/post-queue-slots` | `posts_queue_slots`: Best-time queue slots per channel | `posts:read` | - | | GET | `/v1/posts` | `posts_list`: List posts (calendar window, status, channel) | `posts:read` | - | | POST | `/v1/posts` | `posts_create`: Create a draft or scheduled post with per-channel targets | `posts:write` | - | | POST | `/v1/posts:generate` | `posts_generate`: AI captions and hashtags (S3 `POST /posts:generate`) | `ai:read` | - | | POST | `/v1/posts:validate` | `posts_validate`: Validate a post against per-channel specs and live quota (S3 `POST /posts:validate`) | `posts:read` | - | | DELETE | `/v1/posts/{post_id}` | `posts_delete`: Delete a post (published: also on the platform where the API allows) | `posts:write` | - | | GET | `/v1/posts/{post_id}` | `posts_get`: Get a post with per-target status | `posts:read` | - | | PATCH | `/v1/posts/{post_id}` | `posts_update`: Edit a draft or scheduled post | `posts:write` | - | | GET | `/v1/posts/{post_id}/insights` | `posts_insights`: Insights per target (metric abstraction) | `analytics:read` | - | | POST | `/v1/posts/{post_id}/publish` | `posts_publish`: Publish now | `posts:publish` | - | | POST | `/v1/posts/{post_id}/schedule` | `posts_schedule`: Schedule or reschedule a post | `posts:publish` | - | | POST | `/v1/posts/{post_id}/unschedule` | `posts_unschedule`: Back to draft | `posts:write` | - | | GET | `/v1/posts/limits` | `posts_limits`: Remaining publish quota per channel and plan | `posts:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # privacy Source: https://docs.wapitick.com/reference/privacy Opt-out keywords, data requests (DSR) and the public privacy page. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/data-requests` | `data_requests_list`: Data-request queue (SLA clock, due date) | `contacts:delete` | - | | POST | `/v1/data-requests` | `data_requests_create`: Create a request on behalf of a customer | `contacts:delete` | - | | GET | `/v1/data-requests/{dsr_id}` | `data_requests_get`: Get a data request (with the export download link once fulfilled) | `contacts:delete` | - | | POST | `/v1/data-requests/{dsr_id}/fulfil` | `data_requests_fulfil`: Fulfil: export the data bundle, erase, correct, opt out or withdraw consent | `contacts:delete` | - | | POST | `/v1/data-requests/{dsr_id}/reject` | `data_requests_reject`: Reject with a reason (identity unverified, legal hold) | `contacts:delete` | - | | GET | `/v1/privacy/masking-policy` | `pii_masking_policy_get`: Who can see customer phone numbers and emails | `org:read` | - | | PUT | `/v1/privacy/masking-policy` | `pii_masking_policy_put`: Hide customer contact details from staff | `org:write` | - | | POST | `/v1/privacy/reveal` | `pii_reveal`: Reveal one customer's contact details, with a reason | `contacts:read` | - | | GET | `/v1/privacy/reveals` | `pii_reveals_list`: Who revealed which customer's details | `audit:read` | - | | GET | `/v1/workspaces/{workspace_id}/privacy-settings` | `privacy_settings_get`: Opt-out keywords, confirmation text, data-request page, grievance contact | `org:read` | - | | PUT | `/v1/workspaces/{workspace_id}/privacy-settings` | `privacy_settings_put`: Update privacy settings | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # products Source: https://docs.wapitick.com/reference/products Catalog products: price, stock, bulk upsert and product messages. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/conversations/{conversation_id}/messages/product` | `conversations_send_product_message`: Send a single or multi product message (inside the window) | `messages:send` | - | | GET | `/v1/products` | `products_list`: Products | `catalogs:read` | - | | POST | `/v1/products` | `products_create`: Create a product | `catalogs:write` | - | | DELETE | `/v1/products/{product_id}` | `products_delete`: Delete a product | `catalogs:write` | - | | GET | `/v1/products/{product_id}` | `products_get`: Get a product | `catalogs:read` | - | | PATCH | `/v1/products/{product_id}` | `products_update`: Update a product (price and stock fast path) | `catalogs:write` | - | | POST | `/v1/products/bulk` | `products_bulk`: Bulk upsert (up to 1,000) or CSV by media_id | `catalogs:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # public Source: https://docs.wapitick.com/reference/public Endpoints the website visitor's browser calls directly. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/public/booking-pages/{slug}` | `public_booking_page_get`: Public booking page: services and open slots | public | - | | POST | `/v1/public/booking-pages/{slug}/book` | `public_booking_page_book`: Book a slot from the public page | public | - | | GET | `/v1/public/data-request/{workspace_slug}` | `public_data_request_page`: Public data-request page configuration | public | - | | POST | `/v1/public/data-request/{workspace_slug}` | `public_data_request_submit`: Submit a data request (OTP is sent to that WhatsApp number) | public | - | | GET | `/v1/public/data-request/status/{request_ref}` | `public_data_request_status`: Status for the requester | public | - | | POST | `/v1/public/data-request/verify` | `public_data_request_verify`: Verify the WhatsApp code | public | - | | GET | `/v1/public/developer-links/{token}` | `public_developer_link_get`: The install page behind a 'send to my developer' link | public | - | | POST | `/v1/public/forms/{form_id}/submit` | `public_forms_submit`: Submit a public opt-in / lead form | public | - | | GET | `/v1/public/pages/{slug}` | `public_page_view`: The public page | public | - | | POST | `/v1/public/pages/{slug}/book` | `public_page_book`: Book a slot from the public mini page | public | - | | GET | `/v1/public/pages/{slug}/booking` | `public_page_booking`: Public booking page: services and open slots | public | - | | GET | `/v1/public/pages/{slug}/catalogue` | `public_page_catalogue`: Public catalogue page | public | - | | POST | `/v1/public/pages/{slug}/feedback` | `public_page_feedback_submit`: Leave feedback on a public page | public | - | | GET | `/v1/public/pages/{slug}/opengraph` | `public_page_opengraph`: OpenGraph metadata for the page | public | - | | GET | `/v1/public/pages/{slug}/reviews` | `public_page_reviews`: Public review / feedback page | public | - | | POST | `/v1/public/site/{site_key}/beacon` | `public_site_beacon`: Install beacon from the loader | public | - | | GET | `/v1/public/site/{site_key}/config` | `public_site_config`: The website's embed settings (for custom front ends) | public | - | | POST | `/v1/public/site/{site_key}/forms/{form_id}/submit` | `public_site_form_submit`: Submit an opt-in box or lead form from a website | public | - | | GET | `/v1/public/site/{site_key}/loader.js` | `public_site_loader`: The website loader script | public | - | | GET | `/v1/public/site/{site_key}/qr.svg` | `public_site_qr`: QR code for the WhatsApp button's desktop pop-up | public | - | | GET | `/v1/public/widget/{public_key}` | `public_widget_bootstrap`: Widget appearance and options | public | - | | GET | `/v1/public/widget/{public_key}.js` | `public_widget_script`: The embeddable chat snippet | public | - | | POST | `/v1/public/widget/{public_key}/handoff` | `public_widget_handoff`: Continue this chat on WhatsApp | public | - | | GET | `/v1/public/widget/{public_key}/messages` | `public_widget_messages_poll`: New messages on this chat | public | - | | POST | `/v1/public/widget/{public_key}/messages` | `public_widget_message_send`: Send a message from the website | public | - | | POST | `/v1/public/widget/{public_key}/sessions` | `public_widget_session_start`: Start or resume a chat session | public | - | | GET | `/v1/public/widget/{public_key}/stream` | `public_widget_messages_stream`: New messages on this chat, streamed (Server-Sent Events) | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # public-pages Source: https://docs.wapitick.com/reference/public-pages Your public booking, catalogue and review pages. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/public-page` | `public_page_get`: Your public page settings | `org:read` | - | | PUT | `/v1/public-page` | `public_page_upsert`: Create or update your public page | `org:write` | - | | GET | `/v1/public-page/counter-kit.pdf` | `public_page_counter_kit`: Printable counter card (PDF) with the QR code of your public page | `org:read` | - | | GET | `/v1/public-page/feedback` | `public_page_feedback_list`: Feedback left on your public page | `org:read` | - | | GET | `/v1/public-page/qr.svg` | `public_page_qr`: QR code (SVG) that opens your public page | `org:read` | - | | PATCH | `/v1/public-page/sections/{section}` | `public_page_section_update`: Switch one section of your public page on or off | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # quick-replies Source: https://docs.wapitick.com/reference/quick-replies Saved replies with shortcuts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/quick-replies` | `quick_replies_list`: Quick replies | `conversations:read` | - | | POST | `/v1/quick-replies` | `quick_replies_create`: Create a quick reply | `conversations:write` | - | | DELETE | `/v1/quick-replies/{reply_id}` | `quick_replies_delete`: Delete a quick reply | `conversations:write` | - | | GET | `/v1/quick-replies/{reply_id}` | `quick_replies_get`: Get a quick reply | `conversations:read` | - | | PATCH | `/v1/quick-replies/{reply_id}` | `quick_replies_update`: Update a quick reply | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # recovery Source: https://docs.wapitick.com/reference/recovery Lost SIM / phone change recovery with a cooling-off period. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/auth/recovery/{recovery_id}` | `recovery_get`: Recovery status (recovery token or session) | public | - | | POST | `/v1/auth/recovery/{recovery_id}/cancel` | `recovery_cancel`: Cancel a recovery | public | - | | POST | `/v1/auth/recovery/{recovery_id}/complete` | `recovery_complete`: Bind the new phone after the hold | public | - | | POST | `/v1/auth/recovery/{recovery_id}/verify` | `recovery_verify`: Provide recovery proof | public | - | | POST | `/v1/auth/recovery/start` | `recovery_start`: Start account recovery (lost SIM / phone change) | public | - | | POST | `/v1/channels/{channel_id}/recovery/lost-sim` | `channels_recovery_lost_sim`: Lost SIM: block sends and guide re-verification | `channels:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # review-requests Source: https://docs.wapitick.com/reference/review-requests Ask customers for a Google review, the compliant way. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/integrations/google/reviews` | `integrations_google_reviews_list`: Read Google reviews (display and reply only) | `integrations:read` | - | | POST | `/v1/integrations/google/reviews/{review_id}/reply` | `integrations_google_reviews_reply`: Reply publicly (AI drafts, a human taps send) | `integrations:write` | - | | GET | `/v1/review-requests` | `review_requests_list`: Sent requests and their outcome (no per-star data about individuals) | `org:read` | - | | POST | `/v1/review-requests` | `review_requests_create`: Send one review request to a contact | `messages:send` | - | | GET | `/v1/review-requests/settings` | `review_requests_get_settings`: Review request settings | `org:read` | - | | PUT | `/v1/review-requests/settings` | `review_requests_put_settings`: Save review request settings | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # search Source: https://docs.wapitick.com/reference/search Search contacts, conversations, messages, templates, helpers, posts, offers and products. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/search` | `search_global`: Global search across the Business | `search:read` | - | | GET | `/v1/search/suggest` | `search_suggest`: Typeahead: contacts, tags and labels | `search:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # segments Source: https://docs.wapitick.com/reference/segments Dynamic (rule) and static (list) segments. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/segments` | `segments_list`: List segments | `contacts:read` | - | | POST | `/v1/segments` | `segments_create`: Create a dynamic (rule) or static (list) segment | `contacts:write` | - | | POST | `/v1/segments:preview` | `segments_preview`: Preview rule count, a sample and the estimated Meta cost | `contacts:read` | - | | DELETE | `/v1/segments/{segment_id}` | `segments_delete`: Delete a segment (contacts are not touched) | `contacts:write` | - | | GET | `/v1/segments/{segment_id}` | `segments_get`: Get a segment with its current member count | `contacts:read` | - | | PATCH | `/v1/segments/{segment_id}` | `segments_update`: Rename a segment or replace its rules | `contacts:write` | - | | GET | `/v1/segments/{segment_id}/contacts` | `segments_list_contacts`: Contacts in a segment | `contacts:read` | - | | POST | `/v1/segments/{segment_id}/members` | `segments_add_members`: Add contacts to a static segment | `contacts:write` | - | | DELETE | `/v1/segments/{segment_id}/members/{contact_id}` | `segments_remove_member`: Remove a contact from a static segment | `contacts:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # shopify-app Source: https://docs.wapitick.com/reference/shopify-app Shopify App Store install, webhooks and billing. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/shopify/billing/callback` | `shopify_app_billing_callback`: Return URL after the merchant approves a Shopify charge | public | - | | GET | `/shopify/callback` | `shopify_app_install_callback`: Shopify OAuth callback | public | - | | GET | `/shopify/install` | `shopify_app_install_start`: Start the Shopify app install (any store) | public | - | | POST | `/shopify/webhooks/compliance` | `shopify_app_compliance_webhook`: Shopify mandatory privacy webhooks | public | - | | POST | `/v1/shopify/billing/subscriptions` | `shopify_app_billing_create`: Charge this store through Shopify Billing | `billing:write` | - | | POST | `/v1/shopify/claim` | `shopify_app_claim`: Attach a store that installed the app to this Business | `integrations:write` | - | | GET | `/v1/shopify/installs` | `shopify_app_installs_list`: Stores that installed the app into this Business | `integrations:read` | - | | GET | `/v1/shopify/readiness` | `shopify_app_readiness`: What the App Store listing still needs | `integrations:read` | - | | POST | `/v1/shopify/session-token` | `shopify_app_session_token`: Verify an App Bridge session token | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # sla Source: https://docs.wapitick.com/reference/sla Reply-time commitments, the breach queue and response-time reports. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/sla/conversations/{conversation_id}/recompute` | `sla_recompute`: Recompute the clocks of one conversation | `conversations:write` | - | | GET | `/v1/sla/queue` | `sla_queue_list`: Breach queue | `conversations:read` | - | | GET | `/v1/sla/report` | `sla_report`: Reply and resolution times, with percentiles | `analytics:read` | - | | GET | `/v1/sla/targets` | `sla_targets_list`: Reply-time commitments | `conversations:read` | - | | POST | `/v1/sla/targets` | `sla_targets_create`: Create a reply-time commitment | `conversations:write` | - | | DELETE | `/v1/sla/targets/{target_id}` | `sla_targets_delete`: Delete a reply-time commitment | `conversations:write` | - | | GET | `/v1/sla/targets/{target_id}` | `sla_targets_get`: Get a reply-time commitment | `conversations:read` | - | | PATCH | `/v1/sla/targets/{target_id}` | `sla_targets_update`: Update a reply-time commitment | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # sla-policies Source: https://docs.wapitick.com/reference/sla-policies First-response and resolution targets. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/sla-policies` | `sla_policies_list`: SLA policies | `conversations:read` | - | | PUT | `/v1/sla-policies` | `sla_policies_put`: Replace SLA policies | `conversations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # slack Source: https://docs.wapitick.com/reference/slack Slack interactivity and slash commands. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/integrations/slack/commands` | `slack_commands`: Slack slash commands (/inbox, /contact, /lead) | public | - | | POST | `/integrations/slack/interactivity` | `slack_interactivity`: Slack interactivity (buttons, modals) | public | - | | GET | `/v1/integrations/slack/channels` | `slack_channels_list`: Slack channel picker | `integrations:read` | - | | GET | `/v1/integrations/slack/rules` | `slack_rules_get`: Notification routing rules | `integrations:read` | - | | PUT | `/v1/integrations/slack/rules` | `slack_rules_put`: Set notification rules | `integrations:write` | - | | POST | `/v1/integrations/slack/user-links` | `slack_user_links_create`: Link a Slack user to a member | `integrations:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # social-channels Source: https://docs.wapitick.com/reference/social-channels Instagram, Facebook Page and Threads channels. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | DELETE | `/v1/channels/{channel_id}/social` | `social_channels_disconnect`: Disconnect a social channel (history is kept) | `channels:write` | - | | GET | `/v1/channels/{channel_id}/social/capabilities` | `social_channels_capabilities`: What this social channel can do (Threads = no DMs) | `channels:read` | - | | GET | `/v1/channels/{channel_id}/social/health` | `social_channels_health`: Live health of a social channel | `channels:read` | - | | POST | `/v1/channels/{channel_id}/social/health/refresh` | `social_channels_health_refresh`: Force a health re-check against Meta | `channels:write` | - | | GET | `/v1/channels/{channel_id}/social/ice-breakers` | `social_channels_get_ice_breakers`: Ice breakers (Instagram / Messenger) | `channels:read` | - | | PUT | `/v1/channels/{channel_id}/social/ice-breakers` | `social_channels_set_ice_breakers`: Replace ice breakers (Instagram max 4 per locale) | `channels:write` | - | | POST | `/v1/channels/{channel_id}/social/reconnect` | `social_channels_reconnect`: Re-authorise an expired or revoked social channel | `channels:write` | - | | POST | `/v1/channels/{channel_id}/social/refresh-token` | `social_channels_refresh_token`: Refresh the long-lived token now | `channels:write` | - | | POST | `/v1/channels/social/connect-sessions` | `social_channels_create_connect_session`: Start connecting Instagram, a Facebook Page or Threads | `channels:write` | - | | GET | `/v1/channels/social/connect-sessions/{session_id}` | `social_channels_get_connect_session`: Poll connect progress | `channels:write` | - | | POST | `/v1/channels/social/connect-sessions/{session_id}/callback` | `social_channels_connect_callback`: Finish the Meta login: exchange the code, check permissions, list accounts | `channels:write` | - | | POST | `/v1/channels/social/connect-sessions/{session_id}/select-asset` | `social_channels_select_asset`: Choose the Page / Instagram account / Threads profile to connect | `channels:write` | - | | POST | `/v1/meta/deauthorize` | `meta_deauthorize_callback`: Meta deauthorize callback (Facebook / Instagram access removed) | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # staff-sessions Source: https://docs.wapitick.com/reference/staff-sessions Wapitick support access to your account: see, approve, end. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/staff-sessions` | `staff_sessions_list`: Wapitick support sessions on this organisation | `org:read` | - | | GET | `/v1/staff-sessions/{session_id}` | `staff_sessions_get`: One support session with its full request log | `org:read` | - | | POST | `/v1/staff-sessions/{session_id}/approve` | `staff_sessions_approve`: Approve an act-as request | `org:write` | - | | POST | `/v1/staff-sessions/{session_id}/content-access` | `staff_sessions_content_access`: Show message content to support (15 min) | `org:write` | - | | POST | `/v1/staff-sessions/{session_id}/deny` | `staff_sessions_deny`: Deny an act-as request | `org:write` | - | | POST | `/v1/staff-sessions/{session_id}/end` | `staff_sessions_end`: End a support session now | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # status Source: https://docs.wapitick.com/reference/status Public system status, incidents, banner and per-organisation health. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/status` | `status_get`: Overall status and components | public | - | | GET | `/v1/status/banner` | `status_banner`: In-app banner: worst active component and incident | public | - | | GET | `/v1/status/incidents` | `status_incidents`: Active and recent incidents | public | - | | GET | `/v1/status/me` | `status_me`: Health of my organisation | `org:read` | - | | GET | `/v1/status/meta` | `status_meta`: Meta-side health relay | public | - | | POST | `/v1/status/subscribe` | `status_subscribe`: Subscribe to incident notifications | public | - | | POST | `/wh/betterstack` | `status_betterstack_webhook`: Better Stack incident/component webhook (internal) | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # subscriptions Source: https://docs.wapitick.com/reference/subscriptions Current subscription, plan changes with proration, cancel/resume, add-ons, coupons. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/billing/addons` | `subscriptions_addon_purchase`: Purchase an add-on | `billing:write` | - | | POST | `/v1/billing/coupons/redeem` | `subscriptions_coupon_redeem`: Redeem a coupon or partner referral code | `billing:write` | - | | GET | `/v1/billing/subscription` | `subscriptions_get`: Current subscription | `billing:read` | - | | POST | `/v1/billing/subscription/cancel` | `subscriptions_cancel`: Cancel at period end | `billing:write` | - | | POST | `/v1/billing/subscription/change` | `subscriptions_change`: Upgrade, downgrade or switch interval | `billing:write` | - | | POST | `/v1/billing/subscription/preview` | `subscriptions_preview`: Price, proration and tax preview for a plan change | `billing:read` | - | | POST | `/v1/billing/subscription/resume` | `subscriptions_resume`: Undo a scheduled cancel | `billing:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # support Source: https://docs.wapitick.com/reference/support Talk to a person, assisted setup, callbacks and the reply thread. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/support-requests` | `support_requests_list`: My support requests (admins see the whole organisation) | `org:read` | - | | POST | `/v1/support-requests` | `support_requests_create`: Ask for help (talk to a person, assisted setup, callback) | `org:read` | - | | GET | `/v1/support-requests/{spr_id}` | `support_requests_get`: Support request detail | `org:read` | - | | POST | `/v1/support-requests/{spr_id}/cancel` | `support_requests_cancel`: Cancel a support request | `org:read` | - | | GET | `/v1/support-requests/{spr_id}/messages` | `support_requests_messages_list`: Reply thread (staff and customer) | `org:read` | - | | POST | `/v1/support-requests/{spr_id}/messages` | `support_requests_messages_create`: Reply in the thread | `org:read` | - | | GET | `/v1/support/availability` | `support_availability_get`: Support languages, hours and next free slots | `org:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # suppressions Source: https://docs.wapitick.com/reference/suppressions Opt-out / suppression list. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/suppressions` | `suppressions_list`: Opt-out / suppression list | `contacts:read` | - | | POST | `/v1/suppressions` | `suppressions_create`: Suppress an identity (STOP, manual, bounce) | `contacts:write` | - | | DELETE | `/v1/suppressions/{id}` | `suppressions_delete`: Lift a suppression (needs fresh consent proof) | `contacts:write` | - | | GET | `/v1/suppressions/{id}` | `suppressions_get`: One suppression | `contacts:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # switching Source: https://docs.wapitick.com/reference/switching Move in from another WhatsApp provider: import your data, then move the number. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/switching/imports` | `switching_imports_list`: List imports from another provider | `contacts:read` | - | | POST | `/v1/switching/imports` | `switching_imports_create`: Upload an export from another WhatsApp provider | `contacts:write` | - | | GET | `/v1/switching/imports/{import_id}` | `switching_imports_get`: One import, with its mapping preview and report | `contacts:read` | - | | PATCH | `/v1/switching/imports/{import_id}` | `switching_imports_update_mapping`: Correct the column mapping | `contacts:write` | - | | GET | `/v1/switching/imports/{import_id}/items` | `switching_import_items_list`: What the import did, item by item | `contacts:read` | - | | POST | `/v1/switching/imports/{import_id}/run` | `switching_imports_run`: Run the import (dry run by default) | `contacts:write` | - | | GET | `/v1/switching/migrations` | `switching_migrations_list`: List migration plans | `channels:read` | - | | POST | `/v1/switching/migrations` | `switching_migrations_create`: Start a guided provider migration | `channels:write` | - | | GET | `/v1/switching/migrations/{migration_id}` | `switching_migrations_get`: The checklist, with live progress | `channels:read` | - | | PATCH | `/v1/switching/migrations/{migration_id}/steps/{step_key}` | `switching_migration_steps_update`: Move one checklist step | `channels:write` | - | | POST | `/v1/switching/preflight` | `switching_preflight`: Check what a provider move would mean for this Business | `channels:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # system Source: https://docs.wapitick.com/reference/system Liveness, readiness and version. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/healthz` | `system_healthz`: Liveness probe | public | - | | GET | `/readyz` | `system_readyz`: Readiness probe (database reachable) | public | - | | GET | `/v1/health` | `system_health`: Liveness and version | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # tags Source: https://docs.wapitick.com/reference/tags Contact tags. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/tags` | `tags_list`: List contact tags | `contacts:read` | yes | | POST | `/v1/tags` | `tags_create`: Create a tag | `contacts:write` | yes | | DELETE | `/v1/tags/{tag_id}` | `tags_delete`: Delete a tag (removes it from every contact) | `contacts:write` | yes | | GET | `/v1/tags/{tag_id}` | `tags_get`: Get a tag | `contacts:read` | yes | | PATCH | `/v1/tags/{tag_id}` | `tags_update`: Rename or recolour a tag | `contacts:write` | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # tasks Source: https://docs.wapitick.com/reference/tasks Staff follow-ups and 'My day' (open, overdue, snoozed, done, cancelled). | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/contacts/{contact_id}/activities` | `contacts_log_activity`: Log a manual activity (call, visit, note) | `contacts:write` | - | | GET | `/v1/tasks` | `tasks_list`: List tasks | `tasks:read` | - | | POST | `/v1/tasks` | `tasks_create`: Create a follow-up | `tasks:write` | - | | DELETE | `/v1/tasks/{task_id}` | `tasks_delete`: Delete a task | `tasks:write` | - | | GET | `/v1/tasks/{task_id}` | `tasks_get`: Get a task | `tasks:read` | - | | PATCH | `/v1/tasks/{task_id}` | `tasks_update`: Edit a task | `tasks:write` | - | | POST | `/v1/tasks/{task_id}/complete` | `tasks_complete`: Complete a task (outcome is logged as an activity) | `tasks:write` | - | | POST | `/v1/tasks/{task_id}/snooze` | `tasks_snooze`: Snooze to a new due time (max 30 days) | `tasks:write` | - | | GET | `/v1/tasks/my-day` | `tasks_my_day`: Today, overdue and upcoming bookings in one list | `tasks:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # teams Source: https://docs.wapitick.com/reference/teams Routing teams. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/teams` | `teams_list`: Teams (routing groups) | `members:read` | - | | POST | `/v1/teams` | `teams_create`: Create a team | `members:write` | - | | DELETE | `/v1/teams/{team_id}` | `teams_delete`: Delete a team | `members:write` | - | | GET | `/v1/teams/{team_id}` | `teams_get`: Get a team | `members:read` | - | | PATCH | `/v1/teams/{team_id}` | `teams_update`: Update a team | `members:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # templates Source: https://docs.wapitick.com/reference/templates Message templates: draft, lint, pre-submission check, submit, sync. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/template-library` | `template_library_list`: Curated template gallery | `templates:read` | - | | GET | `/v1/template-trade-rules` | `templates_trade_rules_list`: The trade rules that apply to your templates | `templates:read` | - | | GET | `/v1/templates` | `templates_list`: List templates | `templates:read` | yes | | POST | `/v1/templates` | `templates_create`: Create a template draft (and submit) | `templates:write` | - | | POST | `/v1/templates:generate` | `templates_generate`: AI-draft a template from a description | `ai:read` | - | | POST | `/v1/templates:lint` | `templates_lint`: Lint a draft | `templates:read` | - | | POST | `/v1/templates:precheck` | `templates_precheck`: Will WhatsApp refuse this template? | `templates:read` | - | | POST | `/v1/templates:preview` | `templates_preview`: Render a preview | `templates:read` | - | | DELETE | `/v1/templates/{template_id}` | `templates_delete`: Delete a template | `templates:write` | - | | GET | `/v1/templates/{template_id}` | `templates_get`: Get a template | `templates:read` | yes | | PATCH | `/v1/templates/{template_id}` | `templates_update`: Edit a template | `templates:write` | - | | GET | `/v1/templates/{template_id}/analytics` | `templates_analytics`: Template analytics (sent, delivered, read, clicked) | `analytics:read` | - | | POST | `/v1/templates/{template_id}/clone` | `templates_clone`: Clone to another channel / WABA | `templates:write` | - | | POST | `/v1/templates/{template_id}/submit` | `templates_submit`: Submit to Meta for review | `templates:write` | - | | POST | `/v1/templates/sync` | `templates_sync`: Pull templates and statuses from Meta | `templates:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # test-mode Source: https://docs.wapitick.com/reference/test-mode Test mode: magic numbers, simulated inbound messages and test recipients. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/test/inbound` | `test_inbound_create`: Simulate an inbound WhatsApp message (test mode) | `messages:send` | yes | | GET | `/v1/test/join-qr.svg` | `test_join_qr`: QR code that opens WhatsApp to the shared test number with the START text filled in | `api_keys:write` | - | | GET | `/v1/test/magic-numbers` | `test_magic_numbers_list`: Magic numbers for simulated outcomes in test mode | `any` | yes | | GET | `/v1/test/recipients` | `test_recipients_list`: List test recipients | `messages:read` | yes | | POST | `/v1/test/recipients` | `test_recipients_create`: Add a test recipient (your own phone) | `messages:send` | yes | | DELETE | `/v1/test/recipients/{recipient_id}` | `test_recipients_delete`: Remove a test recipient | `messages:send` | yes | | POST | `/v1/test/recipients/{recipient_id}/verify` | `test_recipients_verify`: Verify a test recipient with the code the test number sent | `messages:send` | yes | | GET | `/v1/test/workspace` | `test_workspace_get`: The organisation's test workspace (created on first use) | `api_keys:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # trust Source: https://docs.wapitick.com/reference/trust Your account's trust level, sending limits, policy notices and appeals. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/trust` | `trust_get`: Trust level, offer sending limits and policy notices | `org:read` | - | | POST | `/v1/trust/notices/{strike_id}/appeal` | `trust_notices_appeal`: Appeal a policy notice | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # usage Source: https://docs.wapitick.com/reference/usage Usage summaries and raw usage events. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/billing/usage` | `usage_summary`: Usage summary | `billing:read` | - | | GET | `/v1/billing/usage/events` | `usage_events_list`: Raw usage events | `billing:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # verification Source: https://docs.wapitick.com/reference/verification Business verification, outbound link scanning and the domain allowlist (anti-scam). | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/business-verification` | `business_verification_get`: Business verification state for this Business | `org:read` | - | | POST | `/v1/business-verification` | `business_verification_submit`: Submit GSTIN, Udyam or PAN for verification | `org:write` | - | | GET | `/v1/business-verification/{ver_id}` | `business_verification_get_by_id`: Verification detail | `org:read` | - | | GET | `/v1/domain-allowlist` | `domain_allowlist_get`: The Business's own domains (skip link warnings) | `org:read` | - | | PUT | `/v1/domain-allowlist` | `domain_allowlist_put`: Replace the domain allowlist | `org:write` | - | | POST | `/v1/link-scans` | `link_scans_create`: Scan URLs before they are sent or published | `offers:read` | - | | GET | `/v1/link-scans/{scan_id}` | `link_scans_get`: Link scan result | `offers:read` | - | | POST | `/v1/link-scans/{scan_id}/appeal` | `link_scans_appeal`: Appeal a blocked link (trust and safety queue) | `offers:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # voice Source: https://docs.wapitick.com/reference/voice Call answering: voices, previews and draft settings. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/ai-assistants/{assistant_id}/calls` | `ai_assistant_calls_get`: Whether the AI Assistant answers calls, line by line | `calls:read` | - | | PUT | `/v1/ai-assistants/{assistant_id}/calls` | `ai_assistant_calls_set`: Turn the AI Assistant on or off for calls | `calls:write` | - | | POST | `/v1/voice/agents/{assistant_id}/test-call` | `voice_agent_test_call`: Create a test room, dispatch the voice agent and return a join token | `calls:write` | - | | GET | `/v1/voice/agents/{assistant_id}/test-call/phone` | `voice_agent_phone_test_call_preview`: Which number a ring-my-phone test call would ring, and whether it can ring now | `calls:write` | - | | POST | `/v1/voice/agents/{assistant_id}/test-call/phone` | `voice_agent_phone_test_call`: Ring my phone: an outbound test call from the assistant to your own verified mobile | `calls:write` | - | | GET | `/v1/voice/analytics` | `voice_analytics`: Calls, answer rate, duration, outcomes, minutes used | `analytics:read` | - | | GET | `/v1/voice/call-balance` | `voice_call_balance`: Call Balance | `billing:read` | - | | POST | `/v1/voice/livekit/token` | `voice_livekit_token`: Mint a LiveKit access token (<= 10 min) | `calls:write` | - | | GET | `/v1/voice/numbers` | `voice_numbers_list`: Phone lines | `calls:read` | - | | POST | `/v1/voice/numbers` | `voice_numbers_provision`: Provision or port a number | `calls:write` | - | | DELETE | `/v1/voice/numbers/{number_id}` | `voice_numbers_release`: Release a number | `calls:write` | - | | GET | `/v1/voice/numbers/{number_id}` | `voice_numbers_get`: Get one phone line | `calls:read` | - | | PATCH | `/v1/voice/numbers/{number_id}` | `voice_numbers_update`: Configure a number | `calls:write` | - | | DELETE | `/v1/voice/numbers/{number_id}/draft` | `voice_numbers_draft_discard`: Discard the draft call-answering settings | `calls:write` | - | | PUT | `/v1/voice/numbers/{number_id}/draft` | `voice_numbers_draft_put`: Save call-answering changes without making them live | `calls:write` | - | | POST | `/v1/voice/numbers/{number_id}/draft/publish` | `voice_numbers_draft_publish`: Make the draft call-answering settings live | `calls:write` | - | | GET | `/v1/voice/numbers/available` | `voice_numbers_available`: Search number inventory | `calls:read` | - | | GET | `/v1/voice/packs` | `voice_packs_list`: Minute packs (100 / 500 / 2,000 minutes; never expire) | `billing:read` | - | | GET | `/v1/voice/rooms` | `voice_rooms_list`: Live rooms for this org | `calls:read` | - | | GET | `/v1/voice/rooms/{room_id}` | `voice_rooms_get`: One room | `calls:read` | - | | POST | `/v1/voice/rooms/{room_id}/end` | `voice_rooms_end`: Force-end a room (also ends billing) | `calls:write` | - | | GET | `/v1/voice/sip/trunks` | `voice_sip_trunks_list`: SIP trunks and dispatch rules for this org (read-only mirror) | `calls:read` | - | | POST | `/v1/voice/sip/trunks` | `voice_sip_trunks_create`: Create a trunk and dispatch rule for a number | `calls:write` | - | | DELETE | `/v1/voice/sip/trunks/{trunk_id}` | `voice_sip_trunks_delete`: Remove a trunk | `calls:write` | - | | GET | `/v1/voice/sip/trunks/{trunk_id}` | `voice_sip_trunks_get`: One SIP trunk (read-only mirror) | `calls:read` | - | | GET | `/v1/voice/voices` | `voice_voices_list`: Voices a phone line can speak with | `calls:read` | - | | POST | `/v1/voice/voices/{voice_id}/preview` | `voice_voices_preview`: Hear a voice say a line | `calls:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # wa-accounts Source: https://docs.wapitick.com/reference/wa-accounts WhatsApp accounts: billing route, estimated Meta balance, payment health. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/wa-accounts` | `wa_accounts_list`: List WhatsApp accounts | `channels:read` | - | | GET | `/v1/wa-accounts/{wa_account_id}` | `wa_accounts_get`: Get a WhatsApp account | `channels:read` | - | | PUT | `/v1/wa-accounts/{wa_account_id}/billing-route` | `wa_accounts_billing_route_put`: Choose how WhatsApp fees are paid | `channels:write` | - | | PUT | `/v1/wa-accounts/{wa_account_id}/meta-balance-estimate` | `wa_accounts_meta_balance_estimate_put`: Enter your estimated Meta balance | `channels:write` | - | | GET | `/v1/wa-accounts/{wa_account_id}/meta-payment-health` | `wa_accounts_meta_payment_health_get`: Meta payment health (banner source) | `channels:read` | - | | POST | `/v1/wa-accounts/{wa_account_id}/meta-payment/acknowledge-topup` | `wa_accounts_acknowledge_topup`: I topped up at Meta | `channels:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # wallets Source: https://docs.wapitick.com/reference/wallets Prepaid wallets, ledger, top-ups, auto top-up and low-balance alerts. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/billing/wallets` | `wallets_list`: Wallets: AI credits and Call Balance | `billing:read` | - | | GET | `/v1/billing/wallets/{wallet_id}` | `wallets_get`: One wallet | `billing:read` | - | | PUT | `/v1/billing/wallets/{wallet_id}/alerts` | `wallets_alerts_set`: Low-balance thresholds | `billing:write` | - | | PUT | `/v1/billing/wallets/{wallet_id}/auto-topup` | `wallets_auto_topup_set`: Auto top-up rule and monthly cap | `billing:write` | - | | POST | `/v1/billing/wallets/{wallet_id}/topup` | `wallets_topup`: Top up a wallet (AI credits or Call Balance) | `billing:write` | - | | GET | `/v1/billing/wallets/{wallet_id}/transactions` | `wallets_transactions_list`: Ledger | `billing:read` | - | | GET | `/v1/billing/wallets/topup-quote` | `wallets_topup_quote`: Price a wallet top-up before paying | `billing:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # webhook-deliveries Source: https://docs.wapitick.com/reference/webhook-deliveries Delivery log and redelivery. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/webhook-deliveries` | `webhook_deliveries_list`: Delivery log | `webhooks:read` | yes | | GET | `/v1/webhook-deliveries/{delivery_id}` | `webhook_deliveries_get`: One delivery with all attempts and the signed payload as sent | `webhooks:read` | yes | | POST | `/v1/webhook-deliveries/{delivery_id}/replay` | `webhook_deliveries_replay`: Re-deliver one event | `webhooks:write` | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # webhook-endpoints Source: https://docs.wapitick.com/reference/webhook-endpoints Outbound webhook endpoints, secrets, test and replay. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/webhook-endpoints` | `webhook_endpoints_list`: List webhook endpoints | `webhooks:read` | yes | | POST | `/v1/webhook-endpoints` | `webhook_endpoints_create`: Create a webhook endpoint | `webhooks:write` | yes | | DELETE | `/v1/webhook-endpoints/{endpoint_id}` | `webhook_endpoints_delete`: Delete an endpoint | `webhooks:write` | yes | | GET | `/v1/webhook-endpoints/{endpoint_id}` | `webhook_endpoints_get`: Get an endpoint with health | `webhooks:read` | yes | | PATCH | `/v1/webhook-endpoints/{endpoint_id}` | `webhook_endpoints_update`: Update url, events or status | `webhooks:write` | yes | | POST | `/v1/webhook-endpoints/{endpoint_id}/enable` | `webhook_endpoints_enable`: Re-enable an endpoint after auto-disable | `webhooks:write` | yes | | POST | `/v1/webhook-endpoints/{endpoint_id}/replay` | `webhook_endpoints_replay`: Bulk replay by time range and status | `webhooks:write` | yes | | POST | `/v1/webhook-endpoints/{endpoint_id}/rotate-secret` | `webhook_endpoints_rotate_secret`: Rotate the signing secret | `webhooks:write` | yes | | POST | `/v1/webhook-endpoints/{endpoint_id}/test` | `webhook_endpoints_test`: Send a sample event | `webhooks:write` | yes | | POST | `/v1/webhook-subscriptions` | `webhook_subscriptions_subscribe`: REST-hook subscribe (Zapier performSubscribe) | `webhooks:write` | yes | | GET | `/v1/webhook-subscriptions/{event}/sample` | `webhook_subscriptions_sample`: Sample payload for an event (Zapier performList) | `webhooks:read` | yes | | DELETE | `/v1/webhook-subscriptions/{id}` | `webhook_subscriptions_unsubscribe`: REST-hook unsubscribe (Zapier performUnsubscribe) | `webhooks:write` | yes | | GET | `/v1/webhook-subscriptions/{id}` | `webhook_subscriptions_get`: REST-hook read (Zapier) | `webhooks:read` | yes | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # webhooks-inbound Source: https://docs.wapitick.com/reference/webhooks-inbound Inbound provider webhooks captured by the API. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/integrations/slack/events` | `slack_events_capture`: Slack events | public | - | | POST | `/wh/calendly/{integration_id}` | `webhooks_calendly_capture`: Calendly webhook | public | - | | POST | `/wh/commerce/{provider}/{integration_id}` | `webhooks_commerce_store_capture`: Store webhook (Shopify, WooCommerce) | public | - | | POST | `/wh/google_calendar/{integration_id}` | `webhooks_google_calendar_capture`: Google Calendar push notification | public | - | | POST | `/wh/hubspot` | `webhooks_hubspot_capture`: HubSpot webhook | public | - | | POST | `/wh/hubspot/{integration_id}` | `webhooks_hubspot_capture_for`: HubSpot webhook (one connection) | public | - | | POST | `/wh/razorpay/{integration_id}` | `webhooks_razorpay_tenant_capture`: Tenant Razorpay webhook (payment links, UPI QR, refunds) | public | - | | POST | `/wh/slack` | `webhooks_slack_capture`: Slack events | public | - | | POST | `/wh/zoho_crm/{integration_id}` | `webhooks_zoho_crm_capture`: Zoho CRM notification | public | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # websites Source: https://docs.wapitick.com/reference/websites Put Wapitick on a website: installs, embeddables, install checks, QR codes. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/sites` | `websites_list`: List the websites Wapitick is installed on | `org:read` | - | | POST | `/v1/sites` | `websites_create`: Add a website | `org:write` | - | | POST | `/v1/sites:detect-platform` | `websites_detect_platform`: Find out what a website is built with | `org:read` | - | | DELETE | `/v1/sites/{site_id}` | `websites_delete`: Remove a website (the loader stops answering at once) | `org:write` | - | | GET | `/v1/sites/{site_id}` | `websites_get`: Get one website install | `org:read` | - | | PATCH | `/v1/sites/{site_id}` | `websites_update`: Change a website's embeddables, allowed sites or status | `org:write` | - | | GET | `/v1/sites/{site_id}/counter-kit.pdf` | `websites_counter_kit`: Printable counter kit (A4 PDF with the WhatsApp QR code) | `org:read` | - | | GET | `/v1/sites/{site_id}/developer-links` | `websites_developer_links_list`: Links sent to a developer for this website | `org:read` | - | | POST | `/v1/sites/{site_id}/developer-links` | `websites_send_to_developer`: E-mail the install code to a developer | `org:write` | - | | DELETE | `/v1/sites/{site_id}/developer-links/{link_id}` | `websites_developer_link_revoke`: Revoke a developer link | `org:write` | - | | GET | `/v1/sites/{site_id}/qr.svg` | `websites_qr`: QR code (SVG) for WhatsApp, the public page, booking or the catalogue | `org:read` | - | | POST | `/v1/sites/{site_id}/verify` | `websites_verify`: Check that the code is on the website | `org:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # whatsapp-calling Source: https://docs.wapitick.com/reference/whatsapp-calling Voice calls inside WhatsApp: settings, call permission, starting a call. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | POST | `/v1/call-permissions:request` | `whatsapp_call_permission_request`: Ask a customer for permission to call | `messages:send` | - | | GET | `/v1/channels/{channel_id}/call-permissions` | `whatsapp_call_permissions_list`: Who allows calls from this number | `channels:read` | - | | GET | `/v1/channels/{channel_id}/calling` | `whatsapp_calling_settings_get`: WhatsApp calling settings | `channels:read` | - | | PUT | `/v1/channels/{channel_id}/calling` | `whatsapp_calling_settings_put`: Turn WhatsApp calling on or off | `channels:write` | - | | POST | `/v1/whatsapp-calls` | `whatsapp_calls_start`: Start a WhatsApp call | `messages:send` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # whatsapp-groups Source: https://docs.wapitick.com/reference/whatsapp-groups WhatsApp groups: create, manage, invite link, join requests, participants. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/groups` | `whatsapp_groups_list`: List WhatsApp groups | `channels:read` | - | | POST | `/v1/groups` | `whatsapp_groups_create`: Create a WhatsApp group | `channels:write` | - | | DELETE | `/v1/groups/{group_id}` | `whatsapp_groups_delete`: Delete a group | `channels:write` | - | | GET | `/v1/groups/{group_id}` | `whatsapp_groups_get`: Get a WhatsApp group | `channels:read` | - | | PATCH | `/v1/groups/{group_id}` | `whatsapp_groups_update`: Rename a group or change its description | `channels:write` | - | | GET | `/v1/groups/{group_id}/invite-link` | `whatsapp_groups_invite_link_get`: Get the group's invite link | `channels:read` | - | | POST | `/v1/groups/{group_id}/invite-link` | `whatsapp_groups_invite_link_reset`: Reset the group's invite link | `channels:write` | - | | GET | `/v1/groups/{group_id}/join-requests` | `whatsapp_groups_join_requests_list`: People waiting to join | `channels:read` | - | | POST | `/v1/groups/{group_id}/join-requests:decide` | `whatsapp_groups_join_requests_decide`: Approve or reject people waiting to join | `channels:write` | - | | GET | `/v1/groups/{group_id}/participants` | `whatsapp_groups_participants_list`: List group participants | `channels:read` | - | | POST | `/v1/groups/{group_id}/participants:remove` | `whatsapp_groups_participants_remove`: Remove people from a group | `channels:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # whatsapp-identity Source: https://docs.wapitick.com/reference/whatsapp-identity The business's WhatsApp username and the verified-badge application. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/oba-applications` | `oba_application_list`: Verified-badge applications | `channels:read` | - | | POST | `/v1/oba-applications` | `oba_application_start`: Start a verified-badge application | `channels:write` | - | | POST | `/v1/oba-applications/{application_id}:submit` | `oba_application_submit`: Submit the verified-badge application | `channels:write` | - | | PUT | `/v1/oba-applications/{application_id}/evidence` | `oba_application_evidence_put`: Add proof that the brand is widely known | `channels:write` | - | | GET | `/v1/wa-usernames` | `wa_username_list`: Usernames reserved for this workspace | `channels:read` | - | | POST | `/v1/wa-usernames` | `wa_username_reserve`: Reserve a WhatsApp username for this number | `channels:write` | - | | POST | `/v1/wa-usernames:check` | `wa_username_check`: Is this WhatsApp username free? | `channels:read` | - | | DELETE | `/v1/wa-usernames/{username_id}` | `wa_username_release`: Release a reserved WhatsApp username | `channels:write` | - | | GET | `/v1/wa-usernames/{username_id}` | `wa_username_get`: Get one username reservation | `channels:read` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # widgets Source: https://docs.wapitick.com/reference/widgets Website chat widgets and their embed snippet. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/widgets` | `widgets_list`: Website chat widgets | `channels:read` | - | | POST | `/v1/widgets` | `widgets_create`: Create a website chat widget | `channels:write` | - | | DELETE | `/v1/widgets/{widget_id}` | `widgets_delete`: Delete a website chat widget | `channels:write` | - | | GET | `/v1/widgets/{widget_id}` | `widgets_get`: Get one website chat widget | `channels:read` | - | | PATCH | `/v1/widgets/{widget_id}` | `widgets_update`: Update a website chat widget | `channels:write` | - | | POST | `/v1/widgets/sessions/{session_id}/reply` | `widgets_session_reply`: Reply to a website chat visitor | `messages:send` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # workspaces Source: https://docs.wapitick.com/reference/workspaces Businesses: profile, settings, business hours and limits. | Method | Path | Operation | Scope | Test mode | |---|---|---|---|---| | GET | `/v1/workspaces` | `workspaces_list`: List the Businesses (workspaces) of the org | `org:read` | - | | POST | `/v1/workspaces` | `workspaces_create`: Create a Business (workspace) | `org:write` | - | | DELETE | `/v1/workspaces/{workspace_id}` | `workspaces_delete`: Delete a Business (disconnects channels, 30-day grace) | `org:write` | - | | GET | `/v1/workspaces/{workspace_id}` | `workspaces_get`: Get a Business | `org:read` | yes | | PATCH | `/v1/workspaces/{workspace_id}` | `workspaces_update`: Update a Business (profile, timezone, language, greeting/away, AI disclosure, brand voice, logo) | `org:write` | - | | GET | `/v1/workspaces/{workspace_id}/business-hours` | `workspaces_get_business_hours`: Business hours and holidays | `org:read` | - | | PUT | `/v1/workspaces/{workspace_id}/business-hours` | `workspaces_replace_business_hours`: Replace business hours and holidays | `org:write` | - | | GET | `/v1/workspaces/{workspace_id}/limits` | `workspaces_get_limits`: Effective entitlements and usage for this Business | `org:read` | - | | GET | `/v1/workspaces/{workspace_id}/settings` | `workspaces_get_settings`: Settings document (inbox, routing, SLA, quick replies, AI policy, consent rules, retention) | `org:read` | - | | PATCH | `/v1/workspaces/{workspace_id}/settings` | `workspaces_update_settings`: Update the settings document | `org:write` | - | Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`. --- # Webhook events Source: https://docs.wapitick.com/reference/webhooks | Event | When | Opt-in | |---|---|---| | `ad_account.connected` | Ad account connected | - | | `ad_account.health_changed` | Ad account health changed | - | | `ad_campaign.billing_blocked` | Ad campaign billing blocked | - | | `ad_campaign.completed` | Ad campaign completed | - | | `ad_campaign.created` | Ad campaign created | - | | `ad.status_changed` | Ad status changed | - | | `ai.credits_used` | Ai credits used | - | | `ai.handoff_requested` | Ai handoff requested | - | | `ai.reply_suppressed` | Ai reply suppressed | - | | `api_key.created` | Api key created | - | | `api_key.revoked` | Api key revoked | - | | `api_key.rotated` | Api key rotated | - | | `approval.decided` | Approval decided | - | | `approval.requested` | Approval requested | - | | `asset_safety.changed` | Asset safety changed | - | | `assistant.activated` | Assistant activated | - | | `assistant.created` | Assistant created | - | | `assistant.deactivated` | Assistant deactivated | - | | `assistant.eval_regression_detected` | Assistant eval regression detected | - | | `assistant.eval_run_completed` | Assistant eval run completed | - | | `assistant.fact_updated` | Assistant fact updated | - | | `assistant.season_rolled_over` | Assistant season rolled over | - | | `assistant.updated` | Assistant updated | - | | `booking.attended` | Booking attended | - | | `booking.cancelled` | Booking cancelled | - | | `booking.created` | Booking created | - | | `booking.deposit_adjusted` | Booking deposit adjusted | - | | `booking.deposit_forfeited` | Booking deposit forfeited | - | | `booking.deposit_paid` | Booking deposit paid | - | | `booking.deposit_refunded` | Booking deposit refunded | - | | `booking.deposit_released` | Booking deposit released | - | | `booking.deposit_requested` | Booking deposit requested | - | | `booking.no_show` | Booking no show | - | | `booking.reminder_requested` | Booking reminder requested | - | | `booking.rescheduled` | Booking rescheduled | - | | `booking.updated` | Booking updated | - | | `business_verification.decided` | Business verification decided | - | | `business_verification.submitted` | Business verification submitted | - | | `call.balance_exhausted` | Call balance exhausted | - | | `call.completed` | Call completed | - | | `call.crm_applied` | Call crm applied | - | | `call.missed` | Call missed | - | | `call.outcome_recorded` | Call outcome recorded | - | | `call.permission_granted` | Call permission granted | - | | `call.permission_requested` | Call permission requested | - | | `call.permission_revoked` | Call permission revoked | - | | `call.recording_ready` | Call recording ready | - | | `call.started` | Call started | - | | `call.summary_ready` | Call summary ready | - | | `call.transcript_ready` | Call transcript ready | - | | `call.voicemail_left` | Call voicemail left | - | | `capi.sent` | Capi sent | - | | `cart.abandoned` | Cart abandoned | - | | `cart.purchased` | Cart purchased | - | | `cart.recovered` | Cart recovered | - | | `cart.recovery_message_sent` | Cart recovery message sent | - | | `catalog.created` | Catalog created | - | | `catalog.sync_started` | Catalog sync started | - | | `catalog.synced` | Catalog synced | - | | `channel.badge_approved` | Channel badge approved | - | | `channel.badge_rejected` | Channel badge rejected | - | | `channel.badge_submitted` | Channel badge submitted | - | | `channel.coexistence_sync_updated` | Channel coexistence sync updated | yes (`+channel.coexistence_sync_updated`) | | `channel.connected` | Channel connected | - | | `channel.disconnected` | Channel disconnected | - | | `channel.health_changed` | Channel health changed | - | | `channel.history_declined` | Channel history declined | - | | `channel.history_synced` | Channel history synced | - | | `channel.limit_changed` | Channel limit changed | - | | `channel.payment_state_changed` | Channel payment state changed | - | | `channel.private_lane_released` | Channel private lane released | - | | `channel.reconnected` | Channel reconnected | - | | `channel.routing_changed` | Channel routing changed | - | | `channel.sync_expired` | Channel sync expired | - | | `channel.token_expiring` | Channel token expiring | - | | `channel.username_released` | Channel username released | - | | `channel.username_reserved` | Channel username reserved | - | | `client_approval.decided` | Client approval decided | - | | `client_approval.requested` | Client approval requested | - | | `client_org.handover_completed` | Client org handover completed | - | | `client_org.handover_started` | Client org handover started | - | | `comment.received` | Comment received | - | | `contact.created` | Contact created | - | | `contact.deleted` | Contact deleted | - | | `contact.merged` | Contact merged | - | | `contact.opted_in` | Contact opted in | - | | `contact.opted_out` | Contact opted out | - | | `contact.stage_changed` | Contact stage changed | - | | `contact.tag_added` | Contact tag added | - | | `contact.tag_removed` | Contact tag removed | - | | `contact.updated` | Contact updated | - | | `conversation.assigned` | Conversation assigned | - | | `conversation.closed` | Conversation closed | - | | `conversation.created` | Conversation created | - | | `conversation.label_changed` | Conversation label changed | - | | `conversation.lane_changed` | Conversation lane changed | - | | `conversation.note_added` | Conversation note added | - | | `conversation.quality_low` | Conversation quality low | - | | `conversation.quality_scored` | Conversation quality scored | - | | `conversation.reopened` | Conversation reopened | - | | `conversation.sla_breached` | Conversation sla breached | - | | `conversation.sla_warned` | Conversation sla warned | - | | `conversation.snoozed` | Conversation snoozed | - | | `conversation.status_changed` | Conversation status changed | - | | `copilot.action_cancelled` | Copilot action cancelled | - | | `copilot.action_confirmed` | Copilot action confirmed | - | | `copilot.action_executed` | Copilot action executed | - | | `copilot.action_expired` | Copilot action expired | - | | `copilot.action_failed` | Copilot action failed | - | | `copilot.action_proposed` | Copilot action proposed | - | | `copilot.action_rejected` | Copilot action rejected | - | | `csat.low_score` | Csat low score | - | | `csat.requested` | Csat requested | - | | `csat.responded` | Csat responded | - | | `document.delivered` | Document delivered | - | | `document.delivery_expired` | Document delivery expired | - | | `document.delivery_revoked` | Document delivery revoked | - | | `document.delivery_sent` | Document delivery sent | - | | `document.delivery_verified` | Document delivery verified | - | | `document.request_completed` | Document request completed | - | | `document.request_item_accepted` | Document request item accepted | - | | `document.request_item_received` | Document request item received | - | | `document.request_item_rejected` | Document request item rejected | - | | `document.request_sent` | Document request sent | - | | `dsr.completed` | Dsr completed | - | | `dsr.created` | Dsr created | - | | `dsr.rejected` | Dsr rejected | - | | `dsr.verified` | Dsr verified | - | | `due_schedule.cancelled` | Due schedule cancelled | - | | `due_schedule.created` | Due schedule created | - | | `due.cancelled` | Due cancelled | - | | `due.created` | Due created | - | | `due.overdue` | Due overdue | - | | `due.paid` | Due paid | - | | `due.part_paid` | Due part paid | - | | `due.reminder_sent` | Due reminder sent | - | | `due.updated` | Due updated | - | | `due.waived` | Due waived | - | | `export.ready` | Export ready | - | | `export.requested` | Export requested | - | | `flow.created` | Flow created | - | | `flow.status_updated` | Flow status updated | - | | `form.submitted` | Form submitted | - | | `group.created` | Group created | - | | `group.deleted` | Group deleted | - | | `group.join_decided` | Group join decided | - | | `group.join_requested` | Group join requested | - | | `group.message_received` | Group message received | - | | `group.participant_joined` | Group participant joined | - | | `group.participant_removed` | Group participant removed | - | | `group.updated` | Group updated | - | | `helper.activated` | Helper activated | - | | `helper.archived` | Helper archived | - | | `helper.created` | Helper created | - | | `helper.deactivated` | Helper deactivated | - | | `helper.deleted` | Helper deleted | - | | `helper.paused` | Helper paused | - | | `helper.published` | Helper published | - | | `helper.resumed` | Helper resumed | - | | `helper.run_cancelled` | Helper run cancelled | - | | `helper.run_completed` | Helper run completed | yes (`+helper.run_completed`) | | `helper.run_failed` | Helper run failed | - | | `helper.run_started` | Helper run started | yes (`+helper.run_started`) | | `helper.updated` | Helper updated | - | | `import.completed` | Import completed | - | | `integration.connected` | Integration connected | - | | `integration.degraded` | Integration degraded | - | | `integration.disconnected` | Integration disconnected | - | | `integration.reauth_required` | Integration reauth required | - | | `integration.recovered` | Integration recovered | - | | `invoice.paid` | Invoice paid | - | | `invoice.payment_failed` | Invoice payment failed | - | | `ivr.activated` | Ivr activated | - | | `ivr.created` | Ivr created | - | | `ivr.deactivated` | Ivr deactivated | - | | `ivr.handed_over` | Ivr handed over | - | | `ivr.updated` | Ivr updated | - | | `knowledge.article_drafted` | Knowledge article drafted | - | | `knowledge.gap_detected` | Knowledge gap detected | - | | `knowledge.source_synced` | Knowledge source synced | - | | `lead.created` | Lead created | - | | `lead.updated` | Lead updated | - | | `library.item_installed` | Library item installed | - | | `link_scan.blocked` | Link scan blocked | - | | `marketing.paused` | Marketing paused | - | | `marketing.resumed` | Marketing resumed | - | | `media.provenance_set` | Media provenance set | - | | `media.ready` | Media ready | - | | `member.access_changed` | Member access changed | - | | `member.invited` | Member invited | - | | `member.joined` | Member joined | - | | `member.removed` | Member removed | - | | `member.role_changed` | Member role changed | - | | `message.failed` | Message failed | - | | `message.reaction_received` | Message reaction received | - | | `message.received` | Message received | - | | `message.sent` | Message sent | - | | `message.status_updated` | Message status updated | yes (`+message.status_updated`) | | `message.updated` | Message updated | - | | `module.toggled` | Module toggled | - | | `offer.cancelled` | Offer cancelled | - | | `offer.completed` | Offer completed | - | | `offer.confirmed` | Offer confirmed | - | | `offer.created` | Offer created | - | | `offer.failed` | Offer failed | - | | `offer.paused` | Offer paused | - | | `offer.recipient_status_updated` | Offer recipient status updated | yes (`+offer.recipient_status_updated`) | | `offer.resumed` | Offer resumed | - | | `offer.scheduled` | Offer scheduled | - | | `offer.started` | Offer started | - | | `offer.undone` | Offer undone | - | | `onboarding.updated` | Onboarding updated | - | | `order.cancelled` | Order cancelled | - | | `order.cod_confirmed` | Order cod confirmed | - | | `order.cod_converted` | Order cod converted | - | | `order.cod_declined` | Order cod declined | - | | `order.cod_expired` | Order cod expired | - | | `order.cod_requested` | Order cod requested | - | | `order.created` | Order created | - | | `order.paid` | Order paid | - | | `order.status_changed` | Order status changed | - | | `order.updated` | Order updated | - | | `org.closure_requested` | Org closure requested | - | | `org.created` | Org created | - | | `org.updated` | Org updated | - | | `owner.anomaly_detected` | Owner anomaly detected | - | | `pack.installed` | Pack installed | - | | `pack.uninstalled` | Pack uninstalled | - | | `partner.applied` | Partner applied | - | | `partner.payout_paid` | Partner payout paid | - | | `partner.payout_requested` | Partner payout requested | - | | `partner.referral_attributed` | Partner referral attributed | - | | `payment_link.cancelled` | Payment link cancelled | - | | `payment_link.created` | Payment link created | - | | `payment_link.expired` | Payment link expired | - | | `payment_link.paid` | Payment link paid | - | | `payment_qr.created` | Payment qr created | - | | `payment_qr.expired` | Payment qr expired | - | | `payment.captured` | Payment captured | - | | `payment.evidence_recorded` | Payment evidence recorded | - | | `payment.refunded` | Payment refunded | - | | `payment.to_check` | Payment to check | - | | `payment.verified` | Payment verified | - | | `post.created` | Post created | - | | `post.deleted` | Post deleted | - | | `post.failed` | Post failed | - | | `post.published` | Post published | - | | `post.scheduled` | Post scheduled | - | | `post.target_updated` | Post target updated | - | | `product.created` | Product created | - | | `product.deleted` | Product deleted | - | | `product.updated` | Product updated | - | | `review_request.sent` | Review request sent | - | | `segment.updated` | Segment updated | - | | `spend.threshold_reached` | Spend threshold reached | - | | `status.incident_updated` | Status incident updated | - | | `subscription.activated` | Subscription activated | - | | `subscription.cancelled` | Subscription cancelled | - | | `subscription.charged` | Subscription charged | - | | `subscription.grace_started` | Subscription grace started | - | | `subscription.past_due` | Subscription past due | - | | `subscription.recovered` | Subscription recovered | - | | `subscription.resumed` | Subscription resumed | - | | `subscription.suspended` | Subscription suspended | - | | `subscription.trial_ended` | Subscription trial ended | - | | `subscription.trial_started` | Subscription trial started | - | | `subscription.updated` | Subscription updated | - | | `support_request.created` | Support request created | - | | `support_request.updated` | Support request updated | - | | `task.completed` | Task completed | - | | `task.created` | Task created | - | | `task.overdue` | Task overdue | - | | `task.updated` | Task updated | - | | `template.appealed` | Template appealed | - | | `template.archived` | Template archived | - | | `template.category_changed` | Template category changed | - | | `template.created` | Template created | - | | `template.deleted` | Template deleted | - | | `template.quality_updated` | Template quality updated | - | | `template.reinstated` | Template reinstated | - | | `template.send_failed` | Template send failed | - | | `template.status_updated` | Template status updated | - | | `template.submitted` | Template submitted | - | | `usage.threshold_reached` | Usage threshold reached | - | | `voice_number.provisioned` | Voice number provisioned | - | | `voice.room_finished` | Voice room finished | yes (`+voice.room_finished`) | | `voice.room_started` | Voice room started | yes (`+voice.room_started`) | | `wallet.depleted` | Wallet depleted | - | | `wallet.low_balance` | Wallet low balance | - | | `wallet.refunded` | Wallet refunded | - | | `wallet.topped_up` | Wallet topped up | - | | `wallet.topup_failed` | Wallet topup failed | - | | `webhook_endpoint.created` | Webhook endpoint created | - | | `webhook_endpoint.disabled` | Webhook endpoint disabled | - | | `widget.chat_started` | Widget chat started | - | | `workspace.created` | Workspace created | - | | `workspace.deleted` | Workspace deleted | - | | `workspace.old_chats_access_changed` | Workspace old chats access changed | - | | `workspace.updated` | Workspace updated | - | Payload schemas: the `webhooks` section of `docs/api/openapi.json`. --- # Errors Source: https://docs.wapitick.com/errors Errors are `application/problem+json` (RFC 9457). Switch on `code`: it never changes. `doc_url` links here. | Code | HTTP | Title | Meaning | |---|---|---|---| | [`aal2_required`](/errors/aal2_required) | 403 | Two-factor sign-in required | Sign in again with two-factor authentication to do this. | | [`account_suspended`](/errors/account_suspended) | 403 | Account suspended | This account is suspended. Contact support to restore it. | | [`ad_account_not_ready`](/errors/ad_account_not_ready) | 422 | Ad account is not ready | The connected ad account is not finished setting up on Meta's side yet. | | [`addon_not_available`](/errors/addon_not_available) | 422 | Add-on not available | This add-on cannot be bought on your current plan. | | [`adult_learners_only`](/errors/adult_learners_only) | 422 | Adult learners only | This pack may only be sold to adult learners. | | [`ai_rate_limited`](/errors/ai_rate_limited) | 429 | Too many AI requests | The assistant is being asked to do too much too quickly. Wait a minute and try again. | | [`already_exists`](/errors/already_exists) | 409 | Already exists | Something with these details already exists. | | [`appeal_window_closed`](/errors/appeal_window_closed) | 409 | Appeal window closed | The time allowed to appeal this decision has passed. | | [`below_minimum`](/errors/below_minimum) | 422 | Below the minimum | The amount is below the minimum allowed. | | [`business_verification_failed`](/errors/business_verification_failed) | 422 | Business verification failed | Meta could not verify this business. Fix the details in Business Manager and try again. | | [`channel_busy`](/errors/channel_busy) | 409 | Channel is busy | This channel is already running another job. Wait for it to finish. | | [`channel_not_ready`](/errors/channel_not_ready) | 422 | Channel is not ready to send | This channel is not connected or not approved to send yet. | | [`channel_rate_limited`](/errors/channel_rate_limited) | 429 | Channel send rate limit exceeded | WhatsApp is throttling this number. Sending will resume shortly. | | [`channel_unhealthy`](/errors/channel_unhealthy) | 422 | Channel needs attention | This channel has a problem that must be fixed before it can be used. | | [`confirmation_required`](/errors/confirmation_required) | 422 | Confirmation required | Confirm this action to continue. | | [`conflict`](/errors/conflict) | 409 | Conflict | Someone changed this at the same moment. Retry the request. | | [`consent_missing`](/errors/consent_missing) | 422 | No consent to message this contact | This contact has not opted in, so you cannot message them. | | [`contact_opted_out`](/errors/contact_opted_out) | 422 | Contact has opted out | This contact asked to stop receiving messages. | | [`country_locked`](/errors/country_locked) | 409 | Country is locked | The billing country cannot be changed once a subscription is active. | | [`coupon_invalid`](/errors/coupon_invalid) | 422 | Coupon is not valid | This coupon code is wrong, expired, or does not apply to this plan. | | [`daily_limit_reached`](/errors/daily_limit_reached) | 422 | Daily spending limit reached | This action would go over the daily spending limit set for the assistant. Raise the limit in Settings or try again tomorrow. | | [`degraded`](/errors/degraded) | 503 | Temporarily degraded | We are running slowly right now. Try again in a few seconds. | | [`discount_rejected`](/errors/discount_rejected) | 422 | Discount rejected | The store would not accept this discount. | | [`entitlement_required`](/errors/entitlement_required) | 402 | Your plan does not include this | This feature is not part of your plan. Upgrade to use it. | | [`export_expired`](/errors/export_expired) | 410 | Export expired | This export has expired. Generate a new one. | | [`feature_unavailable`](/errors/feature_unavailable) | 422 | Not available | This feature is not available for this account, channel or region. | | [`forbidden`](/errors/forbidden) | 403 | Forbidden | You do not have access to this. | | [`four_eyes_required`](/errors/four_eyes_required) | 409 | Second approver required | Another authorised person must approve this before it can happen. | | [`gone`](/errors/gone) | 410 | Gone | This link or resource no longer exists. | | [`helper_invalid`](/errors/helper_invalid) | 422 | Helper is not valid | This helper's configuration is incomplete or invalid. | | [`idempotency_in_progress`](/errors/idempotency_in_progress) | 409 | A request with this Idempotency-Key is in progress | The same request is still being processed. Wait and read the result. | | [`idempotency_key_required`](/errors/idempotency_key_required) | 400 | Idempotency-Key header is required | This write needs an Idempotency-Key header. | | [`idempotency_key_reuse`](/errors/idempotency_key_reuse) | 422 | Idempotency-Key was reused with a different request | This Idempotency-Key was already used for a different request body. | | [`impersonation_denied`](/errors/impersonation_denied) | 403 | Impersonation denied | Staff impersonation is not allowed for this action or account. | | [`impersonation_inactive`](/errors/impersonation_inactive) | 403 | Staff session is not active | This staff session is no longer active. Start a new one. | | [`impersonation_org_locked`](/errors/impersonation_org_locked) | 403 | Account locked for staff sessions | This account has blocked staff access. | | [`impersonation_read_only`](/errors/impersonation_read_only) | 403 | View-as sessions are read-only | A view-as staff session cannot change anything. | | [`insufficient_balance`](/errors/insufficient_balance) | 402 | Insufficient balance | Your wallet does not have enough balance. Top up to continue. | | [`insufficient_call_balance`](/errors/insufficient_call_balance) | 402 | Insufficient call balance | Your calling balance is too low to place this call. Top up to continue. | | [`insufficient_scope`](/errors/insufficient_scope) | 403 | Insufficient scope | This API key or token is missing the scope this endpoint needs. | | [`integration_connect_failed`](/errors/integration_connect_failed) | 422 | Could not connect the integration | We could not complete the connection. Try connecting again. | | [`integration_credentials_missing`](/errors/integration_credentials_missing) | 409 | Integration credentials missing | This integration has no saved credentials. Connect it first. | | [`integration_not_connected`](/errors/integration_not_connected) | 409 | Integration is not connected | Connect this integration before using it. | | [`integration_reauth_required`](/errors/integration_reauth_required) | 409 | Integration needs reconnecting | This integration's access expired. Reconnect it. | | [`integration_scope_missing`](/errors/integration_scope_missing) | 409 | Integration permission missing | The connected account did not grant a permission this needs. Reconnect and approve it. | | [`internal_error`](/errors/internal_error) | 500 | Internal error | Something went wrong on our side. Try again; contact support if it keeps happening. | | [`invalid_api_key`](/errors/invalid_api_key) | 401 | Invalid API key | This API key is wrong, revoked or expired. | | [`invalid_cursor`](/errors/invalid_cursor) | 400 | Invalid cursor | The pagination cursor is not valid. Start from the first page. | | [`invalid_graph`](/errors/invalid_graph) | 422 | Flow is not valid | This flow has a broken or unreachable step. | | [`invalid_request`](/errors/invalid_request) | 400 | Invalid request | The request was not understood. | | [`invalid_signature`](/errors/invalid_signature) | 401 | Invalid signature | The webhook signature did not verify. | | [`invalid_token`](/errors/invalid_token) | 401 | Invalid token | This token is not valid. | | [`ip_not_allowed`](/errors/ip_not_allowed) | 403 | IP address not allowed | This API key is restricted to other IP addresses. | | [`kyc_required`](/errors/kyc_required) | 422 | Verification required | Complete business verification before using this. | | [`link_blocked`](/errors/link_blocked) | 422 | Link blocked | A link in this message is blocked. Remove or replace it. | | [`lint_failed`](/errors/lint_failed) | 422 | Checks failed | This content did not pass our checks. Fix the reported problems. | | [`locked`](/errors/locked) | 423 | Locked | Too many failed attempts. This is locked for a while. | | [`marketing_paused`](/errors/marketing_paused) | 409 | Marketing is paused | Marketing sends are paused for this account right now. | | [`media_invalid`](/errors/media_invalid) | 422 | Media is not valid | This file cannot be used: wrong format, too large, or unreadable. | | [`meta_payment_required`](/errors/meta_payment_required) | 402 | Meta payment method has insufficient funds | Meta rejected the send because the WhatsApp payment method has no funds. | | [`meta_policy_blocked`](/errors/meta_policy_blocked) | 422 | Blocked by Meta policy | Meta blocked this because of their messaging policy. | | [`meta_rate_limited`](/errors/meta_rate_limited) | 429 | Meta rate limit exceeded | Meta is throttling this account. Try again shortly. | | [`method_not_allowed`](/errors/method_not_allowed) | 405 | Method not allowed | This endpoint does not accept that HTTP method. | | [`no_calling_number`](/errors/no_calling_number) | 422 | No calling number | Add a phone number for calls first, then try again. | | [`no_eligible_recipients`](/errors/no_eligible_recipients) | 422 | No eligible recipients | Nobody in this audience can be messaged right now. | | [`not_acceptable`](/errors/not_acceptable) | 406 | Not acceptable | We cannot produce any of the formats you asked for. | | [`not_eligible`](/errors/not_eligible) | 422 | Not eligible | This account or record does not qualify for this action. | | [`not_found`](/errors/not_found) | 404 | Not found | We could not find this. It may have been deleted, or belong to another workspace. | | [`number_not_dialable`](/errors/number_not_dialable) | 422 | Number cannot be dialled | This phone number cannot be called from your account. | | [`oauth_not_configured`](/errors/oauth_not_configured) | 503 | Sign-in provider not configured | This sign-in method is not set up on this deployment. | | [`otp_budget_exhausted`](/errors/otp_budget_exhausted) | 429 | Too many codes sent | Too many verification codes were sent. Try again later. | | [`otp_invalid`](/errors/otp_invalid) | 422 | Code is wrong | That verification code is wrong or has expired. | | [`otp_locked`](/errors/otp_locked) | 429 | Verification locked | Too many wrong codes. Verification is locked for a while. | | [`otp_required`](/errors/otp_required) | 403 | Verification code required | Enter the verification code we sent you. | | [`override_limit_exceeded`](/errors/override_limit_exceeded) | 403 | Override limit reached | You have used all the manual overrides allowed in this period. | | [`pack_exceeds_mandate_limit`](/errors/pack_exceeds_mandate_limit) | 422 | Pack exceeds your auto-pay limit | This top-up is larger than the auto-pay mandate allows. Raise the mandate or pick a smaller pack. | | [`payload_too_large`](/errors/payload_too_large) | 413 | Payload too large | The request or file is too large. | | [`payment_evidence_required`](/errors/payment_evidence_required) | 422 | Payment evidence required | Attach proof of payment before continuing. | | [`payment_method_required`](/errors/payment_method_required) | 409 | Payment method required | Add a payment method to continue. | | [`payout_details_required`](/errors/payout_details_required) | 409 | Payout details required | Add your bank or payout details before you can be paid out. | | [`permission_missing`](/errors/permission_missing) | 422 | Permission missing | The connected account is missing a permission this needs. | | [`phone_not_verified`](/errors/phone_not_verified) | 422 | No verified mobile number | Add and verify your mobile number in your profile first. | | [`phone_verification_required`](/errors/phone_verification_required) | 403 | Verify your mobile number before sending | Verify your mobile number before sending messages or offers. | | [`precondition_failed`](/errors/precondition_failed) | 422 | Precondition failed | Something this depends on is not in place yet. | | [`provider_not_configured`](/errors/provider_not_configured) | 503 | Provider not configured | This provider is not set up on this deployment. | | [`publish_blocked`](/errors/publish_blocked) | 422 | Publishing blocked | This cannot be published until the reported problems are fixed. | | [`quota_exceeded`](/errors/quota_exceeded) | 422 | Plan limit reached | You have reached a limit on your plan. Upgrade or wait for it to reset. | | [`quote_expired`](/errors/quote_expired) | 409 | Quote expired | This price quote has expired. Fetch a new one. | | [`quote_mismatch`](/errors/quote_mismatch) | 409 | Quote no longer matches | The price changed since you were quoted. Review the new price. | | [`rate_limited`](/errors/rate_limited) | 429 | Rate limit exceeded | Too many requests. Slow down and retry after the given delay. | | [`recently_asked`](/errors/recently_asked) | 409 | Asked too recently | This contact was asked recently. Wait before asking again. | | [`recipient_invalid`](/errors/recipient_invalid) | 422 | Number cannot receive messages | This number is not on WhatsApp, or cannot receive messages from you. | | [`region_not_available`](/errors/region_not_available) | 422 | Not available in this region | This is not available in your country yet. | | [`reveal_reason_required`](/errors/reveal_reason_required) | 400 | Reason required | Give a reason before revealing this data. | | [`review_policy_violation`](/errors/review_policy_violation) | 422 | Against review policy | Asking for a review this way breaks the platform's review policy. | | [`role_forbidden`](/errors/role_forbidden) | 403 | Your role cannot do this | Your role does not allow this. Ask an owner or admin. | | [`route_not_found`](/errors/route_not_found) | 404 | Route not found | There is no endpoint at this path. | | [`routing_standby`](/errors/routing_standby) | 422 | Another agent holds this conversation | Another teammate is handling this conversation right now. | | [`run_not_started`](/errors/run_not_started) | 422 | Run has not started | This run has not started yet, so there is nothing to act on. | | [`schedule_too_far`](/errors/schedule_too_far) | 422 | Scheduled too far ahead | That date is further ahead than we allow. Pick a nearer one. | | [`schedule_too_soon`](/errors/schedule_too_soon) | 422 | Scheduled too soon | That time is too close to now. Pick a later one. | | [`second_confirmation_required`](/errors/second_confirmation_required) | 409 | Second confirmation required | Confirm once more to go ahead with this irreversible action. | | [`second_tap_required`](/errors/second_tap_required) | 422 | Confirm on screen | The final confirmation has to be an on-screen tap, not a chat reply. | | [`spend_confirmation_mismatch`](/errors/spend_confirmation_mismatch) | 422 | Spend confirmation does not match | The amount you typed to confirm does not match the amount being spent. | | [`spend_confirmation_required`](/errors/spend_confirmation_required) | 422 | Confirm the amount | Type or tap to confirm the amount being spent. | | [`staff_only`](/errors/staff_only) | 403 | Staff only | This is a Wapitick staff endpoint. | | [`staff_session_blocked`](/errors/staff_session_blocked) | 403 | Blocked during a staff session | Messages to customers are never sent while Wapitick staff are signed in to your account. | | [`staff_session_expired`](/errors/staff_session_expired) | 401 | Staff session expired | This staff session has expired. Sign in again. | | [`state_conflict`](/errors/state_conflict) | 409 | Not allowed in this state | This cannot be done while the record is in its current state. | | [`step_up_required`](/errors/step_up_required) | 403 | Re-authentication required | Confirm your identity again to do this. | | [`tax_id_required`](/errors/tax_id_required) | 422 | Tax id required | Add your GSTIN or tax id before continuing. | | [`template_lint_failed`](/errors/template_lint_failed) | 422 | Template checks failed | This template breaks a WhatsApp rule. Fix the reported problems. | | [`template_not_approved`](/errors/template_not_approved) | 422 | Template is not approved | This template is not approved by WhatsApp yet. | | [`template_required`](/errors/template_required) | 422 | A template message is required | The 24-hour window is closed, so you must send an approved template. | | [`test_mode_only`](/errors/test_mode_only) | 403 | Test mode only | This action only works with a test key (wk_test_) or in the test workspace. | | [`test_mode_unsupported`](/errors/test_mode_unsupported) | 403 | Not available in test mode | Test keys cannot do this. Use a live key, or see the test mode guide for what test mode covers. | | [`test_not_sent`](/errors/test_not_sent) | 422 | Send a test first | Send yourself a test before publishing this. | | [`test_required`](/errors/test_required) | 409 | Test run required | Run a test before turning this on. | | [`token_expired`](/errors/token_expired) | 401 | Token expired | Your session expired. Sign in again. | | [`token_revoked`](/errors/token_revoked) | 401 | Token revoked | This session was signed out. Sign in again. | | [`trust_tier_limit`](/errors/trust_tier_limit) | 422 | Trust tier limit reached | New accounts have lower sending limits. This will rise as your account builds history. | | [`turnstile_failed`](/errors/turnstile_failed) | 422 | Bot check failed | The bot check did not pass. Try again. | | [`unauthenticated`](/errors/unauthenticated) | 401 | Authentication required | Sign in to continue. | | [`undo_window_elapsed`](/errors/undo_window_elapsed) | 409 | Too late to undo | The time allowed to undo this has passed. | | [`unsafe_link`](/errors/unsafe_link) | 422 | Unsafe link | A link in this content looks unsafe. Remove or replace it. | | [`unsupported_integration`](/errors/unsupported_integration) | 422 | Integration not supported | We do not support this integration here. | | [`unsupported_media_type`](/errors/unsupported_media_type) | 415 | Unsupported media type | This file type is not accepted. | | [`upstream_error`](/errors/upstream_error) | 502 | Upstream error | A provider we depend on returned an error. Try again. | | [`upstream_timeout`](/errors/upstream_timeout) | 504 | Upstream timeout | A provider we depend on took too long. Try again. | | [`upstream_unavailable`](/errors/upstream_unavailable) | 503 | Upstream unavailable | A provider we depend on is unavailable. Try again shortly. | | [`url_not_allowed`](/errors/url_not_allowed) | 422 | URL not allowed | This URL is not allowed here. | | [`validation_failed`](/errors/validation_failed) | 400 | Validation failed | One or more fields are wrong. See `errors` for the field pointers. | | [`window_closed`](/errors/window_closed) | 422 | The customer service window is closed | More than 24 hours have passed since the customer's last message, so only templates can be sent. | | [`workspace_forbidden`](/errors/workspace_forbidden) | 403 | No access to this workspace | You are not a member of this workspace. | | [`workspace_required`](/errors/workspace_required) | 400 | Workspace required | Pick a workspace (send the `wapitick-workspace` header). | --- # Two-factor sign-in required Source: https://docs.wapitick.com/errors/aal2_required Code `aal2_required`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/aal2_required", "title": "Two-factor sign-in required", "status": 403, "code": "aal2_required", "detail": "...", "request_id": "req_..." } ``` --- # Account suspended Source: https://docs.wapitick.com/errors/account_suspended Code `account_suspended`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/account_suspended", "title": "Account suspended", "status": 403, "code": "account_suspended", "detail": "...", "request_id": "req_..." } ``` --- # Ad account is not ready Source: https://docs.wapitick.com/errors/ad_account_not_ready Code `ad_account_not_ready`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/ad_account_not_ready", "title": "Ad account is not ready", "status": 422, "code": "ad_account_not_ready", "detail": "...", "request_id": "req_..." } ``` --- # Add-on not available Source: https://docs.wapitick.com/errors/addon_not_available Code `addon_not_available`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/addon_not_available", "title": "Add-on not available", "status": 422, "code": "addon_not_available", "detail": "...", "request_id": "req_..." } ``` --- # Adult learners only Source: https://docs.wapitick.com/errors/adult_learners_only Code `adult_learners_only`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/adult_learners_only", "title": "Adult learners only", "status": 422, "code": "adult_learners_only", "detail": "...", "request_id": "req_..." } ``` --- # Too many AI requests Source: https://docs.wapitick.com/errors/ai_rate_limited Code `ai_rate_limited`, HTTP 429. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/ai_rate_limited", "title": "Too many AI requests", "status": 429, "code": "ai_rate_limited", "detail": "...", "request_id": "req_..." } ``` --- # Already exists Source: https://docs.wapitick.com/errors/already_exists Code `already_exists`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/already_exists", "title": "Already exists", "status": 409, "code": "already_exists", "detail": "...", "request_id": "req_..." } ``` --- # Appeal window closed Source: https://docs.wapitick.com/errors/appeal_window_closed Code `appeal_window_closed`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/appeal_window_closed", "title": "Appeal window closed", "status": 409, "code": "appeal_window_closed", "detail": "...", "request_id": "req_..." } ``` --- # Below the minimum Source: https://docs.wapitick.com/errors/below_minimum Code `below_minimum`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/below_minimum", "title": "Below the minimum", "status": 422, "code": "below_minimum", "detail": "...", "request_id": "req_..." } ``` --- # Business verification failed Source: https://docs.wapitick.com/errors/business_verification_failed Code `business_verification_failed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/business_verification_failed", "title": "Business verification failed", "status": 422, "code": "business_verification_failed", "detail": "...", "request_id": "req_..." } ``` --- # Channel is busy Source: https://docs.wapitick.com/errors/channel_busy Code `channel_busy`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/channel_busy", "title": "Channel is busy", "status": 409, "code": "channel_busy", "detail": "...", "request_id": "req_..." } ``` --- # Channel is not ready to send Source: https://docs.wapitick.com/errors/channel_not_ready Code `channel_not_ready`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/channel_not_ready", "title": "Channel is not ready to send", "status": 422, "code": "channel_not_ready", "detail": "...", "request_id": "req_..." } ``` --- # Channel send rate limit exceeded Source: https://docs.wapitick.com/errors/channel_rate_limited Code `channel_rate_limited`, HTTP 429. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/channel_rate_limited", "title": "Channel send rate limit exceeded", "status": 429, "code": "channel_rate_limited", "detail": "...", "request_id": "req_..." } ``` --- # Channel needs attention Source: https://docs.wapitick.com/errors/channel_unhealthy Code `channel_unhealthy`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/channel_unhealthy", "title": "Channel needs attention", "status": 422, "code": "channel_unhealthy", "detail": "...", "request_id": "req_..." } ``` --- # Confirmation required Source: https://docs.wapitick.com/errors/confirmation_required Code `confirmation_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/confirmation_required", "title": "Confirmation required", "status": 422, "code": "confirmation_required", "detail": "...", "request_id": "req_..." } ``` --- # Conflict Source: https://docs.wapitick.com/errors/conflict Code `conflict`, HTTP 409. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/conflict", "title": "Conflict", "status": 409, "code": "conflict", "detail": "...", "request_id": "req_..." } ``` --- # No consent to message this contact Source: https://docs.wapitick.com/errors/consent_missing Code `consent_missing`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/consent_missing", "title": "No consent to message this contact", "status": 422, "code": "consent_missing", "detail": "...", "request_id": "req_..." } ``` --- # Contact has opted out Source: https://docs.wapitick.com/errors/contact_opted_out Code `contact_opted_out`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/contact_opted_out", "title": "Contact has opted out", "status": 422, "code": "contact_opted_out", "detail": "...", "request_id": "req_..." } ``` --- # Country is locked Source: https://docs.wapitick.com/errors/country_locked Code `country_locked`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/country_locked", "title": "Country is locked", "status": 409, "code": "country_locked", "detail": "...", "request_id": "req_..." } ``` --- # Coupon is not valid Source: https://docs.wapitick.com/errors/coupon_invalid Code `coupon_invalid`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/coupon_invalid", "title": "Coupon is not valid", "status": 422, "code": "coupon_invalid", "detail": "...", "request_id": "req_..." } ``` --- # Daily spending limit reached Source: https://docs.wapitick.com/errors/daily_limit_reached Code `daily_limit_reached`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/daily_limit_reached", "title": "Daily spending limit reached", "status": 422, "code": "daily_limit_reached", "detail": "...", "request_id": "req_..." } ``` --- # Temporarily degraded Source: https://docs.wapitick.com/errors/degraded Code `degraded`, HTTP 503. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/degraded", "title": "Temporarily degraded", "status": 503, "code": "degraded", "detail": "...", "request_id": "req_..." } ``` --- # Discount rejected Source: https://docs.wapitick.com/errors/discount_rejected Code `discount_rejected`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/discount_rejected", "title": "Discount rejected", "status": 422, "code": "discount_rejected", "detail": "...", "request_id": "req_..." } ``` --- # Your plan does not include this Source: https://docs.wapitick.com/errors/entitlement_required Code `entitlement_required`, HTTP 402. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/entitlement_required", "title": "Your plan does not include this", "status": 402, "code": "entitlement_required", "detail": "...", "request_id": "req_..." } ``` --- # Export expired Source: https://docs.wapitick.com/errors/export_expired Code `export_expired`, HTTP 410. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/export_expired", "title": "Export expired", "status": 410, "code": "export_expired", "detail": "...", "request_id": "req_..." } ``` --- # Not available Source: https://docs.wapitick.com/errors/feature_unavailable Code `feature_unavailable`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/feature_unavailable", "title": "Not available", "status": 422, "code": "feature_unavailable", "detail": "...", "request_id": "req_..." } ``` --- # Forbidden Source: https://docs.wapitick.com/errors/forbidden Code `forbidden`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/forbidden", "title": "Forbidden", "status": 403, "code": "forbidden", "detail": "...", "request_id": "req_..." } ``` --- # Second approver required Source: https://docs.wapitick.com/errors/four_eyes_required Code `four_eyes_required`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/four_eyes_required", "title": "Second approver required", "status": 409, "code": "four_eyes_required", "detail": "...", "request_id": "req_..." } ``` --- # Gone Source: https://docs.wapitick.com/errors/gone Code `gone`, HTTP 410. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/gone", "title": "Gone", "status": 410, "code": "gone", "detail": "...", "request_id": "req_..." } ``` --- # Helper is not valid Source: https://docs.wapitick.com/errors/helper_invalid Code `helper_invalid`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/helper_invalid", "title": "Helper is not valid", "status": 422, "code": "helper_invalid", "detail": "...", "request_id": "req_..." } ``` --- # A request with this Idempotency-Key is in progress Source: https://docs.wapitick.com/errors/idempotency_in_progress Code `idempotency_in_progress`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/idempotency_in_progress", "title": "A request with this Idempotency-Key is in progress", "status": 409, "code": "idempotency_in_progress", "detail": "...", "request_id": "req_..." } ``` --- # Idempotency-Key header is required Source: https://docs.wapitick.com/errors/idempotency_key_required Code `idempotency_key_required`, HTTP 400. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/idempotency_key_required", "title": "Idempotency-Key header is required", "status": 400, "code": "idempotency_key_required", "detail": "...", "request_id": "req_..." } ``` --- # Idempotency-Key was reused with a different request Source: https://docs.wapitick.com/errors/idempotency_key_reuse Code `idempotency_key_reuse`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/idempotency_key_reuse", "title": "Idempotency-Key was reused with a different request", "status": 422, "code": "idempotency_key_reuse", "detail": "...", "request_id": "req_..." } ``` --- # Impersonation denied Source: https://docs.wapitick.com/errors/impersonation_denied Code `impersonation_denied`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/impersonation_denied", "title": "Impersonation denied", "status": 403, "code": "impersonation_denied", "detail": "...", "request_id": "req_..." } ``` --- # Staff session is not active Source: https://docs.wapitick.com/errors/impersonation_inactive Code `impersonation_inactive`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/impersonation_inactive", "title": "Staff session is not active", "status": 403, "code": "impersonation_inactive", "detail": "...", "request_id": "req_..." } ``` --- # Account locked for staff sessions Source: https://docs.wapitick.com/errors/impersonation_org_locked Code `impersonation_org_locked`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/impersonation_org_locked", "title": "Account locked for staff sessions", "status": 403, "code": "impersonation_org_locked", "detail": "...", "request_id": "req_..." } ``` --- # View-as sessions are read-only Source: https://docs.wapitick.com/errors/impersonation_read_only Code `impersonation_read_only`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/impersonation_read_only", "title": "View-as sessions are read-only", "status": 403, "code": "impersonation_read_only", "detail": "...", "request_id": "req_..." } ``` --- # Insufficient balance Source: https://docs.wapitick.com/errors/insufficient_balance Code `insufficient_balance`, HTTP 402. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/insufficient_balance", "title": "Insufficient balance", "status": 402, "code": "insufficient_balance", "detail": "...", "request_id": "req_..." } ``` --- # Insufficient call balance Source: https://docs.wapitick.com/errors/insufficient_call_balance Code `insufficient_call_balance`, HTTP 402. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/insufficient_call_balance", "title": "Insufficient call balance", "status": 402, "code": "insufficient_call_balance", "detail": "...", "request_id": "req_..." } ``` --- # Insufficient scope Source: https://docs.wapitick.com/errors/insufficient_scope Code `insufficient_scope`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/insufficient_scope", "title": "Insufficient scope", "status": 403, "code": "insufficient_scope", "detail": "...", "request_id": "req_..." } ``` --- # Could not connect the integration Source: https://docs.wapitick.com/errors/integration_connect_failed Code `integration_connect_failed`, HTTP 422. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/integration_connect_failed", "title": "Could not connect the integration", "status": 422, "code": "integration_connect_failed", "detail": "...", "request_id": "req_..." } ``` --- # Integration credentials missing Source: https://docs.wapitick.com/errors/integration_credentials_missing Code `integration_credentials_missing`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/integration_credentials_missing", "title": "Integration credentials missing", "status": 409, "code": "integration_credentials_missing", "detail": "...", "request_id": "req_..." } ``` --- # Integration is not connected Source: https://docs.wapitick.com/errors/integration_not_connected Code `integration_not_connected`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/integration_not_connected", "title": "Integration is not connected", "status": 409, "code": "integration_not_connected", "detail": "...", "request_id": "req_..." } ``` --- # Integration needs reconnecting Source: https://docs.wapitick.com/errors/integration_reauth_required Code `integration_reauth_required`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/integration_reauth_required", "title": "Integration needs reconnecting", "status": 409, "code": "integration_reauth_required", "detail": "...", "request_id": "req_..." } ``` --- # Integration permission missing Source: https://docs.wapitick.com/errors/integration_scope_missing Code `integration_scope_missing`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/integration_scope_missing", "title": "Integration permission missing", "status": 409, "code": "integration_scope_missing", "detail": "...", "request_id": "req_..." } ``` --- # Internal error Source: https://docs.wapitick.com/errors/internal_error Code `internal_error`, HTTP 500. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "detail": "...", "request_id": "req_..." } ``` --- # Invalid API key Source: https://docs.wapitick.com/errors/invalid_api_key Code `invalid_api_key`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/invalid_api_key", "title": "Invalid API key", "status": 401, "code": "invalid_api_key", "detail": "...", "request_id": "req_..." } ``` --- # Invalid cursor Source: https://docs.wapitick.com/errors/invalid_cursor Code `invalid_cursor`, HTTP 400. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/invalid_cursor", "title": "Invalid cursor", "status": 400, "code": "invalid_cursor", "detail": "...", "request_id": "req_..." } ``` --- # Flow is not valid Source: https://docs.wapitick.com/errors/invalid_graph Code `invalid_graph`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/invalid_graph", "title": "Flow is not valid", "status": 422, "code": "invalid_graph", "detail": "...", "request_id": "req_..." } ``` --- # Invalid request Source: https://docs.wapitick.com/errors/invalid_request Code `invalid_request`, HTTP 400. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/invalid_request", "title": "Invalid request", "status": 400, "code": "invalid_request", "detail": "...", "request_id": "req_..." } ``` --- # Invalid signature Source: https://docs.wapitick.com/errors/invalid_signature Code `invalid_signature`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/invalid_signature", "title": "Invalid signature", "status": 401, "code": "invalid_signature", "detail": "...", "request_id": "req_..." } ``` --- # Invalid token Source: https://docs.wapitick.com/errors/invalid_token Code `invalid_token`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/invalid_token", "title": "Invalid token", "status": 401, "code": "invalid_token", "detail": "...", "request_id": "req_..." } ``` --- # IP address not allowed Source: https://docs.wapitick.com/errors/ip_not_allowed Code `ip_not_allowed`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/ip_not_allowed", "title": "IP address not allowed", "status": 403, "code": "ip_not_allowed", "detail": "...", "request_id": "req_..." } ``` --- # Verification required Source: https://docs.wapitick.com/errors/kyc_required Code `kyc_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/kyc_required", "title": "Verification required", "status": 422, "code": "kyc_required", "detail": "...", "request_id": "req_..." } ``` --- # Link blocked Source: https://docs.wapitick.com/errors/link_blocked Code `link_blocked`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/link_blocked", "title": "Link blocked", "status": 422, "code": "link_blocked", "detail": "...", "request_id": "req_..." } ``` --- # Checks failed Source: https://docs.wapitick.com/errors/lint_failed Code `lint_failed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/lint_failed", "title": "Checks failed", "status": 422, "code": "lint_failed", "detail": "...", "request_id": "req_..." } ``` --- # Locked Source: https://docs.wapitick.com/errors/locked Code `locked`, HTTP 423. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/locked", "title": "Locked", "status": 423, "code": "locked", "detail": "...", "request_id": "req_..." } ``` --- # Marketing is paused Source: https://docs.wapitick.com/errors/marketing_paused Code `marketing_paused`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/marketing_paused", "title": "Marketing is paused", "status": 409, "code": "marketing_paused", "detail": "...", "request_id": "req_..." } ``` --- # Media is not valid Source: https://docs.wapitick.com/errors/media_invalid Code `media_invalid`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/media_invalid", "title": "Media is not valid", "status": 422, "code": "media_invalid", "detail": "...", "request_id": "req_..." } ``` --- # Meta payment method has insufficient funds Source: https://docs.wapitick.com/errors/meta_payment_required Code `meta_payment_required`, HTTP 402. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/meta_payment_required", "title": "Meta payment method has insufficient funds", "status": 402, "code": "meta_payment_required", "detail": "...", "request_id": "req_..." } ``` --- # Blocked by Meta policy Source: https://docs.wapitick.com/errors/meta_policy_blocked Code `meta_policy_blocked`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/meta_policy_blocked", "title": "Blocked by Meta policy", "status": 422, "code": "meta_policy_blocked", "detail": "...", "request_id": "req_..." } ``` --- # Meta rate limit exceeded Source: https://docs.wapitick.com/errors/meta_rate_limited Code `meta_rate_limited`, HTTP 429. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/meta_rate_limited", "title": "Meta rate limit exceeded", "status": 429, "code": "meta_rate_limited", "detail": "...", "request_id": "req_..." } ``` --- # Method not allowed Source: https://docs.wapitick.com/errors/method_not_allowed Code `method_not_allowed`, HTTP 405. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "detail": "...", "request_id": "req_..." } ``` --- # No calling number Source: https://docs.wapitick.com/errors/no_calling_number Code `no_calling_number`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/no_calling_number", "title": "No calling number", "status": 422, "code": "no_calling_number", "detail": "...", "request_id": "req_..." } ``` --- # No eligible recipients Source: https://docs.wapitick.com/errors/no_eligible_recipients Code `no_eligible_recipients`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/no_eligible_recipients", "title": "No eligible recipients", "status": 422, "code": "no_eligible_recipients", "detail": "...", "request_id": "req_..." } ``` --- # Not acceptable Source: https://docs.wapitick.com/errors/not_acceptable Code `not_acceptable`, HTTP 406. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/not_acceptable", "title": "Not acceptable", "status": 406, "code": "not_acceptable", "detail": "...", "request_id": "req_..." } ``` --- # Not eligible Source: https://docs.wapitick.com/errors/not_eligible Code `not_eligible`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/not_eligible", "title": "Not eligible", "status": 422, "code": "not_eligible", "detail": "...", "request_id": "req_..." } ``` --- # Not found Source: https://docs.wapitick.com/errors/not_found Code `not_found`, HTTP 404. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/not_found", "title": "Not found", "status": 404, "code": "not_found", "detail": "...", "request_id": "req_..." } ``` --- # Number cannot be dialled Source: https://docs.wapitick.com/errors/number_not_dialable Code `number_not_dialable`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/number_not_dialable", "title": "Number cannot be dialled", "status": 422, "code": "number_not_dialable", "detail": "...", "request_id": "req_..." } ``` --- # Sign-in provider not configured Source: https://docs.wapitick.com/errors/oauth_not_configured Code `oauth_not_configured`, HTTP 503. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/oauth_not_configured", "title": "Sign-in provider not configured", "status": 503, "code": "oauth_not_configured", "detail": "...", "request_id": "req_..." } ``` --- # Too many codes sent Source: https://docs.wapitick.com/errors/otp_budget_exhausted Code `otp_budget_exhausted`, HTTP 429. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/otp_budget_exhausted", "title": "Too many codes sent", "status": 429, "code": "otp_budget_exhausted", "detail": "...", "request_id": "req_..." } ``` --- # Code is wrong Source: https://docs.wapitick.com/errors/otp_invalid Code `otp_invalid`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/otp_invalid", "title": "Code is wrong", "status": 422, "code": "otp_invalid", "detail": "...", "request_id": "req_..." } ``` --- # Verification locked Source: https://docs.wapitick.com/errors/otp_locked Code `otp_locked`, HTTP 429. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/otp_locked", "title": "Verification locked", "status": 429, "code": "otp_locked", "detail": "...", "request_id": "req_..." } ``` --- # Verification code required Source: https://docs.wapitick.com/errors/otp_required Code `otp_required`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/otp_required", "title": "Verification code required", "status": 403, "code": "otp_required", "detail": "...", "request_id": "req_..." } ``` --- # Override limit reached Source: https://docs.wapitick.com/errors/override_limit_exceeded Code `override_limit_exceeded`, HTTP 403. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/override_limit_exceeded", "title": "Override limit reached", "status": 403, "code": "override_limit_exceeded", "detail": "...", "request_id": "req_..." } ``` --- # Pack exceeds your auto-pay limit Source: https://docs.wapitick.com/errors/pack_exceeds_mandate_limit Code `pack_exceeds_mandate_limit`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/pack_exceeds_mandate_limit", "title": "Pack exceeds your auto-pay limit", "status": 422, "code": "pack_exceeds_mandate_limit", "detail": "...", "request_id": "req_..." } ``` --- # Payload too large Source: https://docs.wapitick.com/errors/payload_too_large Code `payload_too_large`, HTTP 413. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/payload_too_large", "title": "Payload too large", "status": 413, "code": "payload_too_large", "detail": "...", "request_id": "req_..." } ``` --- # Payment evidence required Source: https://docs.wapitick.com/errors/payment_evidence_required Code `payment_evidence_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/payment_evidence_required", "title": "Payment evidence required", "status": 422, "code": "payment_evidence_required", "detail": "...", "request_id": "req_..." } ``` --- # Payment method required Source: https://docs.wapitick.com/errors/payment_method_required Code `payment_method_required`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/payment_method_required", "title": "Payment method required", "status": 409, "code": "payment_method_required", "detail": "...", "request_id": "req_..." } ``` --- # Payout details required Source: https://docs.wapitick.com/errors/payout_details_required Code `payout_details_required`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/payout_details_required", "title": "Payout details required", "status": 409, "code": "payout_details_required", "detail": "...", "request_id": "req_..." } ``` --- # Permission missing Source: https://docs.wapitick.com/errors/permission_missing Code `permission_missing`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/permission_missing", "title": "Permission missing", "status": 422, "code": "permission_missing", "detail": "...", "request_id": "req_..." } ``` --- # No verified mobile number Source: https://docs.wapitick.com/errors/phone_not_verified Code `phone_not_verified`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/phone_not_verified", "title": "No verified mobile number", "status": 422, "code": "phone_not_verified", "detail": "...", "request_id": "req_..." } ``` --- # Verify your mobile number before sending Source: https://docs.wapitick.com/errors/phone_verification_required Code `phone_verification_required`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/phone_verification_required", "title": "Verify your mobile number before sending", "status": 403, "code": "phone_verification_required", "detail": "...", "request_id": "req_..." } ``` --- # Precondition failed Source: https://docs.wapitick.com/errors/precondition_failed Code `precondition_failed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/precondition_failed", "title": "Precondition failed", "status": 422, "code": "precondition_failed", "detail": "...", "request_id": "req_..." } ``` --- # Provider not configured Source: https://docs.wapitick.com/errors/provider_not_configured Code `provider_not_configured`, HTTP 503. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/provider_not_configured", "title": "Provider not configured", "status": 503, "code": "provider_not_configured", "detail": "...", "request_id": "req_..." } ``` --- # Publishing blocked Source: https://docs.wapitick.com/errors/publish_blocked Code `publish_blocked`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/publish_blocked", "title": "Publishing blocked", "status": 422, "code": "publish_blocked", "detail": "...", "request_id": "req_..." } ``` --- # Plan limit reached Source: https://docs.wapitick.com/errors/quota_exceeded Code `quota_exceeded`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/quota_exceeded", "title": "Plan limit reached", "status": 422, "code": "quota_exceeded", "detail": "...", "request_id": "req_..." } ``` --- # Quote expired Source: https://docs.wapitick.com/errors/quote_expired Code `quote_expired`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/quote_expired", "title": "Quote expired", "status": 409, "code": "quote_expired", "detail": "...", "request_id": "req_..." } ``` --- # Quote no longer matches Source: https://docs.wapitick.com/errors/quote_mismatch Code `quote_mismatch`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/quote_mismatch", "title": "Quote no longer matches", "status": 409, "code": "quote_mismatch", "detail": "...", "request_id": "req_..." } ``` --- # Rate limit exceeded Source: https://docs.wapitick.com/errors/rate_limited Code `rate_limited`, HTTP 429. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/rate_limited", "title": "Rate limit exceeded", "status": 429, "code": "rate_limited", "detail": "...", "request_id": "req_..." } ``` --- # Asked too recently Source: https://docs.wapitick.com/errors/recently_asked Code `recently_asked`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/recently_asked", "title": "Asked too recently", "status": 409, "code": "recently_asked", "detail": "...", "request_id": "req_..." } ``` --- # Number cannot receive messages Source: https://docs.wapitick.com/errors/recipient_invalid Code `recipient_invalid`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/recipient_invalid", "title": "Number cannot receive messages", "status": 422, "code": "recipient_invalid", "detail": "...", "request_id": "req_..." } ``` --- # Not available in this region Source: https://docs.wapitick.com/errors/region_not_available Code `region_not_available`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/region_not_available", "title": "Not available in this region", "status": 422, "code": "region_not_available", "detail": "...", "request_id": "req_..." } ``` --- # Reason required Source: https://docs.wapitick.com/errors/reveal_reason_required Code `reveal_reason_required`, HTTP 400. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/reveal_reason_required", "title": "Reason required", "status": 400, "code": "reveal_reason_required", "detail": "...", "request_id": "req_..." } ``` --- # Against review policy Source: https://docs.wapitick.com/errors/review_policy_violation Code `review_policy_violation`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/review_policy_violation", "title": "Against review policy", "status": 422, "code": "review_policy_violation", "detail": "...", "request_id": "req_..." } ``` --- # Your role cannot do this Source: https://docs.wapitick.com/errors/role_forbidden Code `role_forbidden`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/role_forbidden", "title": "Your role cannot do this", "status": 403, "code": "role_forbidden", "detail": "...", "request_id": "req_..." } ``` --- # Route not found Source: https://docs.wapitick.com/errors/route_not_found Code `route_not_found`, HTTP 404. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/route_not_found", "title": "Route not found", "status": 404, "code": "route_not_found", "detail": "...", "request_id": "req_..." } ``` --- # Another agent holds this conversation Source: https://docs.wapitick.com/errors/routing_standby Code `routing_standby`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/routing_standby", "title": "Another agent holds this conversation", "status": 422, "code": "routing_standby", "detail": "...", "request_id": "req_..." } ``` --- # Run has not started Source: https://docs.wapitick.com/errors/run_not_started Code `run_not_started`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/run_not_started", "title": "Run has not started", "status": 422, "code": "run_not_started", "detail": "...", "request_id": "req_..." } ``` --- # Scheduled too far ahead Source: https://docs.wapitick.com/errors/schedule_too_far Code `schedule_too_far`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/schedule_too_far", "title": "Scheduled too far ahead", "status": 422, "code": "schedule_too_far", "detail": "...", "request_id": "req_..." } ``` --- # Scheduled too soon Source: https://docs.wapitick.com/errors/schedule_too_soon Code `schedule_too_soon`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/schedule_too_soon", "title": "Scheduled too soon", "status": 422, "code": "schedule_too_soon", "detail": "...", "request_id": "req_..." } ``` --- # Second confirmation required Source: https://docs.wapitick.com/errors/second_confirmation_required Code `second_confirmation_required`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/second_confirmation_required", "title": "Second confirmation required", "status": 409, "code": "second_confirmation_required", "detail": "...", "request_id": "req_..." } ``` --- # Confirm on screen Source: https://docs.wapitick.com/errors/second_tap_required Code `second_tap_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/second_tap_required", "title": "Confirm on screen", "status": 422, "code": "second_tap_required", "detail": "...", "request_id": "req_..." } ``` --- # Spend confirmation does not match Source: https://docs.wapitick.com/errors/spend_confirmation_mismatch Code `spend_confirmation_mismatch`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/spend_confirmation_mismatch", "title": "Spend confirmation does not match", "status": 422, "code": "spend_confirmation_mismatch", "detail": "...", "request_id": "req_..." } ``` --- # Confirm the amount Source: https://docs.wapitick.com/errors/spend_confirmation_required Code `spend_confirmation_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/spend_confirmation_required", "title": "Confirm the amount", "status": 422, "code": "spend_confirmation_required", "detail": "...", "request_id": "req_..." } ``` --- # Staff only Source: https://docs.wapitick.com/errors/staff_only Code `staff_only`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/staff_only", "title": "Staff only", "status": 403, "code": "staff_only", "detail": "...", "request_id": "req_..." } ``` --- # Blocked during a staff session Source: https://docs.wapitick.com/errors/staff_session_blocked Code `staff_session_blocked`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/staff_session_blocked", "title": "Blocked during a staff session", "status": 403, "code": "staff_session_blocked", "detail": "...", "request_id": "req_..." } ``` --- # Staff session expired Source: https://docs.wapitick.com/errors/staff_session_expired Code `staff_session_expired`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/staff_session_expired", "title": "Staff session expired", "status": 401, "code": "staff_session_expired", "detail": "...", "request_id": "req_..." } ``` --- # Not allowed in this state Source: https://docs.wapitick.com/errors/state_conflict Code `state_conflict`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/state_conflict", "title": "Not allowed in this state", "status": 409, "code": "state_conflict", "detail": "...", "request_id": "req_..." } ``` --- # Re-authentication required Source: https://docs.wapitick.com/errors/step_up_required Code `step_up_required`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/step_up_required", "title": "Re-authentication required", "status": 403, "code": "step_up_required", "detail": "...", "request_id": "req_..." } ``` --- # Tax id required Source: https://docs.wapitick.com/errors/tax_id_required Code `tax_id_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/tax_id_required", "title": "Tax id required", "status": 422, "code": "tax_id_required", "detail": "...", "request_id": "req_..." } ``` --- # Template checks failed Source: https://docs.wapitick.com/errors/template_lint_failed Code `template_lint_failed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/template_lint_failed", "title": "Template checks failed", "status": 422, "code": "template_lint_failed", "detail": "...", "request_id": "req_..." } ``` --- # Template is not approved Source: https://docs.wapitick.com/errors/template_not_approved Code `template_not_approved`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/template_not_approved", "title": "Template is not approved", "status": 422, "code": "template_not_approved", "detail": "...", "request_id": "req_..." } ``` --- # A template message is required Source: https://docs.wapitick.com/errors/template_required Code `template_required`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/template_required", "title": "A template message is required", "status": 422, "code": "template_required", "detail": "...", "request_id": "req_..." } ``` --- # Test mode only Source: https://docs.wapitick.com/errors/test_mode_only Code `test_mode_only`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/test_mode_only", "title": "Test mode only", "status": 403, "code": "test_mode_only", "detail": "...", "request_id": "req_..." } ``` --- # Not available in test mode Source: https://docs.wapitick.com/errors/test_mode_unsupported Code `test_mode_unsupported`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/test_mode_unsupported", "title": "Not available in test mode", "status": 403, "code": "test_mode_unsupported", "detail": "...", "request_id": "req_..." } ``` --- # Send a test first Source: https://docs.wapitick.com/errors/test_not_sent Code `test_not_sent`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/test_not_sent", "title": "Send a test first", "status": 422, "code": "test_not_sent", "detail": "...", "request_id": "req_..." } ``` --- # Test run required Source: https://docs.wapitick.com/errors/test_required Code `test_required`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/test_required", "title": "Test run required", "status": 409, "code": "test_required", "detail": "...", "request_id": "req_..." } ``` --- # Token expired Source: https://docs.wapitick.com/errors/token_expired Code `token_expired`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/token_expired", "title": "Token expired", "status": 401, "code": "token_expired", "detail": "...", "request_id": "req_..." } ``` --- # Token revoked Source: https://docs.wapitick.com/errors/token_revoked Code `token_revoked`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/token_revoked", "title": "Token revoked", "status": 401, "code": "token_revoked", "detail": "...", "request_id": "req_..." } ``` --- # Trust tier limit reached Source: https://docs.wapitick.com/errors/trust_tier_limit Code `trust_tier_limit`, HTTP 422. This is a plan, quota, balance or rate limit: upgrade, top up, or wait for `Retry-After`. ```json { "type": "https://docs.wapitick.com/errors/trust_tier_limit", "title": "Trust tier limit reached", "status": 422, "code": "trust_tier_limit", "detail": "...", "request_id": "req_..." } ``` --- # Bot check failed Source: https://docs.wapitick.com/errors/turnstile_failed Code `turnstile_failed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/turnstile_failed", "title": "Bot check failed", "status": 422, "code": "turnstile_failed", "detail": "...", "request_id": "req_..." } ``` --- # Authentication required Source: https://docs.wapitick.com/errors/unauthenticated Code `unauthenticated`, HTTP 401. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/unauthenticated", "title": "Authentication required", "status": 401, "code": "unauthenticated", "detail": "...", "request_id": "req_..." } ``` --- # Too late to undo Source: https://docs.wapitick.com/errors/undo_window_elapsed Code `undo_window_elapsed`, HTTP 409. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/undo_window_elapsed", "title": "Too late to undo", "status": 409, "code": "undo_window_elapsed", "detail": "...", "request_id": "req_..." } ``` --- # Unsafe link Source: https://docs.wapitick.com/errors/unsafe_link Code `unsafe_link`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/unsafe_link", "title": "Unsafe link", "status": 422, "code": "unsafe_link", "detail": "...", "request_id": "req_..." } ``` --- # Integration not supported Source: https://docs.wapitick.com/errors/unsupported_integration Code `unsupported_integration`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/unsupported_integration", "title": "Integration not supported", "status": 422, "code": "unsupported_integration", "detail": "...", "request_id": "req_..." } ``` --- # Unsupported media type Source: https://docs.wapitick.com/errors/unsupported_media_type Code `unsupported_media_type`, HTTP 415. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "detail": "...", "request_id": "req_..." } ``` --- # Upstream error Source: https://docs.wapitick.com/errors/upstream_error Code `upstream_error`, HTTP 502. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/upstream_error", "title": "Upstream error", "status": 502, "code": "upstream_error", "detail": "...", "request_id": "req_..." } ``` --- # Upstream timeout Source: https://docs.wapitick.com/errors/upstream_timeout Code `upstream_timeout`, HTTP 504. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/upstream_timeout", "title": "Upstream timeout", "status": 504, "code": "upstream_timeout", "detail": "...", "request_id": "req_..." } ``` --- # Upstream unavailable Source: https://docs.wapitick.com/errors/upstream_unavailable Code `upstream_unavailable`, HTTP 503. This is on our side or a provider's: retry with backoff; contact support with the `request_id` if it repeats. ```json { "type": "https://docs.wapitick.com/errors/upstream_unavailable", "title": "Upstream unavailable", "status": 503, "code": "upstream_unavailable", "detail": "...", "request_id": "req_..." } ``` --- # URL not allowed Source: https://docs.wapitick.com/errors/url_not_allowed Code `url_not_allowed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/url_not_allowed", "title": "URL not allowed", "status": 422, "code": "url_not_allowed", "detail": "...", "request_id": "req_..." } ``` --- # Validation failed Source: https://docs.wapitick.com/errors/validation_failed Code `validation_failed`, HTTP 400. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/validation_failed", "title": "Validation failed", "status": 400, "code": "validation_failed", "detail": "...", "request_id": "req_..." } ``` --- # The customer service window is closed Source: https://docs.wapitick.com/errors/window_closed Code `window_closed`, HTTP 422. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/window_closed", "title": "The customer service window is closed", "status": 422, "code": "window_closed", "detail": "...", "request_id": "req_..." } ``` --- # No access to this workspace Source: https://docs.wapitick.com/errors/workspace_forbidden Code `workspace_forbidden`, HTTP 403. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/workspace_forbidden", "title": "No access to this workspace", "status": 403, "code": "workspace_forbidden", "detail": "...", "request_id": "req_..." } ``` --- # Workspace required Source: https://docs.wapitick.com/errors/workspace_required Code `workspace_required`, HTTP 400. Fix the request (the `detail` and `errors[].pointer` say what) and send it again. ```json { "type": "https://docs.wapitick.com/errors/workspace_required", "title": "Workspace required", "status": 400, "code": "workspace_required", "detail": "...", "request_id": "req_..." } ```