Delete

API Reference

Contacts

Bulk

Delete multiple contacts

client.contacts.bulk.delete(BulkDeleteParamsbody, RequestOptionsoptions?): amountnumberstatusstringBulkDeleteResponse

delete/api/v2/contacts

Delete multiple contacts by their IDs

Parameters

bodycontact_idsarrayBulkDeleteParams

Hide ParametersShow Parameters

contact_idsarray

Array<string>

Array of phone numbers in E.164 format to delete

Returns

BulkDeleteResponse

Hide ParametersShow Parameters

amountnumber

optional

Number of contacts deleted

statusstring

optional

HTTPTypeScript

import SendblueAPI from 'sendblue';

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

const bulk = await client.contacts.bulk.delete({ contact_ids: ['+1234567890', '+0987654321'] });

console.log(bulk.amount);

200 Example

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