Delete

API Reference

Contacts

Bulk

Delete multiple contacts

client.contacts.bulk.delete(BulkDeleteParams { contact_ids } body, RequestOptionsoptions?): 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

typescript

• http
• typescript
• python

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"
}

Returns Examples

200 example

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