Modify

API Reference

Groups

Modify a group

post/api/modify-group

Add or manage participants in a group chat (beta feature)

Body ParametersExpand Collapse

group_id: string

Group identifier

modify_type: "add_recipient"

Type of modification to perform

Accepts one of the following:

"add_recipient"

number: string

Phone number to add/modify in E.164 format

ReturnsExpand Collapse

message: optional string

status: optional string

Modify a group

http

• http
• typescript
• python

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"
        }'

200 example

{
  "message": "Group modified successfully",
  "status": "OK"
}

Returns Examples

200 example

{
  "message": "Group modified successfully",
  "status": "OK"
}