Create а coupon collection | Brevo API Documentation

Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.

Authentication

api-keystring

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

Request

Values to create a coupon collection

defaultCouponstringRequired

Default coupons collection name

namestringRequired

Name of the coupons collection

expirationDatedatetimeOptional

Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.

remainingCouponsAlertintegerOptional

Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.

remainingDaysAlertintegerOptional

Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.

Response

Coupon collection created

idstringformat: "uuidv4"

The id of the created collection

Errors

400

Bad Request Error

401

Unauthorized Error

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

Values to create a coupon collection

Default coupons collection name

Name of the coupons collection

Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.

Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.

Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.

Coupon collection created

The id of the created collection

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.coupons.createCouponCollection({
8	defaultCoupon: "Winter",
9	name: "10%OFF",
10	});
11	}
12	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.coupons.createCouponCollection({
8	defaultCoupon: "Winter",
9	name: "10%OFF",
10	});
11	}
12	main();