Create a list | Brevo API Documentation

Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.

Authentication

api-keystring

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

Request

Values to create a list

folderIdlongRequired

Id of the parent folder in which this list is to be created

namestringRequired

Name of the list

Response

successfully created

idlong

ID of the object created

Errors

400

Bad Request Error

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

Values to create a list

Id of the parent folder in which this list is to be created

successfully created

ID of the object created

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.createList({
8	folderId: 2,
9	name: "Magento Customer - ES",
10	});
11	}
12	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.createList({
8	folderId: 2,
9	name: "Magento Customer - ES",
10	});
11	}
12	main();