Create Contact via DOI (Double-Opt-In) Flow

<Note title="How to use attributes param?">attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.</Note>

How to use attributes param?

attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.

Authentication

api-keystring

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

Request

Values to create the Double opt-in (DOI) contact

emailstringRequiredformat: "email"

Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.

includeListIdslist of longsRequired

Lists under user account where contact should be added

redirectionUrlstringRequiredformat: "url"

URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.

templateIdlongRequired

Id of the Double opt-in (DOI) template

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

Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {‘FNAME’:‘Elly’, ‘LNAME’:‘Roger’, ‘COUNTRIES’: [‘India’,‘China’]}

excludeListIdslist of longsOptional

Lists under user account where contact should not be added

Response

DOI Contact created

Errors

400

Bad Request Error

How to use attributes param?

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

Values to create the Double opt-in (DOI) contact

Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.

Lists under user account where contact should be added

URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.

Id of the Double opt-in (DOI) template

Lists under user account where contact should not be added

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.createDoiContact({
8	email: "elly@example.com",
9	includeListIds: [
10	36,
11	],
12	redirectionUrl: "http://requestb.in/173lyyx1",
13	templateId: 2,
14	});
15	}
16	main();

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.createDoiContact({
8	email: "elly@example.com",
9	includeListIds: [
10	36,
11	],
12	redirectionUrl: "http://requestb.in/173lyyx1",
13	templateId: 2,
14	});
15	}
16	main();