Import deals(creation and updation) | Brevo API Documentation

Import deals from a CSV file with mapping options.

Authentication

api-keystring

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

Request

This endpoint expects a multipart form containing an optional file.

filefileOptional

The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) deal_id [brevo mongoID to update deals] (b) associated_contact (c) associated_company (f) any other attribute with internal name

mappingobjectOptional

The mapping options in JSON format. Here is an example of the JSON structure: json { "link_entities": true, // Determines whether to link related entities during the import process "unlink_entities": false, // Determines whether to unlink related entities during the import process "update_existing_records": true, // Determines whether to update based on deal ID or treat every row as create "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank }

Response

Successfully imported deals

processIdinteger

The ID of the import process

Errors

400

Bad Request Error

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

This endpoint expects a multipart form containing an optional file.

Successfully imported deals

The ID of the import process

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.deals.importDealsCreationAndUpdation(, {});
8	}
9	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.deals.importDealsCreationAndUpdation(, {});
8	}
9	main();