Modify a group

groups.modify() -> GroupModifyResponse

post/api/modify-group

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

ParametersExpand Collapse

group_id: str

Group identifier

modify_type: Literal["add_recipient"]

Type of modification to perform

number: str

Phone number to add/modify in E.164 format

ReturnsExpand Collapse

class GroupModifyResponse: …

message: Optional[str]

status: Optional[str]

Modify a group

import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
response = client.groups.modify(
    group_id="group_123456",
    modify_type="add_recipient",
    number="+19998887777",
)
print(response.message)

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

Returns Examples

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