Create a deal | Brevo API Documentation

Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing pipeline and deal_stage attribute IDs, which can be retrieved from the pipeline details endpoint.

Authentication

api-keystring

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

Request

Deal create data.

namestringRequired

Name of deal

attributesobjectOptional

Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes pipeline and deal_stage. Pipeline and deal_stage are ids you can fetch using this endpoint /crm/pipeline/details/{pipelineID}

Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`

linkedCompaniesIdslist of stringsOptional

Company ids to be linked with deal

linkedContactsIdslist of longsOptional

Contact ids to be linked with deal

Response

Created new Deal

idstring

Unique deal id

Errors

400

Bad Request 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.deals.createADeal({
8	name: "Deal: Connect with company",
9	});
10	}
11	main();