Create a tier

POST

https://api.brevo.com/v3/loyalty/tier/programs/:pid/tier-groups/:gid/tiers

POST

/v3/loyalty/tier/programs/:pid/tier-groups/:gid/tiers

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.tier.createTierForTierGroup("gid", "pid", {
8         accessConditions: [
9             {},
10         ],
11         name: "string",
12     });
13 }
14 main();

1 {
2   "accessConditions": [
3     {
4       "balanceDefinitionId": "string",
5       "createdAt": "2024-01-15T09:30:00Z",
6       "minimumValue": 1,
7       "updatedAt": "2024-01-15T09:30:00Z"
8     }
9   ],
10   "createdAt": "2024-01-15T09:30:00Z",
11   "groupId": "string",
12   "imageRef": "string",
13   "loyaltyProgramId": "string",
14   "name": "string",
15   "tierId": "string",
16   "tierRewards": [
17     {
18       "createdAt": "2024-01-15T09:30:00Z",
19       "rewardId": "string",
20       "updatedAt": "2024-01-15T09:30:00Z"
21     }
22   ],
23   "updatedAt": "2024-01-15T09:30:00Z"
24 }

Creates a new tier in a loyalty program tier group. (The changes will take effect with the next publication of the loyalty program)

Authentication

api-keystring

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

Path parameters

pidstringRequiredformat: "uuid"

Loyalty Program ID

gidstringRequiredformat: "uuid"

Tier group ID

Request

This endpoint expects an object.

accessConditionslist of objectsRequired

namestringRequired

Name of the tier to be created

imageRefstringOptional

Image of the tier

tierRewardslist of objectsOptional

Response

Tier successfully created

accessConditionslist of objectsOptional

Conditions required to access this tier

createdAtdatetimeOptional

groupIdstringOptionalformat: "uuid"

Associated group Id

imageRefstringOptional

Tier image reference

loyaltyProgramIdstringOptionalformat: "uuid"

Associated loyalty program Id

namestringOptional

Tier name

tierIdstringOptionalformat: "uuid"

Tier id

tierRewardslist of objectsOptional

Rewards associated with this tier

updatedAtdatetimeOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error