Create a contact

Creates new contacts on Brevo. Contacts can be created by passing either -

1. email address of the contact (email_id),
2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}
3. ext_id

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

📘

Follow this format when passing a "SMS" phone number as an attribute.

Accepted Number Formats
91xxxxxxxxxx
+91xxxxxxxxxx
0091xxxxxxxxxx

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 createContact = new SibApiV3Sdk.CreateContact(); createContact.email = 'example@example.com'; createContact.listIds = [2] apiInstance.createContact(createContact).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 ); $createContact = new \SendinBlue\Client\Model\CreateContact(); // Values to create a contact $createContact['email'] = 'example@example.com'; $createContact['listIds'] = [1]; try { $result = $apiInstance->createContact($createContact); print_r($result); } catch (Exception $e) { print_r($e); echo 'Exception when calling ContactsApi->createContact: ', $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)) create_contact = sib_api_v3_sdk.CreateContact(email="example@example.com", list_ids=[2]) try: api_response = api_instance.create_contact(create_contact) pprint(api_response) except ApiException as e: print("Exception when calling ContactsApi->create_contact: %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 createContact = new SibApiV3Sdk.CreateContact(); createContact.email = 'exampletest@example.com'; createContact.listIds = [2]; apiInstance.createContact(createContact).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"); ContactsApi api = new ContactsApi(); try { CreateContact createContact = new CreateContact(); createContact.setEmail("example@example.com"); Properties attributes = new Properties(); attributes.setProperty("FIRSTNAME", "John"); attributes.setProperty("LASTNAME", "Doe"); attributes.setProperty("SMS", "91XXXXXXXXXX"); createContact.setAttributes(attributes); List<Long> listIds = new ArrayList<Long>(); listIds.add(2l); createContact.setListIds(listIds); createContact.setEmailBlacklisted(false); createContact.setSmsBlacklisted(false); createContact.setUpdateEnabled(false); List<String> smtpBlacklistedSender = new ArrayList<String>(); smtpBlacklistedSender.add("example@example.com"); createContact.setListIds(listIds); createContact.setSmtpBlacklistSender(smtpBlacklistedSender); CreateUpdateContactModel response = api.createContact(createContact); 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 Newtonsoft.Json.Linq; 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 email = "example@example.com"; JObject attributes = new JObject(); attributes.Add("FIRSTNAME", "John"); attributes.Add("LASTNAME", "Doe"); attributes.Add("SMS", "91XXXXXXXXXX"); List<long?> listIds = new List<long?>(); listIds.Add(2); bool emailBlacklisted = false; bool smsBlacklisted = false; bool updateEnabled = false; List<string> smtpBlacklistSender = new List<string>(); smtpBlacklistSender.Add("example@example.com"); try { var createContact = new CreateContact(email, attributes, emailBlacklisted, smsBlacklisted, listIds, updateEnabled, smtpBlacklistSender); CreateUpdateContactModel result = apiInstance.CreateContact(createContact); 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) email := "example@example.com" var params = CreateContact{ Email: email, ListIds: []int64{1}, } obj, resp, err := sib.ContactsApi.CreateContact(ctx, params) if err !=nil{ fmt.Println("Error in ContactsApi->CreateContact", err.Error()) return } fmt.Println("CreateContact Object:",obj," CreateContact 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::ContactsApi.new create_contact = SibApiV3Sdk::CreateContact.new # CreateContact | Values to create a contact create_contact = { 'email'=> 'example@example.com', 'listIds'=> [2] } begin #Create a contact result = api_instance.create_contact(create_contact) p result rescue SibApiV3Sdk::ApiError => e puts "Exception when calling ContactsApi->create_contact: #{e}" end
Body Params

Values to create a contact

string

Email address of the user. Mandatory if "ext_id" & "SMS" field is not passed.

string

Pass your own Id to create a contact.

attributes
object

Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. These attributes must be present in your Brevo account.. For eg:
{"FNAME":"Elly", "LNAME":"Roger", "COUNTRIES":["India","China"]}

boolean

Set this field to blacklist the contact for emails (emailBlacklisted = true)

boolean

Set this field to blacklist the contact for SMS (smsBlacklisted = true)

listIds
array of int64s

Ids of the lists to add the contact to

listIds
boolean
Defaults to false

Facilitate to update the existing contact in the same request (updateEnabled = true)

smtpBlacklistSender
array of strings

transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )

smtpBlacklistSender
Responses

204

Contact updated

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json