Create a product alert for a contact | Brevo API Documentation

Register a contact to receive an alert for a specific product event, such as back_in_stock. At least one contact identifier (ext_id, email, or sms) must be provided; when multiple are given, priority is ext_id > email > sms. Returns a 404 error if the product ID does not exist, and a 403 error if product alerts are not enabled for the account.

Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`. Returns a `404` error if the product ID does not exist, and a `403` error if product alerts are not enabled for the account.

Authentication

api-keystring

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

Path parameters

idstringRequired

Product ID

typeenumRequired

Alert type

Allowed values:

Request

Contact identifier to associate the alert with (at least one is required). Priority is given to ext_id > email > sms

contactIdentifiersobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden 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.ecommerce.createProductAlert("id", "back_in_stock", {});
8	}
9	main();