post https://api.brevo.com/v3/contacts/import
It returns the background process ID which on completion calls
the notify URL that you have set in the input.
Note:
- Any contact attribute that doesn't exist in your account will be ignored at import end.
Sample for fileBody:
LASTNAME | FIRSTNAME | SMS | |
---|---|---|---|
[email protected] | Smith | John | 3123456793 |
harry6#@example.com | Edmund | Harry | 3111222226 |
how#ard6#@example.com | Stern | Howard | 3777888902 |
[email protected] | Jane | Doe | 2344556681 |
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.ContactsApi();
let requestContactImport = new SibApiV3Sdk.RequestContactImport();
requestContactImport.fileBody = "EMAIL;EntitÈ;FIRSTNAME;SMS\n#johnDoÈ[email protected];John;Doe;31234567923";
requestContactImport.listIds = [2];
requestContactImport.emailBlacklist = false;
requestContactImport.smsBlacklist = false;
requestContactImport.updateExistingContacts = true;
requestContactImport.emptyContactsAttributes = false;
apiInstance.importContacts(requestContactImport).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\ContactsApi(
new GuzzleHttp\Client(),
$config
);
$requestContactImport = new \SendinBlue\Client\Model\RequestContactImport();
$requestContactImport['fileBody'] = 'EMAIL;EntitÈ;FIRSTNAME;SMS\n#johnDoÈ[email protected];John;Doe;31234567923';
$requestContactImport['listIds'] = [1];
$requestContactImport['emailBlacklist'] = false;
$requestContactImport['smsBlacklist'] = false;
$requestContactImport['updateExistingContacts'] = true;
$requestContactImport['emptyContactsAttributes'] = false;
try {
$result = $apiInstance->importContacts($requestContactImport);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->importContacts: ', $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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
request_contact_import = sib_api_v3_sdk.RequestContactImport()
request_contact_import.file_body = "EMAIL;FIRSTNAME;SMS\n#[email protected];John;Doe;31234567923"
request_contact_import.list_ids = [2]
request_contact_import.email_blacklist = False
request_contact_import.sms_blacklist = False
request_contact_import.update_existing_contacts = True
request_contact_import.empty_contacts_attributes = False
try:
api_response = api_instance.import_contacts(request_contact_import)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactsApi->import_contacts: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.ContactsApi()
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let requestContactImport = new SibApiV3Sdk.RequestContactImport();
requestContactImport.fileBody = "EMAIL;EntitÈ;FIRSTNAME;SMS\n#johnDoÈ[email protected];John;Doe;31234567923";
requestContactImport.listIds = [2];
requestContactImport.emailBlacklist = false;
requestContactImport.smsBlacklist = false;
requestContactImport.updateExistingContacts = true;
requestContactImport.emptyContactsAttributes = false;
apiInstance.importContacts(requestContactImport).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 {
ContactsApi api = new ContactsApi();
List<Long> listIds = new ArrayList<Long>();
listIds.add(2l);
RequestContactImport requestContactImport = new RequestContactImport();
requestContactImport.setFileBody("EMAIL;EntitÈ;FIRSTNAME;SMS\n#johnDoÈ[email protected];John;Doe;31234567923");
requestContactImport.setListIds(listIds);
requestContactImport.setNotifyUrl("https://[email protected]");
requestContactImport.setEmailBlacklist(false);
requestContactImport.setSmsBlacklist(false);
requestContactImport.setUpdateExistingContacts(true);
requestContactImport.setEmptyContactsAttributes(true);
CreatedProcessId response = api.importContacts(requestContactImport);
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 ContactsApi();
string fileUrl = null;
string fileBody = "EMAIL;EntitÈ;FIRSTNAME;SMS\n#johnDoÈ[email protected];John;Doe;31234567923";
List<long?> listIds = new List<long?>();
listIds.Add(2);
string notifyUrl = "https://[email protected]";
RequestContactImportNewList newList = null;
bool? emailBlacklist = false;
bool? smsBlacklist = false;
bool? updateExistingContacts = true;
bool? emptyContactsAttributes = true;
var requestContactImport = new RequestContactImport(fileUrl, fileBody, listIds, notifyUrl, newList, emailBlacklist, smsBlacklist, updateExistingContacts, emptyContactsAttributes);
try
{
CreatedProcessId result = apiInstance.ImportContacts(requestContactImport);
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)
body := RequestContactImport{
FileBody: "EMAIL;FIRSTNAME;SMS\n#[email protected];John;Doe;31234567923",
ListIds: []int64{2},
EmailBlacklist: false,
SmsBlacklist: false,
UpdateExistingContacts: true,
EmptyContactsAttributes: false,
}
id, resp, err := sib.ContactsApi.ImportContacts(ctx, body)
if err!=nil{
fmt.Println("Error in ContactsApi->ImportContacts ",err.Error())
return
}
fmt.Println( "ImportContacts response:",resp,"ImportContacts process id:",id)
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::ContactsApi.new
request_contact_import = SibApiV3Sdk::RequestContactImport.new # RequestContactImport | Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
request_contact_import = {
'fileBody' => 'EMAIL;EntitÈ;FIRSTNAME;SMS\n#johnDoÈ[email protected];John;Doe;31234567923',
'listIds' => [2],
'emailBlacklist' => false,
'smsBlacklist' => false,
'updateExistingContacts' => true,
'emptyContactsAttributes' => false;
}
begin
#Import contacts
result = api_instance.import_contacts(request_contact_import)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ContactsApi->import_contacts: #{e}"
end