Skip to content
  • Auto
  • Light
  • Dark
Get Started

Delete

Delete a contact
client.contacts.delete(stringphoneNumber, RequestOptionsoptions?): ContactDeleteResponse { status }
delete/api/v2/contacts/{phone_number}

Delete a specific contact

ParametersExpand Collapse
phoneNumber: string
ReturnsExpand Collapse
ContactDeleteResponse { status }
status?: string
Delete a contact
import SendblueAPI from 'sendblue';

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

const contact = await client.contacts.delete('+1234567890');

console.log(contact.status);
{
  "status": "OK"
}
Returns Examples
{
  "status": "OK"
}