Home / Servers / Brevo API / post_loyalty_balance_programs_by_pid_balance_definitions

Create balance definition

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

Create balance definition Creates balance definition and returns information [POST /loyalty/balance/programs/{pid}/balance-definitions]

Name on the gateway: brevo_api__post_loyalty_balance_programs_by_pid_balance_definitions · may change things.

Parameters

NameTypeDescription
pid requiredstringLoyalty Program 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.
balanceExpirationDatestringFixed expiration date (dd/mm format) as an alternative to duration-based expiry.
balanceOptionAmountOvertakingStrategystrict | partialDefines whether partial credit is allowed when reaching max balance.
balanceOptionCreditRoundinglower | upper | naturalDefines rounding strategy for credit transactions.
balanceOptionDebitRoundinglower | upper | naturalDefines rounding 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.
metaobjectAdditional 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__post_loyalty_balance_programs_by_pid_balance_definitions",
  "arguments": {
    "pid": "…",
    "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 create balance definition tool with pid set to ….

More from Brevo API