Modify a group

POST/api/modify-group

Add an external participant to, or remove one from, an existing iMessage group chat (beta feature). Success is reported only after the change is verified on the device: the group’s persisted membership changed and Sendblue’s participant state matches it. Removal requires the group to have at least four total members before the operation and does not require the group’s creator. Only iMessage groups are supported.

Body ParametersJSONExpand Collapse

group_id: string

Group identifier

modify_type: "add_recipient" or "remove_recipient"

Type of modification to perform

One of the following:

"add_recipient"

"remove_recipient"

number: string

External participant to add or remove, in E.164 format (or an iMessage email address). Company-owned lines cannot be added or removed.

from_number: optional string

The Sendblue line to act from. It must belong to the account and already be a participant of the group. Free API accounts must provide it. Other accounts may omit it only when exactly one account line participates in the group. With no participating account line the request fails with line_not_registered; with multiple lines it fails with ambiguous_sending_line. No change is attempted in either case.

ReturnsExpand Collapse

error: optional string

error_message: optional string

group_id: optional string

modify_type: optional string

number: optional string

status: optional string

Modify a group

curl https://api.sendblue.co/api/modify-group \
    -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_id": "group_123456",
          "modify_type": "add_recipient",
          "number": "+19998887777",
          "from_number": "+15550001111"
        }'

{
  "error": null,
  "error_message": null,
  "group_id": "group_123456",
  "modify_type": "add_recipient",
  "number": "+19998887777",
  "status": "SUCCESS"
}

Returns Examples

{
  "error": null,
  "error_message": null,
  "group_id": "group_123456",
  "modify_type": "add_recipient",
  "number": "+19998887777",
  "status": "SUCCESS"
}