Send a message

Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567), (2) email address, (3) group ID (grp_xxxx), or (4) comma-separated list of phone numbers/emails for multi-recipient group chats (e.g., +15551234567,+15559876543). All values should be URL-encoded.

Unique key to prevent duplicate message sends. If the same key is used again, the original message_id and status are returned.

How to interpret text (and each parts[].text). Defaults to plain, which sends the string exactly as given. With markdown, four constructs are parsed and delivered as real iMessage rich text — the recipient sees styled text, not delimiters: | Construct | Syntax | | --- | --- | | Bold | **bold** or __bold__ | | Italic | *italic* or _italic_ | | Underline | ++underline++ | | Strikethrough | ~~strike~~ | They nest freely (**bold and _italic_**). Everything else Markdown can express — headings, lists, links, code spans, blockquotes, images — is NOT styling iMessage can carry, so it is passed through as literal characters: [Blooio](https://blooio.com) is delivered with its brackets and URL intact, and # Heading keeps its #. Escape a delimiter with a backslash (\*not italic\*) to send it literally. The styling travels in the message's attributed body, so the stored text and the text returned on reads and webhooks is always the plain string the recipient sees, with the delimiters removed. The Markdown itself comes back as formatted_text, re-serialized into a normalized spelling rather than echoed verbatim (__bold__ returns as **bold**). Only valid on Blooio iMessage channels — 400 format_unsupported_for_channel_type on any other channel type, since no other channel type has a rich-text equivalent and would otherwise deliver your delimiters as literal text. Rich text also requires the message to be delivered over iMessage: a Blooio send that falls back to SMS arrives as unstyled plain text (the text string), because SMS cannot carry styling. Applies to a text send and to parts. Rejected with 400 invalid_content when combined with attachments — a media caption is not a styled bubble, so send the media and the styled text as two messages — when set without text or parts, when the Markdown source exceeds 20000 characters, or when it compiles to more than 256 distinct formatting ranges.

Whether to show typing indicator before sending. Defaults to org preference.

E.164 phone number to send from. For Twilio API keys, this is optional — if omitted, the first assigned Twilio number is auto-selected. For Blooio (iMessage) API keys, this selects a specific number from your pool. Must be a number assigned to your API key.

If true, the contact card (Name & Photo) will be shared with this message. The contact card is piggybacked onto the outgoing message. Defaults to false. ⚠️ Only available on **Dedicated Commercial** and **Dedicated Enterprise** plans — other plans receive a 403.

Optional. Attach an iMessage send-with-effect to the outgoing message. **Bubble effects** (apply to a single text bubble): - slam — Slam - loud — Loud - gentle — Gentle - invisible-ink — Invisible Ink **Screen effects** (full-screen animation in the recipient's chat): - echo — Echo - spotlight — Spotlight - balloons — Balloons - confetti — Confetti - love — Love (heart) - lasers — Lasers - fireworks — Fireworks - celebration — Celebration (sparkles) Values are case-insensitive and accept either dashes or spaces ("Invisible Ink" and "invisible-ink" both work). Pass "none" or omit the field to send without an effect. **Limitations:** - iMessage-only — when the chat is delivered as SMS or RCS the message is sent without an animation. - Not supported alongside the parts array (multipart bubbles cannot carry an effect). Use the top-level text field instead. - When text is an array, every message in the array is sent with the same effect.

ID of the sent message (single-message sends)

IDs of sent messages. Present when text is an array or when parts uses per-part link_preview (URL-balloon batch mode).

Number of messages sent. Only present in URL-balloon batch mode.

Initial status of the message(s). queued = accepted for delivery (the normal 202 result); failed = rejected before dispatch. Subsequent transitions (sent → delivered, or failed) are reported via the status endpoint and message.status webhooks.

Group ID when sending to multi-recipient (new or existing)

True if a new unnamed group was created for this multi-recipient message

List of participants (present for multi-recipient)

Present (and true) only when reply_to.guid was supplied without a message_id and the GUID didn't map to any Blooio-minted row. The send still proceeds and the device may still thread it; this flag signals that Blooio couldn't link the new message to a known parent.