Home / Servers / Brevo API / update_balance_definition

Update balance definition

An MCP tool from the Brevo API server, hosted on mcp.hjlabs.in.

Update balance definition Updates Balance definition [PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}]

Name on the gateway: brevo_api__update_balance_definition · may change things.

Parameters

NameTypeDescription
pid requiredstringLoyalty Program Id
bdid requiredstringBalance Definition Id
balanceAvailabilityDurationModifiernoModification | startOfPeriod | endOfPeriodDefines when the balance expires within the selected duration.
balanceAvailabilityDurationUnitday | week | month | yearUnit of time for balance validity.
balanceAvailabilityDurationValueintegerNumber of time units before the balance expires.
balanceExpirationDatestringExpiration date (dd/mm format) or empty if not applicable.
balanceOptionAmountOvertakingStrategystrict | partialDefines whether partial credit is allowed when reaching max balance.
balanceOptionCreditRoundinglower | upper | naturalRounding strategy for credit transactions.
balanceOptionDebitRoundinglower | upper | naturalRounding strategy for debit transactions.
descriptionstringShort description of the balance definition.
imageRefstringURL of an optional image reference.
maxAmountnumberMaximum allowable balance amount.
maxCreditAmountLimitnumberMaximum credit allowed per operation.
maxDebitAmountLimitnumberMaximum debit allowed per operation.
metaobjectOptional metadata for the balance definition.
minAmountnumberMinimum allowable balance amount.
name requiredstringName of the balance definition.
unit requiredPOINTS | EUR | USD | MXN | GBP | INR | CAD | SGD | RON | JPY | MYR | CLP | PEN | MAD | AUD | CHF | BRLUnit of balance measurement.

How to call it

Through the Smart Gateway, any client can run it by name with call_tool, or let the gateway find it with search_tools:

call_tool arguments
{
  "name": "brevo_api__update_balance_definition",
  "arguments": {
    "pid": "…",
    "bdid": "…",
    "name": "…",
    "unit": "…"
  }
}

Or connect the Brevo API server directly, which lists 291 tools including this one:

Run in your terminal
claude mcp add --transport http hj-brevo-api https://mcp.hjlabs.in/mcp/brevo-api \
  --header "Authorization: Bearer YOUR_API_KEY"

Try asking

Use the update balance definition tool with pid set to ….

More from Brevo API