Get loyalty program Info | Brevo API Documentation

Returns loyalty program

api-keystring

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

pidstringRequiredformat: "uuid"

Loyalty Program ID. A unique identifier for the loyalty program.

Successfully retrieved loyalty program.

codeCountinteger

Loyalty Program code count

createdAtstring

Loyalty Program creation date

descriptionstring

Loyalty Program description

documentIdstring

string

idstring

Loyalty Program ID

metamap from strings to any

Loyalty Program meta data

namestring

Loyalty Program name

patternstring

string

stateenum

Loyalty Program state

Allowed values:

subscriptionGeneratorIdstring

Loyalty Program subscription generator ID

subscriptionPoolIdstring

Loyalty Program subscription pool ID

updatedAtstring

Loyalty Program last modification date

401

Unauthorized Error

403

Forbidden Error

404

Not Found 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.program.getLoyaltyProgramInfo("pid");
8	}
9	main();

1	{
2	"codeCount": 1,
3	"createdAt": "string",
4	"description": "string",
5	"documentId": "string",
6	"id": "string",
7	"meta": {},
8	"name": "string",
9	"pattern": "string",
10	"state": "inactive",
11	"subscriptionGeneratorId": "string",
12	"subscriptionPoolId": "string",
13	"updatedAt": "string"
14	}