post https://api.brevo.com/v3/smtp/deleteHardbounces
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
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.TransactionalEmailsApi();
let opts = {
'deleteHardbounces': new SibApiV3Sdk.DeleteHardbounces()
};
opts.startDate = "2021-01-01";
opts.endDate = "2021-01-01";
opts.contactEmail = "[email protected]";
apiInstance.deleteHardbounces(opts).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\TransactionalEmailsApi(
new GuzzleHttp\Client(),
$config
);
$deleteHardbounces = new \SendinBlue\Client\Model\DeleteHardbounces();
$deleteHardbounces['startDate'] = '2021-01-01';
$deleteHardbounces['endDate'] = '2021-01-01';
$deleteHardbounces['contactEmail'] = '[email protected]';
try {
$apiInstance->deleteHardbounces($deleteHardbounces);
} catch (Exception $e) {
echo 'Exception when calling TransactionalEmailsApi->deleteHardbounces: ', $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.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration))
start_date = "2021-01-01"
end_date = "2021-01-01"
contact_email = "[email protected]"
delete_hardbounces = sib_api_v3_sdk.DeleteHardbounces(start_date=start_date, end_date=end_date, contact_email=contact_email) # DeleteHardbounces | values to delete hardbounces (optional)
try:
api_instance.delete_hardbounces(delete_hardbounces=delete_hardbounces)
except ApiException as e:
print("Exception when calling SMTPApi->delete_hardbounces: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.TransactionalEmailsApi();
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let deleteHardbounces = new SibApiV3Sdk.DeleteHardbounces();
deleteHardbounces.startDate = "2021-01-01";
deleteHardbounces.endDate = "2021-01-01";
deleteHardbounces.contactEmail = "[email protected]";
apiInstance.deleteHardbounces(opts).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
package sibApi;
import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
import sibModel.*;
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 {
TransactionalEmailsApi api = new TransactionalEmailsApi();
DeleteHardbounces deleteHardbounces = new DeleteHardbounces();
deleteHardbounces.setContactEmail("[email protected]");
deleteHardbounces.setStartDate("2018-12-12");
deleteHardbounces.setEndDate("2019-03-29");
api.deleteHardbounces(deleteHardbounces);
} catch (Exception e) {
System.out.println("Exception occurred:- " + e.getMessage());
}
}
}
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
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 TransactionalEmailsApi();
string startDate = "2018-12-12";
string endDate = "2019-03-29";
string contactEmail = "[email protected]";
try
{
var deleteHardbounces = new DeleteHardbounces(startDate, endDate, contactEmail);
apiInstance.DeleteHardbounces(deleteHardbounces);
Console.ReadLine();
}
catch (Exception e)
{
Debug.WriteLine(e.Message);
Console.WriteLine(e.Message);
Console.ReadLine();
}
}
}
}
type herepackage 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)
body := &TransactionalEmailsApiDeleteHardbouncesOpts{
StartDate: "2021-01-01",
EndDate: "2021-01-01",
ContactEmail: "[email protected]",
}
resp, err := sib.TransactionalEmailsApi.DeleteHardbounces(ctx, body)
if err!=nil{
fmt.Println("Error in DeleteHardbounces ",err.Error())
return
}
fmt.Println( "DeleteHardbounces, 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::TransactionalEmailsApi.new
opts = {
delete_hardbounces: SibApiV3Sdk::DeleteHardbounces.new # DeleteHardbounces | values to delete hardbounces
}
opts[:delete_hardbounces] = {
'startDate'=> '2021-01-01',
'endDate'=> '2021-01-01',
'contactEmail'=> '[email protected]'
}
begin
#Delete hardbounces
api_instance.delete_hardbounces(opts)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling TransactionalEmailsApi->delete_hardbounces: #{e}"
end