# 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](/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
