get https://api.brevo.com/v3/smtp/blockedContacts
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 = {
'startDate': "2021-01-01",
'endDate': "2021-01-01",
'limit': 50,
'offset': 0,
'senders': ["[email protected]"]
};
apiInstance.getTransacBlockedContacts(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, 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
);
$startDate = '2021-01-01';
$endDate = '2021-01-01';
$limit = 50;
$offset = 0;
$senders = array('[email protected]');
try {
$result = $apiInstance->getTransacBlockedContacts($startDate, $endDate, $limit, $offset, $senders);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TransactionalEmailsApi->getTransacBlockedContacts: ', $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'
limit = 50
offset = 0
senders = ['[email protected]']
try:
api_response = api_instance.get_transac_blocked_contacts(start_date=start_date, end_date=end_date, limit=limit, offset=offset, senders=senders)
pprint(api_response)
except ApiException as e:
print("Exception when calling SMTPApi->get_transac_blocked_contacts: %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 startDate = "2021-01-01";
let endDate = "2021-01-01";
let limit = 50;
let offset = 0;
let senders = ["[email protected]"]
apiInstance.getTransacBlockedContacts(startDate, endDate, limit, offset, senders).then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
console.error(error);
});
package sibApi;
import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
import sibModel.*;
import java.util.*;
import java.util.List;
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();
String startDate = "2020-01-30";
String endDate = "2020-04-06";
Long limit = 50l;
Long offset = 0l;
List<String> senders = new ArrayList<String>();
senders.add("[email protected]");
String sort = null;
GetTransacBlockedContacts response = api.getTransacBlockedContacts(startDate, endDate, limit, offset, senders, sort);
System.out.println(response.toString());
} 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;
using System.Collections.Generic;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new TransactionalEmailsApi();
string startDate = "2020-04-01";
string endDate = "2020-04-30";
Long limit = 50L;
Long offset = 0L;
ListsString> senders = new List<string>();
senders.Add("[email protected]");
try
{
GetTransacBlockedContacts result = apiInstance.GetTransacBlockedContacts(startDate, endDate, limit, offset, senders);
Debug.WriteLine(result.ToJson());
Console.WriteLine(result.ToJson());
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"
"github.com/antihax/optional"
)
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 := &TransactionalEmailsApiGetTransacBlockedContactsOpts{
Limit: optional.NewInt64(50),
Offset: optional.NewInt64(0),
StartDate: optional.NewString("2013-10-20"),
EndDate: optional.NewString("2013-10-20"),
Senders: []string{"[email protected]",},
}
blockedModel, resp, err := sib.TransactionalEmailsApi.GetTransacBlockedContacts(ctx, body)
if err!=nil{
fmt.Println("Error in GetTransacBlockedContacts ",err.Error())
return
}
fmt.Println( "GetTransacBlockedContacts, response:",resp," GetTransacBlockedContacts object",blockedModel)
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 = {
start_date: '2021-01-01', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
end_date: '2021-01-02', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
limit: 50, # Integer | Number of documents returned per page
offset: 0, # Integer | Index of the first document on the page
senders: ['[email protected]'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}
begin
#Get the list of blocked or unsubscribed transactional contacts
result = api_instance.get_transac_blocked_contacts(opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling TransactionalEmailsApi->get_transac_blocked_contacts: #{e}"
end