Modify a group

client.groups.modify(, ?): GroupModifyResponse { message, status }

POST/api/modify-group

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

ParametersExpand Collapse

body: GroupModifyParams { group_id, modify_type, number }

group_id: string

Group identifier

modify_type: "add_recipient"

Type of modification to perform

number: string

Phone number to add/modify in E.164 format

ReturnsExpand Collapse

GroupModifyResponse { message, status }

message?: string

status?: string

Modify a group

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

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

console.log(response.message);

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

Returns Examples

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