Delete a contact

client.contacts.delete(, ?): 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: 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 contact = await client.contacts.delete('+1234567890');

console.log(contact.status);

{
  "status": "OK"
}

Returns Examples

{
  "status": "OK"
}