API reference
Every endpoint of the Wapitick API (version 0.0.0), generated from the OpenAPI document.
Base URL https://api.wapitick.com. Authenticate with Authorization: Bearer <key>. JSON in, JSON out; errors are
RFC 9457 problem+json (Errors); lists use limit + cursor; send Idempotency-Key on writes.
- ad-accounts: Connect and monitor the customer's Meta ad account: health, pages, budgets, spend.
- ads: Simple Ads: campaign wizard, targeting, estimates, publish, budgets, insights, attribution.
- agency: Client approvals, handover and per-client billing for agencies.
- ai-assistants: Customer-facing AI Assistants: business-scoped, disclosed, with human handoff.
- ai-disclosure: Telling customers they are talking to an AI, per workspace and per language.
- ai-provenance: Synthetic-content labels and provenance, AI image generation, AI disclosure texts.
- analytics: Funnels and outcome metrics.
- api-keys: Create, rotate, revoke and inspect API keys.
- approvals: Approval rules and requests.
- asset-safety: Health card that shows whether the Business can be locked out or hijacked.
- assistant-facts: Structured facts with expiry, season rollover and assistant routing.
- audit-log: Who did what, when: actor, action, resource, IP and diff.
- auth: Sign-in, sessions, step-up and the current caller.
- automation-apps: Zapier, Make and n8n trigger/action mapping.
- billing: Spend forecast, thresholds and caps.
- bookings: Bookings.
- business-hours: Working hours, holidays, quiet hours and what happens outside them.
- calls: Call log, transcripts, recordings, transfers and call permissions.
- capi: Conversions API events for click-to-message ads.
- carts: Abandoned carts and checkouts, recovery sequences and what the recovery actually earned.
- catalog-sync: Shopify / WooCommerce to our catalog to the Meta catalog.
- catalogs: Product catalogs (manual, CSV, Shopify, WooCommerce, Meta) and collections.
- channels: Connected channels: WhatsApp, Instagram, Messenger, Pages, Threads, voice numbers.
- client-errors: Web client error reports (feeds the staff issue tracker).
- client-portal: Public, token-based client approval pages.
- comments: Comments and replies on Instagram, Facebook Page and Threads posts.
- connectors: Connector packages and their health.
- consent-forms: Opt-in widgets, QR codes and web forms.
- consent-ledger: Proof of marketing consent per contact and channel, and do-not-contact lists.
- contact-exports: Owner-only, step-up, watermarked exports.
- contact-imports: CSV imports with opt-in attestation.
- contacts: Customers: identities, consent, tags, stages, merge, erase.
- conversations: Inbox conversations: assignment, status, notes, labels, AI mode.
- copilot: AI Copilot: runs (WCP/1 SSE), previews, confirmations, approvals tray, limits.
- copilot-parity: Operations behind Copilot tools: SLA views, auto-replies, post repurposing, reach estimates, analytics comparisons, scheduled reports, tool search.
- csat: Satisfaction surveys, responses and reports.
- custom-fields: Custom contact field definitions.
- developers: Request log, usage and limits, live event stream.
- discounts: Discount codes in the connected store.
- documents: Private document delivery and structured document intake.
- dues: Scheduled dues.
- events: Event log (30-day polling fallback), event types and samples.
- exports: Bulk exports (contacts, conversations, audit log, leads, orders, all data) behind step-up.
- flows: WhatsApp Flows library: install, map, publish, preview.
- helper-runs: Executions of helpers with per-step input, output, error and duration.
- helpers: Automations: triggers, steps, versions, test mode and go-live.
- home: The Home briefing, navigation counts, realtime topics and the Settings overview.
- inbox: Saved views: order and per-role defaults.
- integrations: Connected apps.
- invites: Invite staff by phone or email.
- invoices: GST invoices, PDFs and credit notes.
- ivr: Visual IVR menus, versions, simulation and activation.
- knowledge: Knowledge sources for AI Assistants: websites, pages, files, FAQs, catalogs; hybrid retrieval.
- labels: Conversation labels.
- lead-forms: Meta instant forms for lead ads.
- leads: Lead Ads leads: list, qualify, convert into a WhatsApp chat.
- library: Curated library items you can copy into a Business as editable drafts.
- links: Tracked short links: make a link, share it, see its clicks.
- marketing: Pause and resume all scheduled marketing in one tap.
- media: Media library: signed uploads, scan, renditions, signed read URLs.
- members: Organisation members, roles and permissions.
- messages: Send and read messages on every channel through one policy-checked pipeline.
- misc: Changelog, feedback and locales.
- modules: Module and connector on/off toggles per Business.
- notifications: In-app notifications, unread badge and delivery preferences.
- oauth: OAuth 2.1 authorization server for the public API and the MCP server.
- oauth-apps: Register and manage the OAuth clients your organisation owns.
- offers: Broadcast offers: test to self, 60 s undo, throttled sending, reports.
- onboarding: Service-selection onboarding, checklist, trial and readiness.
- orders: Chat, assistant, WhatsApp-cart and store orders with totals computed server-side, COD confirmation and prepaid conversion.
- orgs: Accounts, agency client orgs and access grants.
- owner-companion: Owner briefing and anomaly alerts.
- packs: Vertical packs: ready messages, helpers, AI preset, pipeline and dashboard in one install.
- partners: Partner profile, referrals, commissions and payouts.
- payments: Payment links, UPI QR, evidence (claimed vs verified), refunds, settlements.
- pipeline-stages: Sales pipeline stages.
- plans: Plans, regional prices, entitlements and add-ons.
- post-targets: Per-channel status of a post, retry and cancel.
- posts: Compose, schedule and publish posts to Instagram, Facebook Pages and Threads.
- privacy: Opt-out keywords, data requests (DSR) and the public privacy page.
- products: Catalog products: price, stock, bulk upsert and product messages.
- public: Endpoints the website visitor's browser calls directly.
- public-pages: Your public booking, catalogue and review pages.
- quick-replies: Saved replies with shortcuts.
- recovery: Lost SIM / phone change recovery with a cooling-off period.
- review-requests: Ask customers for a Google review, the compliant way.
- search: Search contacts, conversations, messages, templates, helpers, posts, offers and products.
- segments: Dynamic (rule) and static (list) segments.
- shopify-app: Shopify App Store install, webhooks and billing.
- sla: Reply-time commitments, the breach queue and response-time reports.
- sla-policies: First-response and resolution targets.
- slack: Slack interactivity and slash commands.
- social-channels: Instagram, Facebook Page and Threads channels.
- staff-sessions: Wapitick support access to your account: see, approve, end.
- status: Public system status, incidents, banner and per-organisation health.
- subscriptions: Current subscription, plan changes with proration, cancel/resume, add-ons, coupons.
- support: Talk to a person, assisted setup, callbacks and the reply thread.
- suppressions: Opt-out / suppression list.
- switching: Move in from another WhatsApp provider: import your data, then move the number.
- system: Liveness, readiness and version.
- tags: Contact tags.
- tasks: Staff follow-ups and 'My day' (open, overdue, snoozed, done, cancelled).
- teams: Routing teams.
- templates: Message templates: draft, lint, pre-submission check, submit, sync.
- test-mode: Test mode: magic numbers, simulated inbound messages and test recipients.
- trust: Your account's trust level, sending limits, policy notices and appeals.
- usage: Usage summaries and raw usage events.
- verification: Business verification, outbound link scanning and the domain allowlist (anti-scam).
- voice: Call answering: voices, previews and draft settings.
- wa-accounts: WhatsApp accounts: billing route, estimated Meta balance, payment health.
- wallets: Prepaid wallets, ledger, top-ups, auto top-up and low-balance alerts.
- webhook-deliveries: Delivery log and redelivery.
- webhook-endpoints: Outbound webhook endpoints, secrets, test and replay.
- webhooks-inbound: Inbound provider webhooks captured by the API.
- websites: Put Wapitick on a website: installs, embeddables, install checks, QR codes.
- whatsapp-calling: Voice calls inside WhatsApp: settings, call permission, starting a call.
- whatsapp-groups: WhatsApp groups: create, manage, invite link, join requests, participants.
- whatsapp-identity: The business's WhatsApp username and the verified-badge application.
- widgets: Website chat widgets and their embed snippet.
- workspaces: Businesses: profile, settings, business hours and limits.
- Webhooks: every event and its payload