Delete multiple contacts

client.contacts.bulk.delete(, ?): BulkDeleteResponse { amount, status }

DELETE/api/v2/contacts

Delete multiple contacts by their IDs

ParametersExpand Collapse

body: BulkDeleteParams { contact_ids }

contact_ids: Array<string>

Array of phone numbers in E.164 format to delete

ReturnsExpand Collapse

BulkDeleteResponse { amount, status }

amount?: number

Number of contacts deleted

status?: string

Delete multiple contacts

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 bulk = await client.contacts.bulk.delete({ contact_ids: ['+1234567890', '+0987654321'] });

console.log(bulk.amount);

{
  "amount": 0,
  "status": "OK"
}

Returns Examples

{
  "amount": 0,
  "status": "OK"
}