POST /loyalty/balance/programs/{pid}/balance-definitions

Creates balance definition and returns information

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
`maxDebitAmountLimit`	Number	No	Maximum debit allowed per operation.
`description`	String	No	Short description of the balance definition.
`maxCreditAmountLimit`	Number	No	Maximum credit allowed per operation.
`balanceExpirationDate`	String	No	Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry.
`balanceAvailabilityDurationValue`	Integer	No	Number of time units before the balance expires.
`meta`	Object	No	Additional metadata for the balance definition.
`balanceAvailabilityDurationUnit`	String	No	Unit of time for balance validity. Valid values: `"month"` `"day"` `"week"` `"year"`
`imageRef`	String	No	URL of an optional image reference.
`unit`	String	Yes	Unit of balance measurement. Valid values: `"CAD"` `"MXN"` `"CLP"` `"AUD"` `"POINTS"` `"GBP"` `"PEN"` `"JPY"` `"SGD"` `"INR"` `"RON"` `"BRL"` `"MAD"` `"USD"` `"EUR"` `"MYR"` `"CHF"`
`maxAmount`	Number	No	Maximum allowable balance amount.
`balanceOptionDebitRounding`	String	No	Defines rounding strategy for debit transactions. Valid values: `"lower"` `"natural"` `"upper"`
`name`	String	Yes	Name of the balance definition.
`minAmount`	Number	No	Minimum allowable balance amount.
`balanceOptionAmountOvertakingStrategy`	String	No	Defines whether partial credit is allowed when reaching max balance. Valid values: `"partial"` `"strict"`
`balanceAvailabilityDurationModifier`	String	No	Defines when the balance expires within the selected duration. Valid values: `"startOfPeriod"` `"noModification"` `"endOfPeriod"`
`balanceOptionCreditRounding`	String	No	Defines rounding strategy for credit transactions. Valid values: `"lower"` `"natural"` `"upper"`

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.