Groupsv2

Update a group

PATCH/groups/{groupId}

Update a group's name. If the group already has an iMessage conversation, the conversation is renamed too.

Path parameters

groupIdRequiredstring

Unique identifier of the group chat, prefixed with grp_ (e.g. grp_abc123def456). Returned by the create-group and list-groups endpoints.

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

nameoptionalstring

New group name

Returns

group_idoptionalstring

nameoptionalstring | null

Group name. Null for unnamed groups.

chat_guidoptionalstring | null

Deprecated. An identifier for the group's iMessage conversation, kept for existing integrations. Null until the group has one. Use group_id to identify the group.

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

device_syncoptionalDeviceSyncResult

Result of syncing the operation to a linked iMessage chat

actionoptionalstring

The action that was performed for the linked chat

"add_participant""remove_participant""leave"

syncedoptionalboolean

Whether the sync was successful

erroroptionalstring | null

Error message if sync failed

Response codes

200Group updated successfully.

400Invalid request parameters

401Authentication required or invalid

404Resource not found

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

Request

curl -X PATCH https://api.blooio.com/v2/api/groups/grp_abc123def456 \

  -H "Authorization: Bearer bl_live_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Marketing Team"  }'

Body object

{  "name": "Marketing Team"}

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,  "device_sync": {    "action": "add_participant",    "synced": false,    "error": "string"  }}