Validate a reward | Brevo API Documentation

Validates a reward.

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.

attributedRewardIdstringOptionalformat: "uuid"

Unique identifier for the attributed reward

codestringOptional

Validation code for the reward

contactIdlongOptional>=1

Unique identifier for the contact

loyaltySubscriptionIdstringOptional

Identifier for the loyalty subscription

pointOfSellIdstringOptional

Identifier for the point of sale

rewardIdstringOptionalformat: "uuid"

Unique identifier for the reward

Reward successfully validated

authorizeboolean

Boolean value to authorize a reward or not

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

424

Failed Dependency 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.validateReward("pid", {});
8	}
9	main();