post https://api.brevo.com/v3/emailCampaigns//exportRecipients
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.EmailCampaignsApi();
let campaignId = 1;
let opts = {
'recipientExport': new SibApiV3Sdk.EmailExportRecipients()
};
opts.recipientExport = {
"notifyURL":"https://example.com/notifyurl",
"recipientsType":"all"
};
apiInstance.emailExportRecipients(campaignId, 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\EmailCampaignsApi(
new GuzzleHttp\Client(),
$config
);
$campaignId = 1;
$recipientExport = new \SendinBlue\Client\Model\EmailExportRecipients();
$recipientExport['notifyURL'] = 'https://example.com/notifyurl';
$recipientExport['recipientsType'] = 'all';
try {
$result = $apiInstance->emailExportRecipients($campaignId, $recipientExport);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EmailCampaignsApi->emailExportRecipients: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import datetime
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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration))
campaign_id = 1
recipient_export = sib_api_v3_sdk.EmailExportRecipients(notify_url="https://example.com/notifyurl", recipients_type="all") # EmailExportRecipients | Values to send for a recipient export request (optional)
try:
api_response = api_instance.email_export_recipients(campaign_id, recipient_export=recipient_export)
pprint(api_response)
except ApiException as e:
print("Exception when calling EmailCampaignsApi->email_export_recipients: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.EmailCampaignsApi();
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let campaignId = 1;
let recipientExport = new SibApiV3Sdk.EmailExportRecipients();
recipientExport.notifyURL = "https://example.com/notifyurl";
recipientExport.recipientsType = "all";
apiInstance.emailExportRecipients(campaignId, recipientExport).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.*;
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 {
EmailCampaignsApi api = new EmailCampaignsApi();
Long campaignId = 1l;
EmailExportRecipients recipientExport = new EmailExportRecipients();
recipientExport.setNotifyURL("https://[email protected]");
recipientExport.setRecipientsType(EmailExportRecipients.RecipientsTypeEnum.ALL);
CreatedProcessId response = api.emailExportRecipients(campaignId, recipientExport);
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;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new EmailCampaignsApi();
long? campaignId = 1;
string notifyUrl = "https://[email protected]";
EmailExportRecipients.RecipientsTypeEnum recipientType = EmailExportRecipients.RecipientsTypeEnum.All;
try
{
var recipientExport = new EmailExportRecipients(notifyUrl, recipientType);
CreatedProcessId result = apiInstance.EmailExportRecipients(campaignId, recipientExport);
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"
)
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)
campaignId := int64(1)
params:= map[string]interface{}{
"notifyUrl":"https://example.com/notifyurl",
"recipientsType":"all",
}
model, resp, err := sib.EmailCampaignsApi.EmailExportRecipients(ctx, campaignId, params)
if err!=nil{
fmt.Println("Error in EmailExportRecipients ",err.Error())
return
}
fmt.Println( "EmailExportRecipients, response:",resp,"EmailExportRecipients object",model)
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::EmailCampaignsApi.new
campaign_id = 789 # Integer | Id of the campaign
opts = {
recipient_export: SibApiV3Sdk::EmailExportRecipients.new # EmailExportRecipients | Values to send for a recipient export request
}
opts[:recipient_export] = {
'notifyURL'=> 'https://example.com/notifyurl',
'recipientsType'=> 'all'
}
begin
#Export the recipients of an email campaign
result = api_instance.email_export_recipients(campaign_id, opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling EmailCampaignsApi->email_export_recipients: #{e}"
end