Create a contact

📘

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 = '[email protected]';
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'] = '[email protected]';
$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="[email protected]", 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 = '[email protected]';
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("[email protected]");
            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("[email protected]");
            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 = "[email protected]";
            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("[email protected]");
            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 := "[email protected]"
    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 
}
Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!