Create a reward | Brevo API Documentation

Creates a new reward in the loyalty program.

api-keystring

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

pidstringRequiredformat: "uuid"

Loyalty Program ID

This endpoint expects an object.

namestringRequired<=128 characters

Internal name of the reward

publicDescriptionstringOptional<=500 characters

Public facing description of the reward

publicImagestringOptionalformat: "uri"

URL of the public image for the reward

publicNamestringOptional<=128 characters

Public facing name of the reward

Reward successfully created

idstringformat: "uuid"

Unique identifier for the reward

loyaltyProgramIdstringformat: "uuid"

Loyalty program to which the reward belongs

namestring

Name of the reward

publicDescriptionstring

Public description of the reward

publicImagestring

Public image URL of the reward

publicNamestring

Public name of the reward

createdAtdatetime

Timestamp when the reward was created

updatedAtdatetime

Timestamp when the reward was last updated

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server 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.reward.createReward("pid", {
8	name: "string",
9	});
10	}
11	main();