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 or null

Loyalty Program code count

createdAtstring or null

Loyalty Program creation date

descriptionstring or null

Loyalty Program description

documentIdstring or null

string

idstring or null

Loyalty Program ID

metamap from strings to any or null

Loyalty Program meta data

namestring or null

Loyalty Program name

patternstring or null

string

stateenum or null

Loyalty Program state

Allowed values:

subscriptionGeneratorIdstring or null

Loyalty Program subscription generator ID

subscriptionPoolIdstring or null

Loyalty Program subscription pool ID

updatedAtstring or null

Loyalty Program last modification date

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	}