Groupsv4

Create a group

POST/groups

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.

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Body parameters

JSON
channel_idRequiredstring

Must be a group-capable channel (blooio/whatsapp).

membersRequiredstring | object[]

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.

Array of string | object

string
object
identifierRequiredstring
nameoptionalstring

Returns

dataoptionalGroup
idoptionalstring

Group id (grp_...).

channel_idoptionalstring
channel_typeoptionalstring
"blooio""twilio""whatsapp""whatsapp_business""rcs_business""amb"
nameoptionalstring | null
icon_urloptionalstring | null
chat_idoptionalstring | null
chat_linkedoptionalboolean

Whether the group has an iMessage conversation on at least one of your numbers. false until the first message to the group opens one.

created_atoptionalinteger
membersoptionalGroupMember[]

Array of GroupMember

identity_idoptionalstring
contact_idoptionalstring | null
roleoptionalstring
channel_typeoptionalstring
"blooio""twilio""whatsapp""whatsapp_business""rcs_business""amb"
identifieroptionalstring
nameoptionalstring | null

The member's contact name. null when none is on file.

Response codes

201Created group
400The request was malformed — check the path, query parameters, and body.
401Your API key is missing or invalid. Pass it as a bearer token.
422Validation failed — one or more fields in the request are invalid or missing.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X POST https://api.blooio.com/v4/groups \
Body object
Response objectexample
{  "data": {    "id": "grp_a1b2c3d4",    "channel_id": "ch_a1b2c3d4",    "channel_type": "blooio",    "name": "Jane Doe",    "icon_url": "https://example.com",    "chat_id": "chat_a1b2c3d4",    "chat_linked": false,    "created_at": 0,    "members": [      {        "identity_id": "idn_a1b2c3d4",        "contact_id": "ct_a1b2c3d4",        "role": "string",        "channel_type": "blooio",        "identifier": "+15551234567",        "name": "Jane Doe"      }    ]  }}