5b:I[89597,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js"],"default"] 5c:I[22479,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js"],"default"] 5d:I[41174,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js","/_next/static/chunks/3m4nuoh0-tn47.js","/_next/static/chunks/2wmbbz2exns01.js"],""] 5f:I[37887,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js"],"OutletBoundary"] 60:"$Sreact.suspense" 62:I[37887,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js"],"ViewportBoundary"] 64:I[37887,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js"],"MetadataBoundary"] 66:I[57754,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js","/_next/static/chunks/3m4nuoh0-tn47.js","/_next/static/chunks/2wmbbz2exns01.js"],"default"] 67:I[27641,["/_next/static/chunks/1rh1kqfxfxt2o.js","/_next/static/chunks/09f5msprnopcu.js","/_next/static/chunks/202yvwn28d4x7.js"],"IconMark"] 43:T7d2,text Plain text message. May be combined with (sent as media with a caption) — except a lone audio file, which is sent as a standalone voice memo and cannot carry a caption. Set text parts[].text plain markdown text carousel: false bundle id url com.example.app.Clip https://appclip.apple.com/id?p= url com.acme.app.MessagesExtension bundle id MSMessage.url an summary text quick reply imageIdentifier data url kind id title 422 invalid quick reply kind title identifier title title order multipleSelection Allow selecting more than one item in this section. items identifier title subtitle order style Row style. Defaults to when omitted. default imageIdentifier list Alias for ( = list picker). Accepts (or a bare array of sections). Same validation and normalization as . event Time picker event ( = time picker). Required: at least one entry, each with a (ISO 8601) and a positive (seconds). Rejected with othe identifier title location title timezoneOffset timeslots identifier startTime ISO 8601 start time; normalized to Apple's format on send. duration Slot duration in seconds. dynamic Apple dynamic interactive message (multi page form) object, forwarded verbatim ( = form). Required: at least one page under (or ); also carries , dynamic kind kind paymentRequest total label amount currencyCode countryCode kind oauth2 responseType scope redirectURI 422 invalid authenticate authenticate.oauth2 kind responseType scope redirectURI kind app app id app name app icon bid url app id App Store id for the iMessage app fallback ( = imessage app). Flat alias for . app name App Store name for the iMessage app fallback ( = imessage app). Flat alias for . app icon Base64 PNG icon for the iMessage app fallback ( = imessage app). Flat alias for . bid iMessage extension bundle id. Required for = imessage app (or supply it under ); rejected with otherwise. url Custom app URL / query string ( = imessage app). session identifier use live layout invitation Apple Messages for Business invitation. 44:T48d,update channel settings update channel settings patch /channels/{channel}/settings updatechannelsettings v4 partial update of a channel's settings (send only the keys you want to change). keys are per channel type. blooio (p2p numbers): `auto_mark_read` is available on dedicated and inbound lines; `auto_share_contact` is dedicated-only and the line must have a contact card (name or photo) set up. turning a setting off is always allowed. errors return a machine-readable `code`: `settings_unsupported_for_channel_type` (403, non-blooio channel), `auto_mark_read_not_allowed` / `auto_share_contact_not_allowed` (403, line type can't enable it), `contact_card_not_set_up` (403, enable auto_share_contact with no contact card), `no_settings_provided` (422, empty update), `invalid_settings` (422, unknown key or non-boolean value). a malformed channel selector or non-object body is `400`. auto_mark_read blooio: mark a chat read on the device as soon as a message arrives. dedicated + inbound lines only. auto_share_contact blooio: share the number's name & photo card with people who message it. dedicated lines only, and the line must have a contact card set up.45:T5ba,auto mark read Blooio: mark a chat read on the device as soon as a message arrives. Dedicated + inbound lines only. auto share contact Blooio: share the number's Name & Photo card with people who message it. Dedicated lines only, and the line must have a contact card set up. Update channel settings Partial update of a channel's settings (send only the keys you want to change). Keys are per channel type. Blooio (P2P numbers): is available on dedicated and inbound lines; is dedicated only AND the line must have a contact card (name or photo) set up. Turning a setting OFF is always allowed. Errors return a machine readable : (403, non Blooio channel), / (403, line type can't enable it), (403, enable auto share contact with no contact card), (422, empty update), (422, unknown key or non boolean value). A malformed channel selector or non object body is . /channels/{channel}/settings channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ). Partial update of a channel's settings; keys are per channel type and validated by the channel's provider. Blooio (P2P numbers) accepts and and rejects any other key (422 invalid settings). Blooio: mark a chat read on the device as soon as a message arrives. Dedicated + inbound lines only. Blooio: share the number's Name & Photo card with people who message it. Dedicated lines only, and the line must have a contact card set up.46:T466,source contact id The contact to merge into the survivor, prefixed with . Must differ from the path contact. Merge a contact Collapses two auto created contacts for the same person into one. The survivor is the in the path; the in the body is absorbed into it. Every identity on the source is re parented onto the survivor, tags are unioned, the survivor keeps its own name (falling back to the source's), and the source becomes a deprecated tombstone stamped with . Because chats and messages reference identities (not contacts), all conversations and timeline entries follow the moved identities automatically — nothing is rewritten or lost, and reads such as the survivor's timeline immediately reflect the merge. Idempotent: re merging the same source into the same survivor returns 200; a source already merged into a different contact returns 409. Emits a webhook event. /contacts/{contactId}/merge contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint. The contact to merge into the survivor, prefixed with . Must differ from the path contact.47:T479,Get contact timeline A single, chronological cross channel activity feed for a contact, unifying every conversation the contact takes part in — both 1:1 chats keyed on the contact's identities and group chats where the contact is a current member — across all channel types. After a merge, the survivor's timeline includes the absorbed contact's history automatically. Each entry is a polymorphic envelope tagged by ; ordered newest first by . By default only entries are returned; pass to interleave lifecycle and chat events. /contacts/{contactId}/timeline contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint. limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request. include events When true, interleaves non message activity (delivery/read receipts, reactions, chat/group/typing changes) from the events ledger into the feed as / entries. Defaults to false (messages only).48:T2149,send message to chat send a message to a chat post /chats/{chatid}/messages sendmessagetochat v4 sends a message into an existing chat. both the sender channel and recipient are inferred from the chat, so `from` and `to` must not be supplied. returns the message object at the top level (not wrapped in `data`). text plain text message. may be combined with `attachments` (sent as media with a caption) — except a lone audio file, which is sent as a standalone voice memo and cannot carry a caption. set `format: "mar format 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 — plain markdown attachments public https media urls. may be combined with `text`. on blooio imessage, two or more image/video urls are grouped into one photo/video carousel/collage bubble by default; set `carousel: false` to sen rich_link a tappable rich link bubble (blooio / apple messages for business). url title app_clip an app clip bubble (blooio p2p imessage only). sends an app clip launch url that messages renders as a native app clip card (app icon + name + open button); tapping it launches the instant app clip ex url the app clip launch url (https). mutually exclusive with `bundle_id`; if both are given, `url` wins. bundle_id app clip bundle identifier (e.g. `com.example.app.clip`), expanded to `https://appclip.apple.com/id?p=`. used when `url` is absent. title optional preview title override. imessage_app bring-your-own imessage app extension bubble (blooio p2p imessage only). blooio is the transport, not the renderer: you point at your own signed imessage app extension and we assemble the msmessage ap bundle_id your imessage app extension's bundle identifier (e.g. `com.acme.app.messagesextension`). team_id your apple developer team id. combined with `bundle_id` to form the balloon plugin id. url the app-state url your extension reads on tap (its `msmessage.url`). carries the state to reconstruct on the recipient device. app_name display name shown for the app (the `an` field). defaults to a generic label. caption template-card caption shown to everyone (including recipients without the app). subcaption optional template-card subcaption. image_url optional https image used as the fallback template card thumbnail. fetched best-effort (≤256kb); a fetch failure never fails the send. app_store_id optional app store id (adam id) for your app. when the recipient doesn't have the extension installed, messages uses it to deep-link the app store "get this app" fallback to the correct listing. omitt poll a native blooio poll. routed sends automatically consider only poll-capable channels. title options interactive interactive content. on apple messages for business this renders as a native interactive message: a quick reply, list picker, time picker, dynamic form, apple pay request, authentication (sign in) req kind which interactive experience to render. quick_reply list_picker time_picker form apple_pay authenticate imessage_app summary_text prompt / fallback line shown where the interactive ui can't render. used as the quick reply prompt. text alias for `summary_text`. request_identifier optional stable id echoed back on the customer's reply. defaults to the message id. received_message bubble shown to the customer before they interact. not allowed for `quick_reply` (send a plain text bubble first instead). title subtitle style icon small large imageidentifier reply_message bubble shown after the customer replies. title subtitle style icon small large imageidentifier images inline png assets referenced by `imageidentifier` elsewhere in the payload. supply each as base64 `data` or a `url` (fetched server-side). every image — fetched or inline — is validated from its magic identifier data base64-encoded png. url public https png url, fetched and validated server-side. expected_size optional exact @3x size to enforce for this asset's target style. width height style items quick reply options (`kind` = quick_reply). required: 1–5 items, each with a non-empty `id` and `title`. rejected with `422 invalid_quick_reply` otherwise. id title sections list picker sections (`kind` = list_picker). required: at least one section, each with a non-empty `title` and at least one item; every item needs a non-empty `identifier` and `title`. rejected with ` title order multipleselection allow selecting more than one item in this section. items identifier title subtitle order style row style. defaults to `default` when omitted. default imageidentifier list alias for `sections` (`kind` = list_picker). accepts `{ "sections": [...] }` (or a bare array of sections). same validation and normalization as `sections`. event time picker event (`kind` = time_picker). required: at least one `timeslots` entry, each with a `starttime` (iso-8601) and a positive `duration` (seconds). rejected with `422 invalid_time_picker` othe identifier title location title timezoneoffset timeslots identifier starttime iso-8601 start time; normalized to apple's `+0000` format on send. duration slot duration in seconds. dynamic apple dynamic interactive message (multi-page form) object, forwarded verbatim (`kind` = form). required: at least one page under `pages` (or `data.pages`); also carries `startpageidentifier`, `reques form alias for `dynamic` (`kind` = form). payment apple pay payment request object, forwarded verbatim (`kind` = apple_pay). required: a `paymentrequest` object with `total` (`label` + numeric `amount`), `currencycode` (iso-4217), and `countrycode` ( authenticate oauth2 authentication request object, forwarded verbatim (`kind` = authenticate). required: an `oauth2` object with `responsetype`, `scope`, and `redirecturi`. rejected with `422 invalid_authenticate` oauth2 shorthand for `authenticate.oauth2` (`kind` = authenticate). requires `responsetype`, `scope`, and `redirecturi`. app custom imessage app metadata (`kind` = imessage_app). these app store fallback fields (shown by messages when the extension isn't installed) may also be supplied flat on the interactive object as `app app_id app_name app_icon bid url app_id app store id for the imessage app fallback (`kind` = imessage_app). flat alias for `app.app_id`. app_name app store name for the imessage app fallback (`kind` = imessage_app). flat alias for `app.app_name`. app_icon base64 png icon for the imessage app fallback (`kind` = imessage_app). flat alias for `app.app_icon`. bid imessage extension bundle id. required for `kind` = imessage_app (or supply it under `app.bid`); rejected with `422 invalid_imessage_app` otherwise. url custom app url / query string (`kind` = imessage_app). session_identifier use_live_layout invitation apple messages for business invitation. sends an apple-managed notification template (live layout) that invites the customer into a business chat. addressed to a phone number (`tel:+e164`) rather than template_id the apple-managed notification template id authorized for your business (e.g. `binarychoice.engage.withimage`). reference_id your business context id for this invitation (order number, case id, etc.). required by apple and echoed back on the closesession webhook. max 1000 characters; must not contain quotation marks or apos parameters template parameter values required by the chosen template (e.g. `brandname`, and `brandlogo` as a base64 png). for known templates the required parameters are enforced before sending — e.g. `binarycho locale bcp-47 locale for the template. defaults to `en-us`. template template content (whatsapp business). template_id parts ordered text/media parts sent as one multipart message (blooio only). when every part is an image/video (two or more, no text parts) messages renders them as a photo/video carousel/collage by default; text url reply_to message id to reply to. applies to the whole outgoing message. effect imessage screen/bubble effect (blooio, text only). link_preview imageurl title badge optional attribution badge shown under the bubble: `sent_with_siri` renders "sent with siri" and `sent_with_facetime` renders "sent with facetime", the way a message dictated to siri or sent during a sent_with_siri sent_with_facetime carousel group image/video attachments into one message that messages renders as a swipeable photo/video carousel/collage, instead of separate bubbles (blooio p2p imessage only). defaults on: a blooio send who dry_run49:T7d2,text Plain text message. May be combined with (sent as media with a caption) — except a lone audio file, which is sent as a standalone voice memo and cannot carry a caption. Set text parts[].text plain markdown text carousel: false bundle id url com.example.app.Clip https://appclip.apple.com/id?p= url com.acme.app.MessagesExtension bundle id MSMessage.url an summary text quick reply imageIdentifier data url kind id title 422 invalid quick reply kind title identifier title title order multipleSelection Allow selecting more than one item in this section. items identifier title subtitle order style Row style. Defaults to when omitted. default imageIdentifier list Alias for ( = list picker). Accepts (or a bare array of sections). Same validation and normalization as . event Time picker event ( = time picker). Required: at least one entry, each with a (ISO 8601) and a positive (seconds). Rejected with othe identifier title location title timezoneOffset timeslots identifier startTime ISO 8601 start time; normalized to Apple's format on send. duration Slot duration in seconds. dynamic Apple dynamic interactive message (multi page form) object, forwarded verbatim ( = form). Required: at least one page under (or ); also carries , dynamic kind kind paymentRequest total label amount currencyCode countryCode kind oauth2 responseType scope redirectURI 422 invalid authenticate authenticate.oauth2 kind responseType scope redirectURI kind app app id app name app icon bid url app id App Store id for the iMessage app fallback ( = imessage app). Flat alias for . app name App Store name for the iMessage app fallback ( = imessage app). Flat alias for . app icon Base64 PNG icon for the iMessage app fallback ( = imessage app). Flat alias for . bid iMessage extension bundle id. Required for = imessage app (or supply it under ); rejected with otherwise. url Custom app URL / query string ( = imessage app). session identifier use live layout invitation Apple Messages for Business invitation. 4a:T29cc,send message send a message post /messages sendmessage v4 the primary endpoint for starting a message. the common send is entirely scalar: `{ "from": "+15551230001", "to": "+15551234567", "text": "hello" }`. `from` is one optional string: 1. **phone number** — `"from": "+15551230001"` selects your exact numbered channel with that address. 2. **alias** — `"from": "support"` selects the non-numbered channel (apple messages for business / rcs business) with that organization-wide alias. 3. **channel id** — `"from": "ch_..."` is the advanced exact-channel form. 4. **automatic** — omit `from` to use the key's default priority / automatic routing. advanced routing controls (each mutually exclusive with `from`): `"priority_id": "priority_..."` routes through an explicit priority; `"channel_type": "blooio"` constrains automatic/priority routing to one type; `"hybrid": true` (or a representative phone number string) requests hybrid twilio-first / blooio-after-reply routing. priority routing is history-first and content-aware. poll content currently routes only through blooio. cross-type apple messages for business routing requires a contact with an apple messages for business identity. existing groups require an exact sender whose channel owns the group or a hybrid sender that owns that channel. returns the resolved scalar `from` plus the chosen `channel_id`, `chat_id`, and routing explanation. text plain text message. may be combined with `attachments` (sent as media with a caption) — except a lone audio file, which is sent as a standalone voice memo and cannot carry a caption. set `format: "mar format 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 — plain markdown attachments public https media urls. may be combined with `text`. on blooio imessage, two or more image/video urls are grouped into one photo/video carousel/collage bubble by default; set `carousel: false` to sen rich_link a tappable rich link bubble (blooio / apple messages for business). url title app_clip an app clip bubble (blooio p2p imessage only). sends an app clip launch url that messages renders as a native app clip card (app icon + name + open button); tapping it launches the instant app clip ex url the app clip launch url (https). mutually exclusive with `bundle_id`; if both are given, `url` wins. bundle_id app clip bundle identifier (e.g. `com.example.app.clip`), expanded to `https://appclip.apple.com/id?p=`. used when `url` is absent. title optional preview title override. imessage_app bring-your-own imessage app extension bubble (blooio p2p imessage only). blooio is the transport, not the renderer: you point at your own signed imessage app extension and we assemble the msmessage ap bundle_id your imessage app extension's bundle identifier (e.g. `com.acme.app.messagesextension`). team_id your apple developer team id. combined with `bundle_id` to form the balloon plugin id. url the app-state url your extension reads on tap (its `msmessage.url`). carries the state to reconstruct on the recipient device. app_name display name shown for the app (the `an` field). defaults to a generic label. caption template-card caption shown to everyone (including recipients without the app). subcaption optional template-card subcaption. image_url optional https image used as the fallback template card thumbnail. fetched best-effort (≤256kb); a fetch failure never fails the send. app_store_id optional app store id (adam id) for your app. when the recipient doesn't have the extension installed, messages uses it to deep-link the app store "get this app" fallback to the correct listing. omitt poll a native blooio poll. routed sends automatically consider only poll-capable channels. title options interactive interactive content. on apple messages for business this renders as a native interactive message: a quick reply, list picker, time picker, dynamic form, apple pay request, authentication (sign in) req kind which interactive experience to render. quick_reply list_picker time_picker form apple_pay authenticate imessage_app summary_text prompt / fallback line shown where the interactive ui can't render. used as the quick reply prompt. text alias for `summary_text`. request_identifier optional stable id echoed back on the customer's reply. defaults to the message id. received_message bubble shown to the customer before they interact. not allowed for `quick_reply` (send a plain text bubble first instead). title subtitle style icon small large imageidentifier reply_message bubble shown after the customer replies. title subtitle style icon small large imageidentifier images inline png assets referenced by `imageidentifier` elsewhere in the payload. supply each as base64 `data` or a `url` (fetched server-side). every image — fetched or inline — is validated from its magic identifier data base64-encoded png. url public https png url, fetched and validated server-side. expected_size optional exact @3x size to enforce for this asset's target style. width height style items quick reply options (`kind` = quick_reply). required: 1–5 items, each with a non-empty `id` and `title`. rejected with `422 invalid_quick_reply` otherwise. id title sections list picker sections (`kind` = list_picker). required: at least one section, each with a non-empty `title` and at least one item; every item needs a non-empty `identifier` and `title`. rejected with ` title order multipleselection allow selecting more than one item in this section. items identifier title subtitle order style row style. defaults to `default` when omitted. default imageidentifier list alias for `sections` (`kind` = list_picker). accepts `{ "sections": [...] }` (or a bare array of sections). same validation and normalization as `sections`. event time picker event (`kind` = time_picker). required: at least one `timeslots` entry, each with a `starttime` (iso-8601) and a positive `duration` (seconds). rejected with `422 invalid_time_picker` othe identifier title location title timezoneoffset timeslots identifier starttime iso-8601 start time; normalized to apple's `+0000` format on send. duration slot duration in seconds. dynamic apple dynamic interactive message (multi-page form) object, forwarded verbatim (`kind` = form). required: at least one page under `pages` (or `data.pages`); also carries `startpageidentifier`, `reques form alias for `dynamic` (`kind` = form). payment apple pay payment request object, forwarded verbatim (`kind` = apple_pay). required: a `paymentrequest` object with `total` (`label` + numeric `amount`), `currencycode` (iso-4217), and `countrycode` ( authenticate oauth2 authentication request object, forwarded verbatim (`kind` = authenticate). required: an `oauth2` object with `responsetype`, `scope`, and `redirecturi`. rejected with `422 invalid_authenticate` oauth2 shorthand for `authenticate.oauth2` (`kind` = authenticate). requires `responsetype`, `scope`, and `redirecturi`. app custom imessage app metadata (`kind` = imessage_app). these app store fallback fields (shown by messages when the extension isn't installed) may also be supplied flat on the interactive object as `app app_id app_name app_icon bid url app_id app store id for the imessage app fallback (`kind` = imessage_app). flat alias for `app.app_id`. app_name app store name for the imessage app fallback (`kind` = imessage_app). flat alias for `app.app_name`. app_icon base64 png icon for the imessage app fallback (`kind` = imessage_app). flat alias for `app.app_icon`. bid imessage extension bundle id. required for `kind` = imessage_app (or supply it under `app.bid`); rejected with `422 invalid_imessage_app` otherwise. url custom app url / query string (`kind` = imessage_app). session_identifier use_live_layout invitation apple messages for business invitation. sends an apple-managed notification template (live layout) that invites the customer into a business chat. addressed to a phone number (`tel:+e164`) rather than template_id the apple-managed notification template id authorized for your business (e.g. `binarychoice.engage.withimage`). reference_id your business context id for this invitation (order number, case id, etc.). required by apple and echoed back on the closesession webhook. max 1000 characters; must not contain quotation marks or apos parameters template parameter values required by the chosen template (e.g. `brandname`, and `brandlogo` as a base64 png). for known templates the required parameters are enforced before sending — e.g. `binarycho locale bcp-47 locale for the template. defaults to `en-us`. template template content (whatsapp business). template_id parts ordered text/media parts sent as one multipart message (blooio only). when every part is an image/video (two or more, no text parts) messages renders them as a photo/video carousel/collage by default; text url reply_to message id to reply to. applies to the whole outgoing message. effect imessage screen/bubble effect (blooio, text only). link_preview imageurl title badge optional attribution badge shown under the bubble: `sent_with_siri` renders "sent with siri" and `sent_with_facetime` renders "sent with facetime", the way a message dictated to siri or sent during a sent_with_siri sent_with_facetime carousel group image/video attachments into one message that messages renders as a swipeable photo/video carousel/collage, instead of separate bubbles (blooio p2p imessage only). defaults on: a blooio send who from the sender as a single string: a phone number (any common format; matched to your exact numbered channel), a channel alias (organization-wide name of a non-numbered channel), or an exact channel id (c priority_id route through an explicit priority (priority_...). mutually exclusive with `from`. channel_type constrain automatic/priority routing to one channel type. mutually exclusive with `from`. blooio twilio whatsapp whatsapp_business rcs_business amb hybrid hybrid (twilio-first / blooio-after-reply) routing. `true` uses the calling key's hybrid configuration; a phone number string selects the hybrid owner of that representative number. mutually exclusive to a recipient: a raw identifier string (phone/email/opaque provider id), an array of identifier strings (multiple recipients), an existing `{ group_id }` with an exact or hybrid owner sender, or (for ro contact_id contact id (ct_...) — routed sends only. group_id existing group id (grp_...) — exact sender or a hybrid sender that owns the group's channel. dry_run validate and route only; do not send.4b:T7d2,text Plain text message. May be combined with (sent as media with a caption) — except a lone audio file, which is sent as a standalone voice memo and cannot carry a caption. Set text parts[].text plain markdown text carousel: false bundle id url com.example.app.Clip https://appclip.apple.com/id?p= url com.acme.app.MessagesExtension bundle id MSMessage.url an summary text quick reply imageIdentifier data url kind id title 422 invalid quick reply kind title identifier title title order multipleSelection Allow selecting more than one item in this section. items identifier title subtitle order style Row style. Defaults to when omitted. default imageIdentifier list Alias for ( = list picker). Accepts (or a bare array of sections). Same validation and normalization as . event Time picker event ( = time picker). Required: at least one entry, each with a (ISO 8601) and a positive (seconds). Rejected with othe identifier title location title timezoneOffset timeslots identifier startTime ISO 8601 start time; normalized to Apple's format on send. duration Slot duration in seconds. dynamic Apple dynamic interactive message (multi page form) object, forwarded verbatim ( = form). Required: at least one page under (or ); also carries , dynamic kind kind paymentRequest total label amount currencyCode countryCode kind oauth2 responseType scope redirectURI 422 invalid authenticate authenticate.oauth2 kind responseType scope redirectURI kind app app id app name app icon bid url app id App Store id for the iMessage app fallback ( = imessage app). Flat alias for . app name App Store name for the iMessage app fallback ( = imessage app). Flat alias for . app icon Base64 PNG icon for the iMessage app fallback ( = imessage app). Flat alias for . bid iMessage extension bundle id. Required for = imessage app (or supply it under ); rejected with otherwise. url Custom app URL / query string ( = imessage app). session identifier use live layout invitation Apple Messages for Business invitation. 4c:T479,create group create a group post /groups creategroup v4 creates a group chat on a group-capable channel (blooio/whatsapp) with one or more members. no imessage conversation exists yet: the first message sent to the group opens it, and `chat_linked` becomes `true` once it does. there is no separate linking step. on that first send the device may hand back an imessage conversation that another of your groups already holds with the same people. the new group is then merged into that one. its group id keeps working for `get /groups/{groupid}`, `get /groups/{groupid}/members` and sends with `to.group_id`, and its chat id for `get /chats/{chatid}`; each resolves to the surviving group, whose `id` is the canonical one. every other request addressed to a merged id (updates, deletes, chat actions) returns 404, so switch to the canonical id once you have it. channel_id must be a group-capable channel (blooio/whatsapp). members member phone numbers (e.164) or emails, each given as a string or an object `{ "identifier": "..." }`. every identifier is validated; invalid members 422 `invalid_members` instead of being dropped. identifier name4d:T487,channel id Must be a group capable channel (blooio/whatsapp). members Member phone numbers (E.164) or emails, each given as a string or an object . Every identifier is validated; invalid members 422 instead of being dropped. identifier name Create a group Creates a group chat on a group capable channel (blooio/whatsapp) with one or more members. No iMessage conversation exists yet: the first message sent to the group opens it, and becomes once it does. There is no separate linking step. On that first send the device may hand back an iMessage conversation that another of your groups already holds with the same people. The new group is then merged into that one. Its group id keeps working for , and sends with , and its chat id for ; each resolves to the surviving group, whose is the canonical one. Every other request addressed to a merged id (updates, deletes, chat actions) returns 404, so switch to the canonical id once you have it. /groups Must be a group capable channel (blooio/whatsapp). Member phone numbers (E.164) or emails, each given as a string or an object . Every identifier is validated; invalid members 422 instead of being dropped.4e:T61f,url HTTPS endpoint. event types Retired. Every webhook receives every event; filter by in your handler. Omit this field, or send . Any narrower value is rejected with 422 . Subscriptions created be api key Scope the subscription to the lines this API key owns. Omit and for an organization wide subscription that receives events from every line. Must belong to your organization; integration id Scope the subscription to the lines this integration owns. Mutually exclusive with . channel id channel type blooio twilio whatsapp whatsapp business rcs business amb api version The payload version to deliver. Defaults to the latest. Anything not listed by is rejected with 422 , whose lists the accepte 2026 10 01 2026 09 01 Create a webhook Subscribes an HTTPS endpoint to events. Returns the signing secret once, on creation. /webhooks HTTPS endpoint. Retired. Every webhook receives every event; filter by in your handler. Omit this field, or send . Any narrower value is rejected with 422 . Subscriptions created before the retirement keep the list they were registered with. Scope the subscription to the lines this API key owns. Omit and for an organization wide subscription that receives events from every line. Must belong to your organization; sending both is rejected with 422 . Scope the subscription to the lines this integration owns. Mutually exclusive with . The payload version to deliver. Defaults to the latest. Anything not listed by is rejected with 422 , whose lists the accepted values. A webhook payload version, as a release date. is the latest.4f:T46a,url event types Retired. Omit this field to leave an existing subscription's frozen list untouched; sending anything narrower than is rejected with 422 . status active disabled api version Move the subscription to another payload version, for example to upgrade after updating your handler. Takes effect from the next event. Unsupported values are rejected with 422 . 2026 10 01 2026 09 01 Update a webhook Updates url, status ( / ), or the payload . A version change applies to the next event delivered; deliveries already made, and replays of them, keep the version they were sent with. /webhooks/{webhookId} webhookId Unique identifier of the webhook subscription, prefixed with . Returned when you create a webhook or by the List webhooks endpoint. Retired. Omit this field to leave an existing subscription's frozen list untouched; sending anything narrower than is rejected with 422 . Move the subscription to another payload version, for example to upgrade after updating your handler. Takes effect from the next event. Unsupported values are rejected with 422 . A webhook payload version, as a release date. is the latest.50:T435,Assign a channel to an API key Makes the API key the owner of a channel's line, so messages sent with that key can originate from it. This is the programmatic equivalent of assigning a number to a key on the dashboard Channels board. The key becomes the number's sole owner: if another API key or integration owned it, that ownership is deprecated (and its hybrid mode re evaluated). Assigning is idempotent — re assigning a line the key already owns returns . Only numbered, key ownable channels can be assigned. Blooio lines are the primary case (Twilio where applicable); non numbered channel types return . On plans without number pools, a key may own at most one line ( ). Blooio Apps (OAuth) only. Requires the scope. API key and dashboard authentication are rejected with . /api keys/{apiKey}/channels/{channel} apiKey The API key value (prefixed with ), as returned when the key was created or by the List API keys endpoint. channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ).51:Td0c,decide bloobability v2 decide policies against a conversation post /ai/bloobability/v2/decide decidebloobabilityv2 v4 decides every policy you send against one conversation with bloobability v2. each result carries two calibrated numbers in [0, 1]: `probability` (the policy holds) and `answerable` (the conversation contains enough to judge it). there is no verdict and no threshold: choose your own. a low `answerable` never changes `probability`. ## tiers you choose the model with `tier`. nothing routes between tiers or falls back from one to the other, and the response's `tier` echoes your choice. - `instant` is the fast tier, for short, explicit questions whose deciding facts are stated in the conversation. its `answerable` is not a reliable check for missing information: in the latest measured screen it flagged 0 of 60 deliberately unanswerable cases. - `full` is the more capable tier, for reversals, conditions, several speakers, longer threads and conversations that may be missing facts. use it when unsure. the tiers are separate models and do not return identical probabilities. pin the tier, and store `model_version`, when you compare numbers across requests. ## contract the body is checked exactly: unknown fields, explicit `null`, blank strings, duplicate json keys and duplicate message or policy ids are rejected with 400, and `error.details` names the failing `reason`, `path` and `rule`. message `timestamp`s, when given, must be rfc 3339 with an offset, non-decreasing, and not later than `assessment_time`. bodies over 1 mib are rejected with 413. a request that exceeds the chosen tier's context is rejected with 422 and never truncated. 429 and 503 `model_unavailable` mean the model is busy or restarting: retry with backoff. errors are `{ "error": { "code", "message", "details" } }`; 5xx bodies carry no `details`. policies come back in request order and their ids are echoed unchanged. the call is stateless. tier which model decides. `instant` is fastest, for short questions with the deciding facts stated; `full` handles reversals, conditions and missing information. there is no `auto`. instant full messages the conversation in chronological order. every message is in scope; none are dropped. id unique within the request. the model never reads it. text the full message text, sent unaltered and never cropped. instructions inside it are judged as conversation, not followed. speaker_id optional participant identity, consistent within the conversation. two people never share one, though they may share a role. omit when unknown. role optional free-text role such as `customer`, `agent`, `manager` or `tool`. custom roles are allowed; `system` grants no authority. timestamp optional real send time, rfc 3339 with an offset (`-00:00` is rejected). must not decrease across `messages`; ties are allowed. never invent one from array position. policies independent policies. probabilities do not sum to one. id unique within the request, echoed unchanged. the model never reads it. definition a natural-language statement that is true or false of the conversation. this is the whole policy: no registration, roster or per-policy calibration. assessment_time optional "now" for time-relative policies, rfc 3339 with an offset. never defaulted to the request time, and it does not filter messages.52:T7d0,tier Which model decides. is fastest, for short questions with the deciding facts stated; handles reversals, conditions and missing information. There is no . instant full messages The conversation in chronological order. Every message is in scope; none are dropped. id Unique within the request. The model never reads it. text The full message text, sent unaltered and never cropped. Instructions inside it are judged as conversation, not followed. speaker id Optional participant identity, consistent within the conversation. Two people never share one, though they may share a role. Omit when unknown. role Optional free text role such as , , or . Custom roles are allowed; grants no authority. timestamp Optional real send time, RFC 3339 with an offset ( is rejected). Must not decrease across ; ties are allowed. Never invent one from array position. policies Independent policies. Probabilities do not sum to one. id Unique within the request, echoed unchanged. The model never reads it. definition A natural language statement that is true or false of the conversation. This is the whole policy: no registration, roster or per policy calibration. assessment time Optional "now" for time relative policies, RFC 3339 with an offset. Never defaulted to the request time, and it does not filter messages. Decide policies against a conversation Decides every policy you send against one conversation with Bloobability v2. Each result carries two calibrated numbers in [0, 1]: (the policy holds) and (the conversation contains enough to judge it). There is no verdict and no threshold: choose your own. A low never changes . Tiers You choose the model with . Nothing routes between tiers or falls back from one to the other, and the response's echoes your choice. is the fast tier, for short, explicit questions whose deciding facts are stated in the conversation. Its is not a reliable check for missing information: in the latest measured screen it flagged 0 of 60 deliberately unanswerable cases.56:X 0:{"P":null,"c":["","reference","v2","typing-indicators"],"q":"","i":false,"f":[[["",{"children":[["slug","reference/v2/typing-indicators","c",[]],{"children":["__PAGE__",{},"$undefined","$undefined",4608]},"$undefined","$undefined",4608]},"$undefined","$undefined",4624],[["$","$1","c",{"children":[[["$","link","0",{"rel":"stylesheet","href":"/_next/static/chunks/1oyokrylf2zkq.css","precedence":"next","crossOrigin":"$undefined","nonce":"$undefined"}],["$","link","1",{"rel":"stylesheet","href":"/_next/static/chunks/2e0t95_8e56z-.css","precedence":"next","crossOrigin":"$undefined","nonce":"$undefined"}],["$","script","script-0",{"src":"/_next/static/chunks/1rh1kqfxfxt2o.js","async":true,"nonce":"$undefined"}],["$","script","script-1",{"src":"/_next/static/chunks/09f5msprnopcu.js","async":true,"nonce":"$undefined"}],["$","script","script-2",{"src":"/_next/static/chunks/202yvwn28d4x7.js","async":true,"nonce":"$undefined"}]],["$","html",null,{"lang":"en","data-scroll-behavior":"smooth","className":"geist_9c6cb61b-module__8NX9hq__variable geist_mono_d6617093-module__z61v7q__variable","suppressHydrationWarning":true,"children":[["$","head",null,{"children":[["$","script",null,{"dangerouslySetInnerHTML":{"__html":"(function(){try{var t=localStorage.getItem('theme');var d=t?t==='dark':window.matchMedia('(prefers-color-scheme: dark)').matches;if(d)document.documentElement.classList.add('dark');}catch(e){document.documentElement.classList.add('dark');}})();"}}],["$","script",null,{"type":"application/ld+json","dangerouslySetInnerHTML":{"__html":"{\"@context\":\"https://schema.org\",\"@type\":\"Organization\",\"name\":\"Blooio\",\"url\":\"https://blooio.com\",\"logo\":\"https://blooio.com/logo.png\",\"sameAs\":[\"https://blooio.com\",\"https://twitter.com/blooio\"]}"}}],["$","script",null,{"type":"application/ld+json","dangerouslySetInnerHTML":{"__html":"{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Blooio Docs\",\"url\":\"https://docs.blooio.com\"}"}}]]}],["$","body",null,{"className":"font-sans","children":["$","$L2",null,{"nav":{"versions":[{"id":"v2","label":"v2","isDefault":false},{"id":"v4","label":"v4","isDefault":true}],"defaultVersion":"v4","docsByVersion":{"v2":[{"title":"Getting started","items":[{"title":"Overview","href":"/"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Migrating from v2 to v4","href":"/migrating-to-v4"}]},{"title":"Core concepts","items":[{"title":"Errors","href":"/errors"},{"title":"Idempotency","href":"/idempotency"},{"title":"Pagination","href":"/pagination"}]},{"title":"Sending messages","items":[{"title":"Message sending basics","href":"/guides/message-sending"},{"title":"Messaging safety limits and recovery","href":"/guides/messaging-safety"},{"title":"Send attachments","href":"/guides/attachments"},{"title":"Rich link previews","href":"/guides/link-previews"},{"title":"Custom bubbles (iMessage apps)","href":"/guides/custom-bubbles"},{"title":"Find My & Check In bubbles","href":"/guides/apple-system-apps"},{"title":"Number Pools","href":"/guides/number-pools"},{"title":"Hybrid mode","href":"/hybrid-mode"}]},{"title":"Receiving & webhooks","items":[{"title":"Webhooks","href":"/webhooks"},{"title":"Receive webhooks locally","href":"/guides/webhooks-local"},{"title":"Verify webhook signatures","href":"/guides/webhook-signatures"}]},{"title":"Contacts & identity","items":[{"title":"Contact flows","href":"/guides/contact-flows"},{"title":"Contact cards (Name & Photo)","href":"/guides/contact-card"}]},{"title":"Integrations","items":[{"title":"Twilio Integration","href":"/guides/twilio-integration"},{"title":"Location tracking (FindMy)","href":"/guides/location-tracking"},{"title":"FaceTime calls","href":"/guides/facetime"}]},{"title":"Language tutorials","items":[{"title":"iMessage REST API","href":"/guides/imessage-rest-api"},{"title":"Send iMessage with Node.js","href":"/guides/send-imessage-api-nodejs"},{"title":"Send iMessage with Python","href":"/guides/send-imessage-api-python"}]}],"v4":[{"title":"Getting started","items":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:0:items:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:0:items:1","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:0:items:2","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:0:items:3"]},{"title":"Core concepts","items":[{"title":"Channels & senders","href":"/channels-and-senders"},{"title":"Priorities","href":"/priorities"},{"title":"API key lifecycle","href":"/api-keys"},{"title":"Message content","href":"/message-content"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:1:items:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:1:items:1","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:1:items:2"]},{"title":"Sending messages","items":[{"title":"Message sending","href":"/message-sending"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:2:items:1",{"title":"Attachments","href":"/attachments"},{"title":"Link previews","href":"/link-previews"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:2:items:4","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:2:items:5",{"title":"Number pools","href":"/number-pools"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:2:items:7"]},{"title":"Conversations","items":[{"title":"Chats","href":"/chats"}]},{"title":"Conversation intelligence","items":[{"title":"Tracking trends and conversation insights","href":"/guides/conversation-insights"}]},{"title":"Receiving & webhooks","items":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:nav:docsByVersion:v2:3:items:0",{"title":"Receive webhooks locally","href":"/webhooks-local"},{"title":"Webhook signatures","href":"/webhook-signatures"}]},{"title":"Contacts & identity","items":[{"title":"Contacts","href":"/contacts"},{"title":"Contact cards","href":"/contact-cards"}]},{"title":"Numbers & provisioning","items":[{"title":"Number provisioning","href":"/number-provisioning"},{"title":"Number Purchase API","href":"/guides/number-purchase-api"}]},{"title":"Integrations","items":[{"title":"Twilio integration","href":"/twilio-integration"},{"title":"Location tracking","href":"/location-tracking"}]},{"title":"Developer apps & OAuth","items":[{"title":"Developer apps","href":"/developer-apps"},{"title":"OAuth authorization","href":"/oauth-authorization"},{"title":"Calling the API with OAuth tokens","href":"/oauth-api-tokens"}]},{"title":"Apple Messages for Business","items":[{"title":"Apple Messages for Business","href":"/guides/apple-messages-for-business"},{"title":"Launch Apple Messages for Business","href":"/amb-launch"},{"title":"Pass the Apple Messages for Business Experience Review","href":"/amb-experience-review"},{"title":"Monthly active users","href":"/guides/apple-messages-mau"},{"title":"Interactive messages","href":"/amb-interactive"},{"title":"Rich links & media","href":"/guides/apple-messages-rich-links"},{"title":"Sign in (OAuth 2.0)","href":"/guides/apple-messages-sign-in"},{"title":"Business invitations","href":"/amb-invitations"},{"title":"Apple Pay","href":"/amb-apple-pay"},{"title":"Conversation lifecycle","href":"/guides/apple-messages-conversations"},{"title":"Capabilities & limits","href":"/amb-capabilities"}]}]},"referenceByVersion":{"v2":[{"title":"Account","href":"/reference/v2/account","items":[{"title":"Get me","href":"/reference/v2/account/getMe","method":"GET","status":"$undefined"}]},{"title":"Numbers","href":"/reference/v2/numbers","items":[{"title":"List numbers","href":"/reference/v2/numbers/listNumbers","method":"GET","status":"$undefined"},{"title":"Request call forwarding","href":"/reference/v2/numbers/requestCallForwarding","method":"POST","status":"$undefined"}]},{"title":"Contact Card","href":"/reference/v2/contact-card","items":[{"title":"Share contact card","href":"/reference/v2/contact-card/shareContactCard","method":"POST","status":"$undefined"},{"title":"Get my contact card","href":"/reference/v2/contact-card/getMyContactCard","method":"GET","status":"$undefined"},{"title":"Update my contact card","href":"/reference/v2/contact-card/updateMyContactCard","method":"PUT","status":"$undefined"}]},{"title":"Contacts","href":"/reference/v2/contacts","items":[{"title":"List contacts","href":"/reference/v2/contacts/listContacts","method":"GET","status":"$undefined"},{"title":"Create contact","href":"/reference/v2/contacts/createContact","method":"POST","status":"$undefined"},{"title":"Get contact","href":"/reference/v2/contacts/getContact","method":"GET","status":"$undefined"},{"title":"Update contact","href":"/reference/v2/contacts/updateContact","method":"PATCH","status":"$undefined"},{"title":"Delete contact","href":"/reference/v2/contacts/deleteContact","method":"DELETE","status":"$undefined"},{"title":"Get contact capabilities","href":"/reference/v2/contacts/getContactCapabilities","method":"GET","status":"$undefined"},{"title":"List contact tags","href":"/reference/v2/contacts/listContactTags","method":"GET","status":"$undefined"},{"title":"Add contact tags","href":"/reference/v2/contacts/addContactTags","method":"POST","status":"$undefined"},{"title":"Remove contact tag","href":"/reference/v2/contacts/removeContactTag","method":"DELETE","status":"$undefined"}]},{"title":"Groups","href":"/reference/v2/groups","items":[{"title":"List groups","href":"/reference/v2/groups/listGroups","method":"GET","status":"$undefined"},{"title":"Create group","href":"/reference/v2/groups/createGroup","method":"POST","status":"$undefined"},{"title":"Get group","href":"/reference/v2/groups/getGroup","method":"GET","status":"$undefined"},{"title":"Update group","href":"/reference/v2/groups/updateGroup","method":"PATCH","status":"$undefined"},{"title":"Delete group","href":"/reference/v2/groups/deleteGroup","method":"DELETE","status":"$undefined"},{"title":"Set group icon","href":"/reference/v2/groups/setGroupIcon","method":"POST","status":"$undefined"},{"title":"Remove group icon","href":"/reference/v2/groups/removeGroupIcon","method":"DELETE","status":"$undefined"}]},{"title":"Group Members","href":"/reference/v2/group-members","items":[{"title":"List group members","href":"/reference/v2/group-members/listGroupMembers","method":"GET","status":"$undefined"},{"title":"Add group member","href":"/reference/v2/group-members/addGroupMember","method":"POST","status":"planned"},{"title":"Remove group member","href":"/reference/v2/group-members/removeGroupMember","method":"DELETE","status":"planned"}]},{"title":"Webhooks","href":"/reference/v2/webhooks","items":[{"title":"List webhooks","href":"/reference/v2/webhooks/listWebhooks","method":"GET","status":"$undefined"},{"title":"Create webhook","href":"/reference/v2/webhooks/createWebhook","method":"POST","status":"$undefined"},{"title":"Get webhook","href":"/reference/v2/webhooks/getWebhook","method":"GET","status":"$undefined"},{"title":"Update webhook","href":"/reference/v2/webhooks/updateWebhook","method":"PATCH","status":"$undefined"},{"title":"Delete webhook","href":"/reference/v2/webhooks/deleteWebhook","method":"DELETE","status":"$undefined"},{"title":"Rotate webhook secret","href":"/reference/v2/webhooks/rotateWebhookSecret","method":"POST","status":"$undefined"}]},{"title":"Webhook Logs","href":"/reference/v2/webhook-logs","items":[{"title":"List webhook logs","href":"/reference/v2/webhook-logs/listWebhookLogs","method":"GET","status":"$undefined"},{"title":"Replay webhook event","href":"/reference/v2/webhook-logs/replayWebhookEvent","method":"POST","status":"$undefined"}]},{"title":"Chats","href":"/reference/v2/chats","items":[{"title":"List chats","href":"/reference/v2/chats/listChats","method":"GET","status":"$undefined"},{"title":"Get chat","href":"/reference/v2/chats/getChat","method":"GET","status":"$undefined"},{"title":"Get chat background","href":"/reference/v2/chats/getChatBackground","method":"GET","status":"$undefined"},{"title":"Set chat background","href":"/reference/v2/chats/setChatBackground","method":"PUT","status":"$undefined"},{"title":"Remove chat background","href":"/reference/v2/chats/removeChatBackground","method":"DELETE","status":"$undefined"}]},{"title":"Messages","href":"/reference/v2/messages","items":[{"title":"List chat messages","href":"/reference/v2/messages/listChatMessages","method":"GET","status":"$undefined"},{"title":"Send message","href":"/reference/v2/messages/sendMessage","method":"POST","status":"$undefined"},{"title":"Get message","href":"/reference/v2/messages/getMessage","method":"GET","status":"$undefined"},{"title":"Get message status","href":"/reference/v2/messages/getMessageStatus","method":"GET","status":"$undefined"}]},{"title":"Typing Indicators","href":"/reference/v2/typing-indicators","items":[{"title":"Start typing","href":"/reference/v2/typing-indicators/startTyping","method":"POST","status":"$undefined"},{"title":"Stop typing","href":"/reference/v2/typing-indicators/stopTyping","method":"DELETE","status":"$undefined"}]},{"title":"Read Receipts","href":"/reference/v2/read-receipts","items":[{"title":"Mark chat read","href":"/reference/v2/read-receipts/markChatRead","method":"POST","status":"$undefined"}]},{"title":"Reactions","href":"/reference/v2/reactions","items":[{"title":"Add reaction","href":"/reference/v2/reactions/addReaction","method":"POST","status":"$undefined"}]},{"title":"Polls","href":"/reference/v2/polls","items":[{"title":"Send poll","href":"/reference/v2/polls/sendPoll","method":"POST","status":"$undefined"},{"title":"Get poll results","href":"/reference/v2/polls/getPollResults","method":"GET","status":"$undefined"}]},{"title":"Location","href":"/reference/v2/location","items":[{"title":"List location contacts","href":"/reference/v2/location/listLocationContacts","method":"GET","status":"$undefined"},{"title":"Refresh location contacts","href":"/reference/v2/location/refreshLocationContacts","method":"POST","status":"$undefined"},{"title":"Get location contact","href":"/reference/v2/location/getLocationContact","method":"GET","status":"$undefined"}]},{"title":"FaceTime","href":"/reference/v2/facetime","items":[{"title":"Call face time","href":"/reference/v2/facetime/callFaceTime","method":"POST","status":"planned"}]},{"title":"Phone Numbers","href":"/reference/v2/phone-numbers","items":[{"title":"Batch lookup phone numbers","href":"/reference/v2/phone-numbers/batchLookupPhoneNumbers","method":"POST","status":"$undefined"},{"title":"Lookup phone number","href":"/reference/v2/phone-numbers/lookupPhoneNumber","method":"GET","status":"$undefined"},{"title":"Lookup phone number post","href":"/reference/v2/phone-numbers/lookupPhoneNumberPost","method":"POST","status":"$undefined"}]},{"title":"Analytics","href":"/reference/v2/analytics","items":[{"title":"Get risk tolerance","href":"/reference/v2/analytics/getRiskTolerance","method":"GET","status":"$undefined"},{"title":"Get risk summary","href":"/reference/v2/analytics/getRiskSummary","method":"GET","status":"$undefined"},{"title":"Get number risk tolerance","href":"/reference/v2/analytics/getNumberRiskTolerance","method":"GET","status":"$undefined"}]}],"v4":[{"title":"Account","href":"/reference/v4/account","items":[{"title":"Get me","href":"/reference/v4/account/getMe","method":"GET","status":"$undefined"},{"title":"List numbers","href":"/reference/v4/account/listNumbers","method":"GET","status":"$undefined"},{"title":"Request call forwarding","href":"/reference/v4/account/requestCallForwarding","method":"POST","status":"$undefined"},{"title":"Get contact card","href":"/reference/v4/account/getContactCard","method":"GET","status":"$undefined"},{"title":"Update contact card","href":"/reference/v4/account/updateContactCard","method":"PUT","status":"$undefined"},{"title":"Upload contact card avatar","href":"/reference/v4/account/uploadContactCardAvatar","method":"POST","status":"$undefined"},{"title":"Get my default priority","href":"/reference/v4/account/getMyDefaultPriority","method":"GET","status":"$undefined"}]},{"title":"Location","href":"/reference/v4/location","items":[{"title":"List location contacts","href":"/reference/v4/location/listLocationContacts","method":"GET","status":"$undefined"},{"title":"Refresh location contacts get","href":"/reference/v4/location/refreshLocationContactsGet","method":"GET","status":"$undefined"},{"title":"Refresh location contacts","href":"/reference/v4/location/refreshLocationContacts","method":"POST","status":"$undefined"},{"title":"Get location contact","href":"/reference/v4/location/getLocationContact","method":"GET","status":"$undefined"}]},{"title":"Channels","href":"/reference/v4/channels","items":[{"title":"List channels","href":"/reference/v4/channels/listChannels","method":"GET","status":"$undefined"},{"title":"List available blooio numbers","href":"/reference/v4/channels/listAvailableBlooioNumbers","method":"GET","status":"$undefined"},{"title":"Purchase blooio numbers","href":"/reference/v4/channels/purchaseBlooioNumbers","method":"POST","status":"$undefined"},{"title":"Get blooio purchase","href":"/reference/v4/channels/getBlooioPurchase","method":"GET","status":"$undefined"},{"title":"Get channel","href":"/reference/v4/channels/getChannel","method":"GET","status":"$undefined"},{"title":"Remove blooio number","href":"/reference/v4/channels/removeBlooioNumber","method":"DELETE","status":"$undefined"},{"title":"Get channel capabilities","href":"/reference/v4/channels/getChannelCapabilities","method":"GET","status":"$undefined"},{"title":"Get channel health","href":"/reference/v4/channels/getChannelHealth","method":"GET","status":"$undefined"},{"title":"Send message to channel","href":"/reference/v4/channels/sendMessageToChannel","method":"POST","status":"$undefined"},{"title":"Update channel profile","href":"/reference/v4/channels/updateChannelProfile","method":"PUT","status":"$undefined"},{"title":"Get channel settings","href":"/reference/v4/channels/getChannelSettings","method":"GET","status":"$undefined"},{"title":"Update channel settings","href":"/reference/v4/channels/updateChannelSettings","method":"PATCH","status":"$undefined"}]},{"title":"Priorities","href":"/reference/v4/priorities","items":[{"title":"List priorities","href":"/reference/v4/priorities/listPriorities","method":"GET","status":"$undefined"},{"title":"Create priority","href":"/reference/v4/priorities/createPriority","method":"POST","status":"$undefined"},{"title":"Get priority","href":"/reference/v4/priorities/getPriority","method":"GET","status":"$undefined"},{"title":"Update priority","href":"/reference/v4/priorities/updatePriority","method":"PATCH","status":"$undefined"},{"title":"Delete priority","href":"/reference/v4/priorities/deletePriority","method":"DELETE","status":"$undefined"}]},{"title":"Contacts","href":"/reference/v4/contacts","items":[{"title":"List contacts","href":"/reference/v4/contacts/listContacts","method":"GET","status":"$undefined"},{"title":"Create contact","href":"/reference/v4/contacts/createContact","method":"POST","status":"$undefined"},{"title":"Get contact","href":"/reference/v4/contacts/getContact","method":"GET","status":"$undefined"},{"title":"Update contact","href":"/reference/v4/contacts/updateContact","method":"PATCH","status":"$undefined"},{"title":"Delete contact","href":"/reference/v4/contacts/deleteContact","method":"DELETE","status":"$undefined"},{"title":"Get contact capabilities","href":"/reference/v4/contacts/getContactCapabilities","method":"GET","status":"$undefined"},{"title":"List contact identities","href":"/reference/v4/contacts/listContactIdentities","method":"GET","status":"$undefined"},{"title":"Attach contact identity","href":"/reference/v4/contacts/attachContactIdentity","method":"POST","status":"$undefined"},{"title":"Update contact identity","href":"/reference/v4/contacts/updateContactIdentity","method":"PATCH","status":"$undefined"},{"title":"Detach contact identity","href":"/reference/v4/contacts/detachContactIdentity","method":"DELETE","status":"$undefined"},{"title":"Merge contact","href":"/reference/v4/contacts/mergeContact","method":"POST","status":"$undefined"},{"title":"List contact tags","href":"/reference/v4/contacts/listContactTags","method":"GET","status":"$undefined"},{"title":"Add contact tags","href":"/reference/v4/contacts/addContactTags","method":"POST","status":"$undefined"},{"title":"Remove contact tag","href":"/reference/v4/contacts/removeContactTag","method":"DELETE","status":"$undefined"},{"title":"Get contact timeline","href":"/reference/v4/contacts/getContactTimeline","method":"GET","status":"$undefined"}]},{"title":"Chats","href":"/reference/v4/chats","items":[{"title":"List chats","href":"/reference/v4/chats/listChats","method":"GET","status":"$undefined"},{"title":"Create chat","href":"/reference/v4/chats/createChat","method":"POST","status":"$undefined"},{"title":"Get chat","href":"/reference/v4/chats/getChat","method":"GET","status":"$undefined"},{"title":"Update chat","href":"/reference/v4/chats/updateChat","method":"PATCH","status":"$undefined"},{"title":"Get chat background","href":"/reference/v4/chats/getChatBackground","method":"GET","status":"$undefined"},{"title":"Set chat background","href":"/reference/v4/chats/setChatBackground","method":"PUT","status":"$undefined"},{"title":"Remove chat background","href":"/reference/v4/chats/removeChatBackground","method":"DELETE","status":"$undefined"},{"title":"Share contact card","href":"/reference/v4/chats/shareContactCard","method":"POST","status":"$undefined"},{"title":"Get chat focus","href":"/reference/v4/chats/getChatFocus","method":"GET","status":"$undefined"},{"title":"List chat participants","href":"/reference/v4/chats/listChatParticipants","method":"GET","status":"planned"},{"title":"Add chat participant","href":"/reference/v4/chats/addChatParticipant","method":"POST","status":"planned"},{"title":"Remove chat participant","href":"/reference/v4/chats/removeChatParticipant","method":"DELETE","status":"planned"},{"title":"Mark chat read","href":"/reference/v4/chats/markChatRead","method":"POST","status":"$undefined"},{"title":"Set typing","href":"/reference/v4/chats/setTyping","method":"POST","status":"$undefined"},{"title":"Stop typing","href":"/reference/v4/chats/stopTyping","method":"DELETE","status":"$undefined"}]},{"title":"Messages","href":"/reference/v4/messages","items":[{"title":"Create attachment","href":"/reference/v4/messages/createAttachment","method":"POST","status":"planned"},{"title":"Get attachment","href":"/reference/v4/messages/getAttachment","method":"GET","status":"planned"},{"title":"List chat messages","href":"/reference/v4/messages/listChatMessages","method":"GET","status":"$undefined"},{"title":"Send message to chat","href":"/reference/v4/messages/sendMessageToChat","method":"POST","status":"$undefined"},{"title":"Get chat message","href":"/reference/v4/messages/getChatMessage","method":"GET","status":"$undefined"},{"title":"List message events","href":"/reference/v4/messages/listMessageEvents","method":"GET","status":"$undefined"},{"title":"Notify message","href":"/reference/v4/messages/notifyMessage","method":"POST","status":"$undefined"},{"title":"Add reaction","href":"/reference/v4/messages/addReaction","method":"POST","status":"$undefined"},{"title":"Get message status","href":"/reference/v4/messages/getMessageStatus","method":"GET","status":"$undefined"},{"title":"Send message","href":"/reference/v4/messages/sendMessage","method":"POST","status":"$undefined"},{"title":"List templates","href":"/reference/v4/messages/listTemplates","method":"GET","status":"planned"},{"title":"Create template","href":"/reference/v4/messages/createTemplate","method":"POST","status":"planned"},{"title":"Get template","href":"/reference/v4/messages/getTemplate","method":"GET","status":"planned"},{"title":"Delete template","href":"/reference/v4/messages/deleteTemplate","method":"DELETE","status":"planned"}]},{"title":"Polls","href":"/reference/v4/polls","items":[{"title":"Send poll","href":"/reference/v4/polls/sendPoll","method":"POST","status":"$undefined"},{"title":"Get poll results","href":"/reference/v4/polls/getPollResults","method":"GET","status":"$undefined"},{"title":"Vote poll","href":"/reference/v4/polls/votePoll","method":"POST","status":"$undefined"}]},{"title":"Groups","href":"/reference/v4/groups","items":[{"title":"List groups","href":"/reference/v4/groups/listGroups","method":"GET","status":"$undefined"},{"title":"Create group","href":"/reference/v4/groups/createGroup","method":"POST","status":"$undefined"},{"title":"Get group","href":"/reference/v4/groups/getGroup","method":"GET","status":"$undefined"},{"title":"Update group","href":"/reference/v4/groups/updateGroup","method":"PATCH","status":"$undefined"},{"title":"Delete group","href":"/reference/v4/groups/deleteGroup","method":"DELETE","status":"$undefined"},{"title":"Set group icon","href":"/reference/v4/groups/setGroupIcon","method":"POST","status":"$undefined"},{"title":"Remove group icon","href":"/reference/v4/groups/removeGroupIcon","method":"DELETE","status":"$undefined"},{"title":"List group members","href":"/reference/v4/groups/listGroupMembers","method":"GET","status":"$undefined"}]},{"title":"Webhooks","href":"/reference/v4/webhooks","items":[{"title":"List webhooks","href":"/reference/v4/webhooks/listWebhooks","method":"GET","status":"$undefined"},{"title":"Create webhook","href":"/reference/v4/webhooks/createWebhook","method":"POST","status":"$undefined"},{"title":"List webhook versions","href":"/reference/v4/webhooks/listWebhookVersions","method":"GET","status":"$undefined"},{"title":"Get webhook","href":"/reference/v4/webhooks/getWebhook","method":"GET","status":"$undefined"},{"title":"Update webhook","href":"/reference/v4/webhooks/updateWebhook","method":"PATCH","status":"$undefined"},{"title":"Delete webhook","href":"/reference/v4/webhooks/deleteWebhook","method":"DELETE","status":"$undefined"},{"title":"List webhook deliveries","href":"/reference/v4/webhooks/listWebhookDeliveries","method":"GET","status":"$undefined"},{"title":"Replay webhook delivery","href":"/reference/v4/webhooks/replayWebhookDelivery","method":"POST","status":"$undefined"},{"title":"Rotate webhook secret","href":"/reference/v4/webhooks/rotateWebhookSecret","method":"POST","status":"$undefined"}]},{"title":"Events","href":"/reference/v4/events","items":[{"title":"List events","href":"/reference/v4/events/listEvents","method":"GET","status":"$undefined"},{"title":"Get event","href":"/reference/v4/events/getEvent","method":"GET","status":"$undefined"}]},{"title":"Phone Numbers","href":"/reference/v4/phone-numbers","items":[{"title":"Batch lookup phone numbers","href":"/reference/v4/phone-numbers/batchLookupPhoneNumbers","method":"POST","status":"$undefined"},{"title":"Lookup phone number","href":"/reference/v4/phone-numbers/lookupPhoneNumber","method":"GET","status":"$undefined"},{"title":"Lookup phone number post","href":"/reference/v4/phone-numbers/lookupPhoneNumberPost","method":"POST","status":"$undefined"}]},{"title":"API Keys","href":"/reference/v4/api-keys","items":[{"title":"List API keys","href":"/reference/v4/api-keys/listApiKeys","method":"GET","status":"$undefined"},{"title":"Create API key","href":"/reference/v4/api-keys/createApiKey","method":"POST","status":"$undefined"},{"title":"Get API key","href":"/reference/v4/api-keys/getApiKey","method":"GET","status":"$undefined"},{"title":"Deprecate API key","href":"/reference/v4/api-keys/deprecateApiKey","method":"DELETE","status":"$undefined"},{"title":"List API key channels","href":"/reference/v4/api-keys/listApiKeyChannels","method":"GET","status":"$undefined"},{"title":"Assign channel to API key","href":"/reference/v4/api-keys/assignChannelToApiKey","method":"PUT","status":"$undefined"},{"title":"Unassign channel from API key","href":"/reference/v4/api-keys/unassignChannelFromApiKey","method":"DELETE","status":"$undefined"}]},{"title":"AI","href":"/reference/v4/ai","items":[{"title":"Decide bloobability v1","href":"/reference/v4/ai/decideBloobabilityV1","method":"POST","status":"$undefined"},{"title":"Decide bloobability v2","href":"/reference/v4/ai/decideBloobabilityV2","method":"POST","status":"$undefined"}]}]}},"searchIndex":[{"id":"v2:/","title":"Overview","href":"/","group":"Getting started · v2","version":"v2","keywords":"overview getting started v2","text":"","sections":[]},{"id":"v2:/quickstart","title":"Quickstart","href":"/quickstart","group":"Getting started · v2","version":"v2","keywords":"quickstart getting started v2","text":"Blooio is a messaging API for iMessage and SMS . This guide sends your first message. Get an API key Create an API key in the Blooio dashboard. Keys look like and authenticate every request as a bearer token. Send a message Send a message to a chat addressed by the recipient's phone number or email. The identifier goes in the URL path, so URL encode it ( becomes ): The response contains the queued message with its and . Poll the message status endpoint or subscribe to a webhook to track delivery. Receive replies Create a webhook to get inbound messages delivered to your server in real time.","sections":[{"id":"v2-get-an-api-key","title":"Get an API key"},{"id":"v2-send-a-message","title":"Send a message"},{"id":"v2-receive-replies","title":"Receive replies"}]},{"id":"v2:/authentication","title":"Authentication","href":"/authentication","group":"Getting started · v2","version":"v2","keywords":"authentication getting started v2","text":"All requests authenticate with an API key sent as a bearer token : Create and revoke keys from the Blooio dashboard. Treat keys like passwords — never embed them in client side code or commit them to source control. Base URL: Errors A missing or invalid key returns . The authentication layer uses a flat error shape: Plan or permission gates (for example enterprise only endpoints) return with the same shape.","sections":[{"id":"v2-errors","title":"Errors"}]},{"id":"v2:/migrating-to-v4","title":"Migrating from v2 to v4","href":"/migrating-to-v4","group":"Getting started · v2","version":"v2","keywords":"migrating from v2 to v4 getting started v2","text":"$3","sections":[{"id":"base-url","title":"Base URL"},{"id":"sending-a-message","title":"Sending a message"},{"id":"what-changed-at-a-glance","title":"What changed at a glance"},{"id":"migration-checklist","title":"Migration checklist"}]},{"id":"v2:/errors","title":"Errors","href":"/errors","group":"Core concepts · v2","version":"v2","keywords":"errors core concepts v2","text":"The API uses conventional HTTP status codes. Errors return a flat envelope: The field is a stable, machine readable identifier present on known error cases — branch on it rather than the human readable . Status codes | Status | Meaning | | | | | | Malformed request or validation failure. | | | Missing or invalid API key. | | | Authenticated but not allowed (plan/permission gate). | | | Resource not found. | | | Conflicting state (e.g. webhook limit reached). | | | Rate limit exceeded. | Errors with status or above carry only , , and the error's , when it has one.","sections":[{"id":"v2-status-codes","title":"Status codes"}]},{"id":"v2:/idempotency","title":"Idempotency","href":"/idempotency","group":"Core concepts · v2","version":"v2","keywords":"idempotency core concepts v2","text":"Send endpoints accept an optional header so you can retry safely after a network error: Replaying the same key returns the original and (HTTP ) instead of sending again, so a retried request never creates a duplicate message. Use a unique key (such as a UUID) per logical send.","sections":[]},{"id":"v2:/pagination","title":"Pagination","href":"/pagination","group":"Core concepts · v2","version":"v2","keywords":"pagination core concepts v2","text":"List endpoints return a page of results plus pagination metadata: Use (1–200, default 50) to control page size and to skip results. To fetch the next page, add to the current : You have reached the end of the list once is greater than or equal to .","sections":[]},{"id":"v2:/guides/message-sending","title":"Message sending basics","href":"/guides/message-sending","group":"Sending messages · v2","version":"v2","keywords":"message sending basics sending messages v2","text":"$4","sections":[{"id":"the-basics","title":"The basics"},{"id":"chat-id-formats","title":"Chat ID formats"},{"id":"url-encoding-phone-numbers","title":"URL encoding phone numbers"},{"id":"multi-recipient-messages","title":"Multi-recipient messages"},{"id":"message-body-options","title":"Message body options"},{"id":"text-messages","title":"Text messages"},{"id":"rich-text-markdown","title":"Rich text (Markdown)"},{"id":"attachments","title":"Attachments"},{"id":"typing-indicators","title":"Typing indicators"},{"id":"sender-number","title":"Sender number"},{"id":"message-status-lifecycle","title":"Message status lifecycle"},{"id":"checking-status","title":"Checking status"},{"id":"protocol-detection","title":"Protocol detection"},{"id":"common-quirks-and-gotchas","title":"Common quirks and gotchas"},{"id":"phone-numbers-must-be-e-164-format","title":"Phone numbers must be E.164 format"},{"id":"messages-return-202-not-200","title":"Messages return 202, not 200"},{"id":"use-idempotency-keys-for-retries","title":"Use idempotency keys for retries"},{"id":"group-messages-need-a-linked-chat","title":"Group messages need a linked chat"},{"id":"emergency-numbers-are-blocked","title":"Emergency numbers are blocked"},{"id":"sender-availability-matters","title":"Sender availability matters"},{"id":"messaging-safety-limits-exist","title":"Messaging safety limits exist"},{"id":"response-codes-summary","title":"Response codes summary"},{"id":"next-steps","title":"Next steps"}]},{"id":"v2:/guides/messaging-safety","title":"Messaging safety limits and recovery","href":"/guides/messaging-safety","group":"Sending messages · v2","version":"v2","keywords":"messaging safety limits and recovery sending messages v2","text":"$5","sections":[{"id":"conversation-limits","title":"Conversation limits"},{"id":"conversation-error-handling","title":"Conversation error handling"},{"id":"number-level-protections","title":"Number-level protections"},{"id":"recovery-by-reason","title":"Recovery by reason"},{"id":"oneway-broad-outreach-with-too-few-replies","title":"oneway: broad outreach with too few replies"},{"id":"template-repeated-first-message-openers","title":"template: repeated first-message openers"},{"id":"delivery-recent-delivery-health-changed","title":"delivery: recent delivery health changed"},{"id":"siblingban-another-number-on-the-account-was-banned","title":"siblingban: another number on the account was banned"},{"id":"when-the-protection-clears","title":"When the protection clears"},{"id":"monitor-line-health","title":"Monitor line health"},{"id":"how-fresh-the-data-is","title":"How fresh the data is"},{"id":"slow-down-before-a-protection-applies","title":"Slow down before a protection applies"},{"id":"turning-limits-off","title":"Turning limits off"},{"id":"integration-checklist","title":"Integration checklist"}]},{"id":"v2:/guides/attachments","title":"Send attachments","href":"/guides/attachments","group":"Sending messages · v2","version":"v2","keywords":"send attachments sending messages v2","text":"$6","sections":[{"id":"supported-attachments","title":"Supported attachments"},{"id":"named-attachments","title":"Named attachments"},{"id":"photo-video-carousels-imessage","title":"Photo & video carousels (iMessage)"},{"id":"send-from-an-attachments-array","title":"Send from an attachments array"},{"id":"send-from-parts","title":"Send from parts"},{"id":"what-will-and-won-t-send","title":"What will (and won't) send"},{"id":"reactions-on-a-specific-image","title":"Reactions on a specific image"},{"id":"attribution-badge-imessage","title":"Attribution badge (iMessage)"},{"id":"best-practices","title":"Best practices"}]},{"id":"v2:/guides/link-previews","title":"Rich link previews","href":"/guides/link-previews","group":"Sending messages · v2","version":"v2","keywords":"rich link previews sending messages v2","text":"$7","sections":[{"id":"auto-generated-preview","title":"Auto-generated preview"},{"id":"override-the-image-and-title","title":"Override the image and title"},{"id":"fields","title":"Fields"},{"id":"batch-multiple-url-messages-in-one-request","title":"Batch — multiple URL messages in one request"},{"id":"validation-rules","title":"Validation rules"},{"id":"failure-handling","title":"Failure handling"},{"id":"what-the-recipient-sees","title":"What the recipient sees"},{"id":"animated-previews","title":"Animated previews"},{"id":"related","title":"Related"}]},{"id":"v2:/guides/custom-bubbles","title":"Custom bubbles (iMessage apps)","href":"/guides/custom-bubbles","group":"Sending messages · v2","version":"v2","keywords":"custom bubbles (imessage apps) sending messages v2","text":"$8","sections":[{"id":"sending-a-custom-bubble","title":"Sending a custom bubble"},{"id":"how-the-card-looks-and-what-happens-on-tap","title":"How the card looks — and what happens on tap"},{"id":"if-you-want-a-big-tappable-card-instead","title":"If you want a big, tappable card instead"},{"id":"what-to-include-and-skip","title":"What to include (and skip)"},{"id":"receiving-a-custom-bubble","title":"Receiving a custom bubble"},{"id":"building-a-stateful-experience","title":"Building a stateful experience"},{"id":"delivery-status","title":"Delivery status"},{"id":"related","title":"Related"}]},{"id":"v2:/guides/apple-system-apps","title":"Find My & Check In bubbles","href":"/guides/apple-system-apps","group":"Sending messages · v2","version":"v2","keywords":"find my & check in bubbles sending messages v2","text":"$9","sections":[{"id":"apple-app-identifiers","title":"Apple app identifiers"},{"id":"find-my","title":"Find My"},{"id":"check-in","title":"Check In"},{"id":"receiving","title":"Receiving"},{"id":"related","title":"Related"}]},{"id":"v2:/guides/number-pools","title":"Number Pools","href":"/guides/number-pools","group":"Sending messages · v2","version":"v2","keywords":"number pools sending messages v2","text":"$a","sections":[{"id":"how-number-pools-work","title":"How number pools work"},{"id":"blooio-imessage-number-pools","title":"Blooio (iMessage) number pools"},{"id":"automatic-rotation","title":"Automatic rotation"},{"id":"conversation-stickiness","title":"Conversation stickiness"},{"id":"explicit-number-selection","title":"Explicit number selection"},{"id":"allocation-pools","title":"Allocation pools"},{"id":"twilio-number-pools","title":"Twilio number pools"},{"id":"manual-or-first-available-selection","title":"Manual or first-available selection"},{"id":"no-automatic-stickiness","title":"No automatic stickiness"},{"id":"explicit-selection-recommended","title":"Explicit selection recommended"},{"id":"inbound-numbers-reply-only","title":"Inbound numbers (reply-only)"},{"id":"comparison-blooio-vs-twilio-pools","title":"Comparison: Blooio vs Twilio pools"},{"id":"setting-up-your-number-pool","title":"Setting up your number pool"},{"id":"for-blooio-numbers","title":"For Blooio numbers"},{"id":"for-twilio-numbers","title":"For Twilio numbers"},{"id":"best-practices","title":"Best practices"},{"id":"separate-api-keys-by-use-case","title":"Separate API keys by use case"},{"id":"don-t-mix-protocols-in-logic","title":"Don't mix protocols in logic"},{"id":"monitor-number-health","title":"Monitor number health"},{"id":"use-geographic-matching-when-possible","title":"Use geographic matching when possible"},{"id":"plan-for-growth","title":"Plan for growth"},{"id":"common-errors","title":"Common errors"},{"id":"this-api-key-does-not-own-the-specified-fromnumber","title":"\"This API key does not own the specified fromnumber\""},{"id":"no-numbers-assigned-to-this-api-key","title":"\"No numbers assigned to this API key\""},{"id":"api-key-already-owns-blooio-numbers","title":"\"API key already owns Blooio numbers\""}]},{"id":"v2:/hybrid-mode","title":"Hybrid mode","href":"/hybrid-mode","group":"Sending messages · v2","version":"v2","keywords":"hybrid mode sending messages v2","text":"$b","sections":[{"id":"v2-what-it-does","title":"What it does"},{"id":"v2-requirements","title":"Requirements"},{"id":"v2-send-like-normal","title":"Send like normal"},{"id":"v2-configure-in-the-dashboard","title":"Configure in the dashboard"},{"id":"v2-when-not-to-use-hybrid","title":"When not to use hybrid"},{"id":"v2-related","title":"Related"}]},{"id":"v2:/webhooks","title":"Webhooks","href":"/webhooks","group":"Receiving & webhooks · v2","version":"v2","keywords":"webhooks receiving & webhooks v2","text":"Webhooks deliver events to your server as they happen. Create a subscription with : The creation response includes a once — store it to verify deliveries. Event payload Each delivery is a JSON envelope identifying the event, with the resource it relates to in : Subscriptions registered through the v2 webhook endpoint keep receiving the flat body they were built for: Verifying signatures Each delivery is signed with your (HMAC SHA256) and sent in the header. Recompute the signature over and compare it before trusting the payload — see Verify webhook signatures. Event types A subscription receives every event type — inbound and outbound message events (received, sent, delivered, failed, read, reactions), polls, groups, and contact card events. Switch on in your handler to pick out the ones you act on. Inspect and replay past deliveries with , or with for a subscription registered through the v2 endpoint.","sections":[{"id":"v2-event-payload","title":"Event payload"},{"id":"v2-verifying-signatures","title":"Verifying signatures"},{"id":"v2-event-types","title":"Event types"}]},{"id":"v2:/guides/webhooks-local","title":"Receive webhooks locally","href":"/guides/webhooks-local","group":"Receiving & webhooks · v2","version":"v2","keywords":"receive webhooks locally receiving & webhooks v2","text":"Overview Run a local server, expose it with a tunnel (e.g., ngrok), and point Blooio to the public URL. Start a local server Expose the server Copy the HTTPS URL from ngrok, e.g., . Configure your webhook URL Create a new webhook using the API: The response is with the subscription wrapped in a envelope. It carries the once, at creation: Note The URL must be . A subscription receives every event type — switch on the field in your handler to pick out the ones you care about. Verify deliveries You should see incoming events in your terminal. See event schemas in Webhook events. Managing webhooks List all webhooks Update a webhook Updatable fields are and ( or ): Delete a webhook Rotate webhook secret If you need a new signing secret: Inspect deliveries","sections":[{"id":"overview","title":"Overview"},{"id":"start-a-local-server","title":"Start a local server"},{"id":"expose-the-server","title":"Expose the server"},{"id":"configure-your-webhook-url","title":"Configure your webhook URL"},{"id":"verify-deliveries","title":"Verify deliveries"},{"id":"managing-webhooks","title":"Managing webhooks"},{"id":"list-all-webhooks","title":"List all webhooks"},{"id":"update-a-webhook","title":"Update a webhook"},{"id":"delete-a-webhook","title":"Delete a webhook"},{"id":"rotate-webhook-secret","title":"Rotate webhook secret"},{"id":"inspect-deliveries","title":"Inspect deliveries"}]},{"id":"v2:/guides/webhook-signatures","title":"Verify webhook signatures","href":"/guides/webhook-signatures","group":"Receiving & webhooks · v2","version":"v2","keywords":"verify webhook signatures receiving & webhooks v2","text":"$c","sections":[{"id":"overview","title":"Overview"},{"id":"signature-format","title":"Signature format"},{"id":"getting-your-signing-secret","title":"Getting your signing secret"},{"id":"rotating-your-secret","title":"Rotating your secret"},{"id":"verifying-signatures","title":"Verifying signatures"},{"id":"troubleshooting","title":"Troubleshooting"},{"id":"common-issues","title":"Common issues"},{"id":"testing-signatures","title":"Testing signatures"},{"id":"best-practices","title":"Best practices"}]},{"id":"v2:/guides/contact-flows","title":"Contact flows","href":"/guides/contact-flows","group":"Contacts & identity · v2","version":"v2","keywords":"contact flows contacts & identity v2","text":"Use the capabilities endpoint to decide which protocol to use. Check capabilities Response example: Send on the best channel If is true, prefer iMessage; otherwise send SMS. Blooio automatically selects the best protocol, but you can track which was used via webhooks. Store the expected protocol in for downstream analytics. Managing contacts You can also create and manage contacts with the v2 API: Create a contact Update a contact List contacts","sections":[{"id":"check-capabilities","title":"Check capabilities"},{"id":"send-on-the-best-channel","title":"Send on the best channel"},{"id":"managing-contacts","title":"Managing contacts"},{"id":"create-a-contact","title":"Create a contact"},{"id":"update-a-contact","title":"Update a contact"},{"id":"list-contacts","title":"List contacts"}]},{"id":"v2:/guides/contact-card","title":"Contact cards (Name & Photo)","href":"/guides/contact-card","group":"Contacts & identity · v2","version":"v2","keywords":"contact cards (name & photo) contacts & identity v2","text":"$d","sections":[{"id":"overview","title":"Overview"},{"id":"prerequisites","title":"Prerequisites"},{"id":"discovering-your-numbers","title":"Discovering your numbers"},{"id":"reading-your-contact-card","title":"Reading your contact card"},{"id":"updating-your-contact-card","title":"Updating your contact card"},{"id":"updating-the-profile-photo","title":"Updating the profile photo"},{"id":"sharing-your-contact-card-in-a-chat","title":"Sharing your contact card in a chat"},{"id":"option-1-standalone-endpoint-stage-then-send-separately","title":"Option 1: Standalone endpoint (stage, then send separately)"},{"id":"option-2-flag-on-send-message-one-call","title":"Option 2: Flag on send-message (one call)"},{"id":"how-sharing-works","title":"How sharing works"},{"id":"sharing-settings-reference","title":"Sharing settings reference"}]},{"id":"v2:/guides/twilio-integration","title":"Twilio Integration","href":"/guides/twilio-integration","group":"Integrations · v2","version":"v2","keywords":"twilio integration integrations v2","text":"$e","sections":[{"id":"overview","title":"Overview"},{"id":"when-to-use-twilio-vs-blooio","title":"When to use Twilio vs Blooio"},{"id":"the-hybrid-approach","title":"The hybrid approach"},{"id":"setup","title":"Setup"},{"id":"connect-your-twilio-account","title":"Connect your Twilio account"},{"id":"import-phone-numbers","title":"Import phone numbers"},{"id":"create-an-api-key-for-twilio","title":"Create an API key for Twilio"},{"id":"sending-messages","title":"Sending messages"},{"id":"using-the-api","title":"Using the API"},{"id":"specifying-the-sender-number","title":"Specifying the sender number"},{"id":"number-pools","title":"Number pools"},{"id":"what-is-a-number-pool","title":"What is a number pool?"},{"id":"how-auto-selection-works","title":"How auto-selection works"},{"id":"twilio-vs-blooio-number-pools","title":"Twilio vs Blooio number pools"},{"id":"receiving-messages","title":"Receiving messages"},{"id":"message-status","title":"Message status"},{"id":"limitations","title":"Limitations"},{"id":"compared-to-blooio-imessage","title":"Compared to Blooio (iMessage)"},{"id":"rate-limits","title":"Rate limits"},{"id":"webhook-validation","title":"Webhook validation"},{"id":"best-practices","title":"Best practices"},{"id":"troubleshooting","title":"Troubleshooting"},{"id":"no-twilio-numbers-assigned-to-this-api-key","title":"\"No Twilio numbers assigned to this API key\""},{"id":"this-api-key-does-not-own-the-specified-fromnumber","title":"\"This API key does not own the specified fromnumber\""},{"id":"api-key-already-owns-blooio-numbers","title":"\"API key already owns Blooio numbers\""},{"id":"messages-not-being-received","title":"Messages not being received"}]},{"id":"v2:/guides/location-tracking","title":"Location tracking (FindMy)","href":"/guides/location-tracking","group":"Integrations · v2","version":"v2","keywords":"location tracking (findmy) integrations v2","text":"$f","sections":[{"id":"overview","title":"Overview"},{"id":"prerequisites","title":"Prerequisites"},{"id":"listing-all-contact-locations","title":"Listing all contact locations"},{"id":"getting-a-specific-contact-s-location","title":"Getting a specific contact's location"},{"id":"refreshing-locations","title":"Refreshing locations"},{"id":"response-fields","title":"Response fields"},{"id":"location-status-values","title":"Location status values"},{"id":"common-patterns","title":"Common patterns"},{"id":"polling-for-location-updates","title":"Polling for location updates"}]},{"id":"v2:/guides/facetime","title":"FaceTime calls","href":"/guides/facetime","group":"Integrations · v2","version":"v2","keywords":"facetime calls integrations v2","text":"$10","sections":[{"id":"overview","title":"Overview"},{"id":"initiating-a-call","title":"Initiating a call"},{"id":"response-fields","title":"Response fields"},{"id":"how-the-call-flow-works","title":"How the call flow works"},{"id":"error-handling","title":"Error handling"},{"id":"common-patterns","title":"Common patterns"},{"id":"embedding-a-facetime-link-in-a-notification","title":"Embedding a FaceTime link in a notification"},{"id":"webhook-triggered-calls","title":"Webhook-triggered calls"}]},{"id":"v2:/guides/imessage-rest-api","title":"iMessage REST API","href":"/guides/imessage-rest-api","group":"Language tutorials · v2","version":"v2","keywords":"imessage rest api language tutorials v2","text":"$11","sections":[{"id":"what-is-a-rest-api-for-imessage","title":"What is a REST API for iMessage?"},{"id":"base-url","title":"Base URL"},{"id":"authentication","title":"Authentication"},{"id":"resources","title":"Resources"},{"id":"http-verbs","title":"HTTP verbs"},{"id":"sending-a-message","title":"Sending a message"},{"id":"request-conventions","title":"Request conventions"},{"id":"url-encoding-phone-numbers","title":"URL-encoding phone numbers"},{"id":"pagination","title":"Pagination"},{"id":"sorting-and-filtering","title":"Sorting and filtering"},{"id":"response-shape","title":"Response shape"},{"id":"errors","title":"Errors"},{"id":"idempotency","title":"Idempotency"},{"id":"send-limits","title":"Send limits"},{"id":"webhooks","title":"Webhooks"},{"id":"code-examples","title":"Code examples"},{"id":"next-steps","title":"Next steps"}]},{"id":"v2:/guides/send-imessage-api-nodejs","title":"Send iMessage with Node.js","href":"/guides/send-imessage-api-nodejs","group":"Language tutorials · v2","version":"v2","keywords":"send imessage with node.js language tutorials v2","text":"$12","sections":[{"id":"what-you-ll-need","title":"What you'll need"},{"id":"send-your-first-imessage","title":"Send your first iMessage"},{"id":"check-capability-before-sending","title":"Check capability before sending"},{"id":"attachments-and-multipart-messages","title":"Attachments and multipart messages"},{"id":"bulk-sending-with-concurrency-control","title":"Bulk sending with concurrency control"},{"id":"idempotency","title":"Idempotency"},{"id":"receive-incoming-imessages-express","title":"Receive incoming iMessages (Express)"},{"id":"error-handling-and-retries","title":"Error handling and retries"},{"id":"environment-and-secrets","title":"Environment and secrets"},{"id":"going-further","title":"Going further"}]},{"id":"v2:/guides/send-imessage-api-python","title":"Send iMessage with Python","href":"/guides/send-imessage-api-python","group":"Language tutorials · v2","version":"v2","keywords":"send imessage with python language tutorials v2","text":"$13","sections":[{"id":"what-you-ll-need","title":"What you'll need"},{"id":"send-your-first-imessage","title":"Send your first iMessage"},{"id":"check-imessage-capability-first","title":"Check iMessage capability first"},{"id":"send-an-imessage-with-attachments","title":"Send an iMessage with attachments"},{"id":"send-to-a-group","title":"Send to a group"},{"id":"async-with-httpx","title":"Async with httpx"},{"id":"idempotency","title":"Idempotency"},{"id":"receive-incoming-imessages-fastapi","title":"Receive incoming iMessages (FastAPI)"},{"id":"handling-errors","title":"Handling errors"},{"id":"environment-variables","title":"Environment variables"},{"id":"going-further","title":"Going further"}]},{"id":"v4:/","title":"Overview","href":"/","group":"Getting started · v4","version":"v4","keywords":"overview getting started v4","text":"","sections":[]},{"id":"v4:/quickstart","title":"Quickstart","href":"/quickstart","group":"Getting started · v4","version":"v4","keywords":"quickstart getting started v4","text":"Blooio is a multi channel messaging API for iMessage, SMS, RCS, WhatsApp, and Apple Messages for Business . This guide sends your first message. The path of your first message — from to the webhook. Click a step for details; drag to pan, use the controls to zoom. Get an API key Create an API key in the Blooio dashboard. Keys look like and authenticate every request as a bearer token. Send a message Send directly to a recipient. Blooio chooses the sender from your API key's priority; no channel lookup is required: To send from a specific sender, add one string: a phone number ( ), an alias for a non numbered sender ( ), or an exact channel ID ( ) for advanced integrations. See Channels & senders for when to use each form. The response contains the queued message, resolved , , and routing explanation. Poll the message status endpoint or subscribe to a webhook to track delivery. Receive replies Create a webhook to get inbound messages and lifecycle events delivered to your server in real time.","sections":[{"id":"v4-get-an-api-key","title":"Get an API key"},{"id":"v4-send-a-message","title":"Send a message"},{"id":"v4-receive-replies","title":"Receive replies"}]},{"id":"v4:/authentication","title":"Authentication","href":"/authentication","group":"Getting started · v4","version":"v4","keywords":"authentication getting started v4","text":"All requests authenticate with an API key sent as a bearer token : Create and revoke keys from the Blooio dashboard. Treat keys like passwords — never embed them in client side code or commit them to source control. Base URL: Errors A missing or invalid key returns with a flat auth error shape: Most other API errors use the structured v4 envelope — see Errors. Plan or permission gates return with the flat auth shape.","sections":[{"id":"v4-errors","title":"Errors"}]},{"id":"v4:/migrating-to-v4","title":"Migrating from v2 to v4","href":"/migrating-to-v4","group":"Getting started · v4","version":"v4","keywords":"migrating from v2 to v4 getting started v4","text":"$14","sections":[{"id":"base-url","title":"Base URL"},{"id":"sending-a-message","title":"Sending a message"},{"id":"what-changed-at-a-glance","title":"What changed at a glance"},{"id":"migration-checklist","title":"Migration checklist"}]},{"id":"v4:/channels-and-senders","title":"Channels & senders","href":"/channels-and-senders","group":"Core concepts · v4","version":"v4","keywords":"channels & senders core concepts v4","text":"$15","sections":[{"id":"the-vocabulary","title":"The vocabulary"},{"id":"the-default-omit-from","title":"The default: omit from"},{"id":"the-from-string","title":"The from string"},{"id":"exact-number","title":"Exact number"},{"id":"alias","title":"Alias"},{"id":"exact-channel-id","title":"Exact channel ID"},{"id":"channel-scoped-sends","title":"Channel-scoped sends"},{"id":"new-message-vs-reply","title":"New message vs reply"},{"id":"polls","title":"Polls"},{"id":"what-the-response-tells-you","title":"What the response tells you"},{"id":"dashboard-checklist","title":"Dashboard checklist"},{"id":"common-mistakes","title":"Common mistakes"},{"id":"related","title":"Related"}]},{"id":"v4:/priorities","title":"Priorities","href":"/priorities","group":"Core concepts · v4","version":"v4","keywords":"priorities core concepts v4","text":"$16","sections":[{"id":"how-it-relates-to-pools-and-hybrid","title":"How it relates to pools and hybrid"},{"id":"default-vs-named-priorities","title":"Default vs named priorities"},{"id":"tiers-and-same-type-pools","title":"Tiers and same-type pools"},{"id":"create-and-update-via-api","title":"Create and update via API"},{"id":"send-with-an-explicit-priority","title":"Send with an explicit priority"},{"id":"when-to-use-what","title":"When to use what"},{"id":"related","title":"Related"}]},{"id":"v4:/api-keys","title":"API key lifecycle","href":"/api-keys","group":"Core concepts · v4","version":"v4","keywords":"api key lifecycle core concepts v4","text":"$17","sections":[{"id":"1-create-a-key","title":"1. Create a key"},{"id":"from-the-dashboard","title":"From the dashboard"},{"id":"programmatically-blooio-apps-only","title":"Programmatically (Blooio Apps only)"},{"id":"2-assign-channels-numbers-to-the-key","title":"2. Assign channels (numbers) to the key"},{"id":"3-order-the-key-s-channels-with-priorities","title":"3. Order the key's channels with priorities"},{"id":"4-send-with-the-key","title":"4. Send with the key"},{"id":"5-deprecate-the-key","title":"5. Deprecate the key"},{"id":"scopes-and-who-can-manage-keys","title":"Scopes and who can manage keys"},{"id":"related","title":"Related"}]},{"id":"v4:/message-content","title":"Message content","href":"/message-content","group":"Core concepts · v4","version":"v4","keywords":"message content core concepts v4","text":"$18","sections":[{"id":"text","title":"Text"},{"id":"attachments","title":"Attachments"},{"id":"parts","title":"Parts"},{"id":"rich-link","title":"Rich link"},{"id":"poll","title":"Poll"},{"id":"custom-bubble-imessage-app","title":"Custom bubble (iMessage app)"},{"id":"capability-aware-routing","title":"Capability-aware routing"},{"id":"related","title":"Related"}]},{"id":"v4:/errors","title":"Errors","href":"/errors","group":"Core concepts · v4","version":"v4","keywords":"errors core concepts v4","text":"$19","sections":[{"id":"v4-status-codes","title":"Status codes"},{"id":"v4-messaging-safety-codes","title":"Messaging safety codes"},{"id":"v4-message-errors","title":"Message errors"}]},{"id":"v4:/idempotency","title":"Idempotency","href":"/idempotency","group":"Core concepts · v4","version":"v4","keywords":"idempotency core concepts v4","text":"Send endpoints accept an optional header so you can retry safely after a network error: Why a retry with the same key is safe, and when a reused key returns 409. Click a step for details. Replaying the same key with an identical body returns the original result instead of sending again. Replaying the same key with a different body returns . Use a unique key (such as a UUID) per logical send.","sections":[]},{"id":"v4:/pagination","title":"Pagination","href":"/pagination","group":"Core concepts · v4","version":"v4","keywords":"pagination core concepts v4","text":"List endpoints return a page of results plus pagination metadata: Pass back as the query parameter to fetch the next page, and use (1–200, default 50) to control page size: When is , is and you have reached the end of the list. Cursors are opaque — do not parse or construct them.","sections":[]},{"id":"v4:/message-sending","title":"Message sending","href":"/message-sending","group":"Sending messages · v4","version":"v4","keywords":"message sending sending messages v4","text":"$1a","sections":[{"id":"send-to-a-recipient","title":"Send to a recipient"},{"id":"reply-in-an-existing-chat","title":"Reply in an existing chat"},{"id":"what-comes-back","title":"What comes back"},{"id":"content","title":"Content"},{"id":"messaging-safety","title":"Messaging safety"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/messaging-safety","title":"Messaging safety limits and recovery","href":"/guides/messaging-safety","group":"Sending messages · v4","version":"v4","keywords":"messaging safety limits and recovery sending messages v4","text":"$1b","sections":[{"id":"conversation-limits","title":"Conversation limits"},{"id":"conversation-error-handling","title":"Conversation error handling"},{"id":"number-level-protections","title":"Number-level protections"},{"id":"recovery-by-reason","title":"Recovery by reason"},{"id":"oneway-broad-outreach-with-too-few-replies","title":"oneway: broad outreach with too few replies"},{"id":"template-repeated-first-message-openers","title":"template: repeated first-message openers"},{"id":"delivery-recent-delivery-health-changed","title":"delivery: recent delivery health changed"},{"id":"siblingban-another-number-on-the-account-was-banned","title":"siblingban: another number on the account was banned"},{"id":"when-the-protection-clears","title":"When the protection clears"},{"id":"monitor-line-health","title":"Monitor line health"},{"id":"how-fresh-the-data-is","title":"How fresh the data is"},{"id":"slow-down-before-a-protection-applies","title":"Slow down before a protection applies"},{"id":"turning-limits-off","title":"Turning limits off"},{"id":"integration-checklist","title":"Integration checklist"}]},{"id":"v4:/attachments","title":"Attachments","href":"/attachments","group":"Sending messages · v4","version":"v4","keywords":"attachments sending messages v4","text":"$1c","sections":[{"id":"send-media","title":"Send media"},{"id":"tips","title":"Tips"},{"id":"carousels","title":"Carousels"},{"id":"attribution-badge","title":"Attribution badge"},{"id":"related","title":"Related"}]},{"id":"v4:/link-previews","title":"Link previews","href":"/link-previews","group":"Sending messages · v4","version":"v4","keywords":"link previews sending messages v4","text":"When is exactly one URL on a Blooio channel, Blooio can deliver it as an iMessage URL balloon (hero image, title, link). Previews use Open Graph metadata by default; override them with . Auto preview Override image and title Tips Prefer — rich previews are an iMessage feature. should be exactly the URL (no surrounding copy) for the balloon path. See Message content for the other content fields, including where supported. Related Message content Message sending Send a message","sections":[{"id":"auto-preview","title":"Auto preview"},{"id":"override-image-and-title","title":"Override image and title"},{"id":"tips","title":"Tips"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/custom-bubbles","title":"Custom bubbles (iMessage apps)","href":"/guides/custom-bubbles","group":"Sending messages · v4","version":"v4","keywords":"custom bubbles (imessage apps) sending messages v4","text":"$1d","sections":[{"id":"sending-a-custom-bubble","title":"Sending a custom bubble"},{"id":"how-the-card-looks-and-what-happens-on-tap","title":"How the card looks — and what happens on tap"},{"id":"if-you-want-a-big-tappable-card-instead","title":"If you want a big, tappable card instead"},{"id":"what-to-include-and-skip","title":"What to include (and skip)"},{"id":"receiving-a-custom-bubble","title":"Receiving a custom bubble"},{"id":"building-a-stateful-experience","title":"Building a stateful experience"},{"id":"delivery-status","title":"Delivery status"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/apple-system-apps","title":"Find My & Check In bubbles","href":"/guides/apple-system-apps","group":"Sending messages · v4","version":"v4","keywords":"find my & check in bubbles sending messages v4","text":"$1e","sections":[{"id":"apple-app-identifiers","title":"Apple app identifiers"},{"id":"find-my","title":"Find My"},{"id":"check-in","title":"Check In"},{"id":"receiving","title":"Receiving"},{"id":"related","title":"Related"}]},{"id":"v4:/number-pools","title":"Number pools","href":"/number-pools","group":"Sending messages · v4","version":"v4","keywords":"number pools sending messages v4","text":"$1f","sections":[{"id":"how-pools-work-in-v4","title":"How pools work in v4"},{"id":"default-send-pool-auto-select","title":"Default send (pool auto-select)"},{"id":"pin-a-number-from-the-pool","title":"Pin a number from the pool"},{"id":"blooio-vs-twilio-in-the-pool","title":"Blooio vs Twilio in the pool"},{"id":"inbound-reply-only-numbers","title":"Inbound (reply-only) numbers"},{"id":"setup-checklist","title":"Setup checklist"},{"id":"related","title":"Related"}]},{"id":"v4:/hybrid-mode","title":"Hybrid mode","href":"/hybrid-mode","group":"Sending messages · v4","version":"v4","keywords":"hybrid mode sending messages v4","text":"$20","sections":[{"id":"v4-what-it-does","title":"What it does"},{"id":"v4-requirements","title":"Requirements"},{"id":"v4-example","title":"Example"},{"id":"v4-configure-in-the-dashboard","title":"Configure in the dashboard"},{"id":"v4-when-not-to-use-hybrid","title":"When not to use hybrid"},{"id":"v4-related","title":"Related"}]},{"id":"v4:/chats","title":"Chats","href":"/chats","group":"Conversations · v4","version":"v4","keywords":"chats conversations v4","text":"$21","sections":[{"id":"mental-model","title":"Mental model"},{"id":"two-ways-to-send","title":"Two ways to send"},{"id":"1-agnostic-send-find-or-create","title":"1. Agnostic send (find-or-create)"},{"id":"2-send-into-an-existing-chat","title":"2. Send into an existing chat"},{"id":"create-a-chat-explicitly","title":"Create a chat explicitly"},{"id":"chat-scoped-actions","title":"Chat-scoped actions"},{"id":"focus","title":"Focus"},{"id":"state","title":"State"},{"id":"webhooks","title":"Webhooks"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/conversation-insights","title":"Tracking trends and conversation insights","href":"/guides/conversation-insights","group":"Conversation intelligence · v4","version":"v4","keywords":"tracking trends and conversation insights conversation intelligence v4","text":"$22","sections":[{"id":"how-it-works","title":"How it works"},{"id":"choose-a-tier","title":"Choose a tier"},{"id":"step-1-define-your-policies","title":"Step 1: Define your policies"},{"id":"step-2-decide-a-conversation","title":"Step 2: Decide a conversation"},{"id":"reading-a-result","title":"Reading a result"},{"id":"step-3-estimate-a-rate-across-many-conversations","title":"Step 3: Estimate a rate across many conversations"},{"id":"step-4-track-a-trend-over-time","title":"Step 4: Track a trend over time"},{"id":"step-5-route-the-hard-cases-to-a-human","title":"Step 5: Route the hard cases to a human"},{"id":"errors","title":"Errors"},{"id":"limitations","title":"Limitations"},{"id":"recap","title":"Recap"}]},{"id":"v4:/webhooks","title":"Webhooks","href":"/webhooks","group":"Receiving & webhooks · v4","version":"v4","keywords":"webhooks receiving & webhooks v4","text":"$23","sections":[{"id":"v4-event-envelope","title":"Event envelope"},{"id":"v4-verifying-signatures","title":"Verifying signatures"},{"id":"v4-retries-and-duplicates","title":"Retries and duplicates"},{"id":"v4-versioning","title":"Versioning"},{"id":"v4-upgrading","title":"Upgrading"},{"id":"v4-2026-10-01","title":"2026-10-01"},{"id":"v4-2026-09-01","title":"2026-09-01"},{"id":"v4-rest-events","title":"REST events"},{"id":"v4-event-types","title":"Event types"},{"id":"v4-messages","title":"Messages"},{"id":"v4-polls","title":"Polls"},{"id":"v4-groups","title":"Groups"},{"id":"v4-contact-card","title":"Contact card"},{"id":"v4-typing","title":"Typing"},{"id":"v4-safety","title":"Safety"},{"id":"v4-related","title":"Related"}]},{"id":"v4:/webhooks-local","title":"Receive webhooks locally","href":"/webhooks-local","group":"Receiving & webhooks · v4","version":"v4","keywords":"receive webhooks locally receiving & webhooks v4","text":"To develop against inbound events on your laptop: 1. Run a local HTTP server that accepts and reads the raw body. 2. Expose it with a tunnel (ngrok, Cloudflare Tunnel, etc.). 3. Create a v4 webhook pointed at the public URL. Create a v4 webhook Save the from the response and verify signatures — see Webhook signatures. Minimal receiver (Node) Always return quickly; do heavy work asynchronously. Related Webhooks Webhook signatures Create a webhook","sections":[{"id":"create-a-v4-webhook","title":"Create a v4 webhook"},{"id":"minimal-receiver-node","title":"Minimal receiver (Node)"},{"id":"related","title":"Related"}]},{"id":"v4:/webhook-signatures","title":"Webhook signatures","href":"/webhook-signatures","group":"Receiving & webhooks · v4","version":"v4","keywords":"webhook signatures receiving & webhooks v4","text":"Every webhook delivery includes an header. Verify it before trusting the payload. Verifying a delivery: recompute the HMAC, compare in constant time, and reject stale deliveries. Click a step for details. Header format | Part | Meaning | | | | | | Unix timestamp (seconds) when Blooio sent the delivery | | | HMAC SHA256 hex digest of | Signing secret Creating a webhook returns a once . Store it securely. Rotate with if needed — rotation is immediate. Verify (Node.js) Use the raw request body string (not a re serialized JSON object). Related Webhooks Receive webhooks locally Rotate webhook secret","sections":[{"id":"header-format","title":"Header format"},{"id":"signing-secret","title":"Signing secret"},{"id":"verify-node-js","title":"Verify (Node.js)"},{"id":"related","title":"Related"}]},{"id":"v4:/contacts","title":"Contacts","href":"/contacts","group":"Contacts & identity · v4","version":"v4","keywords":"contacts contacts & identity v4","text":"v4 models people as contacts with one or more identities (phone, email, …). Capabilities tell you what each identity can do on each channel type. Create a contact Capabilities Use capabilities when you need an explicit pre check (for example, only offer polls if iMessage is available). For most sends you can skip this and let Channels & senders routing pick a capable sender. Related Contact cards Chats List contacts Get contact capabilities Message sending","sections":[{"id":"create-a-contact","title":"Create a contact"},{"id":"capabilities","title":"Capabilities"},{"id":"related","title":"Related"}]},{"id":"v4:/contact-cards","title":"Contact cards","href":"/contact-cards","group":"Contacts & identity · v4","version":"v4","keywords":"contact cards contacts & identity v4","text":"A contact card is the Name & Photo identity recipients see for a Blooio number. Cards are per number . Sharing is a chat action on Blooio channels. Contact card update and share features require a plan that includes Name & Photo. Other plans return . List your numbers Read / update a card Upload an avatar with (multipart, max 10MB). Remove the photo by sending . The name stays as it is. Some lines can't clear a photo; those show a plain black image instead. Share into a chat Related Contacts Get contact card Share contact card","sections":[{"id":"list-your-numbers","title":"List your numbers"},{"id":"read-update-a-card","title":"Read / update a card"},{"id":"share-into-a-chat","title":"Share into a chat"},{"id":"related","title":"Related"}]},{"id":"v4:/number-provisioning","title":"Number provisioning","href":"/number-provisioning","group":"Numbers & provisioning · v4","version":"v4","keywords":"number provisioning numbers & provisioning v4","text":"$24","sections":[{"id":"enable-access","title":"Enable access"},{"id":"authenticate","title":"Authenticate"},{"id":"1-browse-available-numbers","title":"1. Browse available numbers"},{"id":"2-purchase-numbers","title":"2. Purchase numbers"},{"id":"rules-enforced","title":"Rules enforced"},{"id":"card-authentication-3ds-sca","title":"Card authentication (3DS/SCA)"},{"id":"3-track-a-purchase","title":"3. Track a purchase"},{"id":"4-remove-unsubscribe-a-number","title":"4. Remove (unsubscribe) a number"},{"id":"webhook-events","title":"Webhook events"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/number-purchase-api","title":"Number Purchase API","href":"/guides/number-purchase-api","group":"Numbers & provisioning · v4","version":"v4","keywords":"number purchase api numbers & provisioning v4","text":"$25","sections":[{"id":"before-you-can-buy-a-line","title":"Before you can buy a line"},{"id":"1-complete-organization-kyc","title":"1. Complete organization KYC"},{"id":"2-request-number-purchase-api-access","title":"2. Request Number Purchase API access"},{"id":"3-add-a-payment-method","title":"3. Add a payment method"},{"id":"per-order-line-cap","title":"Per-order line cap"},{"id":"authentication","title":"Authentication"},{"id":"step-1-browse-available-inventory","title":"Step 1 — Browse available inventory"},{"id":"area-code-quotes","title":"Area-code quotes"},{"id":"step-2-purchase-a-line","title":"Step 2 — Purchase a line"},{"id":"rules-enforced","title":"Rules enforced"},{"id":"cards-that-need-authentication-3ds-sca","title":"Cards that need authentication (3DS/SCA)"},{"id":"step-3-track-provisioning","title":"Step 3 — Track provisioning"},{"id":"poll-the-purchase","title":"Poll the purchase"},{"id":"or-listen-for-webhooks","title":"Or listen for webhooks"},{"id":"removing-a-line","title":"Removing a line"},{"id":"plans","title":"Plans"},{"id":"errors","title":"Errors"},{"id":"related","title":"Related"}]},{"id":"v4:/twilio-integration","title":"Twilio integration","href":"/twilio-integration","group":"Integrations · v4","version":"v4","keywords":"twilio integration integrations v4","text":"Twilio is a first class v4 channel type . Connect your Twilio account in the dashboard, assign Twilio numbers to an API key on Channels , then send with an optional constraint or exact number. Sending SMS through your Twilio account and receiving replies as webhooks. Click a step for details. When to use Twilio SMS/MMS reach when the recipient is not on iMessage Hybrid outbound (Twilio first, continue on Blooio after a reply) Explicit SMS branding via a Twilio number Send on Twilio Pin a specific Twilio line by passing its number as : Setup checklist 1. Connect Twilio under Integrations in the dashboard. 2. Import or select numbers. 3. On Channels , drag Twilio senders onto the API key that should use them. 4. Optionally enable Hybrid Outbound when Blooio + Twilio are both assigned. Related Channels & senders Number pools Hybrid mode Message sending List channels","sections":[{"id":"when-to-use-twilio","title":"When to use Twilio"},{"id":"send-on-twilio","title":"Send on Twilio"},{"id":"setup-checklist","title":"Setup checklist"},{"id":"related","title":"Related"}]},{"id":"v4:/location-tracking","title":"Location tracking","href":"/location-tracking","group":"Integrations · v4","version":"v4","keywords":"location tracking integrations v4","text":"The Location API exposes Find My person sharing data available to the Apple account linked to your Blooio service. Contacts only appear if they already share location with that account in Find My. List contacts Get one contact Refresh Force a device refresh (can take 15–20s): Statuses such as , , and describe how fresh the cached point is — poll after refresh if you need the newest coordinates. Related List location contacts Refresh location contacts","sections":[{"id":"list-contacts","title":"List contacts"},{"id":"get-one-contact","title":"Get one contact"},{"id":"refresh","title":"Refresh"},{"id":"related","title":"Related"}]},{"id":"v4:/developer-apps","title":"Developer apps","href":"/developer-apps","group":"Developer apps & OAuth · v4","version":"v4","keywords":"developer apps developer apps & oauth v4","text":"$26","sections":[{"id":"create-an-app","title":"Create an app"},{"id":"credentials","title":"Credentials"},{"id":"updating-an-app","title":"Updating an app"},{"id":"next-steps","title":"Next steps"}]},{"id":"v4:/oauth-authorization","title":"OAuth authorization","href":"/oauth-authorization","group":"Developer apps & OAuth · v4","version":"v4","keywords":"oauth authorization developer apps & oauth v4","text":"$27","sections":[{"id":"1-redirect-the-user-to-authorize","title":"1. Redirect the user to authorize"},{"id":"2-exchange-the-code-for-tokens","title":"2. Exchange the code for tokens"},{"id":"3-refresh-an-access-token","title":"3. Refresh an access token"},{"id":"4-revoke-a-token","title":"4. Revoke a token"},{"id":"scopes","title":"Scopes"},{"id":"next-step","title":"Next step"}]},{"id":"v4:/oauth-api-tokens","title":"Calling the API with OAuth tokens","href":"/oauth-api-tokens","group":"Developer apps & OAuth · v4","version":"v4","keywords":"calling the api with oauth tokens developer apps & oauth v4","text":"$28","sections":[{"id":"selecting-the-organization","title":"Selecting the organization"},{"id":"scope-enforcement","title":"Scope enforcement"},{"id":"errors","title":"Errors"},{"id":"differences-from-api-keys","title":"Differences from API keys"}]},{"id":"v4:/guides/apple-messages-for-business","title":"Apple Messages for Business","href":"/guides/apple-messages-for-business","group":"Apple Messages for Business · v4","version":"v4","keywords":"apple messages for business apple messages for business v4","text":"$29","sections":[{"id":"why-apple-messages-for-business","title":"Why Apple Messages for Business"},{"id":"how-a-conversation-starts","title":"How a conversation starts"},{"id":"the-opaque-recipient-id","title":"The opaque recipient id"},{"id":"connect-a-channel-to-blooio","title":"Connect a channel to Blooio"},{"id":"send-your-first-reply","title":"Send your first reply"},{"id":"what-you-can-send","title":"What you can send"},{"id":"where-to-go-next","title":"Where to go next"},{"id":"related","title":"Related"}]},{"id":"v4:/amb-launch","title":"Launch Apple Messages for Business","href":"/amb-launch","group":"Apple Messages for Business · v4","version":"v4","keywords":"launch apple messages for business apple messages for business v4","text":"$2a","sections":[{"id":"the-roadmap","title":"The roadmap"},{"id":"before-you-start","title":"Before you start"},{"id":"choose-your-msp","title":"Choose your MSP"},{"id":"register-with-apple","title":"Register with Apple"},{"id":"select-blooio-and-add-testers","title":"Select Blooio and add testers"},{"id":"connect-to-blooio","title":"Connect to Blooio"},{"id":"build-the-experience","title":"Build the experience"},{"id":"entry-points","title":"Entry points"},{"id":"entry-point-urls","title":"Entry point URLs"},{"id":"message-suggest","title":"Message Suggest"},{"id":"naming-in-your-ui","title":"Naming in your UI"},{"id":"brand-assets","title":"Brand assets"},{"id":"pass-the-experience-review","title":"Pass the Experience Review"},{"id":"go-live","title":"Go live"},{"id":"test-device-troubleshooting","title":"Test device troubleshooting"},{"id":"related","title":"Related"}]},{"id":"v4:/amb-experience-review","title":"Pass the Apple Messages for Business Experience Review","href":"/amb-experience-review","group":"Apple Messages for Business · v4","version":"v4","keywords":"pass the apple messages for business experience review apple messages for business v4","text":"$2b","sections":[{"id":"what-apple-is-actually-checking","title":"What Apple is actually checking"},{"id":"how-the-review-works","title":"How the review works"},{"id":"the-checklist","title":"The checklist"},{"id":"agent-and-bot","title":"Agent and bot"},{"id":"conversation-flow","title":"Conversation flow"},{"id":"rich-content-and-interactive-features","title":"Rich content and interactive features"},{"id":"naming-privacy-and-policy","title":"Naming, privacy, and policy"},{"id":"a-conversation-that-passes","title":"A conversation that passes"},{"id":"why-brands-fail","title":"Why brands fail"},{"id":"the-screen-recording","title":"The screen recording"},{"id":"feedback-rounds","title":"Feedback rounds"},{"id":"experience-drift","title":"Experience drift"},{"id":"have-blooio-run-it-for-you","title":"Have Blooio run it for you"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/apple-messages-mau","title":"Monthly active users","href":"/guides/apple-messages-mau","group":"Apple Messages for Business · v4","version":"v4","keywords":"monthly active users apple messages for business v4","text":"$2c","sections":[{"id":"how-a-customer-becomes-an-mau","title":"How a customer becomes an MAU"},{"id":"what-counts-as-an-exchange","title":"What counts as an exchange"},{"id":"counted-once-per-calendar-month","title":"Counted once per calendar month"},{"id":"related","title":"Related"}]},{"id":"v4:/amb-interactive","title":"Interactive messages","href":"/amb-interactive","group":"Apple Messages for Business · v4","version":"v4","keywords":"interactive messages apple messages for business v4","text":"$2d","sections":[{"id":"addressing","title":"Addressing"},{"id":"request-fields","title":"Request fields"},{"id":"common-fields","title":"Common fields"},{"id":"quick-reply","title":"Quick reply"},{"id":"list-picker","title":"List picker"},{"id":"time-picker","title":"Time picker"},{"id":"dynamic-form","title":"Dynamic form"},{"id":"apple-pay-authentication","title":"Apple Pay & authentication"},{"id":"custom-imessage-app","title":"Custom iMessage app"},{"id":"reading-the-reply","title":"Reading the reply"},{"id":"capabilities","title":"Capabilities"},{"id":"structured-output-for-ai-agents","title":"Structured output for AI agents"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/apple-messages-rich-links","title":"Rich links & media","href":"/guides/apple-messages-rich-links","group":"Apple Messages for Business · v4","version":"v4","keywords":"rich links & media apple messages for business v4","text":"$2e","sections":[{"id":"text","title":"Text"},{"id":"rich-link-card","title":"Rich link card"},{"id":"attachments-images-video-audio-files","title":"Attachments (images, video, audio, files)"},{"id":"typing-indicator","title":"Typing indicator"},{"id":"which-content-type-should-i-use","title":"Which content type should I use?"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/apple-messages-sign-in","title":"Sign in (OAuth 2.0)","href":"/guides/apple-messages-sign-in","group":"Apple Messages for Business · v4","version":"v4","keywords":"sign in (oauth 2.0) apple messages for business v4","text":"$2f","sections":[{"id":"requirements","title":"Requirements"},{"id":"send-a-sign-in-request","title":"Send a Sign in request"},{"id":"fields","title":"Fields"},{"id":"what-the-customer-sees","title":"What the customer sees"},{"id":"reading-the-result","title":"Reading the result"},{"id":"troubleshooting","title":"Troubleshooting"},{"id":"related","title":"Related"}]},{"id":"v4:/amb-invitations","title":"Business invitations","href":"/amb-invitations","group":"Apple Messages for Business · v4","version":"v4","keywords":"business invitations apple messages for business v4","text":"$30","sections":[{"id":"requirements","title":"Requirements"},{"id":"send-an-invitation","title":"Send an invitation"},{"id":"fields","title":"Fields"},{"id":"how-to-get-a-template-id","title":"How to get a template id"},{"id":"what-happens-next","title":"What happens next"},{"id":"related","title":"Related"}]},{"id":"v4:/amb-apple-pay","title":"Apple Pay","href":"/amb-apple-pay","group":"Apple Messages for Business · v4","version":"v4","keywords":"apple pay apple messages for business v4","text":"$31","sections":[{"id":"how-it-works","title":"How it works"},{"id":"one-time-setup","title":"One-time setup"},{"id":"sending-an-apple-pay-request","title":"Sending an Apple Pay request"},{"id":"payment-lifecycle-webhooks","title":"Payment lifecycle & webhooks"},{"id":"payment-received-payload","title":"payment.received payload"},{"id":"payment-completed-payload","title":"payment.completed payload"},{"id":"settling-the-payment","title":"Settling the payment"},{"id":"live-checkout-updates-optional","title":"Live checkout updates (optional)"},{"id":"troubleshooting","title":"Troubleshooting"},{"id":"417-payment-services-exception-merchantid-not-registered-for-service","title":"417 Payment Services Exception: merchantId=... not registered for service"},{"id":"the-send-fails-immediately-with-applepaynotconfigured","title":"The send fails immediately with applepaynotconfigured"},{"id":"i-only-see-the-paid-bubble-but-no-webhook","title":"I only see the Paid bubble but no webhook"},{"id":"related","title":"Related"}]},{"id":"v4:/guides/apple-messages-conversations","title":"Conversation lifecycle","href":"/guides/apple-messages-conversations","group":"Apple Messages for Business · v4","version":"v4","keywords":"conversation lifecycle apple messages for business v4","text":"$32","sections":[{"id":"the-lifecycle","title":"The lifecycle"},{"id":"typing-indicators","title":"Typing indicators"},{"id":"read-receipts","title":"Read receipts"},{"id":"handoff-automation-human","title":"Handoff: automation ↔ human"},{"id":"closing-opt-out","title":"Closing & opt-out"},{"id":"related","title":"Related"}]},{"id":"v4:/amb-capabilities","title":"Capabilities & limits","href":"/amb-capabilities","group":"Apple Messages for Business · v4","version":"v4","keywords":"capabilities & limits apple messages for business v4","text":"$33","sections":[{"id":"capability-gating-os-minimum-device-scope","title":"Capability gating — OS minimum & device scope"},{"id":"the-capability-list-header","title":"The capability-list header"},{"id":"drive-gating-from-code-not-from-memory","title":"Drive gating from code, not from memory"},{"id":"what-the-api-offers-you-at-runtime","title":"What the API offers you at runtime"},{"id":"fallback-decision-tree-when-a-device-can-t-render-the-preferred-type","title":"Fallback decision tree (when a device can't render the preferred type)"},{"id":"timeouts-ttls","title":"Timeouts & TTLs"},{"id":"the-attachment-ttl-ratchet-apple-msp-cdn","title":"The attachment TTL ratchet (Apple → MSP → CDN)"},{"id":"timeouts-as-code","title":"Timeouts as code"},{"id":"sources","title":"Sources"},{"id":"related","title":"Related"}]},{"id":"v2:tag:/reference/v2/account","title":"Account","href":"/reference/v2/account","group":"API Reference · v2","version":"v2","keywords":"account authentication and account information v2","text":"Authentication and account information"},{"id":"v2:/reference/v2/account/getMe","title":"Get me","href":"/reference/v2/account/getMe","group":"Account · v2","method":"GET","version":"v2","keywords":"get me get current authentication context get /me getme v2 returns details about the authenticated api key or dashboard user, including organization info, devices, and usage statistics. ","text":"Get current authentication context Returns details about the authenticated API key or dashboard user, including organization info, devices, and usage statistics. /me","sections":[{"id":"headers","title":"Headers"},{"id":"returns","title":"Returns"},{"id":"response-auth_type","title":"auth_type Type of authentication used"},{"id":"response-valid","title":"valid Whether the API key is valid (only for api_key auth)"},{"id":"response-user_id","title":"user_id User ID (only for dashboard auth)"},{"id":"response-api_key","title":"api_key The API key (only for api_key auth)"},{"id":"response-organization_id","title":"organization_id Organization ID (only for api_key auth)"},{"id":"response-organization","title":"organization"},{"id":"response-organization-organization_id","title":"organization_id"},{"id":"response-organization-name","title":"name"},{"id":"response-organization-country_code","title":"country_code"},{"id":"response-organization-created_at","title":"created_at"},{"id":"response-metadata","title":"metadata API key metadata (only for api_key auth)"},{"id":"response-integration_details","title":"integration_details Integration details if the API key is associated with an integration (only for a"},{"id":"response-devices","title":"devices List of devices associated with this API key (only for api_key auth)"},{"id":"response-devices-0-phone_number","title":"phone_number Phone number assigned to this device (E.164 format)"},{"id":"response-devices-0-is_active","title":"is_active False when the line is banned, suspended, or the underlying account is blocked."},{"id":"response-devices-0-banned","title":"banned True when the phone number is banned. Same meaning as `/me/numbers`."},{"id":"response-devices-0-suspended","title":"suspended True when the phone number is suspended. Same meaning as `/me/numbers`."},{"id":"response-devices-0-status","title":"status `banned` if the number is banned, otherwise `suspended` if it is suspended, othe"},{"id":"response-devices-0-last_active","title":"last_active"},{"id":"response-devices-0-plan_kind","title":"plan_kind Plan type the underlying allocation runs on. `inbound` numbers are reply-only —"},{"id":"response-usage","title":"usage Usage statistics (only for api_key auth)"},{"id":"response-usage-inbound_messages","title":"inbound_messages"},{"id":"response-usage-outbound_messages","title":"outbound_messages"},{"id":"response-usage-last_message_sent","title":"last_message_sent"},{"id":"response-codes","title":"Response codes"}]},{"id":"v2:tag:/reference/v2/numbers","title":"Numbers","href":"/reference/v2/numbers","group":"API Reference · v2","version":"v2","keywords":"numbers manage phone numbers linked to your account v2","text":"Manage phone numbers linked to your account"},{"id":"v2:/reference/v2/numbers/listNumbers","title":"List numbers","href":"/reference/v2/numbers/listNumbers","group":"Numbers · v2","method":"GET","version":"v2","keywords":"list numbers list phone numbers get /me/numbers listnumbers v2 list all phone numbers bound to this api key with their availability status. banned and suspended numbers stay in the list. `status` is `banned`, `suspended`, or `active`; a ban takes precedence when both apply. `is_active` is false when the line is banned, suspended, or the underlying account is blocked. use the returned phone numbers as the `:number` path parameter for other `/me/numbers/` endpoints. ","text":"List phone numbers List all phone numbers bound to this API key with their availability status. Banned and suspended numbers stay in the list. is , , or ; a ban takes precedence when both apply. is false when the line is banned, suspended, or the underlying account is blocked. Use the returned phone numbers as the path parameter for other endpoints. /me/numbers","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-numbers","title":"numbers"},{"id":"response-numbers-0-phone_number","title":"phone_number"},{"id":"response-numbers-0-is_active","title":"is_active False when the line is banned, suspended, or the underlying account is blocked."},{"id":"response-numbers-0-banned","title":"banned True when the phone number is banned (`phone_numbers.banned_at` is set)."},{"id":"response-numbers-0-suspended","title":"suspended True when the phone number is suspended. Independent of `status`: a line can be"},{"id":"response-numbers-0-status","title":"status `banned` if the number is banned, otherwise `suspended` if it is suspended, othe"},{"id":"response-numbers-0-last_active","title":"last_active"},{"id":"response-numbers-0-plan_kind","title":"plan_kind Plan type the underlying allocation runs on. Sourced directly from `allocation_p"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/numbers/requestCallForwarding","title":"Request call forwarding","href":"/reference/v2/numbers/requestCallForwarding","group":"Numbers · v2","method":"POST","version":"v2","keywords":"request call forwarding request call forwarding post /me/numbers/{number}/call-forwarding requestcallforwarding v2 open a request to forward calls from one of your numbers to another phone number.\n\nthis does **not** instantly reconfigure forwarding — it opens a support request that the blooio team fulfils, and the change typically takes effect within one business day. the `{number}` path parameter is the source number to forward, and `forward_to` is the destination.\n\nonly **dedicated** or **inbound** numbers owned by your organization can be forwarded; shared numbers cannot, because the underlying line is shared across organizations. both numbers must be valid us numbers. forward_to destination us phone number that calls should be forwarded to. e.164 format recommended (e.g., +15559876543).","text":"forward to Destination US phone number that calls should be forwarded to. E.164 format recommended (e.g., +15559876543). Request call forwarding Open a request to forward calls from one of your numbers to another phone number. This does not instantly reconfigure forwarding — it opens a support request that the Blooio team fulfils, and the change typically takes effect within one business day. The path parameter is the source number to forward, and is the destination. Only dedicated or inbound numbers owned by your organization can be forwarded; shared numbers cannot, because the underlying line is shared across organizations. Both numbers must be valid US numbers. /me/numbers/{number}/call forwarding number Source E.164 phone number to forward (URL encoded, e.g., %2B15551234567). Must be a dedicated or inbound number owned by your organization. Destination US phone number that calls should be forwarded to. E.164 format recommended (e.g., +15559876543).","sections":[{"id":"path-parameters","title":"Path parameters"},{"id":"path-number","title":"number Source E.164 phone number to forward (URL-encoded, e.g., %2B15551234567). Must b"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"body-parameters","title":"Body parameters"},{"id":"body-forward_to","title":"forward_to Destination US phone number that calls should be forwarded to. E.164 format reco"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-ticket_id","title":"ticket_id Identifier of the support ticket tracking this request"},{"id":"response-status","title":"status Ticket status"},{"id":"response-number","title":"number Source number (E.164)"},{"id":"response-forward_to","title":"forward_to Destination number (E.164)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/contact-card","title":"Contact Card","href":"/reference/v2/contact-card","group":"API Reference · v2","version":"v2","keywords":"contact card manage and share your imessage contact card (name & photo) v2","text":"Manage and share your iMessage contact card (Name & Photo)"},{"id":"v2:/reference/v2/contact-card/shareContactCard","title":"Share contact card","href":"/reference/v2/contact-card/shareContactCard","group":"Contact Card · v2","method":"POST","version":"v2","keywords":"share contact card share contact card post /chats/{chatid}/contact-card sharecontactcard v2 stage the contact card (name & photo) for sharing in a chat. the contact card will be piggybacked onto the next outgoing message (text or attachment) sent to this chat. this is idempotent — calling it multiple times is harmless.\n\n⚠️ **plan requirement:** contact card sharing is only available on **dedicated commercial** and **dedicated enterprise** plans. numbers on other plans receive a `403`. ","text":"Share contact card Stage the contact card (Name & Photo) for sharing in a chat. The contact card will be piggybacked onto the next outgoing message (text or attachment) sent to this chat. This is idempotent — calling it multiple times is harmless. ⚠️ Plan requirement: Contact card sharing is only available on Dedicated Commercial and Dedicated Enterprise plans. Numbers on other plans receive a . /chats/{chatId}/contact card chatId 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.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-chat_id","title":"chat_id Normalized chat identifier"},{"id":"response-message","title":"message"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contact-card/getMyContactCard","title":"Get my contact card","href":"/reference/v2/contact-card/getMyContactCard","group":"Contact Card · v2","method":"GET","version":"v2","keywords":"get my contact card get contact card (coming soon) get /me/numbers/{number}/contact-card getmycontactcard v2 ⚠️ **coming soon** - this endpoint is temporarily disabled while we stabilize this feature.\n\nget the personal contact card (name & photo) for the specified phone number. this is the identity that gets shared with contacts in imessage. ","text":"Get contact card (Coming Soon) ⚠️ COMING SOON This endpoint is temporarily disabled while we stabilize this feature. Get the personal contact card (Name & Photo) for the specified phone number. This is the identity that gets shared with contacts in iMessage. /me/numbers/{number}/contact card number E.164 phone number (URL encoded, e.g., %2B15551234567)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number E.164 phone number (URL-encoded, e.g., %2B15551234567)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-phone_number","title":"phone_number"},{"id":"response-first_name","title":"first_name"},{"id":"response-last_name","title":"last_name"},{"id":"response-name","title":"name Display name"},{"id":"response-avatar","title":"avatar Base64-encoded JPEG/PNG image"},{"id":"response-has_wallpaper","title":"has_wallpaper"},{"id":"response-sharing","title":"sharing"},{"id":"response-sharing-enabled","title":"enabled Whether Name & Photo sharing is enabled"},{"id":"response-sharing-audience","title":"audience 0 = Contacts Only, 1 = Always Ask"},{"id":"response-sharing-name_format","title":"name_format 0 = First & Last, 1 = First Only"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contact-card/updateMyContactCard","title":"Update my contact card","href":"/reference/v2/contact-card/updateMyContactCard","group":"Contact Card · v2","method":"PUT","version":"v2","keywords":"update my contact card update contact card put /me/numbers/{number}/contact-card updatemycontactcard v2 update the personal contact card (name & photo) for the specified phone number. all fields are optional — only provided fields are updated.\n\n⚠️ **plan requirement:** setting the `first_name`, `last_name`, or `avatar` is only available on **dedicated commercial** and **dedicated enterprise** plans. numbers on other plans receive a `403`. first_name first name last_name last name avatar profile photo as base64-encoded jpeg/png sharing enabled enable/disable name & photo sharing audience 0 = contacts only, 1 = always ask name_format 0 = first & last, 1 = first only","text":"first name First name last name Last name avatar Profile photo as base64 encoded JPEG/PNG sharing enabled Enable/disable Name & Photo sharing audience 0 = Contacts Only, 1 = Always Ask name format 0 = First & Last, 1 = First Only Update contact card Update the personal contact card (Name & Photo) for the specified phone number. All fields are optional — only provided fields are updated. ⚠️ Plan requirement: Setting the , , or is only available on Dedicated Commercial and Dedicated Enterprise plans. Numbers on other plans receive a . /me/numbers/{number}/contact card number E.164 phone number (URL encoded, e.g., %2B15551234567) First name Last name Profile photo as base64 encoded JPEG/PNG Enable/disable Name & Photo sharing 0 = Contacts Only, 1 = Always Ask 0 = First & Last, 1 = First Only","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number E.164 phone number (URL-encoded, e.g., %2B15551234567)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-first_name","title":"first_name First name"},{"id":"body-last_name","title":"last_name Last name"},{"id":"body-avatar","title":"avatar Profile photo as base64-encoded JPEG/PNG"},{"id":"body-sharing","title":"sharing"},{"id":"body-sharing-enabled","title":"enabled Enable/disable Name & Photo sharing"},{"id":"body-sharing-audience","title":"audience 0 = Contacts Only, 1 = Always Ask"},{"id":"body-sharing-name_format","title":"name_format 0 = First & Last, 1 = First Only"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-phone_number","title":"phone_number"},{"id":"response-first_name","title":"first_name"},{"id":"response-last_name","title":"last_name"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/contacts","title":"Contacts","href":"/reference/v2/contacts","group":"API Reference · v2","version":"v2","keywords":"contacts manage contacts (phone numbers and emails) v2","text":"Manage contacts (phone numbers and emails)"},{"id":"v2:/reference/v2/contacts/listContacts","title":"List contacts","href":"/reference/v2/contacts/listContacts","group":"Contacts · v2","method":"GET","version":"v2","keywords":"list contacts list contacts get /contacts listcontacts v2 list all contacts for the organization with optional search and pagination. ","text":"List contacts List all contacts for the organization with optional search and pagination. /contacts limit Maximum number of items to return in a single response. Must be between 1 and 200; defaults to 50. Use together with to page through large result sets. offset Number of items to skip before returning results. Combine with for page based pagination (e.g. returns the second page). Defaults to 0. q Search query (matches identifier or name) sort Sort order","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"query-parameters","title":"Query parameters"},{"id":"query-limit","title":"limit Maximum number of items to return in a single response. Must be between 1 and 20"},{"id":"query-offset","title":"offset Number of items to skip before returning results. Combine with `limit` for page-"},{"id":"query-q","title":"q Search query (matches identifier or name)"},{"id":"query-sort","title":"sort Sort order"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-contacts","title":"contacts"},{"id":"response-contacts-0-id","title":"id Contact identifier (phone or email)"},{"id":"response-contacts-0-contact_id","title":"contact_id Internal contact ID"},{"id":"response-contacts-0-identifier","title":"identifier Phone number (E.164) or email"},{"id":"response-contacts-0-name","title":"name"},{"id":"response-contacts-0-type","title":"type"},{"id":"response-contacts-0-created_at","title":"created_at"},{"id":"response-contacts-0-last_message_time","title":"last_message_time"},{"id":"response-contacts-0-tags","title":"tags"},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-total","title":"total"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/createContact","title":"Create contact","href":"/reference/v2/contacts/createContact","group":"Contacts · v2","method":"POST","version":"v2","keywords":"create contact create a contact post /contacts createcontact v2 create a new contact with a phone number (e.164 format) or email address. identifier phone number (e.164 format, e.g., +15551234567) or email address name display name for the contact","text":"identifier Phone number (E.164 format, e.g., +15551234567) or email address name Display name for the contact Create a contact Create a new contact with a phone number (E.164 format) or email address. /contacts Phone number (E.164 format, e.g., +15551234567) or email address Display name for the contact","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-identifier","title":"identifier Phone number (E.164 format, e.g., +15551234567) or email address"},{"id":"body-name","title":"name Display name for the contact"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id Contact identifier (phone or email)"},{"id":"response-contact_id","title":"contact_id Internal contact ID"},{"id":"response-identifier","title":"identifier Phone number (E.164) or email"},{"id":"response-name","title":"name"},{"id":"response-type","title":"type"},{"id":"response-created_at","title":"created_at"},{"id":"response-last_message_time","title":"last_message_time"},{"id":"response-tags","title":"tags"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/getContact","title":"Get contact","href":"/reference/v2/contacts/getContact","group":"Contacts · v2","method":"GET","version":"v2","keywords":"get contact get a contact get /contacts/{contactid} getcontact v2 get details for a specific contact by phone number or email. ","text":"Get a contact Get details for a specific contact by phone number or email. /contacts/{contactId} contactId Contact identifier (phone number in E.164 format or email, URL encoded)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id Contact identifier (phone or email)"},{"id":"response-contact_id","title":"contact_id Internal contact ID"},{"id":"response-identifier","title":"identifier Phone number (E.164) or email"},{"id":"response-name","title":"name"},{"id":"response-type","title":"type"},{"id":"response-created_at","title":"created_at"},{"id":"response-last_message_time","title":"last_message_time"},{"id":"response-tags","title":"tags"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/updateContact","title":"Update contact","href":"/reference/v2/contacts/updateContact","group":"Contacts · v2","method":"PATCH","version":"v2","keywords":"update contact update a contact patch /contacts/{contactid} updatecontact v2 update a contact's name. name new display name (null to clear)","text":"name New display name (null to clear) Update a contact Update a contact's name. /contacts/{contactId} contactId Contact identifier (phone number in E.164 format or email, URL encoded) New display name (null to clear)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name New display name (null to clear)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id Contact identifier (phone or email)"},{"id":"response-contact_id","title":"contact_id Internal contact ID"},{"id":"response-identifier","title":"identifier Phone number (E.164) or email"},{"id":"response-name","title":"name"},{"id":"response-type","title":"type"},{"id":"response-created_at","title":"created_at"},{"id":"response-last_message_time","title":"last_message_time"},{"id":"response-tags","title":"tags"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/deleteContact","title":"Delete contact","href":"/reference/v2/contacts/deleteContact","group":"Contacts · v2","method":"DELETE","version":"v2","keywords":"delete contact delete a contact delete /contacts/{contactid} deletecontact v2 soft-delete a contact. ","text":"Delete a contact Soft delete a contact. /contacts/{contactId} contactId Contact identifier (phone number in E.164 format or email, URL encoded)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-deleted_at","title":"deleted_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/getContactCapabilities","title":"Get contact capabilities","href":"/reference/v2/contacts/getContactCapabilities","group":"Contacts · v2","method":"GET","version":"v2","keywords":"get contact capabilities check contact capabilities get /contacts/{contactid}/capabilities getcontactcapabilities v2 check if a contact supports imessage and/or sms. ","text":"Check contact capabilities Check if a contact supports iMessage and/or SMS. /contacts/{contactId}/capabilities contactId Contact identifier (phone number in E.164 format or email, URL encoded)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-contact","title":"contact Normalized contact identifier"},{"id":"response-type","title":"type"},{"id":"response-capabilities","title":"capabilities"},{"id":"response-capabilities-imessage","title":"imessage Whether iMessage is available"},{"id":"response-capabilities-sms","title":"sms Whether SMS is available (phone only)"},{"id":"response-capabilities-facetime","title":"facetime Whether FaceTime is available"},{"id":"response-last_checked","title":"last_checked Timestamp when capabilities were checked"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/listContactTags","title":"List contact tags","href":"/reference/v2/contacts/listContactTags","group":"Contacts · v2","method":"GET","version":"v2","keywords":"list contact tags list contact tags get /contacts/{contactid}/tags listcontacttags v2 list all tags assigned to a contact. ","text":"List contact tags List all tags assigned to a contact. /contacts/{contactId}/tags contactId Contact identifier (phone number in E.164 format or email, URL encoded)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-tags","title":"tags"},{"id":"response-tags-0-tag","title":"tag The tag value"},{"id":"response-tags-0-created_at","title":"created_at Timestamp when the tag was added (ms since epoch)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/addContactTags","title":"Add contact tags","href":"/reference/v2/contacts/addContactTags","group":"Contacts · v2","method":"POST","version":"v2","keywords":"add contact tags add tags to a contact post /contacts/{contactid}/tags addcontacttags v2 add one or more tags to a contact. if a tag already exists on the contact, it is re-activated (idempotent). tags are free-form strings. tags tags to add","text":"tags Tags to add Add tags to a contact Add one or more tags to a contact. If a tag already exists on the contact, it is re activated (idempotent). Tags are free form strings. /contacts/{contactId}/tags contactId Contact identifier (phone number in E.164 format or email, URL encoded) Tags to add","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-tags","title":"tags Tags to add"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-tags_added","title":"tags_added Tags that were added"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/contacts/removeContactTag","title":"Remove contact tag","href":"/reference/v2/contacts/removeContactTag","group":"Contacts · v2","method":"DELETE","version":"v2","keywords":"remove contact tag remove a tag from a contact delete /contacts/{contactid}/tags/{tag} removecontacttag v2 remove a specific tag from a contact. the tag is soft-deleted and can be re-added later. ","text":"Remove a tag from a contact Remove a specific tag from a contact. The tag is soft deleted and can be re added later. /contacts/{contactId}/tags/{tag} contactId Contact identifier (phone number in E.164 format or email, URL encoded) tag The tag to remove (URL encode if it contains special characters)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},{"id":"path-tag","title":"tag The tag to remove (URL-encode if it contains special characters)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-deleted_at","title":"deleted_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/groups","title":"Groups","href":"/reference/v2/groups","group":"API Reference · v2","version":"v2","keywords":"groups manage contact groups v2","text":"Manage contact groups"},{"id":"v2:/reference/v2/groups/listGroups","title":"List groups","href":"/reference/v2/groups/listGroups","group":"Groups · v2","method":"GET","version":"v2","keywords":"list groups list groups get /groups listgroups v2 list all groups for the organization with optional search and pagination. ","text":"List groups List all groups for the organization with optional search and pagination. /groups limit Maximum number of items to return in a single response. Must be between 1 and 200; defaults to 50. Use together with to page through large result sets. offset Number of items to skip before returning results. Combine with for page based pagination (e.g. returns the second page). Defaults to 0. q Search query (matches group name) sort Sort order","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return in a single response. Must be between 1 and 20"},{"id":"query-offset","title":"offset Number of items to skip before returning results. Combine with `limit` for page-"},{"id":"query-q","title":"q Search query (matches group name)"},{"id":"query-sort","title":"sort Sort order"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-groups","title":"groups"},{"id":"response-groups-0-group_id","title":"group_id"},{"id":"response-groups-0-name","title":"name Group name. Null for unnamed groups."},{"id":"response-groups-0-chat_guid","title":"chat_guid Deprecated. An identifier for the group's iMessage conversation, kept for existi"},{"id":"response-groups-0-icon_url","title":"icon_url URL of the group icon/photo"},{"id":"response-groups-0-member_count","title":"member_count"},{"id":"response-groups-0-message_count","title":"message_count Total number of messages in this group"},{"id":"response-groups-0-last_message_text","title":"last_message_text Text of the most recent message in the group"},{"id":"response-groups-0-last_message_time","title":"last_message_time Timestamp of the most recent message"},{"id":"response-groups-0-last_message_direction","title":"last_message_direction Direction of the most recent message"},{"id":"response-groups-0-created_at","title":"created_at"},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-total","title":"total"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/groups/createGroup","title":"Create group","href":"/reference/v2/groups/createGroup","group":"Groups · v2","method":"POST","version":"v2","keywords":"create group create a group post /groups creategroup v2 create a new group. no imessage conversation exists yet: the first message you send to the group opens it. name group name (max 255 characters) members phone numbers or emails of contacts in the group.","text":"name Group name (max 255 characters) members Phone numbers or emails of contacts in the group. Create a group Create a new group. No iMessage conversation exists yet: the first message you send to the group opens it. /groups Group name (max 255 characters) Phone numbers or emails of contacts in the group.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name Group name (max 255 characters)"},{"id":"body-members","title":"members Phone numbers or emails of contacts in the group."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-group_id","title":"group_id"},{"id":"response-name","title":"name Group name. Null for unnamed groups."},{"id":"response-chat_guid","title":"chat_guid Deprecated. An identifier for the group's iMessage conversation, kept for existi"},{"id":"response-icon_url","title":"icon_url URL of the group icon/photo"},{"id":"response-member_count","title":"member_count"},{"id":"response-message_count","title":"message_count Total number of messages in this group"},{"id":"response-last_message_text","title":"last_message_text Text of the most recent message in the group"},{"id":"response-last_message_time","title":"last_message_time Timestamp of the most recent message"},{"id":"response-last_message_direction","title":"last_message_direction Direction of the most recent message"},{"id":"response-created_at","title":"created_at"},{"id":"response-added_members","title":"added_members List of member identifiers that were added to the group"},{"id":"response-created_contacts","title":"created_contacts List of contacts that were auto-created"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/groups/getGroup","title":"Get group","href":"/reference/v2/groups/getGroup","group":"Groups · v2","method":"GET","version":"v2","keywords":"get group get a group get /groups/{groupid} getgroup v2 get details for a specific group. ","text":"Get a group Get details for a specific group. /groups/{groupId} groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-group_id","title":"group_id"},{"id":"response-name","title":"name Group name. Null for unnamed groups."},{"id":"response-chat_guid","title":"chat_guid Deprecated. An identifier for the group's iMessage conversation, kept for existi"},{"id":"response-icon_url","title":"icon_url URL of the group icon/photo"},{"id":"response-member_count","title":"member_count"},{"id":"response-message_count","title":"message_count Total number of messages in this group"},{"id":"response-last_message_text","title":"last_message_text Text of the most recent message in the group"},{"id":"response-last_message_time","title":"last_message_time Timestamp of the most recent message"},{"id":"response-last_message_direction","title":"last_message_direction Direction of the most recent message"},{"id":"response-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/groups/updateGroup","title":"Update group","href":"/reference/v2/groups/updateGroup","group":"Groups · v2","method":"PATCH","version":"v2","keywords":"update group update a group patch /groups/{groupid} updategroup v2 update a group's name. if the group already has an imessage conversation, the conversation is renamed too. name new group name","text":"name New group name Update a group Update a group's name. If the group already has an iMessage conversation, the conversation is renamed too. /groups/{groupId} groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints. New group name","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name New group name"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-group_id","title":"group_id"},{"id":"response-name","title":"name Group name. Null for unnamed groups."},{"id":"response-chat_guid","title":"chat_guid Deprecated. An identifier for the group's iMessage conversation, kept for existi"},{"id":"response-icon_url","title":"icon_url URL of the group icon/photo"},{"id":"response-member_count","title":"member_count"},{"id":"response-message_count","title":"message_count Total number of messages in this group"},{"id":"response-last_message_text","title":"last_message_text Text of the most recent message in the group"},{"id":"response-last_message_time","title":"last_message_time Timestamp of the most recent message"},{"id":"response-last_message_direction","title":"last_message_direction Direction of the most recent message"},{"id":"response-created_at","title":"created_at"},{"id":"response-device_sync","title":"device_sync Result of syncing the operation to a linked iMessage chat"},{"id":"response-device_sync-action","title":"action The action that was performed for the linked chat"},{"id":"response-device_sync-synced","title":"synced Whether the sync was successful"},{"id":"response-device_sync-error","title":"error Error message if sync failed"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/groups/deleteGroup","title":"Delete group","href":"/reference/v2/groups/deleteGroup","group":"Groups · v2","method":"DELETE","version":"v2","keywords":"delete group delete a group delete /groups/{groupid} deletegroup v2 soft-delete a group. members are automatically removed. if the group is linked to an existing imessage chat, the number also leaves that chat. ","text":"Delete a group Soft delete a group. Members are automatically removed. If the group is linked to an existing iMessage chat, the number also leaves that chat. /groups/{groupId} groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-deleted_at","title":"deleted_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/groups/setGroupIcon","title":"Set group icon","href":"/reference/v2/groups/setGroupIcon","group":"Groups · v2","method":"POST","version":"v2","keywords":"set group icon set group icon post /groups/{groupid}/icon setgroupicon v2 set the group icon/photo. requires the group to have an imessage conversation, so send it a message first. uses multipart/form-data.\n\nthe uploaded image is stored in blooio storage and synced to the group's imessage conversation before the request returns. icon the icon image file to set as the group photo","text":"icon The icon image file to set as the group photo Set group icon Set the group icon/photo. Requires the group to have an iMessage conversation, so send it a message first. Uses multipart/form data. The uploaded image is stored in Blooio storage and synced to the group's iMessage conversation before the request returns. /groups/{groupId}/icon groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints. The icon image file to set as the group photo","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-icon","title":"icon The icon image file to set as the group photo"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-group_id","title":"group_id"},{"id":"response-chat_guid","title":"chat_guid Deprecated. An identifier for the group's iMessage conversation, kept for existi"},{"id":"response-icon_url","title":"icon_url URL of the uploaded icon (only present on set)"},{"id":"response-device_sync","title":"device_sync Linked chat sync status"},{"id":"response-device_sync-chat_guid","title":"chat_guid Deprecated. The same value as the top-level `chat_guid`."},{"id":"response-device_sync-synced","title":"synced Whether the icon change was synced to the linked iMessage chat. This will be tru"},{"id":"response-device_sync-message","title":"message Status message about linked chat sync"},{"id":"response-message","title":"message"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/groups/removeGroupIcon","title":"Remove group icon","href":"/reference/v2/groups/removeGroupIcon","group":"Groups · v2","method":"DELETE","version":"v2","keywords":"remove group icon remove group icon delete /groups/{groupid}/icon removegroupicon v2 remove the group icon/photo. requires the group to have an imessage conversation.\n\nthe icon is removed from both blooio storage and the group's imessage conversation before the request returns. ","text":"Remove group icon Remove the group icon/photo. Requires the group to have an iMessage conversation. The icon is removed from both Blooio storage and the group's iMessage conversation before the request returns. /groups/{groupId}/icon groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-group_id","title":"group_id"},{"id":"response-chat_guid","title":"chat_guid Deprecated. An identifier for the group's iMessage conversation, kept for existi"},{"id":"response-icon_url","title":"icon_url URL of the uploaded icon (only present on set)"},{"id":"response-device_sync","title":"device_sync Linked chat sync status"},{"id":"response-device_sync-chat_guid","title":"chat_guid Deprecated. The same value as the top-level `chat_guid`."},{"id":"response-device_sync-synced","title":"synced Whether the icon change was synced to the linked iMessage chat. This will be tru"},{"id":"response-device_sync-message","title":"message Status message about linked chat sync"},{"id":"response-message","title":"message"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/group-members","title":"Group Members","href":"/reference/v2/group-members","group":"API Reference · v2","version":"v2","keywords":"group members manage group membership v2","text":"Manage group membership"},{"id":"v2:/reference/v2/group-members/listGroupMembers","title":"List group members","href":"/reference/v2/group-members/listGroupMembers","group":"Group Members · v2","method":"GET","version":"v2","keywords":"list group members list group members get /groups/{groupid}/members listgroupmembers v2 list all members of a group. ","text":"List group members List all members of a group. /groups/{groupId}/members groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints. limit Maximum number of items to return in a single response. Must be between 1 and 200; defaults to 50. Use together with to page through large result sets. offset Number of items to skip before returning results. Combine with for page based pagination (e.g. returns the second page). Defaults to 0.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return in a single response. Must be between 1 and 20"},{"id":"query-offset","title":"offset Number of items to skip before returning results. Combine with `limit` for page-"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-group_id","title":"group_id The group ID"},{"id":"response-group_name","title":"group_name The group name"},{"id":"response-icon_url","title":"icon_url URL of the group icon/photo"},{"id":"response-members","title":"members"},{"id":"response-members-0-id","title":"id Contact identifier (phone or email)"},{"id":"response-members-0-contact_id","title":"contact_id"},{"id":"response-members-0-identifier","title":"identifier"},{"id":"response-members-0-name","title":"name"},{"id":"response-members-0-added_at","title":"added_at"},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-total","title":"total"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/group-members/addGroupMember","title":"Add group member","href":"/reference/v2/group-members/addGroupMember","group":"Group Members · v2","method":"POST","version":"v2","keywords":"add group member add a member to a group (coming soon) post /groups/{groupid}/members addgroupmember v2 ⚠️ **coming soon** - this endpoint is temporarily disabled while we stabilize this feature.\n\nadd an existing contact to a group. if the group is linked to an existing imessage chat, also adds the participant to that chat. contact_id contact identifier (phone number or email)","text":"contact id Contact identifier (phone number or email) Add a member to a group (Coming Soon) ⚠️ COMING SOON This endpoint is temporarily disabled while we stabilize this feature. Add an existing contact to a group. If the group is linked to an existing iMessage chat, also adds the participant to that chat. /groups/{groupId}/members groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints. Contact identifier (phone number or email)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-contact_id","title":"contact_id Contact identifier (phone number or email)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/group-members/removeGroupMember","title":"Remove group member","href":"/reference/v2/group-members/removeGroupMember","group":"Group Members · v2","method":"DELETE","version":"v2","keywords":"remove group member remove a member from a group (coming soon) delete /groups/{groupid}/members/{contactid} removegroupmember v2 ⚠️ **coming soon** - this endpoint is temporarily disabled while we stabilize this feature.\n\nremove a contact from a group. if the group is linked to an existing imessage chat, also removes the participant from that chat. if the contact being removed is the organization's own phone number, leaves the group chat instead. ","text":"Remove a member from a group (Coming Soon) ⚠️ COMING SOON This endpoint is temporarily disabled while we stabilize this feature. Remove a contact from a group. If the group is linked to an existing iMessage chat, also removes the participant from that chat. If the contact being removed is the organization's own phone number, leaves the group chat instead. /groups/{groupId}/members/{contactId} groupId Unique identifier of the group chat, prefixed with (e.g. ). Returned by the create group and list groups endpoints. contactId Contact identifier (phone number in E.164 format or email, URL encoded)","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group chat, prefixed with `grp_` (e.g. `grp_abc123def45"},{"id":"path-contactid","title":"contactId Contact identifier (phone number in E.164 format or email, URL-encoded)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/webhooks","title":"Webhooks","href":"/reference/v2/webhooks","group":"API Reference · v2","version":"v2","keywords":"webhooks manage webhook subscriptions v2","text":"Manage webhook subscriptions"},{"id":"v2:/reference/v2/webhooks/listWebhooks","title":"List webhooks","href":"/reference/v2/webhooks/listWebhooks","group":"Webhooks · v2","method":"GET","version":"v2","keywords":"list webhooks list webhooks get /webhooks listwebhooks v2 list all webhooks for the organization. ","text":"List webhooks List all webhooks for the organization. /webhooks","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-webhooks","title":"webhooks"},{"id":"response-webhooks-0-webhook_id","title":"webhook_id"},{"id":"response-webhooks-0-webhook_url","title":"webhook_url"},{"id":"response-webhooks-0-webhook_type","title":"webhook_type"},{"id":"response-webhooks-0-scope","title":"scope"},{"id":"response-webhooks-0-api_key_name","title":"api_key_name Name of the API key (if scope is api_key)"},{"id":"response-webhooks-0-integration_name","title":"integration_name Name of the integration (if scope is integration)"},{"id":"response-webhooks-0-created_at","title":"created_at"},{"id":"response-webhooks-0-deprecated_at","title":"deprecated_at"},{"id":"response-webhooks-0-valid_until","title":"valid_until -1 means no expiration"},{"id":"response-webhooks-0-last_triggered","title":"last_triggered"},{"id":"response-webhooks-0-failure_count","title":"failure_count"},{"id":"response-webhooks-0-is_active","title":"is_active Whether the webhook is active (not deprecated)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/webhooks/createWebhook","title":"Create webhook","href":"/reference/v2/webhooks/createWebhook","group":"Webhooks · v2","method":"POST","version":"v2","keywords":"create webhook create a webhook (closed) post /webhooks createwebhook v2 registration through this endpoint is closed and returns 410. use post /v4/webhooks to create new subscriptions. existing webhooks keep working and can still be listed, updated, and deleted here. re-posting the url of a webhook that already exists still returns 200 with that webhook, so idempotent provisioning scripts continue to work unchanged. webhook_url url of an existing webhook, for the idempotent 200 response. a url that does not already exist returns 410. valid_until ignored. retained so existing request bodies stay valid.","text":"webhook url URL of an existing webhook, for the idempotent 200 response. A URL that does not already exist returns 410. valid until Ignored. Retained so existing request bodies stay valid. Create a webhook (closed) Registration through this endpoint is closed and returns 410. Use POST /v4/webhooks to create new subscriptions. Existing webhooks keep working and can still be listed, updated, and deleted here. Re posting the URL of a webhook that already exists still returns 200 with that webhook, so idempotent provisioning scripts continue to work unchanged. /webhooks URL of an existing webhook, for the idempotent 200 response. A URL that does not already exist returns 410. Ignored. Retained so existing request bodies stay valid.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-webhook_url","title":"webhook_url URL of an existing webhook, for the idempotent 200 response. A URL that does not"},{"id":"body-valid_until","title":"valid_until Ignored. Retained so existing request bodies stay valid."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-webhook_id","title":"webhook_id"},{"id":"response-webhook_url","title":"webhook_url"},{"id":"response-scope","title":"scope"},{"id":"response-message","title":"message"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/webhooks/getWebhook","title":"Get webhook","href":"/reference/v2/webhooks/getWebhook","group":"Webhooks · v2","method":"GET","version":"v2","keywords":"get webhook get a webhook get /webhooks/{webhookid} getwebhook v2 get details for a specific webhook. ","text":"Get a webhook Get details for a specific webhook. /webhooks/{webhookId} webhookId Unique identifier of the webhook subscription, prefixed with (e.g. ). Returned when you create or list webhooks.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_` (e.g. `wh_abc"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-webhook_id","title":"webhook_id"},{"id":"response-webhook_url","title":"webhook_url"},{"id":"response-webhook_type","title":"webhook_type"},{"id":"response-scope","title":"scope"},{"id":"response-api_key_name","title":"api_key_name Name of the API key (if scope is api_key)"},{"id":"response-integration_name","title":"integration_name Name of the integration (if scope is integration)"},{"id":"response-created_at","title":"created_at"},{"id":"response-deprecated_at","title":"deprecated_at"},{"id":"response-valid_until","title":"valid_until -1 means no expiration"},{"id":"response-last_triggered","title":"last_triggered"},{"id":"response-failure_count","title":"failure_count"},{"id":"response-is_active","title":"is_active Whether the webhook is active (not deprecated)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/webhooks/updateWebhook","title":"Update webhook","href":"/reference/v2/webhooks/updateWebhook","group":"Webhooks · v2","method":"PATCH","version":"v2","keywords":"update webhook update a webhook patch /webhooks/{webhookid} updatewebhook v2 update a webhook's configuration. webhook_type type of events to receive message status all valid_until expiration timestamp. use -1 or null for no expiration. deprecate set to true to deprecate, false to undeprecate","text":"webhook type Type of events to receive message status all valid until Expiration timestamp. Use 1 or null for no expiration. deprecate Set to true to deprecate, false to undeprecate Update a webhook Update a webhook's configuration. /webhooks/{webhookId} webhookId Unique identifier of the webhook subscription, prefixed with (e.g. ). Returned when you create or list webhooks. Type of events to receive Expiration timestamp. Use 1 or null for no expiration. Set to true to deprecate, false to undeprecate","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_` (e.g. `wh_abc"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-webhook_type","title":"webhook_type Type of events to receive"},{"id":"body-valid_until","title":"valid_until Expiration timestamp. Use -1 or null for no expiration."},{"id":"body-deprecate","title":"deprecate Set to true to deprecate, false to undeprecate"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-webhook_id","title":"webhook_id"},{"id":"response-webhook_url","title":"webhook_url"},{"id":"response-webhook_type","title":"webhook_type"},{"id":"response-scope","title":"scope"},{"id":"response-api_key_name","title":"api_key_name Name of the API key (if scope is api_key)"},{"id":"response-integration_name","title":"integration_name Name of the integration (if scope is integration)"},{"id":"response-created_at","title":"created_at"},{"id":"response-deprecated_at","title":"deprecated_at"},{"id":"response-valid_until","title":"valid_until -1 means no expiration"},{"id":"response-last_triggered","title":"last_triggered"},{"id":"response-failure_count","title":"failure_count"},{"id":"response-is_active","title":"is_active Whether the webhook is active (not deprecated)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/webhooks/deleteWebhook","title":"Delete webhook","href":"/reference/v2/webhooks/deleteWebhook","group":"Webhooks · v2","method":"DELETE","version":"v2","keywords":"delete webhook delete a webhook delete /webhooks/{webhookid} deletewebhook v2 permanently delete a webhook. ","text":"Delete a webhook Permanently delete a webhook. /webhooks/{webhookId} webhookId Unique identifier of the webhook subscription, prefixed with (e.g. ). Returned when you create or list webhooks.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_` (e.g. `wh_abc"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success"},{"id":"response-message","title":"message"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/webhooks/rotateWebhookSecret","title":"Rotate webhook secret","href":"/reference/v2/webhooks/rotateWebhookSecret","group":"Webhooks · v2","method":"POST","version":"v2","keywords":"rotate webhook secret rotate webhook signing secret post /webhooks/{webhookid}/secret/rotate rotatewebhooksecret v2 generate a new signing secret for the webhook. the new secret is returned only once in this response - store it securely. the old secret becomes invalid immediately. ","text":"Rotate webhook signing secret Generate a new signing secret for the webhook. The new secret is returned only once in this response store it securely. The old secret becomes invalid immediately. /webhooks/{webhookId}/secret/rotate webhookId Unique identifier of the webhook subscription, prefixed with (e.g. ). Returned when you create or list webhooks.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_` (e.g. `wh_abc"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-webhook_id","title":"webhook_id"},{"id":"response-signing_secret","title":"signing_secret The new signing secret. Store this securely - it will not be shown again."},{"id":"response-rotated_at","title":"rotated_at Timestamp when the secret was rotated"},{"id":"response-rotated_by","title":"rotated_by Identifier of who rotated the secret"},{"id":"response-rotation_count","title":"rotation_count Total number of times this secret has been rotated"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/webhook-logs","title":"Webhook Logs","href":"/reference/v2/webhook-logs","group":"API Reference · v2","version":"v2","keywords":"webhook logs view and replay webhook deliveries v2","text":"View and replay webhook deliveries"},{"id":"v2:/reference/v2/webhook-logs/listWebhookLogs","title":"List webhook logs","href":"/reference/v2/webhook-logs/listWebhookLogs","group":"Webhook Logs · v2","method":"GET","version":"v2","keywords":"list webhook logs list webhook logs get /webhooks/{webhookid}/logs listwebhooklogs v2 list delivery logs for a specific webhook. ","text":"List webhook logs List delivery logs for a specific webhook. /webhooks/{webhookId}/logs webhookId Unique identifier of the webhook subscription, prefixed with (e.g. ). Returned when you create or list webhooks. limit Maximum number of items to return in a single response. Must be between 1 and 200; defaults to 50. Use together with to page through large result sets. offset Number of items to skip before returning results. Combine with for page based pagination (e.g. returns the second page). Defaults to 0. sort Sort order by attempted time status Filter by exact HTTP status code min status Minimum HTTP status code max status Maximum HTTP status code","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_` (e.g. `wh_abc"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return in a single response. Must be between 1 and 20"},{"id":"query-offset","title":"offset Number of items to skip before returning results. Combine with `limit` for page-"},{"id":"query-sort","title":"sort Sort order by attempted time"},{"id":"query-status","title":"status Filter by exact HTTP status code"},{"id":"query-min_status","title":"min_status Minimum HTTP status code"},{"id":"query-max_status","title":"max_status Maximum HTTP status code"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-logs","title":"logs"},{"id":"response-logs-0-event_id","title":"event_id"},{"id":"response-logs-0-scope","title":"scope"},{"id":"response-logs-0-attempted_time","title":"attempted_time"},{"id":"response-logs-0-response_received_at","title":"response_received_at"},{"id":"response-logs-0-webhook_url","title":"webhook_url"},{"id":"response-logs-0-event_body","title":"event_body Webhook event payload. Structure varies by event type. All message events includ"},{"id":"response-logs-0-event_body-event","title":"event Event type (e.g., message.received, message.sent, message.delivered, message.fai"},{"id":"response-logs-0-event_body-message_id","title":"message_id Unique message identifier"},{"id":"response-logs-0-event_body-external_id","title":"external_id Recipient identifier (phone number, email, or group ID)"},{"id":"response-logs-0-event_body-status","title":"status Message status carried by the event. `queued` / `pending` = accepted, not yet ha"},{"id":"response-logs-0-event_body-protocol","title":"protocol Transport used to carry the message; never null. `pending` = accepted and dispat"},{"id":"response-logs-0-event_body-timestamp","title":"timestamp Event timestamp in milliseconds"},{"id":"response-logs-0-event_body-internal_id","title":"internal_id Phone number that sent/received the message"},{"id":"response-logs-0-event_body-text","title":"text Message text content"},{"id":"response-logs-0-event_body-formatted_text","title":"formatted_text Markdown for a rich-text (bold/italic/underline/strikethrough) message. Omitted"},{"id":"response-logs-0-event_body-attachments","title":"attachments Array of attachment objects"},{"id":"response-logs-0-event_body-attachments-0-url","title":"url"},{"id":"response-logs-0-event_body-attachments-0-name","title":"name"},{"id":"response-logs-0-event_body-is_group","title":"is_group Whether this message is from/to a group chat. Always present."},{"id":"response-logs-0-event_body-group_id","title":"group_id Group ID (only present when is_group=true)"},{"id":"response-logs-0-event_body-group_name","title":"group_name Group display name (only present when is_group=true)"},{"id":"response-logs-0-event_body-participants","title":"participants Array of group participants (only present when is_group=true). One entry per per"},{"id":"response-logs-0-event_body-participants-0-contact_id","title":"contact_id"},{"id":"response-logs-0-event_body-participants-0-identifier","title":"identifier"},{"id":"response-logs-0-event_body-participants-0-name","title":"name"},{"id":"response-logs-0-event_body-chat_guid","title":"chat_guid Deprecated, kept for existing integrations. An identifier for the iMessage conve"},{"id":"response-logs-0-event_body-chat_name","title":"chat_name The name the device reports for the conversation (only on `message.received` whe"},{"id":"response-logs-0-event_body-sender","title":"sender Sender identifier (for inbound messages)"},{"id":"response-logs-0-event_body-sent_at","title":"sent_at Timestamp when message was sent (for message.sent events)"},{"id":"response-logs-0-event_body-delivered_at","title":"delivered_at Timestamp when message was delivered (for message.delivered events)"},{"id":"response-logs-0-event_body-read_at","title":"read_at Timestamp when message was read (for message.read events)"},{"id":"response-logs-0-event_body-error_code","title":"error_code Error code (for message.failed events)"},{"id":"response-logs-0-event_body-error_message","title":"error_message Error description (for message.failed events)"},{"id":"response-logs-0-response_status","title":"response_status HTTP status code received from the webhook endpoint"},{"id":"response-logs-0-response_json","title":"response_json Response body from the webhook endpoint (if JSON)"},{"id":"response-logs-0-metadata","title":"metadata Additional metadata about the webhook delivery"},{"id":"response-logs-0-metadata-organization_id","title":"organization_id"},{"id":"response-logs-0-metadata-event_name","title":"event_name"},{"id":"response-logs-0-metadata-message_id","title":"message_id"},{"id":"response-logs-0-metadata-is_replay","title":"is_replay"},{"id":"response-logs-0-metadata-original_event_id","title":"original_event_id"},{"id":"response-logs-0-metadata-duration_ms","title":"duration_ms"},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-total","title":"total Total number of matching logs"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-returned","title":"returned Number of logs returned in this response"},{"id":"response-pagination-has_more","title":"has_more Whether there are more logs to fetch"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/webhook-logs/replayWebhookEvent","title":"Replay webhook event","href":"/reference/v2/webhook-logs/replayWebhookEvent","group":"Webhook Logs · v2","method":"POST","version":"v2","keywords":"replay webhook event replay a webhook event post /webhooks/{webhookid}/logs/{eventid}/replay replaywebhookevent v2 re-send a webhook event to the configured url. ","text":"Replay a webhook event Re send a webhook event to the configured URL. /webhooks/{webhookId}/logs/{eventId}/replay webhookId Unique identifier of the webhook subscription, prefixed with (e.g. ). Returned when you create or list webhooks. eventId Event ID to replay","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_` (e.g. `wh_abc"},{"id":"path-eventid","title":"eventId Event ID to replay"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-success","title":"success Whether the replay received a 2xx response"},{"id":"response-replay_event_id","title":"replay_event_id New event ID for this replay attempt"},{"id":"response-original_event_id","title":"original_event_id The original event ID that was replayed"},{"id":"response-webhook_id","title":"webhook_id"},{"id":"response-webhook_url","title":"webhook_url"},{"id":"response-response_status","title":"response_status HTTP status code from replay attempt"},{"id":"response-duration_ms","title":"duration_ms Time taken for the replay request in milliseconds"},{"id":"response-response_data","title":"response_data Response details from the replay attempt"},{"id":"response-response_data-body","title":"body Response body (if parseable)"},{"id":"response-response_data-headers","title":"headers"},{"id":"response-response_data-size","title":"size"},{"id":"response-response_data-contenttype","title":"contentType"},{"id":"response-response_data-duration","title":"duration"},{"id":"response-response_data-error","title":"error"},{"id":"response-response_data-errortype","title":"errorType"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/chats","title":"Chats","href":"/reference/v2/chats","group":"API Reference · v2","version":"v2","keywords":"chats view conversations and messages v2","text":"View conversations and messages"},{"id":"v2:/reference/v2/chats/listChats","title":"List chats","href":"/reference/v2/chats/listChats","group":"Chats · v2","method":"GET","version":"v2","keywords":"list chats list chats get /chats listchats v2 list all unique conversations for the organization, sorted by most recent message. ","text":"List chats List all unique conversations for the organization, sorted by most recent message. /chats limit Maximum number of items to return in a single response. Must be between 1 and 200; defaults to 50. Use together with to page through large result sets. offset Number of items to skip before returning results. Combine with for page based pagination (e.g. returns the second page). Defaults to 0. q Search query (matches phone/email or contact name) sort Sort order","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return in a single response. Must be between 1 and 20"},{"id":"query-offset","title":"offset Number of items to skip before returning results. Combine with `limit` for page-"},{"id":"query-q","title":"q Search query (matches phone/email or contact name)"},{"id":"query-sort","title":"sort Sort order"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-chats","title":"chats"},{"id":"response-chats-0-id","title":"id Chat identifier (phone number, email, or group ID)"},{"id":"response-chats-0-type","title":"type"},{"id":"response-chats-0-is_group","title":"is_group Whether this is a group chat"},{"id":"response-chats-0-group_id","title":"group_id Group ID (only for group chats)"},{"id":"response-chats-0-group_name","title":"group_name Group name (only for group chats)"},{"id":"response-chats-0-member_count","title":"member_count Number of members (only for group chats)"},{"id":"response-chats-0-contact","title":"contact Contact info (only for non-group chats)"},{"id":"response-chats-0-contact-contact_id","title":"contact_id"},{"id":"response-chats-0-contact-name","title":"name"},{"id":"response-chats-0-contact-identifier","title":"identifier"},{"id":"response-chats-0-message_count","title":"message_count"},{"id":"response-chats-0-inbound_count","title":"inbound_count"},{"id":"response-chats-0-outbound_count","title":"outbound_count"},{"id":"response-chats-0-background_url","title":"background_url Public URL of the chat background image (if one has been set via the API)"},{"id":"response-chats-0-background_id","title":"background_id Identifier for the active chat background"},{"id":"response-chats-0-last_message_time","title":"last_message_time"},{"id":"response-chats-0-last_inbound_time","title":"last_inbound_time"},{"id":"response-chats-0-last_outbound_time","title":"last_outbound_time"},{"id":"response-chats-0-last_message","title":"last_message"},{"id":"response-chats-0-last_message-message_id","title":"message_id"},{"id":"response-chats-0-last_message-text","title":"text"},{"id":"response-chats-0-last_message-direction","title":"direction"},{"id":"response-chats-0-last_message-time_sent","title":"time_sent"},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-total","title":"total"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/chats/getChat","title":"Get chat","href":"/reference/v2/chats/getChat","group":"Chats · v2","method":"GET","version":"v2","keywords":"get chat get a chat get /chats/{chatid} getchat v2 get details for a specific conversation. ","text":"Get a chat Get details for a specific conversation. /chats/{chatId} chatId 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.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id Chat identifier (phone number, email, or group ID)"},{"id":"response-type","title":"type"},{"id":"response-is_group","title":"is_group Whether this is a group chat"},{"id":"response-group_id","title":"group_id Group ID (only for group chats)"},{"id":"response-group_name","title":"group_name Group name (only for group chats)"},{"id":"response-member_count","title":"member_count Number of members (only for group chats)"},{"id":"response-contact","title":"contact Contact info (only for non-group chats)"},{"id":"response-contact-contact_id","title":"contact_id"},{"id":"response-contact-name","title":"name"},{"id":"response-contact-identifier","title":"identifier"},{"id":"response-message_count","title":"message_count"},{"id":"response-inbound_count","title":"inbound_count"},{"id":"response-outbound_count","title":"outbound_count"},{"id":"response-background_url","title":"background_url Public URL of the chat background image (if one has been set via the API)"},{"id":"response-background_id","title":"background_id Identifier for the active chat background"},{"id":"response-first_message_time","title":"first_message_time"},{"id":"response-last_message_time","title":"last_message_time"},{"id":"response-last_inbound_time","title":"last_inbound_time"},{"id":"response-last_outbound_time","title":"last_outbound_time"},{"id":"response-last_message","title":"last_message"},{"id":"response-last_message-message_id","title":"message_id"},{"id":"response-last_message-text","title":"text"},{"id":"response-last_message-direction","title":"direction"},{"id":"response-last_message-time_sent","title":"time_sent"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/chats/getChatBackground","title":"Get chat background","href":"/reference/v2/chats/getChatBackground","group":"Chats · v2","method":"GET","version":"v2","keywords":"get chat background get chat background get /chats/{chatid}/background getchatbackground v2 get the current background image metadata for a conversation. works for both 1-on-1 and group chats. ","text":"Get chat background Get the current background image metadata for a conversation. Works for both 1 on 1 and group chats. /chats/{chatId}/background chatId 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.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-chat_id","title":"chat_id Normalized chat identifier (phone number, email, or group ID)"},{"id":"response-has_background","title":"has_background Whether the chat currently has a background set"},{"id":"response-background_id","title":"background_id Unique identifier for the current background, or null if none"},{"id":"response-background_url","title":"background_url Public URL of the persisted background image stored in R2. Returned after a succ"},{"id":"response-background_version","title":"background_version Version number of the background (for cache invalidation)"},{"id":"response-changed","title":"changed Whether the background was changed by this operation (only present on PUT)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/chats/setChatBackground","title":"Set chat background","href":"/reference/v2/chats/setChatBackground","group":"Chats · v2","method":"PUT","version":"v2","keywords":"set chat background set chat background put /chats/{chatid}/background setchatbackground v2 set or update the background image for a conversation. works for both 1-on-1 and group chats.\n\nthe request body must be `multipart/form-data` with a single `background` field containing the **raw image file bytes** (not a url or base64 string). supported formats: jpeg, png, gif, webp, heic/heif. maximum file size: 10 mb.\n\n**example with curl** — note the `@` prefix that tells curl to read the file from disk:\n\n```bash\ncurl -x put \"https://api.blooio.com/v2/api/chats/%2b15551234567/background\" \\\n -h \"authorization: bearer your_api_key\" \\\n -f \"background=@/path/to/image.jpg;type=image/jpeg\"\n```\n\nwhen the chat id is a phone number, percent-encode the leading `+` as `%2b` in the url path. background binary image file upload (jpeg, png, gif, webp, heic/heif, max 10 mb). send as a file field in `multipart/form-data` — e.g. `-f \"background=@/path/to/image.jpg\"` with curl, or a `file`/`blob` appended","text":"$34","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-background","title":"background Binary image file upload (JPEG, PNG, GIF, WebP, HEIC/HEIF, max 10 MB). Send as a"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-chat_id","title":"chat_id Normalized chat identifier (phone number, email, or group ID)"},{"id":"response-has_background","title":"has_background Whether the chat currently has a background set"},{"id":"response-background_id","title":"background_id Unique identifier for the current background, or null if none"},{"id":"response-background_url","title":"background_url Public URL of the persisted background image stored in R2. Returned after a succ"},{"id":"response-background_version","title":"background_version Version number of the background (for cache invalidation)"},{"id":"response-changed","title":"changed Whether the background was changed by this operation (only present on PUT)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/chats/removeChatBackground","title":"Remove chat background","href":"/reference/v2/chats/removeChatBackground","group":"Chats · v2","method":"DELETE","version":"v2","keywords":"remove chat background remove chat background delete /chats/{chatid}/background removechatbackground v2 remove the background image from a conversation, reverting to the default appearance. ","text":"Remove chat background Remove the background image from a conversation, reverting to the default appearance. /chats/{chatId}/background chatId 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.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-chat_id","title":"chat_id Normalized chat identifier (phone number, email, or group ID)"},{"id":"response-has_background","title":"has_background Whether the chat currently has a background set"},{"id":"response-background_id","title":"background_id Unique identifier for the current background, or null if none"},{"id":"response-background_url","title":"background_url Public URL of the persisted background image stored in R2. Returned after a succ"},{"id":"response-background_version","title":"background_version Version number of the background (for cache invalidation)"},{"id":"response-changed","title":"changed Whether the background was changed by this operation (only present on PUT)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:tag:/reference/v2/messages","title":"Messages","href":"/reference/v2/messages","group":"API Reference · v2","version":"v2","keywords":"messages view individual messages and their status v2","text":"View individual messages and their status"},{"id":"v2:/reference/v2/messages/listChatMessages","title":"List chat messages","href":"/reference/v2/messages/listChatMessages","group":"Messages · v2","method":"GET","version":"v2","keywords":"list chat messages list messages in a chat get /chats/{chatid}/messages listchatmessages v2 list all messages in a conversation with optional filtering.\n\na conversation must already exist: this returns `404` for an address the organization has never exchanged a message with, rather than an empty list. use `get /chats` to enumerate the conversations that do exist. ","text":"$35","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return in a single response. Must be between 1 and 20"},{"id":"query-offset","title":"offset Number of items to skip before returning results. Combine with `limit` for page-"},{"id":"query-sort","title":"sort Sort order by time"},{"id":"query-direction","title":"direction Filter by message direction"},{"id":"query-since","title":"since Only messages sent after this timestamp (ms)"},{"id":"query-until","title":"until Only messages sent before this timestamp (ms)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-chat_id","title":"chat_id"},{"id":"response-messages","title":"messages"},{"id":"response-messages-0-message_id","title":"message_id"},{"id":"response-messages-0-direction","title":"direction"},{"id":"response-messages-0-external_id","title":"external_id Phone number or email of the contact, or group ID for group messages"},{"id":"response-messages-0-internal_id","title":"internal_id Organization phone number (from-number) used for this message"},{"id":"response-messages-0-text","title":"text"},{"id":"response-messages-0-formatted_text","title":"formatted_text Markdown for a rich-text (bold/italic/underline/strikethrough) message. Omitted"},{"id":"response-messages-0-attachments","title":"attachments"},{"id":"response-messages-0-sender","title":"sender Sender's phone number or email for inbound group messages. Null for outbound mes"},{"id":"response-messages-0-reactions","title":"reactions Reactions on this message (tapbacks and emoji reactions)"},{"id":"response-messages-0-reactions-0-reaction","title":"reaction The reaction value. Classic tapbacks: love, like, dislike, laugh, emphasize, que"},{"id":"response-messages-0-reactions-0-is_added","title":"is_added Whether the reaction is currently active (true) or was removed (false)"},{"id":"response-messages-0-reactions-0-time_sent","title":"time_sent Timestamp when the reaction was sent (ms)"},{"id":"response-messages-0-reactions-0-sender","title":"sender Phone number or email of who sent the reaction. Null when the reaction was sent"},{"id":"response-messages-0-time_sent","title":"time_sent"},{"id":"response-messages-0-time_delivered","title":"time_delivered"},{"id":"response-messages-0-status","title":"status Delivery lifecycle state. `pending` = persisted and being prepared for dispatch;"},{"id":"response-messages-0-protocol","title":"protocol Transport used to carry the message; never null. `pending` = accepted and dispat"},{"id":"response-messages-0-error","title":"error"},{"id":"response-messages-0-reply_to","title":"reply_to Present only on inline-reply messages. Omitted entirely for top-level messages."},{"id":"response-messages-0-reply_to-message_id","title":"message_id The Blooio `message_id` of the parent message. NULL when the parent isn't in our"},{"id":"response-messages-0-reply_to-guid","title":"guid The raw iMessage GUID of the parent. Always populated on real inline replies; th"},{"id":"response-messages-0-reply_to-part_index","title":"part_index Which part of the parent was replied to. 0 for the common single-part case."},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-total","title":"total"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/messages/sendMessage","title":"Send message","href":"/reference/v2/messages/sendMessage","group":"Messages · v2","method":"POST","version":"v2","keywords":"$36","text":"$37","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567),"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"header-idempotency-key","title":"Idempotency-Key Unique key to prevent duplicate message sends. If the same key is used again, th"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-text","title":"text Message text. Can be a single string or array of strings (each becomes a separat"},{"id":"body-format","title":"format How to interpret `text` (and each `parts[].text`). Defaults to `plain`, which se"},{"id":"body-attachments","title":"attachments Array of attachment URLs or objects with url/name.\n\n**Voice memos:** a single au"},{"id":"body-attachments-0-url","title":"url"},{"id":"body-attachments-0-name","title":"name"},{"id":"body-use_typing_indicator","title":"use_typing_indicator Whether to show typing indicator before sending. Defaults to org preference."},{"id":"body-from_number","title":"from_number E.164 phone number to send from. For Twilio API keys, this is optional — if omit"},{"id":"body-share_contact","title":"share_contact If true, the contact card (Name & Photo) will be shared with this message. The c"},{"id":"body-parts","title":"parts Ordered array of message parts. Two modes:\n\n 1. **Multipart mode** — parts sent"},{"id":"body-parts-0-text","title":"text Text content for this part. Mutually exclusive with 'url'."},{"id":"body-parts-0-mention","title":"mention Participant phone number or email to @-mention. Only valid with 'text'. The enti"},{"id":"body-parts-0-url","title":"url URL to an attachment for this part. Mutually exclusive with 'text'."},{"id":"body-parts-0-name","title":"name Filename for the attachment. Only valid with 'url'."},{"id":"body-parts-0-link_preview","title":"link_preview Optional. Per-part rich-link-preview override. When any part carries this, every"},{"id":"body-parts-0-link_preview-image_url","title":"image_url HTTPS URL to an image (png, jpg, webp, gif). Blooio downloads the image server-s"},{"id":"body-parts-0-link_preview-title","title":"title Bold title line rendered in the iMessage bubble. Overrides the page's `= 3 convers"},{"id":"response-phone_numbers-0-metrics-inbound_outbound_message_ratio","title":"inbound_outbound_message_ratio Inbound messages as a percentage of all messages: `total_inbound_messages / tota"},{"id":"response-phone_numbers-0-metrics-max_new_conversations_per_hour","title":"max_new_conversations_per_hour Peak number of NEW conversations the number itself opened in any sliding 60-minu"},{"id":"response-phone_numbers-0-metrics-max_messages_per_hour","title":"max_messages_per_hour Peak outbound messages sent in any sliding 60-minute window (burst detection). S"},{"id":"response-phone_numbers-0-metrics-message_similarity_percentage","title":"message_similarity_percentage Templated-content signal: the largest cluster of near-identical outbound message"},{"id":"response-phone_numbers-0-metrics-inbound_initiated","title":"inbound_initiated Count of new conversations the customer started in the window."},{"id":"response-phone_numbers-0-metrics-outbound_initiated","title":"outbound_initiated Count of new conversations this number started in the window."},{"id":"response-phone_numbers-0-metrics-total_conversations","title":"total_conversations Conversations with any message activity in the window."},{"id":"response-phone_numbers-0-metrics-total_messages","title":"total_messages Inbound + outbound messages in the window (excludes deleted)."},{"id":"response-phone_numbers-0-metrics-total_inbound_messages","title":"total_inbound_messages Inbound message count in the window."},{"id":"response-phone_numbers-0-metrics-total_outbound_messages","title":"total_outbound_messages Outbound message count in the window."},{"id":"response-phone_numbers-0-metrics-avg_messages_per_day","title":"avg_messages_per_day `total_messages` divided by days active."},{"id":"response-phone_numbers-0-metrics-avg_conversation_depth","title":"avg_conversation_depth `total_messages / total_conversations` (0 when there are no conversations)."},{"id":"response-phone_numbers-0-risk_factors","title":"risk_factors The ten additive risk factors that sum (clamped to 0-100) into `risk_score`. Eac"},{"id":"response-phone_numbers-0-risk_factors-outboundconversations","title":"outboundConversations Avg outbound-initiated conversations/day. Scoring: >50 = +30, 40-50 = +20, 30-40"},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-outboundconversations-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-inboundconversations","title":"inboundConversations Avg inbound-initiated conversations/day (bonus). Scoring: >=100 = -20, 50-100 ="},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-inboundconversations-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage","title":"inboundPercentage Percentage of new conversations the customer started (gradient). Scoring ranges"},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-inboundpercentage-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-totalcontacts","title":"totalContacts Distinct contacts messaged in the window. Scoring: >2000 = +15, 1500-2000 = +8,"},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-totalcontacts-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-replyrate","title":"replyRate Percentage of conversations with 3+ inbound messages. Scoring: <20% = +35, 20-30"},{"id":"response-phone_numbers-0-risk_factors-replyrate-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-replyrate-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-replyrate-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-replyrate-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-replyrate-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-replyrate-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-replyrate-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-replyrate-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-replyrate-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount","title":"inboundMsgCount Avg inbound messages per conversation. Scoring: <3 = +25 (with >= 3 conversation"},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-inboundmsgcount-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio","title":"inboundOutboundRatio Inbound share of all messages. Scoring: <=10% = +20, 11-29% = +10, >=30% = 0. Re"},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-inboundoutboundratio-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts","title":"newConversationBursts Peak new conversations the number itself opened in any sliding 60-minute window;"},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-newconversationbursts-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-messagebursts","title":"messageBursts Peak outbound messages in any sliding 60-minute window. Base scoring: >200 = +30"},{"id":"response-phone_numbers-0-risk_factors-messagebursts-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-messagebursts-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-messagebursts-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-messagebursts-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-messagebursts-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-messagebursts-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-messagebursts-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-messagebursts-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-messagebursts-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity","title":"messageSimilarity Largest near-identical outbound cluster (SimHash) as a percentage of qualifying"},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-phone_numbers-0-risk_factors-messagesimilarity-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-phone_numbers-0-daily_data","title":"daily_data"},{"id":"response-phone_numbers-0-daily_data-outbound_conversations","title":"outbound_conversations"},{"id":"response-phone_numbers-0-daily_data-outbound_conversations-0-date","title":"date UTC calendar day (YYYY-MM-DD)."},{"id":"response-phone_numbers-0-daily_data-outbound_conversations-0-count","title":"count"},{"id":"response-phone_numbers-0-daily_data-inbound_conversations","title":"inbound_conversations"},{"id":"response-phone_numbers-0-daily_data-inbound_conversations-0-date","title":"date UTC calendar day (YYYY-MM-DD)."},{"id":"response-phone_numbers-0-daily_data-inbound_conversations-0-count","title":"count"},{"id":"response-period_days","title":"period_days"},{"id":"response-window","title":"window The concrete time window the report was computed over."},{"id":"response-window-from","title":"from Window start (Unix epoch ms)."},{"id":"response-window-to","title":"to Window end (Unix epoch ms)."},{"id":"response-window-is_default","title":"is_default True when the caller supplied no window params (default 30 days)."},{"id":"response-calculated_at","title":"calculated_at When the report was computed (Unix epoch ms)."},{"id":"response-computed_with_expensive_metrics","title":"computed_with_expensive_metrics Whether the message-similarity metric was included."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/analytics/getRiskSummary","title":"Get risk summary","href":"/reference/v2/analytics/getRiskSummary","group":"Analytics · v2","method":"GET","version":"v2","keywords":"get risk summary get risk-tolerance summary get /analytics/risk-tolerance/summary getrisksummary v2 returns a lightweight cached rollup of the organization's most recent risk scores (highest score/level and the count of high-risk numbers). read from a cache populated by the full report; returns zeros with `computed_at: null` when the organization has never been scored. this endpoint never recomputes, so it is cheap to poll on load. ","text":"Get risk tolerance summary Returns a lightweight cached rollup of the organization's most recent risk scores (highest score/level and the count of high risk numbers). Read from a cache populated by the full report; returns zeros with when the organization has never been scored. This endpoint never recomputes, so it is cheap to poll on load. /analytics/risk tolerance/summary","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-high_risk_count","title":"high_risk_count"},{"id":"response-max_risk_level","title":"max_risk_level"},{"id":"response-max_risk_score","title":"max_risk_score"},{"id":"response-phone_count","title":"phone_count"},{"id":"response-high_risk_phones","title":"high_risk_phones"},{"id":"response-high_risk_phones-0-phone_number","title":"phone_number"},{"id":"response-high_risk_phones-0-risk_score","title":"risk_score"},{"id":"response-high_risk_phones-0-risk_level","title":"risk_level"},{"id":"response-computed_at","title":"computed_at When the cached summary was last computed (Unix epoch ms), or null if never."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v2:/reference/v2/analytics/getNumberRiskTolerance","title":"Get number risk tolerance","href":"/reference/v2/analytics/getNumberRiskTolerance","group":"Analytics · v2","method":"GET","version":"v2","keywords":"$3c","text":"$3d","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number E.164 phone number (URL-encoded, e.g. %2B15551234567)"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-days","title":"days Length of the reporting window in days, ending now. Between 1 and 365; defaults"},{"id":"query-from","title":"from Window start as a Unix epoch timestamp in milliseconds. When supplied, overrides"},{"id":"query-to","title":"to Window end as a Unix epoch timestamp in milliseconds. Defaults to now."},{"id":"query-compute","title":"compute Set to `true` to force the expensive message-similarity metric. Small fleets (<="},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-phone_number","title":"phone_number"},{"id":"response-allocation_id","title":"allocation_id"},{"id":"response-line_type","title":"line_type The line's allocation type, which determines the scoring profile applied. `inbou"},{"id":"response-risk_score","title":"risk_score Overall risk score, 0 (lowest) to 100 (highest). Clamped sum of the ten `risk_fa"},{"id":"response-risk_level","title":"risk_level Banding of `risk_score`: `low` = 0-29 (healthy), `medium` = 30-59 (monitor), `hi"},{"id":"response-has_activity","title":"has_activity Whether the number sent, received, or reached anyone in the window. Every factor"},{"id":"response-metrics","title":"metrics Raw and derived usage metrics for a number over the window. A *conversation* is"},{"id":"response-metrics-avg_outbound_conversations_per_day","title":"avg_outbound_conversations_per_day New outbound-initiated conversations started in the window, divided by days acti"},{"id":"response-metrics-avg_inbound_conversations_per_day","title":"avg_inbound_conversations_per_day New inbound-initiated conversations (customer messaged first) in the window, div"},{"id":"response-metrics-inbound_initiated_percentage","title":"inbound_initiated_percentage Share of new conversations that the customer started, as a percentage: `inbound_"},{"id":"response-metrics-total_contacts","title":"total_contacts Distinct contacts (conversation keys) messaged in the window. Large lists sugges"},{"id":"response-metrics-reply_rate","title":"reply_rate Percentage of conversations that received a meaningful reply, defined as 3 or mo"},{"id":"response-metrics-avg_inbound_messages_per_conversation","title":"avg_inbound_messages_per_conversation Mean inbound messages per conversation in the window. Below 3 (with >= 3 convers"},{"id":"response-metrics-inbound_outbound_message_ratio","title":"inbound_outbound_message_ratio Inbound messages as a percentage of all messages: `total_inbound_messages / tota"},{"id":"response-metrics-max_new_conversations_per_hour","title":"max_new_conversations_per_hour Peak number of NEW conversations the number itself opened in any sliding 60-minu"},{"id":"response-metrics-max_messages_per_hour","title":"max_messages_per_hour Peak outbound messages sent in any sliding 60-minute window (burst detection). S"},{"id":"response-metrics-message_similarity_percentage","title":"message_similarity_percentage Templated-content signal: the largest cluster of near-identical outbound message"},{"id":"response-metrics-inbound_initiated","title":"inbound_initiated Count of new conversations the customer started in the window."},{"id":"response-metrics-outbound_initiated","title":"outbound_initiated Count of new conversations this number started in the window."},{"id":"response-metrics-total_conversations","title":"total_conversations Conversations with any message activity in the window."},{"id":"response-metrics-total_messages","title":"total_messages Inbound + outbound messages in the window (excludes deleted)."},{"id":"response-metrics-total_inbound_messages","title":"total_inbound_messages Inbound message count in the window."},{"id":"response-metrics-total_outbound_messages","title":"total_outbound_messages Outbound message count in the window."},{"id":"response-metrics-avg_messages_per_day","title":"avg_messages_per_day `total_messages` divided by days active."},{"id":"response-metrics-avg_conversation_depth","title":"avg_conversation_depth `total_messages / total_conversations` (0 when there are no conversations)."},{"id":"response-risk_factors","title":"risk_factors The ten additive risk factors that sum (clamped to 0-100) into `risk_score`. Eac"},{"id":"response-risk_factors-outboundconversations","title":"outboundConversations Avg outbound-initiated conversations/day. Scoring: >50 = +30, 40-50 = +20, 30-40"},{"id":"response-risk_factors-outboundconversations-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-outboundconversations-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-outboundconversations-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-outboundconversations-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-outboundconversations-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-outboundconversations-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-outboundconversations-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-outboundconversations-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-outboundconversations-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-inboundconversations","title":"inboundConversations Avg inbound-initiated conversations/day (bonus). Scoring: >=100 = -20, 50-100 ="},{"id":"response-risk_factors-inboundconversations-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-inboundconversations-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-inboundconversations-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-inboundconversations-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-inboundconversations-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-inboundconversations-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-inboundconversations-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-inboundconversations-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-inboundconversations-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-inboundpercentage","title":"inboundPercentage Percentage of new conversations the customer started (gradient). Scoring ranges"},{"id":"response-risk_factors-inboundpercentage-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-inboundpercentage-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-inboundpercentage-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-inboundpercentage-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-inboundpercentage-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-inboundpercentage-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-inboundpercentage-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-inboundpercentage-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-inboundpercentage-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-totalcontacts","title":"totalContacts Distinct contacts messaged in the window. Scoring: >2000 = +15, 1500-2000 = +8,"},{"id":"response-risk_factors-totalcontacts-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-totalcontacts-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-totalcontacts-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-totalcontacts-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-totalcontacts-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-totalcontacts-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-totalcontacts-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-totalcontacts-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-totalcontacts-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-replyrate","title":"replyRate Percentage of conversations with 3+ inbound messages. Scoring: <20% = +35, 20-30"},{"id":"response-risk_factors-replyrate-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-replyrate-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-replyrate-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-replyrate-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-replyrate-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-replyrate-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-replyrate-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-replyrate-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-replyrate-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-inboundmsgcount","title":"inboundMsgCount Avg inbound messages per conversation. Scoring: <3 = +25 (with >= 3 conversation"},{"id":"response-risk_factors-inboundmsgcount-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-inboundmsgcount-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-inboundmsgcount-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-inboundmsgcount-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-inboundmsgcount-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-inboundmsgcount-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-inboundmsgcount-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-inboundmsgcount-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-inboundmsgcount-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-inboundoutboundratio","title":"inboundOutboundRatio Inbound share of all messages. Scoring: <=10% = +20, 11-29% = +10, >=30% = 0. Re"},{"id":"response-risk_factors-inboundoutboundratio-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-inboundoutboundratio-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-inboundoutboundratio-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-inboundoutboundratio-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-inboundoutboundratio-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-inboundoutboundratio-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-inboundoutboundratio-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-inboundoutboundratio-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-inboundoutboundratio-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-newconversationbursts","title":"newConversationBursts Peak new conversations the number itself opened in any sliding 60-minute window;"},{"id":"response-risk_factors-newconversationbursts-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-newconversationbursts-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-newconversationbursts-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-newconversationbursts-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-newconversationbursts-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-newconversationbursts-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-newconversationbursts-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-newconversationbursts-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-newconversationbursts-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-messagebursts","title":"messageBursts Peak outbound messages in any sliding 60-minute window. Base scoring: >200 = +30"},{"id":"response-risk_factors-messagebursts-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-messagebursts-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-messagebursts-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-messagebursts-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-messagebursts-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-messagebursts-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-messagebursts-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-messagebursts-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-messagebursts-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-risk_factors-messagesimilarity","title":"messageSimilarity Largest near-identical outbound cluster (SimHash) as a percentage of qualifying"},{"id":"response-risk_factors-messagesimilarity-value","title":"value The measured value for this factor (units depend on the factor)."},{"id":"response-risk_factors-messagesimilarity-score","title":"score Points this factor contributed to the total risk score."},{"id":"response-risk_factors-messagesimilarity-status","title":"status Qualitative status for display. `not_applicable` means the factor doesn't apply"},{"id":"response-risk_factors-messagesimilarity-impact","title":"impact Relative weight of this factor in the overall score."},{"id":"response-risk_factors-messagesimilarity-samplesize","title":"sampleSize Sample size backing the value, when the factor guards on a minimum sample."},{"id":"response-risk_factors-messagesimilarity-peak_at","title":"peak_at Burst factors only (`newConversationBursts`, `messageBursts`). UTC date (`YYYY-M"},{"id":"response-risk_factors-messagesimilarity-scored_value","title":"scored_value Burst factors only. The window count the `score` was actually taken from. Becaus"},{"id":"response-risk_factors-messagesimilarity-scored_at","title":"scored_at Burst factors only. UTC date (`YYYY-MM-DD`) of the window described by `scored_v"},{"id":"response-risk_factors-messagesimilarity-decay_weight","title":"decay_weight Burst factors only. Recency multiplier applied to the base band score, `0.5 ^ (a"},{"id":"response-daily_data","title":"daily_data"},{"id":"response-daily_data-outbound_conversations","title":"outbound_conversations"},{"id":"response-daily_data-outbound_conversations-0-date","title":"date UTC calendar day (YYYY-MM-DD)."},{"id":"response-daily_data-outbound_conversations-0-count","title":"count"},{"id":"response-daily_data-inbound_conversations","title":"inbound_conversations"},{"id":"response-daily_data-inbound_conversations-0-date","title":"date UTC calendar day (YYYY-MM-DD)."},{"id":"response-daily_data-inbound_conversations-0-count","title":"count"},{"id":"response-period_days","title":"period_days"},{"id":"response-window","title":"window The concrete time window the report was computed over."},{"id":"response-window-from","title":"from Window start (Unix epoch ms)."},{"id":"response-window-to","title":"to Window end (Unix epoch ms)."},{"id":"response-window-is_default","title":"is_default True when the caller supplied no window params (default 30 days)."},{"id":"response-calculated_at","title":"calculated_at"},{"id":"response-computed_with_expensive_metrics","title":"computed_with_expensive_metrics"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/account","title":"Account","href":"/reference/v4/account","group":"API Reference · v4","version":"v4","keywords":"account authenticated account, sender numbers, and contact cards. v4","text":"Authenticated account, sender numbers, and contact cards."},{"id":"v4:/reference/v4/account/getMe","title":"Get me","href":"/reference/v4/account/getMe","group":"Account · v4","method":"GET","version":"v4","keywords":"get me get the authenticated account get /me getme v4 returns the authenticated organization, linked devices/numbers, usage, and api key validity. ","text":"Get the authenticated account Returns the authenticated organization, linked devices/numbers, usage, and API key validity. /me","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/account/listNumbers","title":"List numbers","href":"/reference/v4/account/listNumbers","group":"Account · v4","method":"GET","version":"v4","keywords":"list numbers list sender numbers get /me/numbers listnumbers v4 lists the phone numbers / sender addresses available to this api key. banned and suspended numbers stay in the list. `status` is `banned`, `suspended`, or `active`; a ban takes precedence when both apply. `is_active` is false when the line is banned, suspended, or the underlying account is blocked. ","text":"List sender numbers Lists the phone numbers / sender addresses available to this API key. Banned and suspended numbers stay in the list. is , , or ; a ban takes precedence when both apply. is false when the line is banned, suspended, or the underlying account is blocked. /me/numbers","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-phone_number","title":"phone_number"},{"id":"response-data-0-is_active","title":"is_active False when the line is banned, suspended, or the underlying account is blocked."},{"id":"response-data-0-banned","title":"banned True when the phone number is banned."},{"id":"response-data-0-suspended","title":"suspended True when the phone number is suspended. A line can be both banned and suspended"},{"id":"response-data-0-status","title":"status `banned` if the number is banned, otherwise `suspended` if it is suspended, othe"},{"id":"response-data-0-last_active","title":"last_active Epoch milliseconds of the allocation's last activity."},{"id":"response-data-0-plan_kind","title":"plan_kind Plan type the underlying allocation runs on. `inbound` numbers are reply-only."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/account/requestCallForwarding","title":"Request call forwarding","href":"/reference/v4/account/requestCallForwarding","group":"Account · v4","method":"POST","version":"v4","keywords":"request call forwarding request call forwarding post /me/numbers/{number}/call-forwarding requestcallforwarding v4 opens a support request to forward calls from an owned dedicated or inbound blooio number. the destination must be a us e.164 number. shared or foreign source numbers are rejected. forward_to us e.164 number to forward calls to.","text":"forward to US E.164 number to forward calls to. Request call forwarding Opens a support request to forward calls from an owned dedicated or inbound Blooio number. The destination must be a US E.164 number. Shared or foreign source numbers are rejected. /me/numbers/{number}/call forwarding number Sender phone number in E.164 format, e.g. . US E.164 number to forward calls to.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number Sender phone number in E.164 format, e.g. `+15551234567`."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-forward_to","title":"forward_to US E.164 number to forward calls to."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/account/getContactCard","title":"Get contact card","href":"/reference/v4/account/getContactCard","group":"Account · v4","method":"GET","version":"v4","keywords":"get contact card get a number's contact card get /me/numbers/{number}/contact-card getcontactcard v4 ","text":"Get a number's contact card /me/numbers/{number}/contact card number Sender phone number in E.164 format, e.g. .","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number Sender phone number in E.164 format, e.g. `+15551234567`."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/account/updateContactCard","title":"Update contact card","href":"/reference/v4/account/updateContactCard","group":"Account · v4","method":"PUT","version":"v4","keywords":"update contact card update a number's contact card put /me/numbers/{number}/contact-card updatecontactcard v4 updates the contact card (name, avatar, sharing settings) shared from this number. at least one field is required. first_name last_name avatar base64 image or data uri (`data:image/png;base64,...`). `null` removes the photo; lines that cannot clear a photo show a plain black image instead. sharing enabled audience 0 = contacts only, 1 = always ask 0 1 name_format 0 = first & last, 1 = first only 0 1","text":"first name last name avatar Base64 image or data URI ( ). removes the photo; lines that cannot clear a photo show a plain black image instead. sharing enabled audience 0 = Contacts Only, 1 = Always Ask 0 1 name format 0 = First & Last, 1 = First Only 0 1 Update a number's contact card Updates the contact card (name, avatar, sharing settings) shared from this number. At least one field is required. /me/numbers/{number}/contact card number Sender phone number in E.164 format, e.g. . Base64 image or data URI ( ). removes the photo; lines that cannot clear a photo show a plain black image instead. 0 = Contacts Only, 1 = Always Ask 0 = First & Last, 1 = First Only","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number Sender phone number in E.164 format, e.g. `+15551234567`."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-first_name","title":"first_name"},{"id":"body-last_name","title":"last_name"},{"id":"body-avatar","title":"avatar Base64 image or data URI (`data:image/png;base64,...`). `null` removes the photo"},{"id":"body-sharing","title":"sharing"},{"id":"body-sharing-enabled","title":"enabled"},{"id":"body-sharing-audience","title":"audience 0 = Contacts Only, 1 = Always Ask"},{"id":"body-sharing-name_format","title":"name_format 0 = First & Last, 1 = First Only"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/account/uploadContactCardAvatar","title":"Upload contact card avatar","href":"/reference/v4/account/uploadContactCardAvatar","group":"Account · v4","method":"POST","version":"v4","keywords":"upload contact card avatar upload a contact card avatar post /me/numbers/{number}/contact-card/avatar uploadcontactcardavatar v4 uploads an avatar image for the number's contact card. max 10mb. avatar first_name optional. sent to the device with the photo so the write is not photo-only. recommended: without it the device keeps whatever name it currently has. last_name optional. see first_name.","text":"avatar first name Optional. Sent to the device with the photo so the write is not photo only. Recommended: without it the device keeps whatever name it currently has. last name Optional. See first name. Upload a contact card avatar Uploads an avatar image for the number's contact card. Max 10MB. /me/numbers/{number}/contact card/avatar number Sender phone number in E.164 format, e.g. . Optional. Sent to the device with the photo so the write is not photo only. Recommended: without it the device keeps whatever name it currently has. Optional. See first name.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-number","title":"number Sender phone number in E.164 format, e.g. `+15551234567`."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-avatar","title":"avatar"},{"id":"body-first_name","title":"first_name Optional. Sent to the device with the photo so the write is not photo-only. Reco"},{"id":"body-last_name","title":"last_name Optional. See first_name."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/account/getMyDefaultPriority","title":"Get my default priority","href":"/reference/v4/account/getMyDefaultPriority","group":"Account · v4","method":"GET","version":"v4","keywords":"get my default priority get the key's default priority get /me/priority getmydefaultpriority v4 returns the calling api key's default channel priority, or `{ \"data\": null }` when none is configured (in which case the agnostic send falls back to the implicit blooio pool of the key's own numbers). ","text":"Get the key's default priority Returns the calling API key's default channel priority, or when none is configured (in which case the agnostic send falls back to the implicit Blooio pool of the key's own numbers). /me/priority","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Priority id (priority_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-is_default","title":"is_default Whether this is the key's default priority (used by the agnostic send)."},{"id":"response-data-channels","title":"channels"},{"id":"response-data-channels-0-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-channels-0-type","title":"type"},{"id":"response-data-channels-0-address","title":"address The channel's real-world address (phone number for numbered channels)."},{"id":"response-data-channels-0-alias","title":"alias Organization-wide alias, when the channel has one (Apple Messages for Business /"},{"id":"response-data-channels-0-priority","title":"priority Tier (drag order). Lower runs first; same priority + same type = a pool."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-updated_at","title":"updated_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/location","title":"Location","href":"/reference/v4/location","group":"API Reference · v4","version":"v4","keywords":"location find my friend locations (device passthrough). v4","text":"Find My friend locations (device passthrough)."},{"id":"v4:/reference/v4/location/listLocationContacts","title":"List location contacts","href":"/reference/v4/location/listLocationContacts","group":"Location · v4","method":"GET","version":"v4","keywords":"list location contacts list find my contacts get /location/contacts listlocationcontacts v4 lists find my friends sharing their location with the linked apple account. ","text":"List Find My contacts Lists Find My friends sharing their location with the linked Apple account. /location/contacts","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/location/refreshLocationContactsGet","title":"Refresh location contacts get","href":"/reference/v4/location/refreshLocationContactsGet","group":"Location · v4","method":"GET","version":"v4","keywords":"refresh location contacts get refresh find my locations (get) get /location/contacts/refresh refreshlocationcontactsget v4 convenience get form of the refresh endpoint. forces a refresh of find my location data from the device. ","text":"Refresh Find My locations (GET) Convenience GET form of the refresh endpoint. Forces a refresh of Find My location data from the device. /location/contacts/refresh","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/location/refreshLocationContacts","title":"Refresh location contacts","href":"/reference/v4/location/refreshLocationContacts","group":"Location · v4","method":"POST","version":"v4","keywords":"refresh location contacts refresh find my locations post /location/contacts/refresh refreshlocationcontacts v4 forces a refresh of find my location data from the device. ","text":"Refresh Find My locations Forces a refresh of Find My location data from the device. /location/contacts/refresh","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/location/getLocationContact","title":"Get location contact","href":"/reference/v4/location/getLocationContact","group":"Location · v4","method":"GET","version":"v4","keywords":"get location contact get one find my contact get /location/contacts/{handle} getlocationcontact v4 ","text":"Get one Find My contact /location/contacts/{handle} handle Contact handle to resolve — a phone number in E.164 format, an email address, or an Apple ID. URL encode the value.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-handle","title":"handle Contact handle to resolve — a phone number in E.164 format, an email address, or"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/channels","title":"Channels","href":"/reference/v4/channels","group":"API Reference · v4","version":"v4","keywords":"channels sending surfaces (imessage/blooio, twilio, whatsapp, rcs, apple messages for business) and their capabilities. v4","text":"Sending surfaces (iMessage/Blooio, Twilio, WhatsApp, RCS, Apple Messages for Business) and their capabilities."},{"id":"v4:/reference/v4/channels/listChannels","title":"List channels","href":"/reference/v4/channels/listChannels","group":"Channels · v4","method":"GET","version":"v4","keywords":"list channels list channels get /channels listchannels v4 lists messaging channels for the organization. ordinary sends do not require a channel id; use this endpoint to inspect capabilities or obtain an exact channel id for advanced integrations. ","text":"List channels Lists messaging channels for the organization. Ordinary sends do not require a channel id; use this endpoint to inspect capabilities or obtain an exact channel id for advanced integrations. /channels type Filter by channel type. status Filter by channel status. limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-type","title":"type Filter by channel type."},{"id":"query-status","title":"status Filter by channel status."},{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Channel id (ch_...)."},{"id":"response-data-0-type","title":"type"},{"id":"response-data-0-address","title":"address The channel's real address: the phone number for numbered channels, or the provi"},{"id":"response-data-0-alias","title":"alias Movable, organization-wide name for a non-numbered channel (currently Apple Mess"},{"id":"response-data-0-status","title":"status"},{"id":"response-data-0-capabilities","title":"capabilities What a channel can do. Shape varies by channel type."},{"id":"response-data-0-capabilities-protocols","title":"protocols"},{"id":"response-data-0-capabilities-content","title":"content"},{"id":"response-data-0-capabilities-actions","title":"actions"},{"id":"response-data-0-capabilities-interactive","title":"interactive"},{"id":"response-data-0-capabilities-gates","title":"gates"},{"id":"response-data-0-profile","title":"profile Stored channel profile. Omitted on GET when no fields are set. Null or empty str"},{"id":"response-data-0-profile-display_name","title":"display_name"},{"id":"response-data-0-profile-about","title":"about"},{"id":"response-data-0-profile-email","title":"email"},{"id":"response-data-0-profile-avatar","title":"avatar"},{"id":"response-data-0-settings","title":"settings Inline per-channel settings for channel types that support them (currently Blooi"},{"id":"response-data-0-created_at","title":"created_at Epoch milliseconds."},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/listAvailableBlooioNumbers","title":"List available blooio numbers","href":"/reference/v4/channels/listAvailableBlooioNumbers","group":"Channels · v4","method":"GET","version":"v4","keywords":"list available blooio numbers list available blooio numbers get /channels/blooio/available listavailableblooionumbers v4 browse blooio number inventory available to purchase. `type=shared` returns available shared lines; `type=dedicated` returns unassigned dedicated inventory. when one or more `area_code` values are supplied with `type=dedicated` or `type=inbound`, the response is an area-code quote: each requested code is reported as either in stock (provisioned free) or requiring a custom order (a custom area-code fee applies and a provisioning ticket is opened at purchase). requires the number purchase api feature to be enabled for the organization, and the `numbers:read` scope for oauth apps. ","text":"List available Blooio numbers Browse Blooio number inventory available to purchase. returns available shared lines; returns unassigned dedicated inventory. When one or more values are supplied with or , the response is an area code quote: each requested code is reported as either in stock (provisioned free) or requiring a custom order (a custom area code fee applies and a provisioning ticket is opened at purchase). Requires the number purchase API feature to be enabled for the organization, and the scope for OAuth apps. /channels/blooio/available type Plan family to browse. area code A desired 3 digit US area code. Repeat the parameter (or pass a comma separated ) to quote several. Only meaningful for / . country Filter inventory by ISO country code (e.g. ). limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-type","title":"type Plan family to browse."},{"id":"query-area_code","title":"area_code A desired 3-digit US area code. Repeat the parameter (or pass a comma-separated"},{"id":"query-country","title":"country Filter inventory by ISO country code (e.g. `US`)."},{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data Inventory rows (browse mode) or quote lines (when `area_code` is supplied)."},{"id":"response-data-0-masked_national","title":"masked_national National format with only the area code revealed, e.g. `(801) ***-****`."},{"id":"response-data-0-area_code","title":"area_code"},{"id":"response-data-0-country_code","title":"country_code E.164 country calling code, e.g. `1`."},{"id":"response-data-0-phone_number_country","title":"phone_number_country ISO country code, e.g. `US`."},{"id":"response-data-0-location","title":"location Geocoded `City, ST` label for NANPA numbers, when resolvable. Omitted otherwise."},{"id":"response-data-0-matched","title":"matched `true` when the code is in stock (provisioned free)."},{"id":"response-data-0-custom_order","title":"custom_order Present and `true` when the code needs a custom order (custom area-code fee appl"},{"id":"response-data-0-auto_assigned","title":"auto_assigned Present when no specific code was requested for this line and one is auto-assign"},{"id":"response-data-0-zip_code","title":"zip_code"},{"id":"response-matched_count","title":"matched_count Quote mode only: requested area codes found in stock."},{"id":"response-custom_order_count","title":"custom_order_count Quote mode only: requested area codes needing a custom (ticketed, billed) order."},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/purchaseBlooioNumbers","title":"Purchase blooio numbers","href":"/reference/v4/channels/purchaseBlooioNumbers","group":"Channels · v4","method":"POST","version":"v4","keywords":"$3e","text":"$3f","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"header-idempotency-key","title":"Idempotency-Key Unique key that makes the billable purchase safe to retry."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-plan","title":"plan Plan id to purchase (determines shared / dedicated / inbound). Use the specific"},{"id":"body-quantity","title":"quantity Number of new lines (dedicated/inbound). Shared is always 1."},{"id":"body-area_codes","title":"area_codes Preferred 3-digit US area codes (dedicated/inbound). Out-of-stock codes incur a"},{"id":"body-zip_codes","title":"zip_codes Preferred ZIP codes (dedicated/inbound), used when an area code is not specified"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-purchase_id","title":"purchase_id"},{"id":"response-data-status","title":"status"},{"id":"response-data-action_url","title":"action_url Present when `status` is `action_required`: complete card authentication here."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/getBlooioPurchase","title":"Get blooio purchase","href":"/reference/v4/channels/getBlooioPurchase","group":"Channels · v4","method":"GET","version":"v4","keywords":"get blooio purchase get purchase status get /channels/blooio/purchases/{purchaseid} getblooiopurchase v4 poll the status of an asynchronous number purchase by its `purchase_id`. returns `pending`/`provisioning`, `completed` (with the provisioned allocations), or `failed`. requires the `numbers:read` scope for oauth apps. ","text":"Get purchase status Poll the status of an asynchronous number purchase by its . Returns / , (with the provisioned allocations), or . Requires the scope for OAuth apps. /channels/blooio/purchases/{purchaseId} purchaseId","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-purchaseid","title":"purchaseId"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-purchase_id","title":"purchase_id"},{"id":"response-data-status","title":"status"},{"id":"response-data-allocations","title":"allocations"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/getChannel","title":"Get channel","href":"/reference/v4/channels/getChannel","group":"Channels · v4","method":"GET","version":"v4","keywords":"get channel get a channel get /channels/{channel} getchannel v4 ","text":"Get a channel /channels/{channel} channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ).","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Channel id (ch_...)."},{"id":"response-data-type","title":"type"},{"id":"response-data-address","title":"address The channel's real address: the phone number for numbered channels, or the provi"},{"id":"response-data-alias","title":"alias Movable, organization-wide name for a non-numbered channel (currently Apple Mess"},{"id":"response-data-status","title":"status"},{"id":"response-data-capabilities","title":"capabilities What a channel can do. Shape varies by channel type."},{"id":"response-data-capabilities-protocols","title":"protocols"},{"id":"response-data-capabilities-content","title":"content"},{"id":"response-data-capabilities-actions","title":"actions"},{"id":"response-data-capabilities-interactive","title":"interactive"},{"id":"response-data-capabilities-gates","title":"gates"},{"id":"response-data-profile","title":"profile Stored channel profile. Omitted on GET when no fields are set. Null or empty str"},{"id":"response-data-profile-display_name","title":"display_name"},{"id":"response-data-profile-about","title":"about"},{"id":"response-data-profile-email","title":"email"},{"id":"response-data-profile-avatar","title":"avatar"},{"id":"response-data-settings","title":"settings Inline per-channel settings for channel types that support them (currently Blooi"},{"id":"response-data-created_at","title":"created_at Epoch milliseconds."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/removeBlooioNumber","title":"Remove blooio number","href":"/reference/v4/channels/removeBlooioNumber","group":"Channels · v4","method":"DELETE","version":"v4","keywords":"remove blooio number remove (unsubscribe) a blooio number delete /channels/{channel} removeblooionumber v4 removes/unsubscribes an owned blooio line, cancelling its subscription — the same flow as the dashboard unsubscribe button. accepts either the e.164 number or the `ch_` channel id as `{channel}`. a `reasons` array (why the customer is unsubscribing) is required; the same reason handling updates the crm, posts to slack, and emits a `number.removed` webhook. requires the `numbers:manage` scope for oauth apps. reasons one or more churn reason codes/labels for the removal.","text":"reasons One or more churn reason codes/labels for the removal. Remove (unsubscribe) a Blooio number Removes/unsubscribes an owned Blooio line, cancelling its subscription — the same flow as the dashboard unsubscribe button. Accepts either the E.164 number or the channel id as . A array (why the customer is unsubscribing) is required; the same reason handling updates the CRM, posts to Slack, and emits a webhook. Requires the scope for OAuth apps. /channels/{channel} channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ). One or more churn reason codes/labels for the removal.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-reasons","title":"reasons One or more churn reason codes/labels for the removal."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-phone_number","title":"phone_number"},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-reasons","title":"reasons"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/getChannelCapabilities","title":"Get channel capabilities","href":"/reference/v4/channels/getChannelCapabilities","group":"Channels · v4","method":"GET","version":"v4","keywords":"get channel capabilities get channel capabilities get /channels/{channel}/capabilities getchannelcapabilities v4 returns supported protocols, content types, actions, and interactive features for a channel. ","text":"Get channel capabilities Returns supported protocols, content types, actions, and interactive features for a channel. /channels/{channel}/capabilities channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ).","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-type","title":"type"},{"id":"response-data-capabilities","title":"capabilities What a channel can do. Shape varies by channel type."},{"id":"response-data-capabilities-protocols","title":"protocols"},{"id":"response-data-capabilities-content","title":"content"},{"id":"response-data-capabilities-actions","title":"actions"},{"id":"response-data-capabilities-interactive","title":"interactive"},{"id":"response-data-capabilities-gates","title":"gates"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/getChannelHealth","title":"Get channel health","href":"/reference/v4/channels/getChannelHealth","group":"Channels · v4","method":"GET","version":"v4","keywords":"$40","text":"$41","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-days","title":"days Trailing window in days, 1 to 30. Anything else returns `400 invalid_window`."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data One Blooio line's live safety state plus its metrics over the trailing window. R"},{"id":"response-data-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-address","title":"address The line's phone number (E.164)."},{"id":"response-data-window","title":"window The window the metrics cover."},{"id":"response-data-window-start","title":"start Epoch milliseconds."},{"id":"response-data-window-end","title":"end Epoch milliseconds. Equals `computed_at`."},{"id":"response-data-window-days","title":"days"},{"id":"response-data-computed_at","title":"computed_at When the metrics were computed (epoch milliseconds). At most about 5 minutes old"},{"id":"response-data-has_activity","title":"has_activity False when the line sent and received nothing in the window. `risk.score` and `r"},{"id":"response-data-safety","title":"safety Live safety state, read on every request (never cached). The same values the `sa"},{"id":"response-data-safety-tier","title":"tier Warm-up tier."},{"id":"response-data-safety-action","title":"action Current safety action on outbound sends."},{"id":"response-data-safety-reasons","title":"reasons Why the current action applies, keyed by trigger. Empty when `action` is `none`."},{"id":"response-data-safety-limits_disabled","title":"limits_disabled True when safety limits are switched off for this line."},{"id":"response-data-safety-evaluated_at","title":"evaluated_at When the safety system last evaluated the line (epoch milliseconds). Null for a"},{"id":"response-data-replies","title":"replies"},{"id":"response-data-replies-new_conversations","title":"new_conversations Conversations this line started (UTC days in the window). Group chats are exclud"},{"id":"response-data-replies-first_replies","title":"first_replies Of those, how many got a written reply."},{"id":"response-data-replies-first_reply_rate","title":"first_reply_rate `first_replies / new_conversations`. At `days=7` this equals the safety system's"},{"id":"response-data-replies-unanswered_conversations","title":"unanswered_conversations Conversations this line started in the window that used the full 3-message allow"},{"id":"response-data-replies-unanswered_rate","title":"unanswered_rate Share of the conversations this line started in the window that are unanswered a"},{"id":"response-data-delivery","title":"delivery Outbound delivery counts and rates, measured the way the safety system measures"},{"id":"response-data-delivery-resolved","title":"resolved Sends whose protocol a device resolved (excludes pending and unknown)."},{"id":"response-data-delivery-imessage","title":"imessage Resolved sends that went over iMessage."},{"id":"response-data-delivery-reached","title":"reached Sends that reached a device."},{"id":"response-data-delivery-failed","title":"failed Sends that reached a device and then failed."},{"id":"response-data-delivery-imessage_share","title":"imessage_share `imessage / resolved`. Null below 20 resolved sends, too few to act on."},{"id":"response-data-delivery-failure_rate","title":"failure_rate `failed / reached`. Null below 20 resolved sends."},{"id":"response-data-risk","title":"risk"},{"id":"response-data-risk-score","title":"score Risk score; null when `has_activity` is false."},{"id":"response-data-risk-level","title":"level `low` below 30, `medium` below 60, else `high`. Null when `has_activity` is fals"},{"id":"response-data-risk-factors","title":"factors The factors behind `score`. Keys: `outbound_conversations_per_day`, `inbound_con"},{"id":"response-data-daily","title":"daily One entry per UTC day with activity, oldest first. Quiet days are omitted."},{"id":"response-data-daily-0-date","title":"date"},{"id":"response-data-daily-0-sent","title":"sent"},{"id":"response-data-daily-0-received","title":"received"},{"id":"response-data-daily-0-new_conversations","title":"new_conversations"},{"id":"response-data-daily-0-first_replies","title":"first_replies"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/sendMessageToChannel","title":"Send message to channel","href":"/reference/v4/channels/sendMessageToChannel","group":"Channels · v4","method":"POST","version":"v4","keywords":"$42","text":"$43","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"header-idempotency-key","title":"Idempotency-Key Optional key for safe retries. Replaying the same key with an identical body ret"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-text","title":"text Plain text message. May be combined with `attachments` (sent as media with a cap"},{"id":"body-format","title":"format How to interpret `text` (and each `parts[].text`). Defaults to `plain`, which se"},{"id":"body-attachments","title":"attachments Public https media URLs. May be combined with `text`. On Blooio iMessage, two or"},{"id":"body-rich_link","title":"rich_link A tappable rich link bubble (Blooio / Apple Messages for Business)."},{"id":"body-rich_link-url","title":"url"},{"id":"body-rich_link-title","title":"title"},{"id":"body-app_clip","title":"app_clip An App Clip bubble (Blooio p2p iMessage only). Sends an App Clip launch URL that"},{"id":"body-app_clip-url","title":"url The App Clip launch URL (https). Mutually exclusive with `bundle_id`; if both ar"},{"id":"body-app_clip-bundle_id","title":"bundle_id App Clip bundle identifier (e.g. `com.example.app.Clip`), expanded to `https://a"},{"id":"body-app_clip-title","title":"title Optional preview title override."},{"id":"body-imessage_app","title":"imessage_app Bring-your-own iMessage App Extension bubble (Blooio p2p iMessage only). Blooio"},{"id":"body-imessage_app-bundle_id","title":"bundle_id Your iMessage app extension's bundle identifier (e.g. `com.acme.app.MessagesExte"},{"id":"body-imessage_app-team_id","title":"team_id Your Apple Developer Team ID. Combined with `bundle_id` to form the balloon plug"},{"id":"body-imessage_app-url","title":"url The app-state URL your extension reads on tap (its `MSMessage.url`). Carries the"},{"id":"body-imessage_app-app_name","title":"app_name Display name shown for the app (the `an` field). Defaults to a generic label."},{"id":"body-imessage_app-caption","title":"caption Template-card caption shown to everyone (including recipients without the app)."},{"id":"body-imessage_app-subcaption","title":"subcaption Optional template-card subcaption."},{"id":"body-imessage_app-image_url","title":"image_url Optional https image used as the fallback template card thumbnail. Fetched best-"},{"id":"body-imessage_app-app_store_id","title":"app_store_id Optional App Store id (adam id) for your app. When the recipient doesn't have th"},{"id":"body-poll","title":"poll A native Blooio poll. Routed sends automatically consider only poll-capable chan"},{"id":"body-poll-title","title":"title"},{"id":"body-poll-options","title":"options"},{"id":"body-interactive","title":"interactive Interactive content. On Apple Messages for Business this renders as a native int"},{"id":"body-interactive-kind","title":"kind Which interactive experience to render."},{"id":"body-interactive-summary_text","title":"summary_text Prompt / fallback line shown where the interactive UI can't render. Used as the"},{"id":"body-interactive-text","title":"text Alias for `summary_text`."},{"id":"body-interactive-request_identifier","title":"request_identifier Optional stable id echoed back on the customer's reply. Defaults to the message"},{"id":"body-interactive-received_message","title":"received_message Bubble shown to the customer before they interact. Not allowed for `quick_reply`"},{"id":"body-interactive-received_message-title","title":"title"},{"id":"body-interactive-received_message-subtitle","title":"subtitle"},{"id":"body-interactive-received_message-style","title":"style"},{"id":"body-interactive-received_message-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-reply_message","title":"reply_message Bubble shown after the customer replies."},{"id":"body-interactive-reply_message-title","title":"title"},{"id":"body-interactive-reply_message-subtitle","title":"subtitle"},{"id":"body-interactive-reply_message-style","title":"style"},{"id":"body-interactive-reply_message-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-images","title":"images Inline PNG assets referenced by `imageIdentifier` elsewhere in the payload. Supp"},{"id":"body-interactive-images-0-identifier","title":"identifier"},{"id":"body-interactive-images-0-data","title":"data Base64-encoded PNG."},{"id":"body-interactive-images-0-url","title":"url Public https PNG URL, fetched and validated server-side."},{"id":"body-interactive-images-0-expected_size","title":"expected_size Optional exact @3x size to enforce for this asset's target style."},{"id":"body-interactive-images-0-expected_size-width","title":"width"},{"id":"body-interactive-images-0-expected_size-height","title":"height"},{"id":"body-interactive-images-0-expected_size-style","title":"style"},{"id":"body-interactive-items","title":"items Quick reply options (`kind` = quick_reply). Required: 1–5 items, each with a non"},{"id":"body-interactive-items-0-id","title":"id"},{"id":"body-interactive-items-0-title","title":"title"},{"id":"body-interactive-sections","title":"sections List picker sections (`kind` = list_picker). Required: at least one section, eac"},{"id":"body-interactive-sections-0-title","title":"title"},{"id":"body-interactive-sections-0-order","title":"order"},{"id":"body-interactive-sections-0-multipleselection","title":"multipleSelection Allow selecting more than one item in this section."},{"id":"body-interactive-sections-0-items","title":"items"},{"id":"body-interactive-sections-0-items-0-identifier","title":"identifier"},{"id":"body-interactive-sections-0-items-0-title","title":"title"},{"id":"body-interactive-sections-0-items-0-subtitle","title":"subtitle"},{"id":"body-interactive-sections-0-items-0-order","title":"order"},{"id":"body-interactive-sections-0-items-0-style","title":"style Row style. Defaults to `default` when omitted."},{"id":"body-interactive-sections-0-items-0-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-list","title":"list Alias for `sections` (`kind` = list_picker). Accepts `{ \"sections\": [...] }` (or"},{"id":"body-interactive-event","title":"event Time picker event (`kind` = time_picker). Required: at least one `timeslots` ent"},{"id":"body-interactive-event-identifier","title":"identifier"},{"id":"body-interactive-event-title","title":"title"},{"id":"body-interactive-event-location","title":"location"},{"id":"body-interactive-event-location-title","title":"title"},{"id":"body-interactive-event-timezoneoffset","title":"timezoneOffset"},{"id":"body-interactive-event-timeslots","title":"timeslots"},{"id":"body-interactive-event-timeslots-0-identifier","title":"identifier"},{"id":"body-interactive-event-timeslots-0-starttime","title":"startTime ISO-8601 start time; normalized to Apple's `+0000` format on send."},{"id":"body-interactive-event-timeslots-0-duration","title":"duration Slot duration in seconds."},{"id":"body-interactive-dynamic","title":"dynamic Apple dynamic interactive message (multi-page form) object, forwarded verbatim ("},{"id":"body-interactive-form","title":"form Alias for `dynamic` (`kind` = form)."},{"id":"body-interactive-payment","title":"payment Apple Pay payment request object, forwarded verbatim (`kind` = apple_pay). Requi"},{"id":"body-interactive-authenticate","title":"authenticate OAuth2 authentication request object, forwarded verbatim (`kind` = authenticate)"},{"id":"body-interactive-oauth2","title":"oauth2 Shorthand for `authenticate.oauth2` (`kind` = authenticate). Requires `responseT"},{"id":"body-interactive-app","title":"app Custom iMessage app metadata (`kind` = imessage_app). These App Store fallback f"},{"id":"body-interactive-app-app_id","title":"app_id"},{"id":"body-interactive-app-app_name","title":"app_name"},{"id":"body-interactive-app-app_icon","title":"app_icon"},{"id":"body-interactive-app-bid","title":"bid"},{"id":"body-interactive-app-url","title":"url"},{"id":"body-interactive-app_id","title":"app_id App Store id for the iMessage app fallback (`kind` = imessage_app). Flat alias f"},{"id":"body-interactive-app_name","title":"app_name App Store name for the iMessage app fallback (`kind` = imessage_app). Flat alias"},{"id":"body-interactive-app_icon","title":"app_icon Base64 PNG icon for the iMessage app fallback (`kind` = imessage_app). Flat alia"},{"id":"body-interactive-bid","title":"bid iMessage extension bundle id. Required for `kind` = imessage_app (or supply it u"},{"id":"body-interactive-url","title":"url Custom app URL / query string (`kind` = imessage_app)."},{"id":"body-interactive-session_identifier","title":"session_identifier"},{"id":"body-interactive-use_live_layout","title":"use_live_layout"},{"id":"body-invitation","title":"invitation Apple Messages for Business invitation. Sends an Apple-managed notification temp"},{"id":"body-invitation-template_id","title":"template_id The Apple-managed notification template id authorized for your business (e.g. `b"},{"id":"body-invitation-reference_id","title":"reference_id Your business context id for this invitation (order number, case id, etc.). Requ"},{"id":"body-invitation-parameters","title":"parameters Template parameter values required by the chosen template (e.g. `brandName`, and"},{"id":"body-invitation-locale","title":"locale BCP-47 locale for the template. Defaults to `en-us`."},{"id":"body-template","title":"template Template content (WhatsApp Business)."},{"id":"body-template-template_id","title":"template_id"},{"id":"body-parts","title":"parts Ordered text/media parts sent as one multipart message (Blooio only). When every"},{"id":"body-parts-0-text","title":"text"},{"id":"body-parts-0-url","title":"url"},{"id":"body-reply_to","title":"reply_to Message id to reply to. Applies to the whole outgoing message."},{"id":"body-effect","title":"effect iMessage screen/bubble effect (Blooio, text only)."},{"id":"body-link_preview","title":"link_preview"},{"id":"body-link_preview-imageurl","title":"imageUrl"},{"id":"body-link_preview-title","title":"title"},{"id":"body-badge","title":"badge Optional attribution badge shown under the bubble: `sent_with_siri` renders \"Sen"},{"id":"body-carousel","title":"carousel Group image/video attachments into ONE message that Messages renders as a swipea"},{"id":"body-to","title":"to A recipient: a raw identifier string (phone/email/opaque provider id), an array"},{"id":"body-to-contact_id","title":"contact_id Contact id (ct_...) — routed sends only."},{"id":"body-to-group_id","title":"group_id Existing group id (grp_...) — exact sender or a hybrid sender that owns the grou"},{"id":"body-dry_run","title":"dry_run Validate and route only; do not send."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id"},{"id":"response-chat_id","title":"chat_id"},{"id":"response-channel_id","title":"channel_id"},{"id":"response-channel_type","title":"channel_type"},{"id":"response-protocol","title":"protocol Transport state or resolved wire service; never null. `pending` = accepted and d"},{"id":"response-from","title":"from The resolved sender as a human value: the sending channel's phone number (number"},{"id":"response-direction","title":"direction"},{"id":"response-type","title":"type"},{"id":"response-status","title":"status Initial lifecycle state for the send: normally `queued` (accepted for delivery),"},{"id":"response-group_id","title":"group_id Existing group id for a group-targeted send."},{"id":"response-hybrid","title":"hybrid Hybrid routing phase and optional transition placement."},{"id":"response-error","title":"error Why the message failed; null unless it failed. On a `blooio` channel `code` is a"},{"id":"response-error-code","title":"code"},{"id":"response-error-message","title":"message A description of the failure."},{"id":"response-fallback","title":"fallback Present when a send could not be delivered on the requested channel and a differ"},{"id":"response-fallback-recommended","title":"recommended True when falling back to another channel is recommended."},{"id":"response-fallback-reason","title":"reason"},{"id":"response-to","title":"to Recipient identifier. Present only on per-recipient items inside a fan-out (FanO"},{"id":"response-dry_run","title":"dry_run"},{"id":"response-would_send","title":"would_send"},{"id":"response-preview","title":"preview"},{"id":"response-poll","title":"poll"},{"id":"response-poll-title","title":"title"},{"id":"response-poll-options","title":"options"},{"id":"response-routing","title":"routing How Blooio selected the concrete sender channel."},{"id":"response-routing-mode","title":"mode"},{"id":"response-routing-channel_type","title":"channel_type"},{"id":"response-routing-number","title":"number"},{"id":"response-routing-alias","title":"alias"},{"id":"response-routing-priority_id","title":"priority_id"},{"id":"response-routing-priority","title":"priority"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/updateChannelProfile","title":"Update channel profile","href":"/reference/v4/channels/updateChannelProfile","group":"Channels · v4","method":"PUT","version":"v4","keywords":"update channel profile update channel profile put /channels/{channel}/profile updatechannelprofile v4 partial update of the channel profile (`display_name`, `about`, `email`, `avatar`). stored under `metadata.profile` and returned on `get /channels/{channel}`. null or empty string clears a field. unknown keys are rejected. this writes blooio metadata only; it does not push a display name to the device. display_name about email avatar","text":"display name about email avatar Update channel profile Partial update of the channel profile ( , , , ). Stored under and returned on . Null or empty string clears a field. Unknown keys are rejected. This writes Blooio metadata only; it does not push a display name to the device. /channels/{channel}/profile channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ). Stored channel profile. Omitted on GET when no fields are set. Null or empty string on PUT clears a field.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-display_name","title":"display_name"},{"id":"body-about","title":"about"},{"id":"body-email","title":"email"},{"id":"body-avatar","title":"avatar"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Channel id (ch_...)."},{"id":"response-data-type","title":"type"},{"id":"response-data-address","title":"address The channel's real address: the phone number for numbered channels, or the provi"},{"id":"response-data-alias","title":"alias Movable, organization-wide name for a non-numbered channel (currently Apple Mess"},{"id":"response-data-status","title":"status"},{"id":"response-data-capabilities","title":"capabilities What a channel can do. Shape varies by channel type."},{"id":"response-data-capabilities-protocols","title":"protocols"},{"id":"response-data-capabilities-content","title":"content"},{"id":"response-data-capabilities-actions","title":"actions"},{"id":"response-data-capabilities-interactive","title":"interactive"},{"id":"response-data-capabilities-gates","title":"gates"},{"id":"response-data-profile","title":"profile Stored channel profile. Omitted on GET when no fields are set. Null or empty str"},{"id":"response-data-profile-display_name","title":"display_name"},{"id":"response-data-profile-about","title":"about"},{"id":"response-data-profile-email","title":"email"},{"id":"response-data-profile-avatar","title":"avatar"},{"id":"response-data-settings","title":"settings Inline per-channel settings for channel types that support them (currently Blooi"},{"id":"response-data-created_at","title":"created_at Epoch milliseconds."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/getChannelSettings","title":"Get channel settings","href":"/reference/v4/channels/getChannelSettings","group":"Channels · v4","method":"GET","version":"v4","keywords":"get channel settings get channel settings get /channels/{channel}/settings getchannelsettings v4 per-channel settings for channel types that support them. `settings` and `available` are per channel type; the blooio (p2p numbers) provider exposes `auto_mark_read` and `auto_share_contact`. `available[key]` says whether this channel may turn `key` on (type-gated). a channel whose type has no settings yet returns `403 settings_unsupported_for_channel_type`. ","text":"Get channel settings Per channel settings for channel types that support them. and are per channel type; the Blooio (P2P numbers) provider exposes and . says whether THIS channel may turn on (type gated). A channel whose type has no settings yet returns . /channels/{channel}/settings channel The channel reference — the same three forms accepts: a phone number (URL encode as ), a channel alias, or the exact channel id ( ).","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data Per-channel settings envelope. `settings` and `available` shapes vary by channel"},{"id":"response-data-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-type","title":"type"},{"id":"response-data-settings","title":"settings Current setting values for this channel (keys are per channel type)."},{"id":"response-data-available","title":"available Whether this channel may turn each setting on (type-gated)."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/channels/updateChannelSettings","title":"Update channel settings","href":"/reference/v4/channels/updateChannelSettings","group":"Channels · v4","method":"PATCH","version":"v4","keywords":"$44","text":"$45","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-channel","title":"channel The channel reference — the same three forms `from` accepts: a phone number (URL"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-auto_mark_read","title":"auto_mark_read Blooio: mark a chat read on the device as soon as a message arrives. Dedicated +"},{"id":"body-auto_share_contact","title":"auto_share_contact Blooio: share the number's Name & Photo card with people who message it. Dedicat"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data Per-channel settings envelope. `settings` and `available` shapes vary by channel"},{"id":"response-data-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-type","title":"type"},{"id":"response-data-settings","title":"settings Current setting values for this channel (keys are per channel type)."},{"id":"response-data-available","title":"available Whether this channel may turn each setting on (type-gated)."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/priorities","title":"Priorities","href":"/reference/v4/priorities","group":"API Reference · v4","version":"v4","keywords":"priorities channel routing / number pools: ordered sets of channels walked by priority for the agnostic send. v4","text":"Channel routing / number pools: ordered sets of channels walked by priority for the agnostic send."},{"id":"v4:/reference/v4/priorities/listPriorities","title":"List priorities","href":"/reference/v4/priorities/listPriorities","group":"Priorities · v4","method":"GET","version":"v4","keywords":"list priorities list priorities get /priorities listpriorities v4 lists channel priorities owned by the calling api key. ","text":"List priorities Lists channel priorities owned by the calling API key. /priorities limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Priority id (priority_...)."},{"id":"response-data-0-name","title":"name"},{"id":"response-data-0-is_default","title":"is_default Whether this is the key's default priority (used by the agnostic send)."},{"id":"response-data-0-channels","title":"channels"},{"id":"response-data-0-channels-0-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-0-channels-0-type","title":"type"},{"id":"response-data-0-channels-0-address","title":"address The channel's real-world address (phone number for numbered channels)."},{"id":"response-data-0-channels-0-alias","title":"alias Organization-wide alias, when the channel has one (Apple Messages for Business /"},{"id":"response-data-0-channels-0-priority","title":"priority Tier (drag order). Lower runs first; same priority + same type = a pool."},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-data-0-updated_at","title":"updated_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/priorities/createPriority","title":"Create priority","href":"/reference/v4/priorities/createPriority","group":"Priorities · v4","method":"POST","version":"v4","keywords":"create priority create a priority post /priorities createpriority v4 creates a channel priority. channels sharing a `priority` (and type) form a pool; ascending priority is the send-time waterfall. the first priority created for a key becomes its default unless `is_default: false` is set. name is_default make this the key's default priority. defaults to true for the key's first priority. channels channels in the priority. each item is a channel id string or `{ channel_id, priority }`. channels sharing a priority must be the same type. channel_id priority","text":"name is default Make this the key's default priority. Defaults to true for the key's first priority. channels Channels in the priority. Each item is a channel id string or . Channels sharing a priority must be the same type. channel id priority Create a priority Creates a channel priority. Channels sharing a (and type) form a pool; ascending priority is the send time waterfall. The first priority created for a key becomes its default unless is set. /priorities Make this the key's default priority. Defaults to true for the key's first priority. Channels in the priority. Each item is a channel id string or . Channels sharing a priority must be the same type.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name"},{"id":"body-is_default","title":"is_default Make this the key's default priority. Defaults to true for the key's first prior"},{"id":"body-channels","title":"channels Channels in the priority. Each item is a channel id string or `{ channel_id, pri"},{"id":"body-channels-0-channel_id","title":"channel_id"},{"id":"body-channels-0-priority","title":"priority"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Priority id (priority_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-is_default","title":"is_default Whether this is the key's default priority (used by the agnostic send)."},{"id":"response-data-channels","title":"channels"},{"id":"response-data-channels-0-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-channels-0-type","title":"type"},{"id":"response-data-channels-0-address","title":"address The channel's real-world address (phone number for numbered channels)."},{"id":"response-data-channels-0-alias","title":"alias Organization-wide alias, when the channel has one (Apple Messages for Business /"},{"id":"response-data-channels-0-priority","title":"priority Tier (drag order). Lower runs first; same priority + same type = a pool."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-updated_at","title":"updated_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/priorities/getPriority","title":"Get priority","href":"/reference/v4/priorities/getPriority","group":"Priorities · v4","method":"GET","version":"v4","keywords":"get priority get a priority get /priorities/{priorityid} getpriority v4 ","text":"Get a priority /priorities/{priorityId} priorityId Unique identifier of the priority, prefixed with . Returned when you create a priority or by the List priorities endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-priorityid","title":"priorityId Unique identifier of the priority, prefixed with `priority_`. Returned when you"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Priority id (priority_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-is_default","title":"is_default Whether this is the key's default priority (used by the agnostic send)."},{"id":"response-data-channels","title":"channels"},{"id":"response-data-channels-0-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-channels-0-type","title":"type"},{"id":"response-data-channels-0-address","title":"address The channel's real-world address (phone number for numbered channels)."},{"id":"response-data-channels-0-alias","title":"alias Organization-wide alias, when the channel has one (Apple Messages for Business /"},{"id":"response-data-channels-0-priority","title":"priority Tier (drag order). Lower runs first; same priority + same type = a pool."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-updated_at","title":"updated_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/priorities/updatePriority","title":"Update priority","href":"/reference/v4/priorities/updatePriority","group":"Priorities · v4","method":"PATCH","version":"v4","keywords":"update priority update a priority patch /priorities/{priorityid} updatepriority v4 updates a priority's name, default flag, and/or channel set. when `channels` is supplied it replaces the priority's channels wholesale. name is_default channels channel_id priority","text":"name is default channels channel id priority Update a priority Updates a priority's name, default flag, and/or channel set. When is supplied it replaces the priority's channels wholesale. /priorities/{priorityId} priorityId Unique identifier of the priority, prefixed with . Returned when you create a priority or by the List priorities endpoint. Any subset of fields. When is present it replaces the priority's channels wholesale.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-priorityid","title":"priorityId Unique identifier of the priority, prefixed with `priority_`. Returned when you"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name"},{"id":"body-is_default","title":"is_default"},{"id":"body-channels","title":"channels"},{"id":"body-channels-0-channel_id","title":"channel_id"},{"id":"body-channels-0-priority","title":"priority"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Priority id (priority_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-is_default","title":"is_default Whether this is the key's default priority (used by the agnostic send)."},{"id":"response-data-channels","title":"channels"},{"id":"response-data-channels-0-channel_id","title":"channel_id Channel id (ch_...)."},{"id":"response-data-channels-0-type","title":"type"},{"id":"response-data-channels-0-address","title":"address The channel's real-world address (phone number for numbered channels)."},{"id":"response-data-channels-0-alias","title":"alias Organization-wide alias, when the channel has one (Apple Messages for Business /"},{"id":"response-data-channels-0-priority","title":"priority Tier (drag order). Lower runs first; same priority + same type = a pool."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-updated_at","title":"updated_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/priorities/deletePriority","title":"Delete priority","href":"/reference/v4/priorities/deletePriority","group":"Priorities · v4","method":"DELETE","version":"v4","keywords":"delete priority delete a priority delete /priorities/{priorityid} deletepriority v4 ","text":"Delete a priority /priorities/{priorityId} priorityId Unique identifier of the priority, prefixed with . Returned when you create a priority or by the List priorities endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-priorityid","title":"priorityId Unique identifier of the priority, prefixed with `priority_`. Returned when you"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-deleted","title":"deleted"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/contacts","title":"Contacts","href":"/reference/v4/contacts","group":"API Reference · v4","version":"v4","keywords":"contacts contacts, their channel identities, capabilities, timeline, and tags. v4","text":"Contacts, their channel identities, capabilities, timeline, and tags."},{"id":"v4:/reference/v4/contacts/listContacts","title":"List contacts","href":"/reference/v4/contacts/listContacts","group":"Contacts · v4","method":"GET","version":"v4","keywords":"list contacts list contacts get /contacts listcontacts v4 lists contacts. cursor pagination is the default. supplying `offset`, `q`, `tag`, `sort`, or `filter` switches to offset pagination and includes `pagination.total`. ","text":"List contacts Lists contacts. Cursor pagination is the default. Supplying , , , , or switches to offset pagination and includes . /contacts identifier Filter to the contact owning this phone/email. q Case insensitive search across contact names, identities, and tags. tag Case insensitive tag filter. sort filter offset Zero based offset. Cannot be combined with cursor. limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-identifier","title":"identifier Filter to the contact owning this phone/email."},{"id":"query-q","title":"q Case-insensitive search across contact names, identities, and tags."},{"id":"query-tag","title":"tag Case-insensitive tag filter."},{"id":"query-sort","title":"sort"},{"id":"query-filter","title":"filter"},{"id":"query-offset","title":"offset Zero-based offset. Cannot be combined with cursor."},{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Contact id (ct_...)."},{"id":"response-data-0-name","title":"name"},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-data-0-tags","title":"tags"},{"id":"response-data-0-last_message_time","title":"last_message_time"},{"id":"response-data-0-last_direction","title":"last_direction"},{"id":"response-data-0-last_text","title":"last_text"},{"id":"response-data-0-last_status","title":"last_status"},{"id":"response-data-0-identities","title":"identities"},{"id":"response-data-0-identities-0-id","title":"id"},{"id":"response-data-0-identities-0-channel_type","title":"channel_type"},{"id":"response-data-0-identities-0-identifier","title":"identifier"},{"id":"response-data-0-identities-0-channel_id","title":"channel_id"},{"id":"response-data-0-identities-0-created_at","title":"created_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},{"id":"response-pagination","title":"pagination"},{"id":"response-pagination-limit","title":"limit"},{"id":"response-pagination-offset","title":"offset"},{"id":"response-pagination-total","title":"total"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/createContact","title":"Create contact","href":"/reference/v4/contacts/createContact","group":"Contacts · v4","method":"POST","version":"v4","keywords":"create contact create a contact post /contacts createcontact v4 creates a contact, optionally with one identity (phone/email on a channel type). name identifier phone (e.164) or email to attach as the first identity. channel_type blooio twilio whatsapp whatsapp_business rcs_business amb channel_id required when channel_type is amb.","text":"name identifier Phone (E.164) or email to attach as the first identity. channel type blooio twilio whatsapp whatsapp business rcs business amb channel id Required when channel type is amb. Create a contact Creates a contact, optionally with one identity (phone/email on a channel type). /contacts Phone (E.164) or email to attach as the first identity. Required when channel type is amb.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name"},{"id":"body-identifier","title":"identifier Phone (E.164) or email to attach as the first identity."},{"id":"body-channel_type","title":"channel_type"},{"id":"body-channel_id","title":"channel_id Required when channel_type is amb."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Contact id (ct_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-tags","title":"tags"},{"id":"response-data-last_message_time","title":"last_message_time"},{"id":"response-data-last_direction","title":"last_direction"},{"id":"response-data-last_text","title":"last_text"},{"id":"response-data-last_status","title":"last_status"},{"id":"response-data-identities","title":"identities"},{"id":"response-data-identities-0-id","title":"id"},{"id":"response-data-identities-0-channel_type","title":"channel_type"},{"id":"response-data-identities-0-identifier","title":"identifier"},{"id":"response-data-identities-0-channel_id","title":"channel_id"},{"id":"response-data-identities-0-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/getContact","title":"Get contact","href":"/reference/v4/contacts/getContact","group":"Contacts · v4","method":"GET","version":"v4","keywords":"get contact get a contact get /contacts/{contactid} getcontact v4 ","text":"Get a contact /contacts/{contactId} contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Contact id (ct_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-tags","title":"tags"},{"id":"response-data-last_message_time","title":"last_message_time"},{"id":"response-data-last_direction","title":"last_direction"},{"id":"response-data-last_text","title":"last_text"},{"id":"response-data-last_status","title":"last_status"},{"id":"response-data-identities","title":"identities"},{"id":"response-data-identities-0-id","title":"id"},{"id":"response-data-identities-0-channel_type","title":"channel_type"},{"id":"response-data-identities-0-identifier","title":"identifier"},{"id":"response-data-identities-0-channel_id","title":"channel_id"},{"id":"response-data-identities-0-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/updateContact","title":"Update contact","href":"/reference/v4/contacts/updateContact","group":"Contacts · v4","method":"PATCH","version":"v4","keywords":"update contact update a contact patch /contacts/{contactid} updatecontact v4 name","text":"name Update a contact /contacts/{contactId} contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Contact id (ct_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-tags","title":"tags"},{"id":"response-data-last_message_time","title":"last_message_time"},{"id":"response-data-last_direction","title":"last_direction"},{"id":"response-data-last_text","title":"last_text"},{"id":"response-data-last_status","title":"last_status"},{"id":"response-data-identities","title":"identities"},{"id":"response-data-identities-0-id","title":"id"},{"id":"response-data-identities-0-channel_type","title":"channel_type"},{"id":"response-data-identities-0-identifier","title":"identifier"},{"id":"response-data-identities-0-channel_id","title":"channel_id"},{"id":"response-data-identities-0-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/deleteContact","title":"Delete contact","href":"/reference/v4/contacts/deleteContact","group":"Contacts · v4","method":"DELETE","version":"v4","keywords":"delete contact delete a contact delete /contacts/{contactid} deletecontact v4 soft-deletes a contact and its identities. ","text":"Delete a contact Soft deletes a contact and its identities. /contacts/{contactId} contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-deleted","title":"deleted"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/getContactCapabilities","title":"Get contact capabilities","href":"/reference/v4/contacts/getContactCapabilities","group":"Contacts · v4","method":"GET","version":"v4","keywords":"get contact capabilities get contact capabilities get /contacts/{contactid}/capabilities getcontactcapabilities v4 returns per-identity reachability/capabilities (imessage/sms/rcs, etc.) for a contact. for imessage (blooio) identities this is a live per-number lookup performed by an active imessage channel — the request is rejected with 409 if the api key has no active imessage (blooio) channel provisioned. ","text":"Get contact capabilities Returns per identity reachability/capabilities (iMessage/SMS/RCS, etc.) for a contact. For iMessage (blooio) identities this is a LIVE per number lookup performed by an active iMessage channel — the request is rejected with 409 if the API key has no active iMessage (blooio) channel provisioned. /contacts/{contactId}/capabilities contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-identifier","title":"identifier"},{"id":"response-data-0-channel_id","title":"channel_id"},{"id":"response-data-0-capabilities","title":"capabilities"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/listContactIdentities","title":"List contact identities","href":"/reference/v4/contacts/listContactIdentities","group":"Contacts · v4","method":"GET","version":"v4","keywords":"list contact identities list contact identities get /contacts/{contactid}/identities listcontactidentities v4 ","text":"List contact identities /contacts/{contactId}/identities contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Identity id (cid_...)."},{"id":"response-data-0-contact_id","title":"contact_id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-identifier","title":"identifier Phone (E.164) or email."},{"id":"response-data-0-channel_id","title":"channel_id Required for Apple Messages for Business identities."},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/attachContactIdentity","title":"Attach contact identity","href":"/reference/v4/contacts/attachContactIdentity","group":"Contacts · v4","method":"POST","version":"v4","keywords":"attach contact identity attach an identity post /contacts/{contactid}/identities attachcontactidentity v4 attaches a phone/email identity (on a channel type) to a contact. identifier channel_type blooio twilio whatsapp whatsapp_business rcs_business amb channel_id required when channel_type is amb.","text":"identifier channel type blooio twilio whatsapp whatsapp business rcs business amb channel id Required when channel type is amb. Attach an identity Attaches a phone/email identity (on a channel type) to a contact. /contacts/{contactId}/identities contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint. Required when channel type is amb.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-identifier","title":"identifier"},{"id":"body-channel_type","title":"channel_type"},{"id":"body-channel_id","title":"channel_id Required when channel_type is amb."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Identity id (cid_...)."},{"id":"response-data-contact_id","title":"contact_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-identifier","title":"identifier Phone (E.164) or email."},{"id":"response-data-channel_id","title":"channel_id Required for Apple Messages for Business identities."},{"id":"response-data-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/updateContactIdentity","title":"Update contact identity","href":"/reference/v4/contacts/updateContactIdentity","group":"Contacts · v4","method":"PATCH","version":"v4","keywords":"update contact identity update an identity patch /contacts/{contactid}/identities/{identityid} updatecontactidentity v4 renames a contact identity in place. an optional name updates the parent contact in the same request. identifier name","text":"identifier name Update an identity Renames a contact identity in place. An optional name updates the parent contact in the same request. /contacts/{contactId}/identities/{identityId} contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint. identityId Unique identifier of the contact identity, prefixed with .","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},{"id":"path-identityid","title":"identityId Unique identifier of the contact identity, prefixed with `cid_`."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-identifier","title":"identifier"},{"id":"body-name","title":"name"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Identity id (cid_...)."},{"id":"response-data-contact_id","title":"contact_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-identifier","title":"identifier Phone (E.164) or email."},{"id":"response-data-channel_id","title":"channel_id Required for Apple Messages for Business identities."},{"id":"response-data-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/detachContactIdentity","title":"Detach contact identity","href":"/reference/v4/contacts/detachContactIdentity","group":"Contacts · v4","method":"DELETE","version":"v4","keywords":"detach contact identity detach an identity delete /contacts/{contactid}/identities/{identityid} detachcontactidentity v4 ","text":"Detach an identity /contacts/{contactId}/identities/{identityId} contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint. identityId Unique identifier of the contact identity (a phone/email tied to the contact), prefixed with . Returned by the List contact identities endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},{"id":"path-identityid","title":"identityId Unique identifier of the contact identity (a phone/email tied to the contact), p"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-detached","title":"detached"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/mergeContact","title":"Merge contact","href":"/reference/v4/contacts/mergeContact","group":"Contacts · v4","method":"POST","version":"v4","keywords":"merge contact merge a contact post /contacts/{contactid}/merge mergecontact v4 collapses two auto-created contacts for the same person into one. the survivor is the `{contactid}` in the path; the `source_contact_id` in the body is absorbed into it. every identity on the source is re-parented onto the survivor, tags are unioned, the survivor keeps its own name (falling back to the source's), and the source becomes a deprecated tombstone stamped with `merged_into`. because chats and messages reference identities (not contacts), all conversations and timeline entries follow the moved identities automatically — nothing is rewritten or lost, and reads such as the survivor's timeline immediately reflect the merge. idempotent: re-merging the same source into the same survivor returns 200; a source already merged into a different contact returns 409. emits a `contact.merged` webhook event. source_contact_id the contact to merge into the survivor, prefixed with `ct_`. must differ from the path contact.","text":"$46","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-source_contact_id","title":"source_contact_id The contact to merge into the survivor, prefixed with `ct_`. Must differ from th"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Contact id (ct_...)."},{"id":"response-data-name","title":"name"},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-tags","title":"tags"},{"id":"response-data-last_message_time","title":"last_message_time"},{"id":"response-data-last_direction","title":"last_direction"},{"id":"response-data-last_text","title":"last_text"},{"id":"response-data-last_status","title":"last_status"},{"id":"response-data-identities","title":"identities"},{"id":"response-data-identities-0-id","title":"id"},{"id":"response-data-identities-0-channel_type","title":"channel_type"},{"id":"response-data-identities-0-identifier","title":"identifier"},{"id":"response-data-identities-0-channel_id","title":"channel_id"},{"id":"response-data-identities-0-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/listContactTags","title":"List contact tags","href":"/reference/v4/contacts/listContactTags","group":"Contacts · v4","method":"GET","version":"v4","keywords":"list contact tags list contact tags get /contacts/{contactid}/tags listcontacttags v4 ","text":"List contact tags /contacts/{contactId}/tags contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/addContactTags","title":"Add contact tags","href":"/reference/v4/contacts/addContactTags","group":"Contacts · v4","method":"POST","version":"v4","keywords":"add contact tags add contact tags post /contacts/{contactid}/tags addcontacttags v4 tags tag","text":"tags tag Add contact tags /contacts/{contactId}/tags contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-tags","title":"tags"},{"id":"body-tag","title":"tag"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/removeContactTag","title":"Remove contact tag","href":"/reference/v4/contacts/removeContactTag","group":"Contacts · v4","method":"DELETE","version":"v4","keywords":"remove contact tag remove a contact tag delete /contacts/{contactid}/tags/{tag} removecontacttag v4 ","text":"Remove a contact tag /contacts/{contactId}/tags/{tag} contactId Unique identifier of the contact, prefixed with . Returned when you create a contact or by the List contacts endpoint. tag The tag to remove from the contact. URL encode values that contain spaces or special characters.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},{"id":"path-tag","title":"tag The tag to remove from the contact. URL-encode values that contain spaces or spe"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/contacts/getContactTimeline","title":"Get contact timeline","href":"/reference/v4/contacts/getContactTimeline","group":"Contacts · v4","method":"GET","version":"v4","keywords":"get contact timeline get contact timeline get /contacts/{contactid}/timeline getcontacttimeline v4 a single, chronological cross-channel activity feed for a contact, unifying every conversation the contact takes part in — both 1:1 chats keyed on the contact's identities and group chats where the contact is a current member — across all channel types. after a merge, the survivor's timeline includes the absorbed contact's history automatically. each entry is a polymorphic envelope tagged by `type`; ordered newest-first by `occurred_at`. by default only `message` entries are returned; pass `include_events=true` to interleave lifecycle and chat events. ","text":"$47","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-contactid","title":"contactId Unique identifier of the contact, prefixed with `ct_`. Returned when you create"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},{"id":"query-include_events","title":"include_events When true, interleaves non-message activity (delivery/read receipts, reactions,"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-type","title":"type `message`: a message the contact sent or received. `message_event`: a lifecycle"},{"id":"response-data-0-occurred_at","title":"occurred_at Epoch-millisecond timestamp the entry occurred at; the feed is ordered by this d"},{"id":"response-data-0-id","title":"id The underlying object id — a `msg_` message id for `message` entries, an `evt_`"},{"id":"response-data-0-chat_id","title":"chat_id"},{"id":"response-data-0-channel_id","title":"channel_id"},{"id":"response-data-0-channel_type","title":"channel_type The channel type this entry occurred on. Always set for `message` entries; may b"},{"id":"response-data-0-object","title":"object The full entry payload. For `message` entries: id, chat_id, channel_id, channel_"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/chats","title":"Chats","href":"/reference/v4/chats","group":"API Reference · v4","version":"v4","keywords":"chats conversations and chat-level actions (typing, read, contact card, background). v4","text":"Conversations and chat level actions (typing, read, contact card, background)."},{"id":"v4:/reference/v4/chats/listChats","title":"List chats","href":"/reference/v4/chats/listChats","group":"Chats · v4","method":"GET","version":"v4","keywords":"list chats list chats get /chats listchats v4 lists conversations, most recent first. filter by channel type, state, channel, or contact. ","text":"List chats Lists conversations, most recent first. Filter by channel type, state, channel, or contact. /chats type state channel id contact id limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-type","title":"type"},{"id":"query-state","title":"state"},{"id":"query-channel_id","title":"channel_id"},{"id":"query-contact_id","title":"contact_id"},{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Chat id (chat_...)."},{"id":"response-data-0-channel_id","title":"channel_id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-contact_id","title":"contact_id"},{"id":"response-data-0-identity_id","title":"identity_id"},{"id":"response-data-0-group_id","title":"group_id"},{"id":"response-data-0-contact","title":"contact The person on the other side of a 1:1 chat. `null` in a group chat; see `group`."},{"id":"response-data-0-contact-contact_id","title":"contact_id The contact (ct_...). `null` when no contact record matches the identifier."},{"id":"response-data-0-contact-identifier","title":"identifier The contact's identifier (phone number, email, or handle)."},{"id":"response-data-0-contact-name","title":"name The contact's name. `null` when none is on file. On a webhook it is a snapshot f"},{"id":"response-data-0-group","title":"group The group, when this is a group chat. `null` in a 1:1 chat."},{"id":"response-data-0-group-group_id","title":"group_id Group id (grp_...)."},{"id":"response-data-0-group-name","title":"name The group's name. `null` when it has none."},{"id":"response-data-0-state","title":"state"},{"id":"response-data-0-capabilities","title":"capabilities"},{"id":"response-data-0-window_expires_at","title":"window_expires_at"},{"id":"response-data-0-last_message_at","title":"last_message_at"},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/createChat","title":"Create chat","href":"/reference/v4/chats/createChat","group":"Chats · v4","method":"POST","version":"v4","keywords":"create chat find or create a chat post /chats createchat v4 finds or creates a 1:1 chat with a recipient on a channel. returns the chat (with `created` indicating whether it was newly created). channel_id to recipient identifier (phone/email/opaque provider id).","text":"channel id to Recipient identifier (phone/email/opaque provider id). Find or create a chat Finds or creates a 1:1 chat with a recipient on a channel. Returns the chat (with indicating whether it was newly created). /chats Recipient identifier (phone/email/opaque provider id).","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-channel_id","title":"channel_id"},{"id":"body-to","title":"to Recipient identifier (phone/email/opaque provider id)."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id"},{"id":"response-channel_id","title":"channel_id"},{"id":"response-channel_type","title":"channel_type"},{"id":"response-contact_id","title":"contact_id"},{"id":"response-identity_id","title":"identity_id"},{"id":"response-state","title":"state"},{"id":"response-created","title":"created True if the chat was newly created."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/getChat","title":"Get chat","href":"/reference/v4/chats/getChat","group":"Chats · v4","method":"GET","version":"v4","keywords":"get chat get a chat get /chats/{chatid} getchat v4 the chat of a group that was merged into another group on its first send returns the surviving group's chat on the same number. ","text":"Get a chat The chat of a group that was merged into another group on its first send returns the surviving group's chat on the same number. /chats/{chatId} chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Chat id (chat_...)."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-contact_id","title":"contact_id"},{"id":"response-data-identity_id","title":"identity_id"},{"id":"response-data-group_id","title":"group_id"},{"id":"response-data-contact","title":"contact The person on the other side of a 1:1 chat. `null` in a group chat; see `group`."},{"id":"response-data-contact-contact_id","title":"contact_id The contact (ct_...). `null` when no contact record matches the identifier."},{"id":"response-data-contact-identifier","title":"identifier The contact's identifier (phone number, email, or handle)."},{"id":"response-data-contact-name","title":"name The contact's name. `null` when none is on file. On a webhook it is a snapshot f"},{"id":"response-data-group","title":"group The group, when this is a group chat. `null` in a 1:1 chat."},{"id":"response-data-group-group_id","title":"group_id Group id (grp_...)."},{"id":"response-data-group-name","title":"name The group's name. `null` when it has none."},{"id":"response-data-state","title":"state"},{"id":"response-data-capabilities","title":"capabilities"},{"id":"response-data-window_expires_at","title":"window_expires_at"},{"id":"response-data-last_message_at","title":"last_message_at"},{"id":"response-data-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/updateChat","title":"Update chat","href":"/reference/v4/chats/updateChat","group":"Chats · v4","method":"PATCH","version":"v4","keywords":"update chat update a chat patch /chats/{chatid} updatechat v4 sets chat state (`open`/`closed`) on an apple messages for business chat. chats on every other channel return 422 `state_not_writable`: `closed` reflects the customer ending an apple messages for business conversation, and no other protocol has an equivalent. state apple messages for business chats only. `closed` blocks further sends to the chat with 409 `chat_closed_by_user`; an apple messages for business chat also closes itself when the customer ends the conv open closed","text":"state Apple Messages for Business chats only. blocks further sends to the chat with 409 ; an Apple Messages for Business chat also closes itself when the customer ends the conv open closed Update a chat Sets chat state ( / ) on an Apple Messages for Business chat. Chats on every other channel return 422 : reflects the customer ending an Apple Messages for Business conversation, and no other protocol has an equivalent. /chats/{chatId} chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. Apple Messages for Business chats only. blocks further sends to the chat with 409 ; an Apple Messages for Business chat also closes itself when the customer ends the conversation, and reopens when they message again.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-state","title":"state Apple Messages for Business chats only. `closed` blocks further sends to the cha"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Chat id (chat_...)."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-contact_id","title":"contact_id"},{"id":"response-data-identity_id","title":"identity_id"},{"id":"response-data-group_id","title":"group_id"},{"id":"response-data-contact","title":"contact The person on the other side of a 1:1 chat. `null` in a group chat; see `group`."},{"id":"response-data-contact-contact_id","title":"contact_id The contact (ct_...). `null` when no contact record matches the identifier."},{"id":"response-data-contact-identifier","title":"identifier The contact's identifier (phone number, email, or handle)."},{"id":"response-data-contact-name","title":"name The contact's name. `null` when none is on file. On a webhook it is a snapshot f"},{"id":"response-data-group","title":"group The group, when this is a group chat. `null` in a 1:1 chat."},{"id":"response-data-group-group_id","title":"group_id Group id (grp_...)."},{"id":"response-data-group-name","title":"name The group's name. `null` when it has none."},{"id":"response-data-state","title":"state"},{"id":"response-data-capabilities","title":"capabilities"},{"id":"response-data-window_expires_at","title":"window_expires_at"},{"id":"response-data-last_message_at","title":"last_message_at"},{"id":"response-data-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/getChatBackground","title":"Get chat background","href":"/reference/v4/chats/getChatBackground","group":"Chats · v4","method":"GET","version":"v4","keywords":"get chat background get chat background get /chats/{chatid}/background getchatbackground v4 reads the chat's background image (blooio channels). reads live from the device. ","text":"Get chat background Reads the chat's background image (Blooio channels). Reads live from the device. /chats/{chatId}/background chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-has_background","title":"has_background"},{"id":"response-data-background_id","title":"background_id"},{"id":"response-data-background_version","title":"background_version"},{"id":"response-data-background_url","title":"background_url"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/setChatBackground","title":"Set chat background","href":"/reference/v4/chats/setChatBackground","group":"Chats · v4","method":"PUT","version":"v4","keywords":"set chat background set chat background put /chats/{chatid}/background setchatbackground v4 uploads a chat background image. max 10mb; image/jpeg|png|gif|webp|heic|heif. blooio channels only. background","text":"background Set chat background Uploads a chat background image. Max 10MB; image/jpeg|png|gif|webp|heic|heif. Blooio channels only. /chats/{chatId}/background chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-background","title":"background"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-background_id","title":"background_id"},{"id":"response-data-background_url","title":"background_url"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/removeChatBackground","title":"Remove chat background","href":"/reference/v4/chats/removeChatBackground","group":"Chats · v4","method":"DELETE","version":"v4","keywords":"remove chat background remove chat background delete /chats/{chatid}/background removechatbackground v4 ","text":"Remove chat background /chats/{chatId}/background chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-removed","title":"removed"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/shareContactCard","title":"Share contact card","href":"/reference/v4/chats/shareContactCard","group":"Chats · v4","method":"POST","version":"v4","keywords":"share contact card share contact card post /chats/{chatid}/contact-card sharecontactcard v4 shares the sender's contact card into a chat. blooio channels only. ","text":"Share contact card Shares the sender's contact card into a chat. Blooio channels only. /chats/{chatId}/contact card chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-shared","title":"shared"},{"id":"response-data-at","title":"at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/getChatFocus","title":"Get chat focus","href":"/reference/v4/chats/getChatFocus","group":"Chats · v4","method":"GET","version":"v4","keywords":"get chat focus read focus status get /chats/{chatid}/focus getchatfocus v4 reads whether the other person in the chat has notifications silenced by a focus, as their device shares it over imessage. `silenced` means new messages arrive quietly; to break through for a message you sent, use notify anyway. `unknown` means the device has no status for this person (for example, a handle messages has not seen yet, or someone who does not share focus status). apple does not expose a way to turn another person's focus on or off. returns 409 for group chats and non-blooio channels. ","text":"Read Focus status Reads whether the other person in the chat has notifications silenced by a Focus, as their device shares it over iMessage. means new messages arrive quietly; to break through for a message you sent, use Notify Anyway. means the device has no status for this person (for example, a handle Messages has not seen yet, or someone who does not share Focus status). Apple does not expose a way to turn another person's Focus on or off. Returns 409 for group chats and non Blooio channels. /chats/{chatId}/focus chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-status","title":"status"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/listChatParticipants","title":"List chat participants","href":"/reference/v4/chats/listChatParticipants","group":"Chats · v4","method":"GET","version":"v4","keywords":"list chat participants list chat participants get /chats/{chatid}/participants listchatparticipants v4 ","text":"List chat participants /chats/{chatId}/participants chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/addChatParticipant","title":"Add chat participant","href":"/reference/v4/chats/addChatParticipant","group":"Chats · v4","method":"POST","version":"v4","keywords":"add chat participant add a chat participant post /chats/{chatid}/participants addchatparticipant v4 ","text":"Add a chat participant /chats/{chatId}/participants chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/removeChatParticipant","title":"Remove chat participant","href":"/reference/v4/chats/removeChatParticipant","group":"Chats · v4","method":"DELETE","version":"v4","keywords":"remove chat participant remove a chat participant delete /chats/{chatid}/participants/{identityid} removechatparticipant v4 ","text":"Remove a chat participant /chats/{chatId}/participants/{identityId} chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. identityId Unique identifier of the contact identity, prefixed with . Returned by the List contact identities endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-identityid","title":"identityId Unique identifier of the contact identity, prefixed with `cid_`. Returned by the"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/markChatRead","title":"Mark chat read","href":"/reference/v4/chats/markChatRead","group":"Chats · v4","method":"POST","version":"v4","keywords":"mark chat read mark chat as read post /chats/{chatid}/read markchatread v4 sends a read receipt. blooio channels only. ","text":"Mark chat as read Sends a read receipt. Blooio channels only. /chats/{chatId}/read chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-read","title":"read"},{"id":"response-data-at","title":"at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/setTyping","title":"Set typing","href":"/reference/v4/chats/setTyping","group":"Chats · v4","method":"POST","version":"v4","keywords":"set typing start/stop typing indicator post /chats/{chatid}/typing settyping v4 shows or clears a business-to-customer typing indicator. supported on blooio channels and apple messages for business. state started stopped","text":"state started stopped Start/stop typing indicator Shows or clears a business to customer typing indicator. Supported on Blooio channels and Apple Messages for Business. /chats/{chatId}/typing chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-state","title":"state"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-state","title":"state"},{"id":"response-data-at","title":"at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/chats/stopTyping","title":"Stop typing","href":"/reference/v4/chats/stopTyping","group":"Chats · v4","method":"DELETE","version":"v4","keywords":"stop typing stop typing indicator delete /chats/{chatid}/typing stoptyping v4 clears the business-to-customer typing indicator. supported on blooio channels and apple messages for business. ","text":"Stop typing indicator Clears the business to customer typing indicator. Supported on Blooio channels and Apple Messages for Business. /chats/{chatId}/typing chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-state","title":"state"},{"id":"response-data-at","title":"at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/messages","title":"Messages","href":"/reference/v4/messages","group":"API Reference · v4","version":"v4","keywords":"messages send messages and read message history, status, events, and reactions. v4","text":"Send messages and read message history, status, events, and reactions."},{"id":"v4:/reference/v4/messages/createAttachment","title":"Create attachment","href":"/reference/v4/messages/createAttachment","group":"Messages · v4","method":"POST","version":"v4","keywords":"create attachment register an attachment post /attachments createattachment v4 ","text":"Register an attachment /attachments","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/getAttachment","title":"Get attachment","href":"/reference/v4/messages/getAttachment","group":"Messages · v4","method":"GET","version":"v4","keywords":"get attachment get an attachment get /attachments/{attachmentid} getattachment v4 ","text":"Get an attachment /attachments/{attachmentId} attachmentId Unique identifier of the attachment, as referenced on a message's content.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-attachmentid","title":"attachmentId Unique identifier of the attachment, as referenced on a message's content."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/listChatMessages","title":"List chat messages","href":"/reference/v4/messages/listChatMessages","group":"Messages · v4","method":"GET","version":"v4","keywords":"list chat messages list chat messages get /chats/{chatid}/messages listchatmessages v4 lists messages in a chat, newest first by default. use `order=asc` for oldest first. ","text":"List chat messages Lists messages in a chat, newest first by default. Use for oldest first. /chats/{chatId}/messages chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. order limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-order","title":"order"},{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Message id (msg_...)."},{"id":"response-data-0-chat_id","title":"chat_id"},{"id":"response-data-0-channel_id","title":"channel_id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-channel_address","title":"channel_address The address of your own line on this channel (the sending/receiving number or al"},{"id":"response-data-0-protocol","title":"protocol Transport state or resolved wire service; never null. `pending` = accepted and d"},{"id":"response-data-0-direction","title":"direction"},{"id":"response-data-0-sender","title":"sender Who the message is FROM, direction-aware. On `inbound` this is the other party ("},{"id":"response-data-0-recipient","title":"recipient Who the message is TO, direction-aware. On `inbound` this is your own line (`cha"},{"id":"response-data-0-contact","title":"contact The other party (never your own line), regardless of direction — so you always k"},{"id":"response-data-0-contact-contact_id","title":"contact_id The contact (ct_...). `null` when no contact record matches the identifier."},{"id":"response-data-0-contact-identifier","title":"identifier The contact's identifier (phone number, email, or handle)."},{"id":"response-data-0-contact-name","title":"name The contact's name. `null` when none is on file. On a webhook it is a snapshot f"},{"id":"response-data-0-group","title":"group The group, when the message is in a group chat. `null` in a 1:1 chat. Matches th"},{"id":"response-data-0-group-group_id","title":"group_id Group id (grp_...)."},{"id":"response-data-0-group-name","title":"name The group's name. `null` when it has none."},{"id":"response-data-0-type","title":"type Content type, e.g. text, media, poll."},{"id":"response-data-0-text","title":"text The plain text of the message — what the recipient actually sees. On a rich-text"},{"id":"response-data-0-formatted_text","title":"formatted_text Markdown for a rich-text (bold/italic/underline/strikethrough) message. Omitted"},{"id":"response-data-0-status","title":"status Delivery lifecycle state: `queued` (accepted, awaiting dispatch), `sent` (handed"},{"id":"response-data-0-reply_to_message_id","title":"reply_to_message_id"},{"id":"response-data-0-error","title":"error Why the message failed; null unless it failed. On a `blooio` channel `code` is a"},{"id":"response-data-0-error-code","title":"code"},{"id":"response-data-0-error-message","title":"message A description of the failure."},{"id":"response-data-0-attachments","title":"attachments Ordered attachments on the message. Each entry is retrievable directly: `url` (s"},{"id":"response-data-0-attachments-0-url","title":"url"},{"id":"response-data-0-attachments-0-media_type","title":"media_type"},{"id":"response-data-0-attachments-0-size","title":"size"},{"id":"response-data-0-attachments-0-caption","title":"caption"},{"id":"response-data-0-interactive","title":"interactive Structured interactive content, present on interactive messages. For an inbound"},{"id":"response-data-0-imessage_app","title":"imessage_app Present on `imessage_app` messages (custom app bubbles): the app's `bundle_id`,"},{"id":"response-data-0-routing","title":"routing Apple Messages for Business only: the entry-point `intent` / `group` Apple attac"},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-data-0-updated_at","title":"updated_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/sendMessageToChat","title":"Send message to chat","href":"/reference/v4/messages/sendMessageToChat","group":"Messages · v4","method":"POST","version":"v4","keywords":"$48","text":"$49","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"header-idempotency-key","title":"Idempotency-Key Optional key for safe retries. Replaying the same key with an identical body ret"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-text","title":"text Plain text message. May be combined with `attachments` (sent as media with a cap"},{"id":"body-format","title":"format How to interpret `text` (and each `parts[].text`). Defaults to `plain`, which se"},{"id":"body-attachments","title":"attachments Public https media URLs. May be combined with `text`. On Blooio iMessage, two or"},{"id":"body-rich_link","title":"rich_link A tappable rich link bubble (Blooio / Apple Messages for Business)."},{"id":"body-rich_link-url","title":"url"},{"id":"body-rich_link-title","title":"title"},{"id":"body-app_clip","title":"app_clip An App Clip bubble (Blooio p2p iMessage only). Sends an App Clip launch URL that"},{"id":"body-app_clip-url","title":"url The App Clip launch URL (https). Mutually exclusive with `bundle_id`; if both ar"},{"id":"body-app_clip-bundle_id","title":"bundle_id App Clip bundle identifier (e.g. `com.example.app.Clip`), expanded to `https://a"},{"id":"body-app_clip-title","title":"title Optional preview title override."},{"id":"body-imessage_app","title":"imessage_app Bring-your-own iMessage App Extension bubble (Blooio p2p iMessage only). Blooio"},{"id":"body-imessage_app-bundle_id","title":"bundle_id Your iMessage app extension's bundle identifier (e.g. `com.acme.app.MessagesExte"},{"id":"body-imessage_app-team_id","title":"team_id Your Apple Developer Team ID. Combined with `bundle_id` to form the balloon plug"},{"id":"body-imessage_app-url","title":"url The app-state URL your extension reads on tap (its `MSMessage.url`). Carries the"},{"id":"body-imessage_app-app_name","title":"app_name Display name shown for the app (the `an` field). Defaults to a generic label."},{"id":"body-imessage_app-caption","title":"caption Template-card caption shown to everyone (including recipients without the app)."},{"id":"body-imessage_app-subcaption","title":"subcaption Optional template-card subcaption."},{"id":"body-imessage_app-image_url","title":"image_url Optional https image used as the fallback template card thumbnail. Fetched best-"},{"id":"body-imessage_app-app_store_id","title":"app_store_id Optional App Store id (adam id) for your app. When the recipient doesn't have th"},{"id":"body-poll","title":"poll A native Blooio poll. Routed sends automatically consider only poll-capable chan"},{"id":"body-poll-title","title":"title"},{"id":"body-poll-options","title":"options"},{"id":"body-interactive","title":"interactive Interactive content. On Apple Messages for Business this renders as a native int"},{"id":"body-interactive-kind","title":"kind Which interactive experience to render."},{"id":"body-interactive-summary_text","title":"summary_text Prompt / fallback line shown where the interactive UI can't render. Used as the"},{"id":"body-interactive-text","title":"text Alias for `summary_text`."},{"id":"body-interactive-request_identifier","title":"request_identifier Optional stable id echoed back on the customer's reply. Defaults to the message"},{"id":"body-interactive-received_message","title":"received_message Bubble shown to the customer before they interact. Not allowed for `quick_reply`"},{"id":"body-interactive-received_message-title","title":"title"},{"id":"body-interactive-received_message-subtitle","title":"subtitle"},{"id":"body-interactive-received_message-style","title":"style"},{"id":"body-interactive-received_message-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-reply_message","title":"reply_message Bubble shown after the customer replies."},{"id":"body-interactive-reply_message-title","title":"title"},{"id":"body-interactive-reply_message-subtitle","title":"subtitle"},{"id":"body-interactive-reply_message-style","title":"style"},{"id":"body-interactive-reply_message-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-images","title":"images Inline PNG assets referenced by `imageIdentifier` elsewhere in the payload. Supp"},{"id":"body-interactive-images-0-identifier","title":"identifier"},{"id":"body-interactive-images-0-data","title":"data Base64-encoded PNG."},{"id":"body-interactive-images-0-url","title":"url Public https PNG URL, fetched and validated server-side."},{"id":"body-interactive-images-0-expected_size","title":"expected_size Optional exact @3x size to enforce for this asset's target style."},{"id":"body-interactive-images-0-expected_size-width","title":"width"},{"id":"body-interactive-images-0-expected_size-height","title":"height"},{"id":"body-interactive-images-0-expected_size-style","title":"style"},{"id":"body-interactive-items","title":"items Quick reply options (`kind` = quick_reply). Required: 1–5 items, each with a non"},{"id":"body-interactive-items-0-id","title":"id"},{"id":"body-interactive-items-0-title","title":"title"},{"id":"body-interactive-sections","title":"sections List picker sections (`kind` = list_picker). Required: at least one section, eac"},{"id":"body-interactive-sections-0-title","title":"title"},{"id":"body-interactive-sections-0-order","title":"order"},{"id":"body-interactive-sections-0-multipleselection","title":"multipleSelection Allow selecting more than one item in this section."},{"id":"body-interactive-sections-0-items","title":"items"},{"id":"body-interactive-sections-0-items-0-identifier","title":"identifier"},{"id":"body-interactive-sections-0-items-0-title","title":"title"},{"id":"body-interactive-sections-0-items-0-subtitle","title":"subtitle"},{"id":"body-interactive-sections-0-items-0-order","title":"order"},{"id":"body-interactive-sections-0-items-0-style","title":"style Row style. Defaults to `default` when omitted."},{"id":"body-interactive-sections-0-items-0-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-list","title":"list Alias for `sections` (`kind` = list_picker). Accepts `{ \"sections\": [...] }` (or"},{"id":"body-interactive-event","title":"event Time picker event (`kind` = time_picker). Required: at least one `timeslots` ent"},{"id":"body-interactive-event-identifier","title":"identifier"},{"id":"body-interactive-event-title","title":"title"},{"id":"body-interactive-event-location","title":"location"},{"id":"body-interactive-event-location-title","title":"title"},{"id":"body-interactive-event-timezoneoffset","title":"timezoneOffset"},{"id":"body-interactive-event-timeslots","title":"timeslots"},{"id":"body-interactive-event-timeslots-0-identifier","title":"identifier"},{"id":"body-interactive-event-timeslots-0-starttime","title":"startTime ISO-8601 start time; normalized to Apple's `+0000` format on send."},{"id":"body-interactive-event-timeslots-0-duration","title":"duration Slot duration in seconds."},{"id":"body-interactive-dynamic","title":"dynamic Apple dynamic interactive message (multi-page form) object, forwarded verbatim ("},{"id":"body-interactive-form","title":"form Alias for `dynamic` (`kind` = form)."},{"id":"body-interactive-payment","title":"payment Apple Pay payment request object, forwarded verbatim (`kind` = apple_pay). Requi"},{"id":"body-interactive-authenticate","title":"authenticate OAuth2 authentication request object, forwarded verbatim (`kind` = authenticate)"},{"id":"body-interactive-oauth2","title":"oauth2 Shorthand for `authenticate.oauth2` (`kind` = authenticate). Requires `responseT"},{"id":"body-interactive-app","title":"app Custom iMessage app metadata (`kind` = imessage_app). These App Store fallback f"},{"id":"body-interactive-app-app_id","title":"app_id"},{"id":"body-interactive-app-app_name","title":"app_name"},{"id":"body-interactive-app-app_icon","title":"app_icon"},{"id":"body-interactive-app-bid","title":"bid"},{"id":"body-interactive-app-url","title":"url"},{"id":"body-interactive-app_id","title":"app_id App Store id for the iMessage app fallback (`kind` = imessage_app). Flat alias f"},{"id":"body-interactive-app_name","title":"app_name App Store name for the iMessage app fallback (`kind` = imessage_app). Flat alias"},{"id":"body-interactive-app_icon","title":"app_icon Base64 PNG icon for the iMessage app fallback (`kind` = imessage_app). Flat alia"},{"id":"body-interactive-bid","title":"bid iMessage extension bundle id. Required for `kind` = imessage_app (or supply it u"},{"id":"body-interactive-url","title":"url Custom app URL / query string (`kind` = imessage_app)."},{"id":"body-interactive-session_identifier","title":"session_identifier"},{"id":"body-interactive-use_live_layout","title":"use_live_layout"},{"id":"body-invitation","title":"invitation Apple Messages for Business invitation. Sends an Apple-managed notification temp"},{"id":"body-invitation-template_id","title":"template_id The Apple-managed notification template id authorized for your business (e.g. `b"},{"id":"body-invitation-reference_id","title":"reference_id Your business context id for this invitation (order number, case id, etc.). Requ"},{"id":"body-invitation-parameters","title":"parameters Template parameter values required by the chosen template (e.g. `brandName`, and"},{"id":"body-invitation-locale","title":"locale BCP-47 locale for the template. Defaults to `en-us`."},{"id":"body-template","title":"template Template content (WhatsApp Business)."},{"id":"body-template-template_id","title":"template_id"},{"id":"body-parts","title":"parts Ordered text/media parts sent as one multipart message (Blooio only). When every"},{"id":"body-parts-0-text","title":"text"},{"id":"body-parts-0-url","title":"url"},{"id":"body-reply_to","title":"reply_to Message id to reply to. Applies to the whole outgoing message."},{"id":"body-effect","title":"effect iMessage screen/bubble effect (Blooio, text only)."},{"id":"body-link_preview","title":"link_preview"},{"id":"body-link_preview-imageurl","title":"imageUrl"},{"id":"body-link_preview-title","title":"title"},{"id":"body-badge","title":"badge Optional attribution badge shown under the bubble: `sent_with_siri` renders \"Sen"},{"id":"body-carousel","title":"carousel Group image/video attachments into ONE message that Messages renders as a swipea"},{"id":"body-dry_run","title":"dry_run"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id"},{"id":"response-chat_id","title":"chat_id"},{"id":"response-channel_id","title":"channel_id"},{"id":"response-channel_type","title":"channel_type"},{"id":"response-protocol","title":"protocol Transport state or resolved wire service; never null. `pending` = accepted and d"},{"id":"response-from","title":"from The resolved sender as a human value: the sending channel's phone number (number"},{"id":"response-direction","title":"direction"},{"id":"response-type","title":"type"},{"id":"response-status","title":"status Initial lifecycle state for the send: normally `queued` (accepted for delivery),"},{"id":"response-group_id","title":"group_id Existing group id for a group-targeted send."},{"id":"response-hybrid","title":"hybrid Hybrid routing phase and optional transition placement."},{"id":"response-error","title":"error Why the message failed; null unless it failed. On a `blooio` channel `code` is a"},{"id":"response-error-code","title":"code"},{"id":"response-error-message","title":"message A description of the failure."},{"id":"response-fallback","title":"fallback Present when a send could not be delivered on the requested channel and a differ"},{"id":"response-fallback-recommended","title":"recommended True when falling back to another channel is recommended."},{"id":"response-fallback-reason","title":"reason"},{"id":"response-to","title":"to Recipient identifier. Present only on per-recipient items inside a fan-out (FanO"},{"id":"response-dry_run","title":"dry_run"},{"id":"response-would_send","title":"would_send"},{"id":"response-preview","title":"preview"},{"id":"response-poll","title":"poll"},{"id":"response-poll-title","title":"title"},{"id":"response-poll-options","title":"options"},{"id":"response-routing","title":"routing How Blooio selected the concrete sender channel."},{"id":"response-routing-mode","title":"mode"},{"id":"response-routing-channel_type","title":"channel_type"},{"id":"response-routing-number","title":"number"},{"id":"response-routing-alias","title":"alias"},{"id":"response-routing-priority_id","title":"priority_id"},{"id":"response-routing-priority","title":"priority"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/getChatMessage","title":"Get chat message","href":"/reference/v4/messages/getChatMessage","group":"Messages · v4","method":"GET","version":"v4","keywords":"get chat message get a message get /chats/{chatid}/messages/{messageid} getchatmessage v4 ","text":"Get a message /chats/{chatId}/messages/{messageId} chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. messageId Unique identifier of the message — the returned when you send a message or by the List messages endpoint. Outbound messages use a id; inbound (received) messages use the id the List endpoint exposes for that row. Both are addressable.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-messageid","title":"messageId Unique identifier of the message — the `id` returned when you send a message or"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Message id (msg_...)."},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-channel_address","title":"channel_address The address of your own line on this channel (the sending/receiving number or al"},{"id":"response-data-protocol","title":"protocol Transport state or resolved wire service; never null. `pending` = accepted and d"},{"id":"response-data-direction","title":"direction"},{"id":"response-data-sender","title":"sender Who the message is FROM, direction-aware. On `inbound` this is the other party ("},{"id":"response-data-recipient","title":"recipient Who the message is TO, direction-aware. On `inbound` this is your own line (`cha"},{"id":"response-data-contact","title":"contact The other party (never your own line), regardless of direction — so you always k"},{"id":"response-data-contact-contact_id","title":"contact_id The contact (ct_...). `null` when no contact record matches the identifier."},{"id":"response-data-contact-identifier","title":"identifier The contact's identifier (phone number, email, or handle)."},{"id":"response-data-contact-name","title":"name The contact's name. `null` when none is on file. On a webhook it is a snapshot f"},{"id":"response-data-group","title":"group The group, when the message is in a group chat. `null` in a 1:1 chat. Matches th"},{"id":"response-data-group-group_id","title":"group_id Group id (grp_...)."},{"id":"response-data-group-name","title":"name The group's name. `null` when it has none."},{"id":"response-data-type","title":"type Content type, e.g. text, media, poll."},{"id":"response-data-text","title":"text The plain text of the message — what the recipient actually sees. On a rich-text"},{"id":"response-data-formatted_text","title":"formatted_text Markdown for a rich-text (bold/italic/underline/strikethrough) message. Omitted"},{"id":"response-data-status","title":"status Delivery lifecycle state: `queued` (accepted, awaiting dispatch), `sent` (handed"},{"id":"response-data-reply_to_message_id","title":"reply_to_message_id"},{"id":"response-data-error","title":"error Why the message failed; null unless it failed. On a `blooio` channel `code` is a"},{"id":"response-data-error-code","title":"code"},{"id":"response-data-error-message","title":"message A description of the failure."},{"id":"response-data-attachments","title":"attachments Ordered attachments on the message. Each entry is retrievable directly: `url` (s"},{"id":"response-data-attachments-0-url","title":"url"},{"id":"response-data-attachments-0-media_type","title":"media_type"},{"id":"response-data-attachments-0-size","title":"size"},{"id":"response-data-attachments-0-caption","title":"caption"},{"id":"response-data-interactive","title":"interactive Structured interactive content, present on interactive messages. For an inbound"},{"id":"response-data-imessage_app","title":"imessage_app Present on `imessage_app` messages (custom app bubbles): the app's `bundle_id`,"},{"id":"response-data-routing","title":"routing Apple Messages for Business only: the entry-point `intent` / `group` Apple attac"},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-updated_at","title":"updated_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/listMessageEvents","title":"List message events","href":"/reference/v4/messages/listMessageEvents","group":"Messages · v4","method":"GET","version":"v4","keywords":"list message events list message events get /chats/{chatid}/messages/{messageid}/events listmessageevents v4 lifecycle events for a message (sent, delivered, read, reactions, ...). ","text":"List message events Lifecycle events for a message (sent, delivered, read, reactions, ...). /chats/{chatId}/messages/{messageId}/events chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. messageId Unique identifier of the message — the returned when you send a message or by the List messages endpoint. Outbound messages use a id; inbound (received) messages use the id the List endpoint exposes for that row. Both are addressable. limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-messageid","title":"messageId Unique identifier of the message — the `id` returned when you send a message or"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Event id (evt_...)."},{"id":"response-data-0-message_id","title":"message_id"},{"id":"response-data-0-kind","title":"kind Bare lifecycle kind, e.g. sent, delivered, read, reaction."},{"id":"response-data-0-occurred_at","title":"occurred_at"},{"id":"response-data-0-metadata","title":"metadata The event's data, as `GET /events` returns it: a `reaction` carries the same fie"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/notifyMessage","title":"Notify message","href":"/reference/v4/messages/notifyMessage","group":"Messages · v4","method":"POST","version":"v4","keywords":"notify message notify anyway post /chats/{chatid}/messages/{messageid}/notify notifymessage v4 breaks through the recipient's focus for a message you sent, the same as tapping notify anyway in messages. use it when read focus status reports `silenced`. calling it again for a message that was already notified succeeds. it cannot be undone. returns 404 if the message isn't in the chat. returns 409 for an inbound message, an sms or rcs message, a message that hasn't been dispatched to the device yet, a group chat, or a non-blooio channel. ","text":"Notify Anyway Breaks through the recipient's Focus for a message you sent, the same as tapping Notify Anyway in Messages. Use it when Read Focus status reports . Calling it again for a message that was already notified succeeds. It cannot be undone. Returns 404 if the message isn't in the chat. Returns 409 for an inbound message, an SMS or RCS message, a message that hasn't been dispatched to the device yet, a group chat, or a non Blooio channel. /chats/{chatId}/messages/{messageId}/notify chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. messageId Unique identifier of the message — the returned when you send a message or by the List messages endpoint. Outbound messages use a id; inbound (received) messages use the id the List endpoint exposes for that row. Both are addressable.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-messageid","title":"messageId Unique identifier of the message — the `id` returned when you send a message or"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-message_id","title":"message_id"},{"id":"response-data-notified","title":"notified"},{"id":"response-data-at","title":"at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/addReaction","title":"Add reaction","href":"/reference/v4/messages/addReaction","group":"Messages · v4","method":"POST","version":"v4","keywords":"add reaction react to a message post /chats/{chatid}/messages/{messageid}/reactions addreaction v4 adds or removes a tapback reaction on any message in the chat — inbound (received) or outbound — addressed by the message `id` from the list messages endpoint. use a `+` prefix to add and `-` to remove (e.g. `+love`, `-love`). returns 404 if the message isn't in the chat and 409 if it hasn't been dispatched to the device yet. blooio channels only. reaction e.g. '+love' to add, '-love' to remove.","text":"reaction e.g. '+love' to add, ' love' to remove. React to a message Adds or removes a tapback reaction on any message in the chat — inbound (received) or outbound — addressed by the message from the List messages endpoint. Use a prefix to add and to remove (e.g. , ). Returns 404 if the message isn't in the chat and 409 if it hasn't been dispatched to the device yet. Blooio channels only. /chats/{chatId}/messages/{messageId}/reactions chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. messageId Unique identifier of the message — the returned when you send a message or by the List messages endpoint. Outbound messages use a id; inbound (received) messages use the id the List endpoint exposes for that row. Both are addressable. e.g. '+love' to add, ' love' to remove.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-messageid","title":"messageId Unique identifier of the message — the `id` returned when you send a message or"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-reaction","title":"reaction e.g. '+love' to add, '-love' to remove."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-message_id","title":"message_id"},{"id":"response-data-reaction","title":"reaction"},{"id":"response-data-at","title":"at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/getMessageStatus","title":"Get message status","href":"/reference/v4/messages/getMessageStatus","group":"Messages · v4","method":"GET","version":"v4","keywords":"get message status get message status get /chats/{chatid}/messages/{messageid}/status getmessagestatus v4 lightweight delivery status of a message. ","text":"Get message status Lightweight delivery status of a message. /chats/{chatId}/messages/{messageId}/status chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. messageId Unique identifier of the message — the returned when you send a message or by the List messages endpoint. Outbound messages use a id; inbound (received) messages use the id the List endpoint exposes for that row. Both are addressable.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-messageid","title":"messageId Unique identifier of the message — the `id` returned when you send a message or"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-status","title":"status Delivery lifecycle state: `queued` (accepted, awaiting dispatch), `sent` (handed"},{"id":"response-data-protocol","title":"protocol Transport state or resolved wire service; never null. `pending` = accepted and d"},{"id":"response-data-error","title":"error Why the message failed; null unless it failed. On a `blooio` channel `code` is a"},{"id":"response-data-error-code","title":"code"},{"id":"response-data-error-message","title":"message A description of the failure."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-updated_at","title":"updated_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/sendMessage","title":"Send message","href":"/reference/v4/messages/sendMessage","group":"Messages · v4","method":"POST","version":"v4","keywords":"$4a","text":"$4b","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0",{"id":"header-idempotency-key","title":"Idempotency-Key Optional key for safe retries. Replaying the same key with an identical body ret"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-text","title":"text Plain text message. May be combined with `attachments` (sent as media with a cap"},{"id":"body-format","title":"format How to interpret `text` (and each `parts[].text`). Defaults to `plain`, which se"},{"id":"body-attachments","title":"attachments Public https media URLs. May be combined with `text`. On Blooio iMessage, two or"},{"id":"body-rich_link","title":"rich_link A tappable rich link bubble (Blooio / Apple Messages for Business)."},{"id":"body-rich_link-url","title":"url"},{"id":"body-rich_link-title","title":"title"},{"id":"body-app_clip","title":"app_clip An App Clip bubble (Blooio p2p iMessage only). Sends an App Clip launch URL that"},{"id":"body-app_clip-url","title":"url The App Clip launch URL (https). Mutually exclusive with `bundle_id`; if both ar"},{"id":"body-app_clip-bundle_id","title":"bundle_id App Clip bundle identifier (e.g. `com.example.app.Clip`), expanded to `https://a"},{"id":"body-app_clip-title","title":"title Optional preview title override."},{"id":"body-imessage_app","title":"imessage_app Bring-your-own iMessage App Extension bubble (Blooio p2p iMessage only). Blooio"},{"id":"body-imessage_app-bundle_id","title":"bundle_id Your iMessage app extension's bundle identifier (e.g. `com.acme.app.MessagesExte"},{"id":"body-imessage_app-team_id","title":"team_id Your Apple Developer Team ID. Combined with `bundle_id` to form the balloon plug"},{"id":"body-imessage_app-url","title":"url The app-state URL your extension reads on tap (its `MSMessage.url`). Carries the"},{"id":"body-imessage_app-app_name","title":"app_name Display name shown for the app (the `an` field). Defaults to a generic label."},{"id":"body-imessage_app-caption","title":"caption Template-card caption shown to everyone (including recipients without the app)."},{"id":"body-imessage_app-subcaption","title":"subcaption Optional template-card subcaption."},{"id":"body-imessage_app-image_url","title":"image_url Optional https image used as the fallback template card thumbnail. Fetched best-"},{"id":"body-imessage_app-app_store_id","title":"app_store_id Optional App Store id (adam id) for your app. When the recipient doesn't have th"},{"id":"body-poll","title":"poll A native Blooio poll. Routed sends automatically consider only poll-capable chan"},{"id":"body-poll-title","title":"title"},{"id":"body-poll-options","title":"options"},{"id":"body-interactive","title":"interactive Interactive content. On Apple Messages for Business this renders as a native int"},{"id":"body-interactive-kind","title":"kind Which interactive experience to render."},{"id":"body-interactive-summary_text","title":"summary_text Prompt / fallback line shown where the interactive UI can't render. Used as the"},{"id":"body-interactive-text","title":"text Alias for `summary_text`."},{"id":"body-interactive-request_identifier","title":"request_identifier Optional stable id echoed back on the customer's reply. Defaults to the message"},{"id":"body-interactive-received_message","title":"received_message Bubble shown to the customer before they interact. Not allowed for `quick_reply`"},{"id":"body-interactive-received_message-title","title":"title"},{"id":"body-interactive-received_message-subtitle","title":"subtitle"},{"id":"body-interactive-received_message-style","title":"style"},{"id":"body-interactive-received_message-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-reply_message","title":"reply_message Bubble shown after the customer replies."},{"id":"body-interactive-reply_message-title","title":"title"},{"id":"body-interactive-reply_message-subtitle","title":"subtitle"},{"id":"body-interactive-reply_message-style","title":"style"},{"id":"body-interactive-reply_message-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-images","title":"images Inline PNG assets referenced by `imageIdentifier` elsewhere in the payload. Supp"},{"id":"body-interactive-images-0-identifier","title":"identifier"},{"id":"body-interactive-images-0-data","title":"data Base64-encoded PNG."},{"id":"body-interactive-images-0-url","title":"url Public https PNG URL, fetched and validated server-side."},{"id":"body-interactive-images-0-expected_size","title":"expected_size Optional exact @3x size to enforce for this asset's target style."},{"id":"body-interactive-images-0-expected_size-width","title":"width"},{"id":"body-interactive-images-0-expected_size-height","title":"height"},{"id":"body-interactive-images-0-expected_size-style","title":"style"},{"id":"body-interactive-items","title":"items Quick reply options (`kind` = quick_reply). Required: 1–5 items, each with a non"},{"id":"body-interactive-items-0-id","title":"id"},{"id":"body-interactive-items-0-title","title":"title"},{"id":"body-interactive-sections","title":"sections List picker sections (`kind` = list_picker). Required: at least one section, eac"},{"id":"body-interactive-sections-0-title","title":"title"},{"id":"body-interactive-sections-0-order","title":"order"},{"id":"body-interactive-sections-0-multipleselection","title":"multipleSelection Allow selecting more than one item in this section."},{"id":"body-interactive-sections-0-items","title":"items"},{"id":"body-interactive-sections-0-items-0-identifier","title":"identifier"},{"id":"body-interactive-sections-0-items-0-title","title":"title"},{"id":"body-interactive-sections-0-items-0-subtitle","title":"subtitle"},{"id":"body-interactive-sections-0-items-0-order","title":"order"},{"id":"body-interactive-sections-0-items-0-style","title":"style Row style. Defaults to `default` when omitted."},{"id":"body-interactive-sections-0-items-0-imageidentifier","title":"imageIdentifier"},{"id":"body-interactive-list","title":"list Alias for `sections` (`kind` = list_picker). Accepts `{ \"sections\": [...] }` (or"},{"id":"body-interactive-event","title":"event Time picker event (`kind` = time_picker). Required: at least one `timeslots` ent"},{"id":"body-interactive-event-identifier","title":"identifier"},{"id":"body-interactive-event-title","title":"title"},{"id":"body-interactive-event-location","title":"location"},{"id":"body-interactive-event-location-title","title":"title"},{"id":"body-interactive-event-timezoneoffset","title":"timezoneOffset"},{"id":"body-interactive-event-timeslots","title":"timeslots"},{"id":"body-interactive-event-timeslots-0-identifier","title":"identifier"},{"id":"body-interactive-event-timeslots-0-starttime","title":"startTime ISO-8601 start time; normalized to Apple's `+0000` format on send."},{"id":"body-interactive-event-timeslots-0-duration","title":"duration Slot duration in seconds."},{"id":"body-interactive-dynamic","title":"dynamic Apple dynamic interactive message (multi-page form) object, forwarded verbatim ("},{"id":"body-interactive-form","title":"form Alias for `dynamic` (`kind` = form)."},{"id":"body-interactive-payment","title":"payment Apple Pay payment request object, forwarded verbatim (`kind` = apple_pay). Requi"},{"id":"body-interactive-authenticate","title":"authenticate OAuth2 authentication request object, forwarded verbatim (`kind` = authenticate)"},{"id":"body-interactive-oauth2","title":"oauth2 Shorthand for `authenticate.oauth2` (`kind` = authenticate). Requires `responseT"},{"id":"body-interactive-app","title":"app Custom iMessage app metadata (`kind` = imessage_app). These App Store fallback f"},{"id":"body-interactive-app-app_id","title":"app_id"},{"id":"body-interactive-app-app_name","title":"app_name"},{"id":"body-interactive-app-app_icon","title":"app_icon"},{"id":"body-interactive-app-bid","title":"bid"},{"id":"body-interactive-app-url","title":"url"},{"id":"body-interactive-app_id","title":"app_id App Store id for the iMessage app fallback (`kind` = imessage_app). Flat alias f"},{"id":"body-interactive-app_name","title":"app_name App Store name for the iMessage app fallback (`kind` = imessage_app). Flat alias"},{"id":"body-interactive-app_icon","title":"app_icon Base64 PNG icon for the iMessage app fallback (`kind` = imessage_app). Flat alia"},{"id":"body-interactive-bid","title":"bid iMessage extension bundle id. Required for `kind` = imessage_app (or supply it u"},{"id":"body-interactive-url","title":"url Custom app URL / query string (`kind` = imessage_app)."},{"id":"body-interactive-session_identifier","title":"session_identifier"},{"id":"body-interactive-use_live_layout","title":"use_live_layout"},{"id":"body-invitation","title":"invitation Apple Messages for Business invitation. Sends an Apple-managed notification temp"},{"id":"body-invitation-template_id","title":"template_id The Apple-managed notification template id authorized for your business (e.g. `b"},{"id":"body-invitation-reference_id","title":"reference_id Your business context id for this invitation (order number, case id, etc.). Requ"},{"id":"body-invitation-parameters","title":"parameters Template parameter values required by the chosen template (e.g. `brandName`, and"},{"id":"body-invitation-locale","title":"locale BCP-47 locale for the template. Defaults to `en-us`."},{"id":"body-template","title":"template Template content (WhatsApp Business)."},{"id":"body-template-template_id","title":"template_id"},{"id":"body-parts","title":"parts Ordered text/media parts sent as one multipart message (Blooio only). When every"},{"id":"body-parts-0-text","title":"text"},{"id":"body-parts-0-url","title":"url"},{"id":"body-reply_to","title":"reply_to Message id to reply to. Applies to the whole outgoing message."},{"id":"body-effect","title":"effect iMessage screen/bubble effect (Blooio, text only)."},{"id":"body-link_preview","title":"link_preview"},{"id":"body-link_preview-imageurl","title":"imageUrl"},{"id":"body-link_preview-title","title":"title"},{"id":"body-badge","title":"badge Optional attribution badge shown under the bubble: `sent_with_siri` renders \"Sen"},{"id":"body-carousel","title":"carousel Group image/video attachments into ONE message that Messages renders as a swipea"},{"id":"body-from","title":"from The sender as a single string: a phone number (any common format; matched to you"},{"id":"body-priority_id","title":"priority_id Route through an explicit priority (priority_...). Mutually exclusive with `from"},{"id":"body-channel_type","title":"channel_type"},{"id":"body-hybrid","title":"hybrid Hybrid (Twilio-first / Blooio-after-reply) routing. `true` uses the calling key'"},{"id":"body-to","title":"to A recipient: a raw identifier string (phone/email/opaque provider id), an array"},{"id":"body-to-contact_id","title":"contact_id Contact id (ct_...) — routed sends only."},{"id":"body-to-group_id","title":"group_id Existing group id (grp_...) — exact sender or a hybrid sender that owns the grou"},{"id":"body-dry_run","title":"dry_run Validate and route only; do not send."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-id","title":"id"},{"id":"response-chat_id","title":"chat_id"},{"id":"response-channel_id","title":"channel_id"},{"id":"response-channel_type","title":"channel_type"},{"id":"response-protocol","title":"protocol Transport state or resolved wire service; never null. `pending` = accepted and d"},{"id":"response-from","title":"from The resolved sender as a human value: the sending channel's phone number (number"},{"id":"response-direction","title":"direction"},{"id":"response-type","title":"type"},{"id":"response-status","title":"status Initial lifecycle state for the send: normally `queued` (accepted for delivery),"},{"id":"response-group_id","title":"group_id Existing group id for a group-targeted send."},{"id":"response-hybrid","title":"hybrid Hybrid routing phase and optional transition placement."},{"id":"response-error","title":"error Why the message failed; null unless it failed. On a `blooio` channel `code` is a"},{"id":"response-error-code","title":"code"},{"id":"response-error-message","title":"message A description of the failure."},{"id":"response-fallback","title":"fallback Present when a send could not be delivered on the requested channel and a differ"},{"id":"response-fallback-recommended","title":"recommended True when falling back to another channel is recommended."},{"id":"response-fallback-reason","title":"reason"},{"id":"response-to","title":"to Recipient identifier. Present only on per-recipient items inside a fan-out (FanO"},{"id":"response-dry_run","title":"dry_run"},{"id":"response-would_send","title":"would_send"},{"id":"response-preview","title":"preview"},{"id":"response-poll","title":"poll"},{"id":"response-poll-title","title":"title"},{"id":"response-poll-options","title":"options"},{"id":"response-routing","title":"routing How Blooio selected the concrete sender channel."},{"id":"response-routing-mode","title":"mode"},{"id":"response-routing-channel_type","title":"channel_type"},{"id":"response-routing-number","title":"number"},{"id":"response-routing-alias","title":"alias"},{"id":"response-routing-priority_id","title":"priority_id"},{"id":"response-routing-priority","title":"priority"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/listTemplates","title":"List templates","href":"/reference/v4/messages/listTemplates","group":"Messages · v4","method":"GET","version":"v4","keywords":"list templates list templates get /templates listtemplates v4 ","text":"List templates /templates","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/createTemplate","title":"Create template","href":"/reference/v4/messages/createTemplate","group":"Messages · v4","method":"POST","version":"v4","keywords":"create template create a template post /templates createtemplate v4 ","text":"Create a template /templates","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/getTemplate","title":"Get template","href":"/reference/v4/messages/getTemplate","group":"Messages · v4","method":"GET","version":"v4","keywords":"get template get a template get /templates/{templateid} gettemplate v4 ","text":"Get a template /templates/{templateId} templateId Unique identifier of the message template. Returned when you create a template or by the List templates endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-templateid","title":"templateId Unique identifier of the message template. Returned when you create a template o"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/messages/deleteTemplate","title":"Delete template","href":"/reference/v4/messages/deleteTemplate","group":"Messages · v4","method":"DELETE","version":"v4","keywords":"delete template delete a template delete /templates/{templateid} deletetemplate v4 ","text":"Delete a template /templates/{templateId} templateId Unique identifier of the message template. Returned when you create a template or by the List templates endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-templateid","title":"templateId Unique identifier of the message template. Returned when you create a template o"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/polls","title":"Polls","href":"/reference/v4/polls","group":"API Reference · v4","version":"v4","keywords":"polls native imessage polls (blooio channels). v4","text":"Native iMessage polls (Blooio channels)."},{"id":"v4:/reference/v4/polls/sendPoll","title":"Send poll","href":"/reference/v4/polls/sendPoll","group":"Polls · v4","method":"POST","version":"v4","keywords":"send poll send a poll post /chats/{chatid}/polls sendpoll v4 sends a native imessage poll to a chat. requires a title and 2+ options. blooio channels only. title options","text":"title options Send a poll Sends a native iMessage poll to a chat. Requires a title and 2+ options. Blooio channels only. /chats/{chatId}/polls chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-title","title":"title"},{"id":"body-options","title":"options"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-type","title":"type"},{"id":"response-data-status","title":"status"},{"id":"response-data-poll","title":"poll"},{"id":"response-data-poll-title","title":"title"},{"id":"response-data-poll-options","title":"options"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/polls/getPollResults","title":"Get poll results","href":"/reference/v4/polls/getPollResults","group":"Polls · v4","method":"GET","version":"v4","keywords":"get poll results get poll results get /chats/{chatid}/polls/{pollid} getpollresults v4 ","text":"Get poll results /chats/{chatId}/polls/{pollId} chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. pollId Unique identifier of the poll, prefixed with (a poll shares the id of its underlying message).","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-pollid","title":"pollId Unique identifier of the poll, prefixed with `msg_` (a poll shares the id of its"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-poll_id","title":"poll_id"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-title","title":"title"},{"id":"response-data-options","title":"options"},{"id":"response-data-options-0-text","title":"text"},{"id":"response-data-options-0-votes","title":"votes"},{"id":"response-data-total_votes","title":"total_votes"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/polls/votePoll","title":"Vote poll","href":"/reference/v4/polls/votePoll","group":"Polls · v4","method":"POST","version":"v4","keywords":"vote poll vote on a poll post /chats/{chatid}/polls/{pollid}/vote votepoll v4 casts or toggles a vote by `option_index` (0-based) or `option` text. blooio channels only. option_index 0-based option index. option option text.","text":"option index 0 based option index. option Option text. Vote on a poll Casts or toggles a vote by (0 based) or text. Blooio channels only. /chats/{chatId}/polls/{pollId}/vote chatId Unique identifier of the chat, prefixed with . Returned by the List chats endpoint. pollId Unique identifier of the poll, prefixed with (a poll shares the id of its underlying message). Provide option index (0 based) or option text. 0 based option index. Option text.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-chatid","title":"chatId Unique identifier of the chat, prefixed with `chat_`. Returned by the List chats"},{"id":"path-pollid","title":"pollId Unique identifier of the poll, prefixed with `msg_` (a poll shares the id of its"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-option_index","title":"option_index 0-based option index."},{"id":"body-option","title":"option Option text."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-poll_id","title":"poll_id"},{"id":"response-data-voted_option","title":"voted_option"},{"id":"response-data-toggled","title":"toggled"},{"id":"response-data-active_votes","title":"active_votes"},{"id":"response-data-active_vote_indices","title":"active_vote_indices"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/groups","title":"Groups","href":"/reference/v4/groups","group":"API Reference · v4","version":"v4","keywords":"groups group chats on group-capable channels (blooio, whatsapp). v4","text":"Group chats on group capable channels (Blooio, WhatsApp)."},{"id":"v4:/reference/v4/groups/listGroups","title":"List groups","href":"/reference/v4/groups/listGroups","group":"Groups · v4","method":"GET","version":"v4","keywords":"list groups list groups get /groups listgroups v4 ","text":"List groups /groups limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Group id (grp_...)."},{"id":"response-data-0-channel_id","title":"channel_id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-name","title":"name"},{"id":"response-data-0-icon_url","title":"icon_url"},{"id":"response-data-0-chat_id","title":"chat_id"},{"id":"response-data-0-chat_linked","title":"chat_linked Whether the group has an iMessage conversation on at least one of your numbers."},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-data-0-members","title":"members"},{"id":"response-data-0-members-0-identity_id","title":"identity_id"},{"id":"response-data-0-members-0-contact_id","title":"contact_id"},{"id":"response-data-0-members-0-role","title":"role"},{"id":"response-data-0-members-0-channel_type","title":"channel_type"},{"id":"response-data-0-members-0-identifier","title":"identifier"},{"id":"response-data-0-members-0-name","title":"name The member's contact name. `null` when none is on file."},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/createGroup","title":"Create group","href":"/reference/v4/groups/createGroup","group":"Groups · v4","method":"POST","version":"v4","keywords":"$4c","text":"$4d","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-channel_id","title":"channel_id Must be a group-capable channel (blooio/whatsapp)."},{"id":"body-members","title":"members Member phone numbers (E.164) or emails, each given as a string or an object `{ \""},{"id":"body-members-0-identifier","title":"identifier"},{"id":"body-name","title":"name"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Group id (grp_...)."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-name","title":"name"},{"id":"response-data-icon_url","title":"icon_url"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-chat_linked","title":"chat_linked Whether the group has an iMessage conversation on at least one of your numbers."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-members","title":"members"},{"id":"response-data-members-0-identity_id","title":"identity_id"},{"id":"response-data-members-0-contact_id","title":"contact_id"},{"id":"response-data-members-0-role","title":"role"},{"id":"response-data-members-0-channel_type","title":"channel_type"},{"id":"response-data-members-0-identifier","title":"identifier"},{"id":"response-data-members-0-name","title":"name The member's contact name. `null` when none is on file."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/getGroup","title":"Get group","href":"/reference/v4/groups/getGroup","group":"Groups · v4","method":"GET","version":"v4","keywords":"get group get a group get /groups/{groupid} getgroup v4 a group id that was merged into another group on its first send (see create a group) returns the surviving group. compare the returned `id` with the one you asked for to pick up the canonical id. ","text":"Get a group A group id that was merged into another group on its first send (see Create a group) returns the surviving group. Compare the returned with the one you asked for to pick up the canonical id. /groups/{groupId} groupId Unique identifier of the group, prefixed with . Returned by the List groups endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group, prefixed with `grp_`. Returned by the List group"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Group id (grp_...)."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-name","title":"name"},{"id":"response-data-icon_url","title":"icon_url"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-chat_linked","title":"chat_linked Whether the group has an iMessage conversation on at least one of your numbers."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-members","title":"members"},{"id":"response-data-members-0-identity_id","title":"identity_id"},{"id":"response-data-members-0-contact_id","title":"contact_id"},{"id":"response-data-members-0-role","title":"role"},{"id":"response-data-members-0-channel_type","title":"channel_type"},{"id":"response-data-members-0-identifier","title":"identifier"},{"id":"response-data-members-0-name","title":"name The member's contact name. `null` when none is on file."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/updateGroup","title":"Update group","href":"/reference/v4/groups/updateGroup","group":"Groups · v4","method":"PATCH","version":"v4","keywords":"update group update a group patch /groups/{groupid} updategroup v4 name","text":"name Update a group /groups/{groupId} groupId Unique identifier of the group, prefixed with . Returned by the List groups endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group, prefixed with `grp_`. Returned by the List group"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-name","title":"name"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Group id (grp_...)."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-name","title":"name"},{"id":"response-data-icon_url","title":"icon_url"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-chat_linked","title":"chat_linked Whether the group has an iMessage conversation on at least one of your numbers."},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-members","title":"members"},{"id":"response-data-members-0-identity_id","title":"identity_id"},{"id":"response-data-members-0-contact_id","title":"contact_id"},{"id":"response-data-members-0-role","title":"role"},{"id":"response-data-members-0-channel_type","title":"channel_type"},{"id":"response-data-members-0-identifier","title":"identifier"},{"id":"response-data-members-0-name","title":"name The member's contact name. `null` when none is on file."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/deleteGroup","title":"Delete group","href":"/reference/v4/groups/deleteGroup","group":"Groups · v4","method":"DELETE","version":"v4","keywords":"delete group delete a group delete /groups/{groupid} deletegroup v4 ","text":"Delete a group /groups/{groupId} groupId Unique identifier of the group, prefixed with . Returned by the List groups endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group, prefixed with `grp_`. Returned by the List group"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-deleted","title":"deleted"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/setGroupIcon","title":"Set group icon","href":"/reference/v4/groups/setGroupIcon","group":"Groups · v4","method":"POST","version":"v4","keywords":"set group icon set group icon post /groups/{groupid}/icon setgroupicon v4 uploads a group icon. max 10mb; image/jpeg|png|gif|webp|heic|heif. requires the group chat to be linked on a device. icon","text":"icon Set group icon Uploads a group icon. Max 10MB; image/jpeg|png|gif|webp|heic|heif. Requires the group chat to be linked on a device. /groups/{groupId}/icon groupId Unique identifier of the group, prefixed with . Returned by the List groups endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group, prefixed with `grp_`. Returned by the List group"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-icon","title":"icon"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-icon_url","title":"icon_url"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/removeGroupIcon","title":"Remove group icon","href":"/reference/v4/groups/removeGroupIcon","group":"Groups · v4","method":"DELETE","version":"v4","keywords":"remove group icon remove group icon delete /groups/{groupid}/icon removegroupicon v4 ","text":"Remove group icon /groups/{groupId}/icon groupId Unique identifier of the group, prefixed with . Returned by the List groups endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group, prefixed with `grp_`. Returned by the List group"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-removed","title":"removed"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/groups/listGroupMembers","title":"List group members","href":"/reference/v4/groups/listGroupMembers","group":"Groups · v4","method":"GET","version":"v4","keywords":"list group members list group members get /groups/{groupid}/members listgroupmembers v4 for a merged group id, lists the members of the surviving group. ","text":"List group members For a merged group id, lists the members of the surviving group. /groups/{groupId}/members groupId Unique identifier of the group, prefixed with . Returned by the List groups endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-groupid","title":"groupId Unique identifier of the group, prefixed with `grp_`. Returned by the List group"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-identity_id","title":"identity_id"},{"id":"response-data-0-contact_id","title":"contact_id"},{"id":"response-data-0-role","title":"role"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-identifier","title":"identifier"},{"id":"response-data-0-name","title":"name The member's contact name. `null` when none is on file."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/webhooks","title":"Webhooks","href":"/reference/v4/webhooks","group":"API Reference · v4","version":"v4","keywords":"webhooks webhook subscriptions and delivery attempts for inbound + lifecycle events. v4","text":"Webhook subscriptions and delivery attempts for inbound + lifecycle events."},{"id":"v4:/reference/v4/webhooks/listWebhooks","title":"List webhooks","href":"/reference/v4/webhooks/listWebhooks","group":"Webhooks · v4","method":"GET","version":"v4","keywords":"list webhooks list webhooks get /webhooks listwebhooks v4 ","text":"List webhooks /webhooks limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Webhook id (wh_...)."},{"id":"response-data-0-url","title":"url"},{"id":"response-data-0-event_types","title":"event_types The events this webhook receives. `[\"*\"]` for every webhook created since event"},{"id":"response-data-0-status","title":"status"},{"id":"response-data-0-scope","title":"scope Which lines this subscription receives events for. `organization` covers every l"},{"id":"response-data-0-api_key","title":"api_key The owning API key when `scope` is `api_key`, otherwise null."},{"id":"response-data-0-integration_id","title":"integration_id The owning integration when `scope` is `integration`, otherwise null."},{"id":"response-data-0-channel_id","title":"channel_id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-api_version","title":"api_version The payload version this subscription receives, also sent as `api_version` in ev"},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/createWebhook","title":"Create webhook","href":"/reference/v4/webhooks/createWebhook","group":"Webhooks · v4","method":"POST","version":"v4","keywords":"create webhook create a webhook post /webhooks createwebhook v4 subscribes an https endpoint to events. returns the signing secret once, on creation. url https endpoint. event_types retired. every webhook receives every event; filter by `type` in your handler. omit this field, or send `[\"*\"]`. any narrower value is rejected with 422 `event_types_retired`. subscriptions created be api_key scope the subscription to the lines this api key owns. omit `api_key` and `integration_id` for an organization-wide subscription that receives events from every line. must belong to your organization; integration_id scope the subscription to the lines this integration owns. mutually exclusive with `api_key`. channel_id channel_type blooio twilio whatsapp whatsapp_business rcs_business amb api_version the payload version to deliver. defaults to the latest. anything not listed by `get /webhooks/versions` is rejected with 422 `invalid_api_version`, whose `details.supported_versions` lists the accepte 2026-10-01 2026-09-01","text":"$4e","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-url","title":"url HTTPS endpoint."},{"id":"body-event_types","title":"event_types Retired. Every webhook receives every event; filter by `type` in your handler. O"},{"id":"body-api_key","title":"api_key Scope the subscription to the lines this API key owns. Omit `api_key` and `integ"},{"id":"body-integration_id","title":"integration_id Scope the subscription to the lines this integration owns. Mutually exclusive wi"},{"id":"body-channel_id","title":"channel_id"},{"id":"body-channel_type","title":"channel_type"},{"id":"body-api_version","title":"api_version The payload version to deliver. Defaults to the latest. Anything not listed by `"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Webhook id (wh_...)."},{"id":"response-data-url","title":"url"},{"id":"response-data-event_types","title":"event_types The events this webhook receives. `[\"*\"]` for every webhook created since event"},{"id":"response-data-status","title":"status"},{"id":"response-data-scope","title":"scope Which lines this subscription receives events for. `organization` covers every l"},{"id":"response-data-api_key","title":"api_key The owning API key when `scope` is `api_key`, otherwise null."},{"id":"response-data-integration_id","title":"integration_id The owning integration when `scope` is `integration`, otherwise null."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-api_version","title":"api_version The payload version this subscription receives, also sent as `api_version` in ev"},{"id":"response-data-created_at","title":"created_at"},{"id":"response-data-signing_secret","title":"signing_secret Returned once, on creation. Store it to verify signatures."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/listWebhookVersions","title":"List webhook versions","href":"/reference/v4/webhooks/listWebhookVersions","group":"Webhooks · v4","method":"GET","version":"v4","keywords":"list webhook versions list webhook payload versions get /webhooks/versions listwebhookversions v4 every payload version a subscription can be set to, newest first, with what each one changed. new subscriptions default to the version marked `latest`. set a subscription's version with `api_version` on create or update. ","text":"List webhook payload versions Every payload version a subscription can be set to, newest first, with what each one changed. New subscriptions default to the version marked . Set a subscription's version with on create or update. /webhooks/versions","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-version","title":"version A webhook payload version, as a release date. `2026-10-01` is the latest."},{"id":"response-data-0-latest","title":"latest True for exactly one version: the one new subscriptions get."},{"id":"response-data-0-released_at","title":"released_at"},{"id":"response-data-0-summary","title":"summary"},{"id":"response-data-0-changes","title":"changes What this version changed relative to the one before it. Empty for the baseline."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/getWebhook","title":"Get webhook","href":"/reference/v4/webhooks/getWebhook","group":"Webhooks · v4","method":"GET","version":"v4","keywords":"get webhook get a webhook get /webhooks/{webhookid} getwebhook v4 ","text":"Get a webhook /webhooks/{webhookId} webhookId Unique identifier of the webhook subscription, prefixed with . Returned when you create a webhook or by the List webhooks endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_`. Returned whe"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Webhook id (wh_...)."},{"id":"response-data-url","title":"url"},{"id":"response-data-event_types","title":"event_types The events this webhook receives. `[\"*\"]` for every webhook created since event"},{"id":"response-data-status","title":"status"},{"id":"response-data-scope","title":"scope Which lines this subscription receives events for. `organization` covers every l"},{"id":"response-data-api_key","title":"api_key The owning API key when `scope` is `api_key`, otherwise null."},{"id":"response-data-integration_id","title":"integration_id The owning integration when `scope` is `integration`, otherwise null."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-api_version","title":"api_version The payload version this subscription receives, also sent as `api_version` in ev"},{"id":"response-data-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/updateWebhook","title":"Update webhook","href":"/reference/v4/webhooks/updateWebhook","group":"Webhooks · v4","method":"PATCH","version":"v4","keywords":"update webhook update a webhook patch /webhooks/{webhookid} updatewebhook v4 updates url, status (`active`/`disabled`), or the payload `api_version`. a version change applies to the next event delivered; deliveries already made, and replays of them, keep the version they were sent with. url event_types retired. omit this field to leave an existing subscription's frozen list untouched; sending anything narrower than `[\"*\"]` is rejected with 422 `event_types_retired`. status active disabled api_version move the subscription to another payload version, for example to upgrade after updating your handler. takes effect from the next event. unsupported values are rejected with 422 `invalid_api_version`. 2026-10-01 2026-09-01","text":"$4f","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_`. Returned whe"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-url","title":"url"},{"id":"body-event_types","title":"event_types Retired. Omit this field to leave an existing subscription's frozen list untouch"},{"id":"body-status","title":"status"},{"id":"body-api_version","title":"api_version Move the subscription to another payload version, for example to upgrade after u"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Webhook id (wh_...)."},{"id":"response-data-url","title":"url"},{"id":"response-data-event_types","title":"event_types The events this webhook receives. `[\"*\"]` for every webhook created since event"},{"id":"response-data-status","title":"status"},{"id":"response-data-scope","title":"scope Which lines this subscription receives events for. `organization` covers every l"},{"id":"response-data-api_key","title":"api_key The owning API key when `scope` is `api_key`, otherwise null."},{"id":"response-data-integration_id","title":"integration_id The owning integration when `scope` is `integration`, otherwise null."},{"id":"response-data-channel_id","title":"channel_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-api_version","title":"api_version The payload version this subscription receives, also sent as `api_version` in ev"},{"id":"response-data-created_at","title":"created_at"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/deleteWebhook","title":"Delete webhook","href":"/reference/v4/webhooks/deleteWebhook","group":"Webhooks · v4","method":"DELETE","version":"v4","keywords":"delete webhook delete a webhook delete /webhooks/{webhookid} deletewebhook v4 ","text":"Delete a webhook /webhooks/{webhookId} webhookId Unique identifier of the webhook subscription, prefixed with . Returned when you create a webhook or by the List webhooks endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_`. Returned whe"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-deleted","title":"deleted"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/listWebhookDeliveries","title":"List webhook deliveries","href":"/reference/v4/webhooks/listWebhookDeliveries","group":"Webhooks · v4","method":"GET","version":"v4","keywords":"list webhook deliveries list webhook deliveries get /webhooks/{webhookid}/deliveries listwebhookdeliveries v4 recent delivery attempts for a webhook. also available at `/webhooks/{webhookid}/logs`. ","text":"List webhook deliveries Recent delivery attempts for a webhook. Also available at . /webhooks/{webhookId}/deliveries webhookId Unique identifier of the webhook subscription, prefixed with . Returned when you create a webhook or by the List webhooks endpoint. limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_`. Returned whe"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Delivery id (wdel_...)."},{"id":"response-data-0-webhook_id","title":"webhook_id"},{"id":"response-data-0-event_id","title":"event_id"},{"id":"response-data-0-event_type","title":"event_type"},{"id":"response-data-0-status","title":"status"},{"id":"response-data-0-attempt_count","title":"attempt_count"},{"id":"response-data-0-response_status","title":"response_status"},{"id":"response-data-0-last_attempt_at","title":"last_attempt_at"},{"id":"response-data-0-next_attempt_at","title":"next_attempt_at"},{"id":"response-data-0-created_at","title":"created_at"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/replayWebhookDelivery","title":"Replay webhook delivery","href":"/reference/v4/webhooks/replayWebhookDelivery","group":"Webhooks · v4","method":"POST","version":"v4","keywords":"replay webhook delivery replay a webhook delivery post /webhooks/{webhookid}/deliveries/{deliveryid}/replay replaywebhookdelivery v4 re-sends a past delivery. also available at `/webhooks/{webhookid}/logs/{deliveryid}/replay`. ","text":"Replay a webhook delivery Re sends a past delivery. Also available at . /webhooks/{webhookId}/deliveries/{deliveryId}/replay webhookId Unique identifier of the webhook subscription, prefixed with . Returned when you create a webhook or by the List webhooks endpoint. deliveryId Unique identifier of the webhook delivery attempt, prefixed with . Returned by the List webhook deliveries endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_`. Returned whe"},{"id":"path-deliveryid","title":"deliveryId Unique identifier of the webhook delivery attempt, prefixed with `wdel_`. Return"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-replay_of","title":"replay_of"},{"id":"response-data-status","title":"status"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/webhooks/rotateWebhookSecret","title":"Rotate webhook secret","href":"/reference/v4/webhooks/rotateWebhookSecret","group":"Webhooks · v4","method":"POST","version":"v4","keywords":"rotate webhook secret rotate webhook signing secret post /webhooks/{webhookid}/secret/rotate rotatewebhooksecret v4 rotates and returns a new signing secret (once). ","text":"Rotate webhook signing secret Rotates and returns a new signing secret (once). /webhooks/{webhookId}/secret/rotate webhookId Unique identifier of the webhook subscription, prefixed with . Returned when you create a webhook or by the List webhooks endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-webhookid","title":"webhookId Unique identifier of the webhook subscription, prefixed with `wh_`. Returned whe"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id"},{"id":"response-data-signing_secret","title":"signing_secret"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/events","title":"Events","href":"/reference/v4/events","group":"API Reference · v4","version":"v4","keywords":"events unified activity feed across messages, polls, groups, reactions, typing, payments, and messaging-safety state changes. v4","text":"Unified activity feed across messages, polls, groups, reactions, typing, payments, and messaging safety state changes."},{"id":"v4:/reference/v4/events/listEvents","title":"List events","href":"/reference/v4/events/listEvents","group":"Events · v4","method":"GET","version":"v4","keywords":"list events list events get /events listevents v4 unified activity feed (message lifecycle, polls, groups, reactions, typing, payments, `safety.state_changed`, `safety.number_banned`). filter by type, chat, or message. ","text":"List events Unified activity feed (message lifecycle, polls, groups, reactions, typing, payments, , ). Filter by type, chat, or message. /events type Event type or wildcard, e.g. or . chat id message id limit Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with to paginate. cursor Opaque pagination cursor. Pass the value from a previous response to fetch the next page; omit it on the first request.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-type","title":"type Event type or wildcard, e.g. `message.received` or `message.*`."},{"id":"query-chat_id","title":"chat_id"},{"id":"query-message_id","title":"message_id"},{"id":"query-limit","title":"limit Maximum number of items to return per page. Must be between 1 and 200; defaults"},{"id":"query-cursor","title":"cursor Opaque pagination cursor. Pass the `next_cursor` value from a previous response"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-id","title":"id Event id (evt_...)."},{"id":"response-data-0-type","title":"type e.g. message.delivered, poll.voted."},{"id":"response-data-0-message_id","title":"message_id"},{"id":"response-data-0-chat_id","title":"chat_id"},{"id":"response-data-0-channel_type","title":"channel_type"},{"id":"response-data-0-occurred_at","title":"occurred_at"},{"id":"response-data-0-data","title":"data `typing.*`, `contact.shared`, `message.reaction`, `poll.*` and `group.*` carry t"},{"id":"response-has_more","title":"has_more"},{"id":"response-next_cursor","title":"next_cursor"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/events/getEvent","title":"Get event","href":"/reference/v4/events/getEvent","group":"Events · v4","method":"GET","version":"v4","keywords":"get event get an event get /events/{eventid} getevent v4 ","text":"Get an event /events/{eventId} eventId Unique identifier of the event, prefixed with . Returned by the List events endpoint.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:0",{"id":"path-eventid","title":"eventId Unique identifier of the event, prefixed with `evt_`. Returned by the List event"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-id","title":"id Event id (evt_...)."},{"id":"response-data-type","title":"type e.g. message.delivered, poll.voted."},{"id":"response-data-message_id","title":"message_id"},{"id":"response-data-chat_id","title":"chat_id"},{"id":"response-data-channel_type","title":"channel_type"},{"id":"response-data-occurred_at","title":"occurred_at"},{"id":"response-data-data","title":"data `typing.*`, `contact.shared`, `message.reaction`, `poll.*` and `group.*` carry t"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/phone-numbers","title":"Phone Numbers","href":"/reference/v4/phone-numbers","group":"API Reference · v4","version":"v4","keywords":"phone numbers phone number lookup and geocoding (enterprise plans). v4","text":"Phone number lookup and geocoding (enterprise plans)."},{"id":"v4:/reference/v4/phone-numbers/batchLookupPhoneNumbers","title":"Batch lookup phone numbers","href":"/reference/v4/phone-numbers/batchLookupPhoneNumbers","group":"Phone Numbers · v4","method":"POST","version":"v4","keywords":"batch lookup phone numbers batch phone number lookup post /phone-numbers/batch batchlookupphonenumbers v4 looks up up to 100 phone numbers. requires an enterprise plan. numbers","text":"numbers Batch phone number lookup Looks up up to 100 phone numbers. Requires an enterprise plan. /phone numbers/batch","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-numbers","title":"numbers"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/phone-numbers/lookupPhoneNumber","title":"Lookup phone number","href":"/reference/v4/phone-numbers/lookupPhoneNumber","group":"Phone Numbers · v4","method":"GET","version":"v4","keywords":"lookup phone number look up a phone number get /phone-numbers/lookup lookupphonenumber v4 returns parsed info / geocoding for a phone number. requires an enterprise plan. ","text":"Look up a phone number Returns parsed info / geocoding for a phone number. Requires an enterprise plan. /phone numbers/lookup number Phone number in E.164.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:80:sections:1",{"id":"query-number","title":"number Phone number in E.164."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:/reference/v4/phone-numbers/lookupPhoneNumberPost","title":"Lookup phone number post","href":"/reference/v4/phone-numbers/lookupPhoneNumberPost","group":"Phone Numbers · v4","method":"POST","version":"v4","keywords":"lookup phone number post look up a phone number (post) post /phone-numbers/lookup lookupphonenumberpost v4 same as the get form, accepting the number in a json body. returns parsed info / geocoding for a phone number. requires an enterprise plan. number phone number in e.164.","text":"number Phone number in E.164. Look up a phone number (POST) Same as the GET form, accepting the number in a JSON body. Returns parsed info / geocoding for a phone number. Requires an enterprise plan. /phone numbers/lookup Phone number in E.164.","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:74:sections:3",{"id":"body-number","title":"number Phone number in E.164."},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},"$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:26"]},{"id":"v4:tag:/reference/v4/api-keys","title":"API Keys","href":"/reference/v4/api-keys","group":"API Reference · v4","version":"v4","keywords":"api keys programmatic api key management — create keys, list them, deprecate them, and assign them to channels.\n\n**blooio apps (oauth) only.** every endpoint under this tag is callable *only* with a blooio apps oauth access token (`blo_at_...`) whose install was granted the `apikeys:read` / `apikeys:manage` scopes. api-key and dashboard authentication are rejected with `403 oauth_token_required`. this mirrors the api-key management that has always lived in the dashboard, exposed to installed apps under explicit user consent. v4","text":"Programmatic API key management — create keys, list them, deprecate them, and assign them to channels. Blooio Apps (OAuth) only. Every endpoint under this tag is callable only with a Blooio Apps OAuth access token ( ) whose install was granted the / scopes. API key and dashboard authentication are rejected with . This mirrors the API key management that has always lived in the dashboard, exposed to installed apps under explicit user consent."},{"id":"v4:/reference/v4/api-keys/listApiKeys","title":"List API keys","href":"/reference/v4/api-keys/listApiKeys","group":"API Keys · v4","method":"GET","version":"v4","keywords":"list api keys list api keys get /api-keys listapikeys v4 lists the installed organization's api keys with their metadata (name, type, expiry, blocked/deprecated state). the raw key values are returned so the app can reuse them.\n\n**blooio apps (oauth) only.** requires the `apikeys:read` scope. api-key and dashboard authentication are rejected with `403 oauth_token_required`. ","text":"List API keys Lists the installed organization's API keys with their metadata (name, type, expiry, blocked/deprecated state). The raw key values are returned so the app can reuse them. Blooio Apps (OAuth) only. Requires the scope. API key and dashboard authentication are rejected with . /api keys","sections":["$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:0","$0:f:0:1:0:props:children:1:props:children:1:props:children:props:searchIndex:71:sections:1",{"id":"response-data","title":"data"},{"id":"response-data-0-api_key","title":"api_key The secret key value (prefixed `api_`). Send it as `Authorization: Bearer