POST /loyalty/tier/programs/{pid}/tier-groups

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

Servers

https://api.brevo.com/v3

Path parameters

Name	Type	Required	Description
`pid`	String	Yes	Loyalty Program ID

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`upgradeStrategy`	String	No	Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary. Valid values: `"real_time"` `"membership_anniversary"` `"tier_anniversary"` Default value: "real_time"
`downgradeSchedule`	Object	No	Schedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy.
`downgradeSchedule.durationModifier`	String	No	Modifier for the duration. Valid values: `"start_of_period"` `"end_of_period"`
`downgradeSchedule.scheduledDate`	String	No	Scheduled date in DD/MM format.
`downgradeSchedule.durationValue`	Integer	No	Duration value for the schedule.
`downgradeSchedule.durationUnit`	String	No	Duration unit for the schedule. Valid values: `"month"` `"day"` `"week"` `"year"`
`name`	String	Yes	Name of the tier group
`upgradeSchedule`	Object	No	Schedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy.
`upgradeSchedule.durationModifier`	String	No	Modifier for the duration. Valid values: `"start_of_period"` `"end_of_period"`
`upgradeSchedule.scheduledDate`	String	No	Scheduled date in DD/MM format.
`upgradeSchedule.durationValue`	Integer	No	Duration value for the schedule.
`upgradeSchedule.durationUnit`	String	No	Duration unit for the schedule. Valid values: `"month"` `"day"` `"week"` `"year"`
`downgradeStrategy`	String	No	Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary. Valid values: `"real_time"` `"membership_anniversary"` `"tier_anniversary"` Default value: "real_time"
`meta`	Object	No	Additional metadata for the tier group.
`meta.isInternal`	Boolean	No	Indicates whether the tier group is internal.
`tierOrder[]`	Array	No	Order of the tiers in the group in ascending order

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.