Rename or clear an iMessage group

POST/api/v2/groups/{group_id}/name

Changes the Apple-visible name of an existing iMessage group and waits for the Sendblue line to verify the resulting state. Pass null or an empty string to clear the name. The verified value is persisted as the group’s group_name.

The group must already have an iMessage chat, and the Sendblue line serving it must be online and support group name changes. Failed requests are not replayed automatically; retrying the same desired state is safe.

Path ParametersExpand Collapse

group_id: string

Body ParametersJSONExpand Collapse

name: string

New group name, or null/empty string to clear it

maxLength255

ReturnsExpand Collapse

data: object { group_id, group_name, service }

group_id: string

group_name: string

Device-verified name; empty when cleared

service: "iMessage"

status: "OK"

Rename or clear an iMessage group

curl https://api.sendblue.co/api/v2/groups/$GROUP_ID/name \
    -H 'Content-Type: application/json' \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET" \
    -d '{
          "name": "Project Falcon"
        }'

{
  "data": {
    "group_id": "sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455",
    "group_name": "Project Falcon",
    "service": "iMessage"
  },
  "status": "OK"
}

Returns Examples

{
  "data": {
    "group_id": "sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455",
    "group_name": "Project Falcon",
    "service": "iMessage"
  },
  "status": "OK"
}