Groupsv2

Create a group

POST/groups

Create a new group. There are two modes:

1. Link to existing iMessage chat: Provide chat_guid to join an existing group chat that was created outside the API. The members list records who is in the group but does NOT add them to the linked iMessage chat. Multiple groups can have the same participants if they have different chat_guids.

2. Create new group: Omit chat_guid to create a new group. When you send the first message, a new iMessage chat will be created. Note: iMessage only allows one chat per unique participant set when created via API.

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

nameRequiredstring

Group name (max 255 characters)

chat_guidoptionalstring

BlueBubbles chat GUID to link this group to an existing iMessage chat. Use this to join groups created elsewhere. You can get this from the BlueBubbles API or from inbound message webhooks.

membersoptionalstring[]

Phone numbers or emails of contacts in the group. When linking via chat_guid, this is for record-keeping only (members are not added to the linked iMessage chat).

Returns

group_idoptionalstring

nameoptionalstring | null

Group name. Null for unnamed groups.

chat_guidoptionalstring | null

BlueBubbles chat GUID if linked to a device group chat

icon_urloptionalstring | null

URL of the group icon/photo

member_countoptionalinteger

message_countoptionalinteger

Total number of messages in this group

last_message_textoptionalstring | null

Text of the most recent message in the group

last_message_timeoptionalinteger | null

Timestamp of the most recent message

last_message_directionoptionalstring

Direction of the most recent message

"inbound""outbound"

created_atoptionalinteger

added_membersoptionalstring[]

List of member identifiers that were added to the group

created_contactsoptionalstring[]

List of contacts that were auto-created

Response codes

201Group created

400Invalid request parameters

401Authentication required or invalid

409Conflict. Either: (1) A group with this chat_guid already exists, or (2) A group with the same participants already exists on this allocation.

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/v2/api/groups \  -H "Authorization: Bearer bl_live_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Sales Team",    "chat_guid": "iMessage;+;chat123456789",    "members": [      "+15551234567",      "+15559876543"    ]  }'

Body object

{  "name": "Sales Team",  "chat_guid": "iMessage;+;chat123456789",  "members": [    "+15551234567",    "+15559876543"  ]}

Response objectexample

{  "group_id": "grp_a1b2c3d4",  "name": "Jane Doe",  "chat_guid": "grp_a1b2c3d4",  "icon_url": "https://example.com",  "member_count": 3,  "message_count": 3,  "last_message_text": "string",  "last_message_time": 0,  "last_message_direction": "inbound",  "created_at": 0,  "added_members": [    "string"  ],  "created_contacts": [    "string"  ]}