Modify

API Reference

Groups

Modify a group

client.groups.modify(GroupModifyParamsbody, RequestOptionsoptions?): messagestringstatusstringGroupModifyResponse

post/api/modify-group

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

Parameters

bodygroup_idstringmodify_type"add_recipient"numberstringGroupModifyParams

Hide ParametersShow Parameters

group_idstring

Group identifier

modify_type"add_recipient"

Type of modification to perform

Hide ParametersShow Parameters

"add_recipient"

numberstring

Phone number to add/modify in E.164 format

Returns

GroupModifyResponse

Hide ParametersShow Parameters

messagestring

optional

statusstring

optional

HTTPTypeScript

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const response = await client.groups.modify({
  group_id: 'group_123456',
  modify_type: 'add_recipient',
  number: '+19998887777',
});

console.log(response.message);

200 Example

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