Update a note | Brevo API Documentation

Update an existing CRM note''s text content and its associations with contacts, companies, or deals. You can modify the note text, change the pinned status, or update the linked entities.

Authentication

api-keystring

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

Path parameters

idstringRequired

Note ID to update

Request

Note data to update a note.

textstringRequired1-10000 characters

Content of the note. Supports HTML for rich text formatting. Supported tags include:  (paragraph),  /  (bold),  /  (italic),  (underline),   (line break), <a href="..."> (labelled hyperlink). Example labelled link: <a href="https://example.com">Link text</a>.

companyIdslist of stringsOptional

Company Ids linked to a note

contactIdslist of integersOptional

Contact Ids linked to a note

dealIdslist of stringsOptional

Deal Ids linked to a note

Errors

400

Bad Request Error

404

Not Found Error

415

Unsupported Media Type Error

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

Note data to update a note.

Company Ids linked to a note

Contact Ids linked to a note

Deal Ids linked to a note

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.notes.updateANote("id", {
8	body: {
9	text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>",
10	},
11	});
12	}
13	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.notes.updateANote("id", {
8	body: {
9	text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>",
10	},
11	});
12	}
13	main();