Send the report of a campaign

A PDF will be sent to the specified email addresses

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 sendReport = new SibApiV3Sdk.SendReport();

sendReport = {
  "language":"en",
  "email":{
    "to":["[email protected]"],
    "contentType":"html",
    "subject":"New Subject",
    "body":"<html><body><h1>This is my first campaign</h1></body></html>"
  }
}

apiInstance.sendReport(campaignId, sendReport).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\EmailCampaignsApi(
    new GuzzleHttp\Client(),
    $config
);
$campaignId = 1;
$sendReport = new \SendinBlue\Client\Model\SendReport();
$sendReport['language'] = 'en';
$sendReport['email'] = array(
    'to' => array('[email protected]'),
  'contentType' => 'html',
  'subject' => 'New Subject',
  'body' => '<html><body><h1>This is my first campaign</h1></body></html>'
); 

try {
    $apiInstance->sendReport($campaignId, $sendReport);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->sendReport: ', $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
send_report = sib_api_v3_sdk.SendReport(language="en", email={"to":["[email protected]"],"contentType":"html","subject":"New Subject","body":"<html><body><h1>This is my first campaign</h1></body></html>"})

try:
    api_instance.send_report(campaign_id, send_report)
except ApiException as e:
    print("Exception when calling EmailCampaignsApi->send_report: %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 sendReport = new SibApiV3Sdk.SendReport();

sendReport = {
  "language":"en",
  "email":{
    "to":["[email protected]"],
    "contentType":"html",
    "subject":"New Subject",
    "body":"<html><body><h1>This is my first campaign</h1></body></html>"
  }
}

apiInstance.sendReport(campaignId, sendReport).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.*;
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 {
            EmailCampaignsApi api = new EmailCampaignsApi();
            Long campaignId = 1l;
            List<String> toEmails = new ArrayList<String>();
            toEmails.add("[email protected]");
            SendReportEmail email = new SendReportEmail();
            email.setTo(toEmails);
            email.setBody("<html><body><h1>This is my first campaign</h1></body></html>");
            SendReport sendReport = new SendReport();
            sendReport.setLanguage(SendReport.LanguageEnum.EN);
            sendReport.setEmail(email);
            api.sendReport(campaignId, sendReport);
        } 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 EmailCampaignsApi();
            long? campaignId = 1;
            SendReport.LanguageEnum language = SendReport.LanguageEnum.En;
            List<string> to = new List<string>();
            to.Add("[email protected]");
            string body = "<html><body><h1>This is my first campaign</h1></body></html>";
            SendReportEmail email = new SendReportEmail(to, body);
            try
            {
                var sendReport = new SendReport(language, email);
                apiInstance.SendReport(campaignId, sendReport);
                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 := SendReport{
        Language: "en",
        Email: &SendReportEmail{
            To:   []string{"[email protected]"},
            Body: "<html><body><h1>This is my first campaign</h1></body></html>",
        },
    }
    resp, err := sib.EmailCampaignsApi.SendReport(ctx, params, campaignId)
    if err!=nil{
        fmt.Println("Error in EmailCampaignsApi->SendReport ",err.Error())
        return
    }
    fmt.Println( "SendReport, response:",resp)
    return 
}
Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!