Messaging ยท CONNECTIONSend and track email, SMS, WhatsApp, Apple Messages and voice through Bird, and manage contacts, templates, numbers, eSIMs and verification.
Explore 381 workflow actions for Bird, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Adds a brand to the workspace's watchlist so its figures appear next to your own.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Approves the named join requests, up to 50 in one call.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archiving is how you remove a contact property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assigns an existing, allocated eSIM to a subscriber in the same workspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds up to 1,000 contacts to an audience.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancels a scheduled, accepted, or sending broadcast.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancels a message that was scheduled with scheduled_at before it sends.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancels an order waiting for funds in charging.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Checks the sending IPs behind a sending domain against the blocklists receivers consult, and returns what is listed now plus the listings seen recently against each target.
Assesses up to 1,000 email addresses synchronously and returns one result per input in submission order.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Accepts up to 100 independent email messages and queues them for delivery.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends up to 100 independent SMS messages in one request.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a broadcast for a stored audience.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Accepts a real outbound call that runs a voice sequence after the recipient answers, starting at the selected entry node.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a contact in the workspace, identified by an email address, a phone number, or both; at least one is required.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Defines a custom property that contacts in the workspace can carry.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a gateway address for forwarding inbound calls to this trunk.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a mailbox.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends a new message from the mailbox's own address and starts a new conversation with it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns the number's serving and issuing networks, porting state, country, and line type.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Provisions a new Realtime app for the workspace and returns it with the initial key.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds an allow or block rule to the mailbox.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Registers a new sending domain and returns the DNS records to publish for it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Provisions a new SIP trunk for the workspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a verification and sends the recipient a one-time passcode.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Checks a passcode for a recipient and returns the outcome together with the verification's current state.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Registers a phone number as an outbound caller ID for the workspace and starts verification.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a WhatsApp group administered by one of your business numbers.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a keyword rule.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Manually adds a WhatsApp address to the suppression list with reason manual.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates an Apple Messages for Business record in your workspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a routing rule for one of your Apple Messages for Business brands.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Manually opens a suppression episode for a address, blocking every outbound path to it: operator and automated replies, API sends, typing indicators, and invitations.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates an audience in the workspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns a deliverability result, a delivery_confidence score, address characteristics, an assessment reason, and a suggested correction when available.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends an email to the recipients you list explicitly in to/cc/bcc.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds an email address to the suppression list, stopping all email to it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a template and its first editable draft.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates or returns the subscriber associated with a contact in this workspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a new inbound address.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a routing rule that delivers matching inbound mail on one of your domains to a mailbox, or drops it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a workspace keyword rule.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends one SMS to one recipient with exactly one content form: text, which requires category and from, or a stored template, which supplies its category.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stops a sender's messages to a subscriber, with reason manual, blocking every category including transactional.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates or updates up to 1,000 contacts in one request.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Advances an in-progress verification to the next channel in its plan and sends a fresh passcode there.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a draft broadcast.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a contact permanently and removes it from every audience it belongs to.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a mailbox.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Moves the message to the trash.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a preference, returning its key to having no record, as if nothing had ever been stated.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes the app: disconnects all clients and removes its keys and configuration.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a receive rule from the mailbox.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes the domain and revokes its sender authorization.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes the SIP trunk.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes the gateway.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Moves the conversation and all of its messages to the trash.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes the verified number.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently removes the webhook endpoint and stops all deliveries to it, including retries of earlier failed deliveries.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes the group at WhatsApp.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a rule you created.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a routing rule.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes an audience and its memberships.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes the selected suppression record.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes the template and all its versions.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Discards the draft's unsaved work: its content resets to what is currently published (or to a single empty language when nothing has been published yet), so the draft matches.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes an inbound address.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes an inbound route.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a rule you created.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Ends a suppression, so the sender reaches the subscriber again.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes one language from the template's draft, along with its content.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stops new and queued sends while retaining the account, Apple UUID, approval, credentials and history.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a new template by copying an existing one: one of your workspace templates, or a built-in system template (by its bird_ slug).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Ends the suppression, so the address can be messaged again.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Ends a manual suppression created by a user or API caller, retaining the episode and the time it ended.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns one broadcast, with its audience reference and counters.
Returns a live estimate of how many contacts the broadcast can reach, narrowing from everyone in its audience down to the ones the send would go to.
Returns a single contact, including its custom data values and the channels it can be reached on.
Returns a single contact property: its immutable key and type, the fallback value, and whether it is archived.
Returns one conversation, including closed conversations.
Returns one data package with its balance, validity, speed class, and status.
Returns the full Markdown content of a documentation page.
Returns a single leg at any point in its lifecycle.
Returns a single mailbox by ID.
Returns a single Apple Messages for Business message: its current status, the content it carries, and failure detail when it failed.
Returns a single message with its aggregate delivery status and per-state recipient counts.
Returns a single message in a conversation, including its extracted plain text.
Returns one template by its ID or slug: its lifecycle, the languages a send can currently resolve, a summary of where every language stands at Meta, and a pointer to the version.
Returns one notification you sent the agent, with what came of it: accepted while WhatsApp is still working on it, then success, skipped with WhatsApp's reason, or failed with.
Returns a single number order by id, including its current lifecycle state and, once completed, the number it produced.
Performs the same lookup as [Create a phone number lookup](/docs/api/reference/create-phone-number-lookup), with the number in the URL.
Returns one preference: the key it is about, the current statement on it, and the statement's provenance.
Returns a single Realtime app with its configuration and connection details (app_id, region).
Returns the parsed metadata for a received email: - Addresses.
Returns the parsed, decoded body of a received email as JSON: the html and text parts, each null when the message had no such part.
Returns the current paid period separately from package delivery and cancellation state.
Returns the domain with its capability statuses and every DNS record's current verification state.
Returns a single SIP trunk, including its Bird-assigned domain, its access control lists.
Returns a single gateway by ID.
Returns one version: the content of every language it holds and what its submission did with each.
Returns a single conversation.
Returns the original rendered HTML and plain-text body of a message in a conversation.
Returns the verified number with the given ID, including its verification status.
Returns one language of one version: its content blocks, what this version's submission did with it, and everything Meta holds about it: review outcome and category.
Returns one of the numbers your workspace can use for voice.
Returns one watched brand's figures for the period, together with how each mailbox provider treated its mail and how that compares with your own.
Returns one webhook endpoint's configuration and current delivery status, including its URL and subscribed event types.
Returns one WhatsApp Business Account your workspace has connected, addressed by either the id the account list reports (waa_ prefix) or the waba value WhatsApp reports for it.
Returns one group as it currently stands, including who is in it.
Returns one keyword rule, either one of Bird's own or one you created, with its effective_keywords and the reply it sends.
Returns a single WhatsApp message: its current delivery status, per-stage timestamps (sent_at, delivered_at, read_at), and failure detail when it failed.
Returns a WhatsApp number connected to the workspace and its state as of meta_synced_at.
Returns the business profile WhatsApp shows to people this number messages, read from WhatsApp on each request rather than from a stored copy.
Returns the suppression record for the given ID, including one that has already ended.
Returns one aggregate row of Apple Messages for Business conversation lifecycle counts (started, reopened, closed, conversations) for the requested period.
Returns a single-row aggregate across the requested period covering delivery, bounce, complaint, open, and click counts plus the derived rates, along with processing, delivery.
Returns one aggregate row of inbound Apple Messages for Business counts for the requested period.
Returns the total number of messages your numbers received over the period, using the time the carrier received each message.
Returns the total number of WhatsApp messages your business numbers received over the period, using the time each message reached your number.
Returns one aggregate row of outbound Apple Messages for Business counts and latency percentiles (p50, p95, and p99) for the requested period.
Returns one aggregate row for the requested period.
Returns one aggregate row for the requested period.
Returns a single phone number allocated to your workspace, whether it is a dedicated number you bought or a shared number managed for you.
Returns your workspace's Apple Messages for Business record, including its current status with Apple.
Returns one routing rule by ID.
Returns the suppression episode for the given ID, including one that has already ended.
Returns a single audience: its name, description, and type.
Returns a single phone number available for purchase, whether it is already in inventory or can be acquired for you.
Performs the same deliverability lookup as [Create an email address lookup](/docs/api/reference/create-email-lookup), with the address in the URL.
Returns one suppression record: - The address.
Returns a template's metadata, language states, sendable languages, draft revision, and draft and published version IDs.
Renders a template with the sample values you supply and returns the resulting subject, HTML, and plain-text bodies.
Returns a single version of an email template: - Its lifecycle metadata (status, version_number, published_at).
Returns one eSIM: lifecycle status, device installation state, current data packages with balances, service-period timestamps, and the most recent network attachment.
Returns the assigned person.
Returns one coverage zone with its authoritative country list.
Returns one eSIM offer with its pricing and embedded coverage zone.
Returns the contact reference for a subscriber in this workspace.
Returns a single inbound address: the address you forward a mailbox to, and the label you gave it.
Returns a single inbound route: - Its match rule.
Returns one order.
Returns one keyword rule, either one of Bird's defaults or one you created, including every keyword that matches it and the reply it sends.
Returns a single SMS message: its current delivery status, segment breakdown, cost, and failure detail when it failed.
Returns one suppression: the sender and subscriber it covers, why messages are stopped, how the record came to exist, what it blocks, and whether it is still in force.
Returns one SMS template's metadata, policies, language states, draft revision, and draft and live version IDs.
Returns one version with its variables and text in every language.
Returns one language's full text, revision, content hash, and update time.
Returns the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page.
Returns bounce counts for the requested period, grouped by the SMTP error code the receiving mail server returned.
Returns spam-complaint counts for the requested period, grouped by the feedback-loop complaint type the mailbox provider reported, for example abuse, fraud, or virus.
Returns identification guidance as a JSON Schema for each country in the offer's coverage zone.
Returns one row of Apple Messages for Business conversation lifecycle counts (started, reopened, closed, conversations) per calendar day for the workspace, gap-filled so a.
Returns one row of inbound Apple Messages for Business counts per calendar day for the workspace, gap-filled so a silent day is a zero row rather than a missing one.
Returns the number of messages your numbers received, one row per calendar day.
Returns the number of WhatsApp messages your business numbers received, one row per calendar day.
Returns one row of outbound Apple Messages for Business counts and processing-latency percentiles per calendar day for the workspace, gap-filled so a silent day is a zero row.
Returns one row of SMS lifecycle counts per calendar day.
Returns one row of aggregate WhatsApp statistics per calendar day for the workspace.
Returns one row of aggregate sending statistics per calendar day for the workspace: UTC days by default, or your local days when timezone is set.
Searches the documentation and returns matching sections, best match first.
Returns whether the domain's mail authenticates and who sends as the domain: SPF and DKIM pass rates, the DMARC standing with its published policy and a conservative.
Returns engagement counts (opens and clicks) for the requested period, grouped by the email client, operating system, or device type they were recorded from.
Returns engagement counts (opens and clicks) for the requested period, grouped by the location they were recorded from.
Returns published one-time terms and automatic renewal availability for a new eSIM.
Returns one row of Apple Messages for Business conversation lifecycle counts (started, reopened, closed, conversations) per hour, gap-filled so a silent hour is a zero row.
Returns one row of inbound Apple Messages for Business counts per hour, gap-filled so a silent hour is a zero row rather than a missing one.
Returns the number of messages your numbers received, one row per hour.
Returns the number of WhatsApp messages your business numbers received, one row per hour.
Returns one row of outbound Apple Messages for Business counts and processing-latency percentiles per hour, gap-filled so a silent hour is a zero row rather than a missing one.
Returns one row of SMS lifecycle counts per hour.
Returns one row of WhatsApp lifecycle counts per hour.
Returns one row of aggregate sending statistics per hour for the workspace: UTC hours by default, or your local hours when timezone is set (a timezone with a sub-hour offset.
Returns how much of the broadcast the organization's email send allowance covers, so a send that would run past it can be reconsidered rather than failing part-way.
Returns inbound received counts grouped by business, for the requested period.
Returns inbound received counts grouped by entry-point intent, for the requested period.
Returns the number of messages your numbers received, grouped by the receiving number's country.
Returns how many messages each of your numbers received.
Returns the number of messages your numbers received, grouped by the sender's mobile operator.
Returns how many WhatsApp messages each of your business phone numbers received.
Returns where a sending domain's measured mail landed over the period (inbox or spam): the domain-wide rates, a per-provider table, a time series, the Gmail tab split, and.
Returns the mailbox's sent and received email statistics over a time window: a period-wide summary plus a bucketed series.
Returns one campaign an email panel observed a watched brand sending.
Returns one language's content from a version (its subject and bodies) plus the revision to send back when saving it.
Returns outbound counts and latency percentiles grouped by business, for the requested period.
Returns outbound counts and latency percentiles grouped by message category, for the requested period.
Returns outbound counts and latency percentiles grouped by failure reason, for the requested period.
Returns outbound counts and latency percentiles grouped by entry-point group, for the requested period.
Returns outbound counts and latency percentiles grouped by entry-point intent, for the requested period.
Returns outbound counts and latency percentiles grouped by message content kind, for the requested period.
Returns outbound counts and latency percentiles grouped by tag (name or name:value), for the requested period.
Returns aggregate delivery and latency stats grouped by delivery carrier for the requested period.
Returns aggregate delivery and latency stats grouped by message category for the requested period.
Returns aggregate delivery and latency stats grouped by destination country for the requested period.
Returns aggregate delivery and latency statistics grouped by normalized failure reason for the requested period.
Returns aggregate delivery and latency stats grouped by originator (the sender address messages were sent from) for the requested period.
Returns one row per lifecycle status with activity in the requested period, ordered by count descending.
Returns delivery and latency statistics grouped by tag (name:value).
Returns delivery counts, read engagement and latency grouped by the recipient's destination country.
Returns the count of failed WhatsApp messages grouped by normalized failure reason for the requested period.
Returns delivery counts grouped by business phone number, including whether each is platform-managed or customer-owned.
Returns lifecycle counts and delivery rates for WhatsApp messages grouped by tag (name:value) for the requested period.
Returns lifecycle counts and delivery rates for WhatsApp messages grouped by the template they were sent from, for the requested period.
Returns lifecycle counts and delivery rates for WhatsApp messages grouped by template category for the requested period.
Returns the published whole-package recurring price and calendar-month or fixed-day cadence.
Returns the seed tests run for a sending domain over the period, newest first, together with the newest test's full results and the organization's seed-test allowance for the.
Returns daily send volume for the watched brands you name, plus a line for your own sending, over one shared axis.
Returns your workspace's sending-health verdict for the requested window, together with reference deliverability limits and the boundaries used to classify risk.
Returns the spam-trap hits recorded against a sending domain over the period: the total, a split by the kind of trap, a split by the trap network that observed them, and the.
Returns aggregate delivery and engagement counts grouped by broadcast for the requested period, so each broadcast's deliverability and engagement can be compared side by side.
Returns delivery and engagement counts for the requested period, grouped by category, so you can compare deliverability and engagement between your transactional and marketing.
Returns delivery, engagement, and deliverability counts for the requested period, grouped by recipient mailbox provider, for example gmail, yahoo, microsoft, or apple.
Returns delivery, engagement, and deliverability counts for the requested period, grouped by mailbox provider and provider region pair, for example gmail in NA or microsoft in EU.
Returns delivery and engagement counts for the requested period, grouped by recipient mailbox domain: the part of each recipient address after the @, for example gmail.com.
Returns delivery, engagement, and deliverability counts for the requested period, grouped by sending domain: the portion of the From address after the @.
Returns delivery and deliverability counts for the requested period, grouped by the specific IP address used to send each message.
Returns delivery and engagement counts for the requested period, grouped by tag.
Returns aggregate delivery and engagement counts grouped by the template each message was sent with, so a template's deliverability and engagement can be compared side by side.
Returns the stored HTML and text bodies for a sent message.
Returns a page of campaigns an email panel observed a watched brand sending over the period, in the requested order.
Returns what a new seed test can be configured with for a sending domain: the seed pools the account can use, the regions seeds can be placed in, and the engagement behaviours.
Returns every competitor brand on the workspace's watchlist, plus a row for your own sending, each with estimated send volume and how it changed against the previous period, how.
Returns the workspace the current credentials are scoped to: its ID, name, the ID of the organization that owns it, and its notification and logo settings.
Returns how often the domain's mail is reported as spam by Gmail recipients, as Google Postmaster measures it: the rate for the period and a time series for charting.
Returns how senders in a sending domain's industry place: the median inbox rate across the industry's measured senders, how many senders that median covers, and the industry the.
Returns the campaigns worth a second look across every brand the workspace watches, surfaced for what they did rather than for when they were sent.
Returns the voice settings for your workspace.
Returns how a watched brand's sending is spread across the week: one figure per weekday and hour of the day, over the last 90 days, with the hour of the day it sends most of its.
Returns the destination URLs a broadcast's recipients clicked, grouped by URL and sorted by click count.
Returns the preferences on record for the contact's current handles: rows keyed to their email address on the email channel, and to their phone number on SMS and WhatsApp.
Returns the labels available in a mailbox.
Returns the messages in a mailbox across all of its conversations, newest first.
Returns metadata for each attachment on a received email: - The attachment_id.
Returns the gateway addresses used to forward inbound calls to this trunk, ordered by priority.
Returns the template's versions, newest first.
Returns the attachments on a message in a conversation.
Returns every language the version holds, ordered by language tag, without the content itself, so listing a template with twenty-five languages stays small.
Returns every language a version holds, without content: each language's tag, what this version's submission did with it, its write counter, and a hash over its content.
Returns the join requests still waiting for a decision, oldest first.
Lists the contacts in a static audience as a cursor page, ordered by the time each contact joined the audience, most recent first.
Returns the credential deliveries sent for this eSIM, newest first (the most recent 50), each with its outcome.
Returns the eSIM's data packages with per-zone balances, validity, and status, newest first and in full: an eSIM holds at most package_limit concurrent packages.
Returns the languages a version holds, ordered by canonical language tag, without their text.
Returns a cursor-paginated version history, newest first.
Returns account activity with event time, summary and source metadata, newest first by default.
Returns a paginated list of your workspace's Apple Messages for Business records.
Returns the workspace's Apple Messages for Business routing rules, highest precedence first.
Returns review attempts with frozen evidence for this business, newest first, with fresh private evidence URLs.
Returns a paginated list of the workspace's active Apple Messages for Business suppressions: customers who have opted out of one brand, or of the whole workspace.
Returns a paginated list of audiences in the workspace, newest first.
Returns the WhatsApp message templates available to your workspace: both the workspace's own templates (scope: workspace) and our built-in, Meta-approved templates (scope.
Returns phone numbers available for purchase in a country.
Returns a paginated list of broadcasts in the workspace, newest first.
Returns a paginated list of the workspace's contact properties, newest first.
Returns a paginated list of contacts in the workspace, newest first.
Returns the conversations your business has with customers on Apple Messages for Business, newest first by last message.
Returns the endpoint's recent delivery attempts, newest first.
Returns the domain's activity history, newest first by default: - Registration.
Returns the workspace's suppressed email addresses as a paginated list, newest first.
Returns the template's versions as a cursor page (the current draft plus all published versions), newest first.
Returns a paginated list of email templates, newest first.
Returns the coverage zones behind the offer catalog as a cursor-paginated list.
Returns the eSIM offers your workspace can order as a cursor-paginated list.
Returns person references in this workspace, newest first.
Returns your workspace's eSIMs as a cursor-paginated list, newest first.
Returns the per-recipient delivery timeline for a broadcast, oldest first, as a cursor page.
Returns a message's lifecycle events in chronological order, one entry per status transition (amb.accepted, amb.sent, amb.send_failed, amb.received).
Returns the message's per-recipient event timeline, oldest first, as a cursor page.
Returns a WhatsApp message's lifecycle events in chronological order, one entry per delivery transition (whatsapp.accepted, whatsapp.sent, whatsapp.delivered, whatsapp.read.
Returns the lifecycle event timeline for a message, in chronological order.
Returns a paginated list of the workspace's inbound addresses.
Returns a paginated list of the workspace's inbound routes in evaluation order, lowest priority number first.
Returns a paginated list of the workspace's legs, ordered by start time descending.
Returns a paginated list of the workspace's mailboxes, newest first.
Returns your business's Apple Messages for Business messages across conversations, newest first, both received and sent.
Returns the workspace's sent and scheduled messages, newest first, as a cursor page.
Returns the messages in a conversation, newest first, both received and sent.
Returns the messages in a conversation, newest first, both received and sent.
Returns offers currently compatible with this eSIM's network, package capacity, and existing packages.
Returns the workspace's orders as a cursor-paginated list, newest first.
Returns the workspace's recorded preferences, most recently created first.
Returns the changes made to this message's reactions as a cursor-paginated list, newest first: each emoji placed, each one replaced by a different emoji, and each one taken back.
Returns the workspace's Realtime apps as a paginated list, filterable by a case-insensitive name substring.
Returns the regions a Realtime app can be created in.
Returns a paginated list of the mailbox's receive rules, oldest first.
Returns a paginated list of received emails for the workspace, newest first.
Returns recipient-level delivery state for a broadcast, paginated.
Returns the message's per-recipient delivery state as a cursor page: each entry is one to/cc/bcc recipient with its role, current status, rejection or bounce detail when.
Returns funded periods with their original charges, confirmed credits, and delivery orders.
Returns recurring services for assigned eSIMs in this workspace.
Returns all sending domains for the current workspace, newest first by default.
Returns a page of sending domains this workspace can report on, in alphabetical order by default, and whether Inbox Insights is switched on for each.
Returns the workspace's SIP trunks as a paginated list, each with its assigned domain and access control lists.
Returns the default and workspace keyword rules that apply to inbound messages, most specific first.
Returns the workspace's SMS messages as a cursor-paginated list, newest first.
Returns the suppressions currently stopping your messages, most recent opt-out first.
Returns SMS templates as a cursor-paginated list.
Returns the SMTP send-option configs stored for API keys in this workspace, as a cursor page.
Returns the broadcasts that block deleting this template, as a cursor page, newest first.
Returns the notifications you have sent your agents, newest first, each with what came of it.
Lists the phone numbers your workspace can use for voice: the voice-capable numbers we allocated to you, and the numbers from other carriers you registered and verified.
Returns a paginated list of conversations across the workspace's mailboxes, most recently active first.
Returns a paginated list of the workspace's verified numbers and their verification status.
Returns every country the Voice service supports, each annotated with whether your workspace has enabled calling to it, whether the platform supports calling it (status), and.
Returns the workspace's webhook endpoints as a cursor-paginated list, newest first by default.
Returns a paginated list of the WhatsApp Business Accounts your workspace has connected, so you can choose which one a template belongs to.
Returns the WhatsApp groups your workspace created as a cursor-paginated list, newest first.
Returns the keyword rules that apply to inbound messages, most specific first.
Returns the workspace's WhatsApp messages as a cursor-paginated list, newest first, outbound and inbound alike.
Returns the number's activity history, newest first by default: - The number being added, and every change of its status.
Returns a paginated list of the WhatsApp numbers your workspace can send from.
Returns a paginated list of the WhatsApp addresses the workspace is currently suppressing.
Returns a paginated list of the phone numbers currently allocated to your workspace, newest first.
Returns your workspace's number orders, newest first.
Marks an inbound WhatsApp message as read, showing the contact the blue ticks.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pins one of the group's messages at the top of its chat, where it stays for the number of days you give, from 1 to 30.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns selected delivery, engagement, and latency metrics for the workspace.
Places an emoji reaction on a message this workspace received, the same way tapping and holding a message in WhatsApp does.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restores the local connection.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Records one statement, a grant or an opt-out, for a handle on one channel.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Registers a seed test for a sending domain and returns the seed addresses it measures.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rejects the named join requests, up to 50 in one call.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes the link tracking configuration from this domain and releases the claim on its tracking subdomain, so another organization can configure the same hostname.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Takes a brand off the workspace's watchlist and frees its place in the organization's allowance.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes one person from the group.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Takes back the reaction this workspace placed on a message, the same way tapping your own reaction in WhatsApp does.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Queues redelivery of deliveries that failed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends a reply to a specific message in a conversation, from the mailbox's own address.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restores receiving and access to unexpired messages.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resumes a mailbox that was suspended because the organization dropped below the plan needed to keep it active.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resumes a suspended eSIM so it can use data again.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Makes an earlier published version the live version used by sends, and replaces the draft with that version's content so editing continues from it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Searches for brands by name and returns the ones that can be watched, each with the domain its figures would describe and the identifier to add it with.
Sends a draft or scheduled broadcast, either immediately or at scheduled_at.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a message in an existing Apple Messages for Business conversation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends a typing indicator to the customer's device on this conversation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends one WhatsApp message to one recipient.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Tells the agent on the from business number that something happened in your systems for one contact, such as a payment landing, an order shipping or an identity check passing.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends a hosted installation link by email or SMS.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Emails the domain's current DNS records to up to three recipients, so a colleague who manages your DNS can publish them without an account.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Submits an account for review, making its name, Apple UUID and three uploaded evidence attachments available to Bird staff.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Submits the template's draft as a new immutable, numbered version and makes it the live version used by sends.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Suspends the eSIM's data service, for example during a payment dispute or a suspected-fraud hold.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Switches Inbox Insights on for the workspace's main sending domain, so a workspace opening the product for the first time has something to read without having to pick a domain.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes the workspace's monitoring preference for one of its verified sending domains.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends a signed synthetic event and returns whether your endpoint accepted it, its HTTP status, and the round-trip latency.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restores an archived contact property with its stored values.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a contact's membership in an audience.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes up to 1,000 contacts from an audience.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Takes the message off the top of the group's chat before its pin would have expired.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a draft or scheduled broadcast.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a contact.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a contact property's fallback value, the only mutable field.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates assignment, labels, inbox status, queue, or shared workspace read state, or settles a pending routing_change.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a mailbox.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Applies read-state, label, and contact changes to a message in a conversation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a Realtime app's name and configuration flags.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates settings and configuration on a sending domain.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a SIP trunk's name, access control (ip_acls, allowed_api_key_ids), and Digest algorithm offer (digest_algorithms).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the gateway's sip_uri, its priority, either number format, or any combination.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Applies label changes to a conversation, and links or unlinks a contact.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the verified number's label.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes what you have said about this number: the label you gave it, and what happens when a call arrives for it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes what participants see at the top of the group: its subject, its description, and its picture.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes the reply or the added keywords of a rule you created.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the name and reference for a number allocated to your workspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes your workspace's Apple Messages for Business record.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes a routing rule's business, match, queue, precedence, or default status.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates an audience's name or description.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a template's metadata and draft settings, such as its name or default language.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the eSIM's display name, tags, or metadata.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the label on an inbound address.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates an inbound route.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes the reply or the added keywords of a rule you created.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes the channel settings for your workspace's Apple Messages for Business record.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Enables or disables specific destination countries for your workspace, and sets or removes their daily spend limits.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes part of one language's content on the template's draft: send only the fields you are changing and the rest keep their current values.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Applies partial changes to your workspace's eSIM settings and returns the effective result.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Changes your workspace's voice settings.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Saves one language's content on the template's draft, creating that language if the draft does not have it yet and replacing it in full if it does.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Runs a fresh DNS check across the domain's records (DKIM, return path, DMARC, tracking, inbound MX, and any staged changes) and returns the updated domain.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Completes the number ownership verification challenge that registering the number started.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in Bird. A saved workflow is not a completed provider action.
