# FireFlo OMNI

> One inbox, one set of contacts and one API for SMS, WhatsApp, RCS and voice — with batteries for AI agents, calendars, catalogues, customer data, pipelines and tickets.

- [FireFlo OMNI](https://omni.fireflo.au/index.md): What FireFlo OMNI is: one inbox, one set of contacts and one API for SMS, WhatsApp, RCS and Voice.
- [Concepts](https://omni.fireflo.au/get-started/concepts.md): The ideas OMNI is built on: accounts, resellers, plans and features, roles, modules, connections and consent.
- [Plans and roles](https://omni.fireflo.au/get-started/plans-and-roles.md): What each of OMNI's roles may do, how custom roles work, and how plans are built from features.
- [Quickstart](https://omni.fireflo.au/get-started/quickstart.md): A business's first hour with OMNI: connect a channel, add contacts, send a broadcast, answer replies and read the delivery report.
- [Developer quickstart](https://omni.fireflo.au/get-started/developer-quickstart.md): Make an API key, check it with GET /v1/me, send a message with POST /v1/messages, and receive your first webhook.
- [Finding your way](https://omni.fireflo.au/using/finding-your-way.md): How the OMNI panel is laid out: the menu, the account icons, your balance, notices and your own preferences.
- [Dashboard](https://omni.fireflo.au/using/dashboard.md): What the dashboard shows: messages sent, replies waiting, what needs attention, and how each channel is doing.
- [Inbox](https://omni.fireflo.au/using/inbox.md): How to read, sort, assign and answer conversations from every channel in one place.
- [Contacts](https://omni.fireflo.au/using/contacts.md): How to find, add, import, organise and export the people you message, with segments, fields and tags.
- [Contact page](https://omni.fireflo.au/using/contact-page.md): Everything about one person: what has passed between you, their fields, their activity, and whether they may be contacted.
- [Broadcasts](https://omni.fireflo.au/using/broadcasts.md): How to send one message to many people on any channel, schedule it, and follow how it went.
- [Delivery report](https://omni.fireflo.au/using/delivery-report.md): How to find any message on any channel, see whether it arrived, and export what you see.
- [Downloads](https://omni.fireflo.au/using/downloads.md): Where saved exports and campaign reports are kept, and how long they stay.
- [Billing](https://omni.fireflo.au/using/billing.md): Your prepaid balance, what you have sent this month, what each message costs, and every movement on the ledger.
- [Team and roles](https://omni.fireflo.au/using/team-and-roles.md): How to add people to your account, give them roles, and make roles of your own.
- [Plan and modules](https://omni.fireflo.au/using/plan-and-modules.md): What your plan includes, where your subscription stands, how to pay, and which channels and batteries your account has.
- [Branding](https://omni.fireflo.au/using/branding.md): How a reseller puts its own name, logo, colour and web address on the panel its customers use.
- [Resellers](https://omni.fireflo.au/using/resellers.md): How a reseller sets up customers, puts them on a plan, funds them, sets its markup and suspends them.
- [Channels](https://omni.fireflo.au/channels/overview.md): The four ways OMNI reaches people — SMS, WhatsApp, RCS and Voice — how each connects, what they all share, and what each battery adds on each one.
- [SMS](https://omni.fireflo.au/channels/sms.md): How to connect SMS, send to numbers, contacts and segments, read the SMS dashboard, and what SMS does with and without batteries.
- [Sender IDs and DLT](https://omni.fireflo.au/channels/sms-sender-ids-and-dlt.md): How to request SMS sender IDs and templates, how a message is matched against a template, and how India's DLT identifiers are added.
- [WhatsApp](https://omni.fireflo.au/channels/whatsapp.md): How to connect WhatsApp — on a number FireFlo hosts or your own WhatsApp Business Account — and how conversations, the 24-hour window, media, buttons and reactions work.
- [WhatsApp templates](https://omni.fireflo.au/channels/whatsapp-templates.md): How to submit WhatsApp message templates for Meta's approval, edit and delete them, and use them to start conversations and send broadcasts.
- [RCS](https://omni.fireflo.au/channels/rcs.md): How RCS reaches people with rich cards and buttons, how bots and routes by country decide who sends each message, and how to send RCS and read its figures.
- [RCS templates](https://omni.fireflo.au/channels/rcs-templates.md): How to write an RCS template — text, rich card, carousel or a message with a file — add buttons and variables, and get it approved by each bot you send through.
- [Voice](https://omni.fireflo.au/channels/voice.md): What Voice does — numbers, IVRs, click-to-call, voice broadcasts, voice agents and a call log with recordings — how to connect it, and what needs your own voice organisation.
- [Numbers and IVRs](https://omni.fireflo.au/channels/voice-numbers-and-ivrs.md): How to see your voice numbers, send each one's calls to an IVR, an extension or another number, design and publish IVRs, and ring someone into one.
- [Calls](https://omni.fireflo.au/channels/voice-calls.md): How to read the call log, listen to recordings and see what was said, call people from your phone, run voice broadcasts and have a voice agent call a contact.
- [Batteries](https://omni.fireflo.au/batteries/overview.md): What a battery is, the six batteries OMNI offers, and which channels each one works with.
- [AI Agents](https://omni.fireflo.au/batteries/ai-agents.md): How AI agents work in OMNI: roles, plans and approvals, workflows, stories, activity, usage and AI providers, and how agents share conversations with your team.
- [Knowledge](https://omni.fireflo.au/batteries/knowledge.md): How to give AI agents the FAQs, articles, files and web pages they answer from, and how to find and fill the gaps.
- [Calendar](https://omni.fireflo.au/batteries/calendar.md): How to use OMNI's shared calendar: booking types, team availability and time off, reminders on WhatsApp and SMS, and online booking with a one-time code.
- [Catalogue](https://omni.fireflo.au/batteries/catalogue.md): How to keep your products, prices, stock and pictures in OMNI, sync them to your WhatsApp catalogue, send them in messages and handle orders.
- [Customer data](https://omni.fireflo.au/batteries/customer-data.md): How OMNI's Customer data battery builds audiences and traits, finds and merges duplicate contacts, keeps consent per channel, and takes in events from your website and server.
- [Pipelines](https://omni.fireflo.au/batteries/pipelines.md): How to track deals in OMNI with pipelines: the board and list, a deal's page, stages, and the record of every change.
- [Tickets](https://omni.fireflo.au/batteries/tickets.md): How OMNI turns Inbox conversations into tickets — one per problem — with status, priority, categories and settings.
- [The OMNI API](https://omni.fireflo.au/developers/overview.md): One API for every channel and service in OMNI: one kind of key, one error shape, one stream of signed webhooks.
- [Keys and scopes](https://omni.fireflo.au/developers/keys-and-scopes.md): Live and test keys, what a key may do, where it may be used from, and how to retire one.
- [Errors](https://omni.fireflo.au/developers/errors.md): One shape for every refusal, the HTTP status that goes with it, and every code your program can branch on.
- [Conventions](https://omni.fireflo.au/developers/conventions.md): Idempotency, paging, rate limits, times and versions — the rules every endpoint follows.
- [API & playground](https://omni.fireflo.au/developers/playground.md): Every endpoint, run in the panel as one of your own keys, on your own data, with the code to take away.
- [Messages with failover](https://omni.fireflo.au/developers/messages-with-failover.md): One message to one person, tried on each channel of a route until one gets there — with routes, unified templates and every outcome told back.
- [Webhooks](https://omni.fireflo.au/developers/webhooks.md): One signed stream of events to your server: messages, every channel's deliveries and replies, and calls — how to receive them, check them, and what each carries.
- [Contacts and consent](https://omni.fireflo.au/developers/contacts-and-consent.md): Keeping OMNI's contacts in step with your own system: finding people by any number they've had, their fields and tags, and recording consent.
- [The Inbox through the API](https://omni.fireflo.au/developers/conversations.md): Reading conversations, replying, and organising them — closed, assigned, prioritised, labelled — as your team does in the Inbox.
- [Calls](https://omni.fireflo.au/developers/calls.md): The call log, and ringing someone into one of your IVRs or having a voice agent call them.
- [Channel extensions](https://omni.fireflo.au/developers/channel-extensions.md): Each channel's own features on the API, under /v1/channels/<channel>/: WhatsApp templates, SMS sender IDs and DLT templates.
- [API reference](https://omni.fireflo.au/api-reference/overview.md): Every endpoint of the OMNI API, with its scope, parameters, an example in three languages, the answer and the errors.
- [Scopes and events](https://omni.fireflo.au/api-reference/scopes-and-events.md): Everything a key can be allowed to do, and everything a webhook can be told.
- [GET /v1/me](https://omni.fireflo.au/api-reference/account/get-me.md): Which account and plan a key belongs to, and what the key may do.
- [GET /v1/events](https://omni.fireflo.au/api-reference/account/list-event-types.md): Every event a webhook endpoint can subscribe to, with what each means.
- [POST /v1/messages](https://omni.fireflo.au/api-reference/messages/send.md): Send one message to one person, trying each channel of a route until one gets there.
- [GET /v1/messages](https://omni.fireflo.au/api-reference/messages/list.md): The messages sent through the API, newest first.
- [GET /v1/messages/{message_id}](https://omni.fireflo.au/api-reference/messages/get.md): One message sent through the API, with every attempt on every channel.
- [POST /v1/messages/{message_id}/cancel](https://omni.fireflo.au/api-reference/messages/cancel.md): Stop a message that is still being tried, so no further channel is tried.
- [GET /v1/routes](https://omni.fireflo.au/api-reference/routes/list.md): Your routes, and what a message that names none is tried on.
- [POST /v1/routes](https://omni.fireflo.au/api-reference/routes/create.md): Add a route: the channels a message is tried on, in order.
- [GET /v1/routes/{route_id}](https://omni.fireflo.au/api-reference/routes/get.md): One route and its steps.
- [PATCH /v1/routes/{route_id}](https://omni.fireflo.au/api-reference/routes/update.md): Change a route's name, its steps or whether it is the default.
- [DELETE /v1/routes/{route_id}](https://omni.fireflo.au/api-reference/routes/delete.md): Remove a route.
- [GET /v1/templates](https://omni.fireflo.au/api-reference/templates/list.md): Your message templates, with the values each needs.
- [POST /v1/templates](https://omni.fireflo.au/api-reference/templates/create.md): Add a template: one message, written once per channel, with values to fill in.
- [GET /v1/templates/{template_id}](https://omni.fireflo.au/api-reference/templates/get.md): One message template.
- [PATCH /v1/templates/{template_id}](https://omni.fireflo.au/api-reference/templates/update.md): Change a template's name, note or channel versions.
- [DELETE /v1/templates/{template_id}](https://omni.fireflo.au/api-reference/templates/delete.md): Remove a message template.
- [GET /v1/contacts](https://omni.fireflo.au/api-reference/contacts/list.md): Your contacts, newest first, found by phone or filtered by name, number or tag.
- [POST /v1/contacts](https://omni.fireflo.au/api-reference/contacts/create.md): Add a contact, with their fields, tags, time zone and quiet hours.
- [GET /v1/contacts/{contact_id}](https://omni.fireflo.au/api-reference/contacts/get.md): One contact, with every number and identifier, their fields, tags and consent.
- [PATCH /v1/contacts/{contact_id}](https://omni.fireflo.au/api-reference/contacts/update.md): Change a contact's number, name, fields, tags, time zone or quiet hours.
- [POST /v1/contacts/{contact_id}/consent](https://omni.fireflo.au/api-reference/contacts/consent.md): Mark a contact never to be contacted, until a time or for good, or lift it.
- [GET /v1/conversations](https://omni.fireflo.au/api-reference/conversations/list.md): Inbox conversations, the most recently active first.
- [GET /v1/conversations/{contact_id}](https://omni.fireflo.au/api-reference/conversations/get.md): One conversation, with which channels can take a typed reply now.
- [PATCH /v1/conversations/{contact_id}](https://omni.fireflo.au/api-reference/conversations/update.md): Close or reopen a conversation, snooze it, assign it, set its priority or labels.
- [GET /v1/conversations/{contact_id}/messages](https://omni.fireflo.au/api-reference/conversations/messages.md): A conversation's messages on every channel, newest first.
- [POST /v1/conversations/{contact_id}/reply](https://omni.fireflo.au/api-reference/conversations/reply.md): Reply in a conversation, on the channel named or where a reply goes by default.
- [POST /v1/conversations/{contact_id}/read](https://omni.fireflo.au/api-reference/conversations/read.md): Mark a conversation read, sending read receipts where the channel has them.
- [GET /v1/senders](https://omni.fireflo.au/api-reference/senders/list.md): Everything your messages and calls can come from, on every channel you have.
- [GET /v1/calls](https://omni.fireflo.au/api-reference/calls/list.md): Your calls, newest first, whichever way they went.
- [GET /v1/calls/targets](https://omni.fireflo.au/api-reference/calls/targets.md): What a call can be placed into: your published IVRs and voice agents.
- [POST /v1/calls](https://omni.fireflo.au/api-reference/calls/place.md): Ring someone into one of your IVRs, or have a voice agent call them.
- [GET /v1/calls/{call_id}](https://omni.fireflo.au/api-reference/calls/get.md): One call: who, which way, how it ended, and what was said on it.
- [GET /v1/usage](https://omni.fireflo.au/api-reference/usage/get.md): What the account sent, received and called, its API use and what was charged.
- [GET /v1/webhooks](https://omni.fireflo.au/api-reference/webhooks/list.md): Your webhook endpoints.
- [POST /v1/webhooks](https://omni.fireflo.au/api-reference/webhooks/create.md): Add a webhook endpoint; the answer carries its signing secret, shown this once.
- [GET /v1/webhooks/{endpoint_id}](https://omni.fireflo.au/api-reference/webhooks/get.md): One webhook endpoint.
- [PATCH /v1/webhooks/{endpoint_id}](https://omni.fireflo.au/api-reference/webhooks/update.md): Change an endpoint's address, events or note, or pause it.
- [DELETE /v1/webhooks/{endpoint_id}](https://omni.fireflo.au/api-reference/webhooks/delete.md): Remove a webhook endpoint; nothing more is sent to it.
- [POST /v1/webhooks/{endpoint_id}/rotate-secret](https://omni.fireflo.au/api-reference/webhooks/rotate-secret.md): Make a new signing secret for an endpoint.
- [POST /v1/webhooks/{endpoint_id}/test](https://omni.fireflo.au/api-reference/webhooks/test.md): Send a webhook.test event to an endpoint now, and answer how it went.
- [GET /v1/webhooks/{endpoint_id}/deliveries](https://omni.fireflo.au/api-reference/webhooks/deliveries.md): The latest deliveries to an endpoint: each event, its answer and its tries.
- [GET /v1/channels/whatsapp/templates](https://omni.fireflo.au/api-reference/whatsapp/list-templates.md): Your WhatsApp message templates, with their approval status.
- [POST /v1/channels/whatsapp/templates](https://omni.fireflo.au/api-reference/whatsapp/submit-template.md): Submit a WhatsApp template for approval.
- [GET /v1/channels/whatsapp/templates/{template_id}](https://omni.fireflo.au/api-reference/whatsapp/get-template.md): One WhatsApp template, its parts and its approval status.
- [PATCH /v1/channels/whatsapp/templates/{template_id}](https://omni.fireflo.au/api-reference/whatsapp/edit-template.md): Change a WhatsApp template's body, footer or category.
- [DELETE /v1/channels/whatsapp/templates/{template_id}](https://omni.fireflo.au/api-reference/whatsapp/delete-template.md): Delete a WhatsApp template in this one language.
- [GET /v1/channels/sms/senders](https://omni.fireflo.au/api-reference/sms/list-senders.md): Your SMS sender IDs as registered at the gateway, with their status.
- [POST /v1/channels/sms/senders](https://omni.fireflo.au/api-reference/sms/request-sender.md): Ask for an SMS sender ID; it is pending until the gateway decides.
- [DELETE /v1/channels/sms/senders/{registration_id}](https://omni.fireflo.au/api-reference/sms/withdraw-sender.md): Withdraw a sender ID request nobody has decided yet.
- [GET /v1/channels/sms/templates](https://omni.fireflo.au/api-reference/sms/list-templates.md): Your DLT templates as registered at the gateway, with their status.
- [POST /v1/channels/sms/templates](https://omni.fireflo.au/api-reference/sms/request-template.md): Ask for a DLT template; it is pending until the gateway decides.
- [DELETE /v1/channels/sms/templates/{registration_id}](https://omni.fireflo.au/api-reference/sms/withdraw-template.md): Withdraw a DLT template request nobody has decided yet.
- [GET /v1/channels/sms/balance](https://omni.fireflo.au/api-reference/sms/balance.md): Your own SMS gateway's balance.
- [Get v1calls](https://omni.fireflo.au/api-reference/calls/get-v1calls.md): The account's calls, newest first, whichever way they went. Filter by direction (inbound or outbound), status (dialling, started, ended, failed or missed), kind, or contact (a contact's id).
- [Post v1calls](https://omni.fireflo.au/api-reference/calls/post-v1calls.md): Ring someone into one of your IVRs or have a voice agent call them (target from GET /v1/calls/targets). Screened like any message: refused with not_permitted when their consent doesn't allow it. Answers 202 with the call; its status moves on as it is answered and ends.
- [Get v1calls 1](https://omni.fireflo.au/api-reference/calls/get-v1calls-1.md): One call: who, which way, how it ended and how long it lasted, and for a voice agent's call what was said and its summary.
- [Get v1callstargets](https://omni.fireflo.au/api-reference/calls/get-v1callstargets.md): What a call can be placed into: your published IVRs, and on your own voice organisation your voice agents.
- [Get v1channelssmsbalance](https://omni.fireflo.au/api-reference/channels/get-v1channelssmsbalance.md): Your own SMS gateway's balance. On FireFlo's shared gateway there is none of yours to show: see /v1/usage for your account's.
- [Get v1channelssmssenders](https://omni.fireflo.au/api-reference/channels/get-v1channelssmssenders.md): Your SMS sender IDs as registered at the gateway, with their status: approved, pending, rejected or withdrawn.
- [Post v1channelssmssenders](https://omni.fireflo.au/api-reference/channels/post-v1channelssmssenders.md): Ask for a sender ID: sender_id (as the operator registered it), and optional label, note and tlvs (tag=value, comma separated). It is pending until the gateway decides.
- [Delete v1channelssmssenders](https://omni.fireflo.au/api-reference/channels/delete-v1channelssmssenders.md): Withdraw a sender ID request nobody has decided yet.
- [Get v1channelssmstemplates](https://omni.fireflo.au/api-reference/channels/get-v1channelssmstemplates.md): Your DLT templates as registered at the gateway, with their status. An SMS's text must fill one in where the gateway enforces them.
- [Post v1channelssmstemplates](https://omni.fireflo.au/api-reference/channels/post-v1channelssmstemplates.md): Ask for a DLT template: name, and body with {#var#} blanks where the text changes; optional note and tlvs. Pending until decided.
- [Delete v1channelssmstemplates](https://omni.fireflo.au/api-reference/channels/delete-v1channelssmstemplates.md): Withdraw a template request nobody has decided yet.
- [Get v1channelswhatsapptemplates](https://omni.fireflo.au/api-reference/channels/get-v1channelswhatsapptemplates.md): Your WhatsApp message templates with Meta's approval status. Filter by status: approved, pending, rejected, paused or disabled.
- [Post v1channelswhatsapptemplates](https://omni.fireflo.au/api-reference/channels/post-v1channelswhatsapptemplates.md): Submit a template for Meta's approval: name (lower case, digits and underscores), category (utility, marketing or authentication), language, body with {{1}}-style values, and optional header_text and footer. It is pending until Meta decides.
- [Get v1channelswhatsapptemplates 1](https://omni.fireflo.au/api-reference/channels/get-v1channelswhatsapptemplates-1.md): One WhatsApp template, its parts and its approval status.
- [Delete v1channelswhatsapptemplates](https://omni.fireflo.au/api-reference/channels/delete-v1channelswhatsapptemplates.md): Delete a template in this one language.
- [Patch v1channelswhatsapptemplates](https://omni.fireflo.au/api-reference/channels/patch-v1channelswhatsapptemplates.md): Change a template's body, footer or category. Meta reviews every edit: it is pending, and can't be sent, until approved again.
- [Get v1contacts](https://omni.fireflo.au/api-reference/contacts/get-v1contacts.md): Contacts, newest first; find one by phone (any number they have had), or filter by name, number or tag.
- [Post v1contacts](https://omni.fireflo.au/api-reference/contacts/post-v1contacts.md): Add a contact. A number another contact already has is refused with contact_exists, naming that contact.
- [Get v1contacts 1](https://omni.fireflo.au/api-reference/contacts/get-v1contacts-1.md): One contact, with every number and identifier, their fields, tags and consent.
- [Patch v1contacts](https://omni.fireflo.au/api-reference/contacts/patch-v1contacts.md): Change a contact. Fields given are set (null clears one); tags given replace theirs; a new phone keeps the old one as theirs.
- [Post v1contacts consent](https://omni.fireflo.au/api-reference/contacts/post-v1contacts-consent.md): Mark a contact never to be contacted (until a time, or for good), or lift it. Nothing is sent to them on any channel while it stands.
- [Get v1conversations](https://omni.fireflo.au/api-reference/conversations/get-v1conversations.md): Conversations, the most recently active first. Filter by state (open, snoozed or closed; open by default), channel, unassigned=true, unread=true, or q (a name, a number or words from a message).
- [Get v1conversations 1](https://omni.fireflo.au/api-reference/conversations/get-v1conversations-1.md): One conversation, with which channels may take a typed reply now (a WhatsApp conversation is open for 24 hours after the person last wrote) and where a reply goes if no channel is named.
- [Patch v1conversations](https://omni.fireflo.au/api-reference/conversations/patch-v1conversations.md): Close or reopen a conversation, snooze it, assign it to a team member by email (or null for nobody), set its priority, or set its labels by name.
- [Get v1conversations messages](https://omni.fireflo.au/api-reference/conversations/get-v1conversations-messages.md): A conversation's messages on every channel, newest first.
- [Post v1conversations read](https://omni.fireflo.au/api-reference/conversations/post-v1conversations-read.md): Mark a conversation read, sending read receipts on the channels that have them (WhatsApp's blue ticks).
- [Post v1conversations reply](https://omni.fireflo.au/api-reference/conversations/post-v1conversations-reply.md): Reply in a conversation, on the channel named or where a reply goes by default. Screened like a reply typed in the Inbox: refused with not_permitted when the person's consent doesn't allow it, and with channel_closed when the channel can't take typed text now. An AI agent on the conversation steps b…
- [Get v1events](https://omni.fireflo.au/api-reference/events/get-v1events.md): Every event a webhook endpoint can ask for, with what each means.
- [Get v1me](https://omni.fireflo.au/api-reference/me/get-v1me.md): The key's account and plan, and what the key may do: what an integration checks first.
- [Get v1messages](https://omni.fireflo.au/api-reference/messages/get-v1messages.md): Messages sent through the API, newest first; filter by reference or status.
- [Post v1messages](https://omni.fireflo.au/api-reference/messages/post-v1messages.md): Send one message to one person, trying each channel of a route in turn until one gets there. Answers 202: what happens next arrives as message.* events.
- [Get v1messages 1](https://omni.fireflo.au/api-reference/messages/get-v1messages-1.md): One message, with every attempt on every channel.
- [Post v1messages cancel](https://omni.fireflo.au/api-reference/messages/post-v1messages-cancel.md): Stop a message still being tried: no further channel is tried.
- [Get v1routes](https://omni.fireflo.au/api-reference/routes/get-v1routes.md): Your routes, and what a message that names none is tried on.
- [Post v1routes](https://omni.fireflo.au/api-reference/routes/post-v1routes.md): Add a route: the channels a message is tried on, in order, and what counts as done on each.
- [Get v1routes 1](https://omni.fireflo.au/api-reference/routes/get-v1routes-1.md): One route.
- [Delete v1routes](https://omni.fireflo.au/api-reference/routes/delete-v1routes.md): Remove a route.
- [Patch v1routes](https://omni.fireflo.au/api-reference/routes/patch-v1routes.md): Change a route's name, steps or whether it is the default.
- [Get v1senders](https://omni.fireflo.au/api-reference/senders/get-v1senders.md): Everything your messages and calls can come from, on every channel you have: SMS sender IDs (with their registration status), your WhatsApp number, RCS bots and voice numbers. Filter by channel or status. A channel whose provider can't be asked right now is named in unavailable, and the rest are sti…
- [Get v1templates](https://omni.fireflo.au/api-reference/templates/get-v1templates.md): Your templates, with the values each needs.
- [Post v1templates](https://omni.fireflo.au/api-reference/templates/post-v1templates.md): Add a template: one message, written once per channel, with {{values}}.
- [Get v1templates 1](https://omni.fireflo.au/api-reference/templates/get-v1templates-1.md): One template.
- [Delete v1templates](https://omni.fireflo.au/api-reference/templates/delete-v1templates.md): Remove a template.
- [Patch v1templates](https://omni.fireflo.au/api-reference/templates/patch-v1templates.md): Change a template's name, note or channel versions.
- [Get v1usage](https://omni.fireflo.au/api-reference/usage/get-v1usage.md): What the account sent and received on each channel (messages, and SMS parts), its calls and minutes, its API requests, its balance and what was charged — for this month, or from and to (YYYY-MM-DD, in the account's time zone, up to a year). by=day adds a row per day and channel.
- [Get v1webhooks](https://omni.fireflo.au/api-reference/webhooks/get-v1webhooks.md): Your webhook endpoints.
- [Post v1webhooks](https://omni.fireflo.au/api-reference/webhooks/post-v1webhooks.md): Add a webhook endpoint. The answer carries its signing secret, shown this once.
- [Get v1webhooks 1](https://omni.fireflo.au/api-reference/webhooks/get-v1webhooks-1.md): One webhook endpoint.
- [Delete v1webhooks](https://omni.fireflo.au/api-reference/webhooks/delete-v1webhooks.md): Remove an endpoint. Nothing more is sent to it.
- [Patch v1webhooks](https://omni.fireflo.au/api-reference/webhooks/patch-v1webhooks.md): Change an endpoint's address, events, note, or pause it.
- [Get v1webhooks deliveries](https://omni.fireflo.au/api-reference/webhooks/get-v1webhooks-deliveries.md): The latest deliveries to an endpoint: each event, its answer and its tries.
- [Post v1webhooks rotate secret](https://omni.fireflo.au/api-reference/webhooks/post-v1webhooks-rotate-secret.md): Make a new signing secret for an endpoint; deliveries are signed with it from now on.
- [Post v1webhooks test](https://omni.fireflo.au/api-reference/webhooks/post-v1webhooks-test.md): Send a webhook.test event to an endpoint now, and answer how it went.
- [Running OMNI for your customers](https://omni.fireflo.au/operators/overview.md): Who operators are, what the Platform section of the panel is, and what it lets you control for every account at once.
- [Customers](https://omni.fireflo.au/operators/customers.md): How to find any customer account, read where it stands, and change its product, trial, price, wallet, modules and status.
- [Products and plans](https://omni.fireflo.au/operators/products-and-plans.md): How to set up the products customers can be on — monthly price, trial, signup, seat limits and the channels and batteries each includes — and what a change does to the customers already on it.
- [Pricing](https://omni.fireflo.au/operators/pricing.md): How to set what each channel costs per country and kind of message, keep separate price lists for products and customers, and how a reseller's markup sits on top.
- [Channel connections](https://omni.fireflo.au/operators/channel-connections.md): How to set up the shared connection customers send through when they don't bring their own, test it, host WhatsApp numbers, run RCS bots and routes, and switch a channel off for everyone.
- [Modules](https://omni.fireflo.au/operators/modules.md): What the Modules page shows about the channels, batteries and OMNI API a deployment carries, how a module reaches customers, and how to switch one off for everyone or clear its data.
- [Domains and email](https://omni.fireflo.au/operators/domains-and-email.md): How to put a reseller's own web address live, set up the email server every message to customers goes through, open self-signup, and tell customers how to pay.
- [Resellers](https://omni.fireflo.au/operators/resellers.md): How resellers work from the operator's side: turning an account into one, funding it, and what it can do for its own customers with credit, markup, products and suspension.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.