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.

By default an eligible Sendblue line in the group is selected automatically. Pass from_number to require a specific Sendblue line: it must have an iMessage mapping for this group, and if that line cannot act the request fails without falling back to another line. The success response reports the line that performed the change as from_number.

Path ParametersExpand Collapse

group_id: string

Body ParametersJSONExpand Collapse

group_name: string

New group name; whitespace-only values are rejected, while null or an empty string clears it

maxLength255

from_number: optional string

Sendblue line that must perform the change; it must have an iMessage mapping for this group, and no other line is used if it cannot act. Omit or pass null for automatic selection

ReturnsExpand Collapse

data: object { from_number, group_id, group_name }

from_number: string

Sendblue line that performed the change

group_id: string

group_name: string

Device-verified name; empty when cleared

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 '{
          "group_name": "Project Falcon",
          "from_number": "+15551234567"
        }'

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

Returns Examples

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