API Reference

Update balance definition

put
https://api.brevo.com/v3/loyalty/balance/programs//balance-definitions/

Updates Balance definition

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Loyalty Program Id

uuid
required

Balance Definition Id

Body Params

Create Balance Definition Payload

string
enum

Defines when the balance expires within the selected duration.

Allowed:
string
enum

Unit of time for balance validity.

Allowed:
integer

Number of time units before the balance expires.

string

Expiration date (dd/mm format) or empty if not applicable.

string
enum

Defines whether partial credit is allowed when reaching max balance.

Allowed:
string
enum

Rounding strategy for credit transactions.

Allowed:
string
enum

Rounding strategy for debit transactions.

Allowed:
string
length ≤ 256

Short description of the balance definition.

string

URL of an optional image reference.

number

Maximum allowable balance amount.

number

Maximum credit allowed per operation.

number

Maximum debit allowed per operation.

meta
object

Optional metadata for the balance definition.

number

Minimum allowable balance amount.

string
required
length ≤ 128

Name of the balance definition.

string
enum
required

Unit of balance measurement.

Responses

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago