Update a deal | Brevo API Documentation

Update an existing deal”s attributes, name, linked contacts, or linked companies. Note that passing linkedContactsIds or linkedCompaniesIds replaces the entire list of associations, so omitted IDs will be removed. To move a deal to a different pipeline or stage, provide both the pipeline and deal_stage attribute IDs.

Authentication

api-keystring

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

Path parameters

idstringRequired

Request

Updated deal details.

attributesobjectOptional

Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the pipeline and the deal_stage Pipeline and deal_stage are ids you can fetch using this endpoint /crm/pipeline/details/{pipelineID}

linkedCompaniesIdslist of stringsOptional

Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed.

linkedContactsIdslist of longsOptional

Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.

namestringOptional

Name of deal

Errors

400

Bad Request Error

404

Not Found 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.updateADeal("id", {});
8	}
9	main();