Create a contact | Brevo API Documentation

Follow this format when passing a “SMS” phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx

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

<Note>Follow this format when passing a "SMS" phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note> 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

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Values to create a contact

attributesmap from strings to doubles or integers or strings or booleans or lists of stringsOptional

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”]}

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"]}**

emailstringOptionalformat: "email"

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

emailBlacklistedbooleanOptional

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

ext_idstringOptional

Pass your own Id to create a contact.

listIdslist of longsOptional

Ids of the lists to add the contact to

smsBlacklistedbooleanOptional

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

smtpBlacklistSenderlist of stringsOptional

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

updateEnabledbooleanOptionalDefaults to false

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

forceMergebooleanOptionalDefaults to false

When true, if the contact being created shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent last_modified timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict.

Response

Contact created

idlong

ID of the contact when a new contact is created

Errors

400

Bad Request Error

425

Too Early Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.contacts.createContact({});
8	}
9	main();