Send a template to your test list

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 templateId = 1; 

let sendTestEmail = new SibApiV3Sdk.SendTestEmail(); 

sendTestEmail.emailTo = ["[email protected]","[email protected]"];

apiInstance.sendTestTemplate(templateId, sendTestEmail).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
);
$templateId = 1;
$sendTestEmail = new \SendinBlue\Client\Model\SendTestEmail();
$sendTestEmail['emailTo'] = array('[email protected]', '[email protected]');

try {
    $apiInstance->sendTestTemplate($templateId, $sendTestEmail);
} catch (Exception $e) {
    echo 'Exception when calling TransactionalEmailsApi->sendTestTemplate: ', $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))
template_id = 1
email_to = ["[email protected]","[email protected]"]
send_test_email = sib_api_v3_sdk.SendTestEmail(email_to=email_to)

try:
    api_instance.send_test_template(template_id, send_test_email)
except ApiException as e:
    print("Exception when calling SMTPApi->send_test_template: %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 templateId = 1;

let sendTestEmail = new SibApiV3Sdk.SendTestEmail(); 

sendTestEmail.emailTo = ["[email protected]","[email protected]"];

apiInstance.sendTestTemplate(templateId, sendTestEmail).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 {
            AllRouteExamples obj = new AllRouteExamples();
            TransactionalEmailsApi api = new TransactionalEmailsApi();
            Long templateId = 1L;
            List<String> emailTo = new ArrayList<String>();
            emailTo.add("[email protected]");
            SendTestEmail sendTestEmail = new SendTestEmail();
            sendTestEmail.setEmailTo(emailTo);
            api.sendTestTemplate(templateId, sendTestEmail);
        } 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();
            long? templateId = 1;
            List<string> emailTo = new List<string>();
            emailTo.Add("[email protected]");
            try
            {
                var sendTestEmail = new SendTestEmail(emailTo);
                apiInstance.SendTestTemplate(templateId, sendTestEmail);
                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)
	templateId := int64(5)
	body := SendTestEmail{
		EmailTo: []string{
			"[email protected]",
		},
	}
	resp, err := sib.TransactionalEmailsApi.SendTestTemplate(ctx, body, templateId)
  if err!=nil{
    fmt.Println("Error in SendTestTemplate ",err.Error())
    return
  }
	fmt.Println( "SendTestTemplate, 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

template_id = 789 # Integer | Id of the template

send_test_email = SibApiV3Sdk::SendTestEmail.new # SendTestEmail | 

send_test_email = {
  'emailTo'=> ['[email protected]','[email protected]']
}

begin
  #Send a template to your test list
  api_instance.send_test_template(template_id, send_test_email)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling TransactionalEmailsApi->send_test_template: #{e}"
end
Language
Authorization
Header
Click Try It! to start a request and see the response here!