delete https://api.brevo.com/v3/contacts/
There are 2 ways to delete a contact
Option 1- https://api.brevo.com/v3/contacts/{identifier}
Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={}
Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.
Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute.
Code Examples
You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here
const SibApiV3Sdk = require('sib-api-v3-sdk');
let defaultClient = SibApiV3Sdk.ApiClient.instance;
let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
let apiInstance = new SibApiV3Sdk.ContactsApi();
let identifier = "[email protected]";
apiInstance.deleteContact(identifier).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
new GuzzleHttp\Client(),
$config
);
$identifier = '[email protected]';
try {
$apiInstance->deleteContact($identifier);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteContact: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
email = '[email protected]'
try:
api_instance.delete_contact(email)
except ApiException as e:
print("Exception when calling ContactsApi->delete_contact: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.ContactsApi()
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let identifier = "[email protected]";
apiInstance.deleteContact(identifier).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
package sibApi;
import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
public class Program {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
try {
ContactsApi api = new ContactsApi();
String email = "[email protected]";
api.deleteContact(email);
} catch (Exception e) {
System.out.println("Exception occurred:- " + e.getMessage());
}
}
}
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using System;
using System.Diagnostics;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new ContactsApi();
string email = "[email protected]";
try
{
apiInstance.DeleteContact(email);
Console.ReadLine();
}
catch (Exception e)
{
Debug.WriteLine(e.Message);
Console.WriteLine(e.Message);
Console.ReadLine();
}
}
}
}
package main
import (
"fmt"
"context"
sib_api_v3_sdk "./lib"
)
func main() {
var ctx context.Context
var cli = sib_api_v3_sdk.APIClient{
cfg: sib_api_v3_sdk.NewConfiguration(),
}
//Configure API key authorization: api-key
cli.cfg.AddDefaultHeader("api-key", "YOUR_API_KEY")
sib := sib_api_v3_sdk.NewAPIClient(cli.cfg)
identifier := "[email protected]" //string|email identifier
resp, err := sib.ContactsApi.DeleteContact(ctx, identifier)
if err!=nil{
fmt.Println("Error in ContactsApi->DeleteContact",err.Error())
return
}
fmt.Println( "Delete contact response:",resp)
return
}
# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
# Configure API key authorization: api-key
config.api_key['api-key'] = 'YOUR API KEY'
end
api_instance = SibApiV3Sdk::ContactsApi.new
identifier = '[email protected]' # String | Email (urlencoded) OR ID of the contact
begin
#Delete a contact
api_instance.delete_contact(identifier)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ContactsApi->delete_contact: #{e}"
end