Skip to main content
Server path: /brevo-loyalty | Type: Application | PCID required: Yes

Tools

ToolDescription
brevo_loyalty_add_subscription_to_tierAssign a tier
brevo_loyalty_begin_transactionCreate new transaction
brevo_loyalty_cancel_transactionCancel transaction
brevo_loyalty_complete_redeem_transactionComplete redeem voucher request
brevo_loyalty_complete_transactionComplete transaction
brevo_loyalty_create_balance_limitCreate balance limits
brevo_loyalty_create_balance_orderCreate balance order
brevo_loyalty_create_loyalty_balance_programs_by_pid_balance_definitionsCreate balance definition
brevo_loyalty_create_loyalty_balance_programs_by_pid_subscriptions_by_cid_balancesCreate subscription balances
brevo_loyalty_create_new_lpCreate loyalty program
brevo_loyalty_create_rewardCreate a reward
brevo_loyalty_create_tier_for_tier_groupCreate a tier
brevo_loyalty_create_tier_groupCreate a tier group
brevo_loyalty_create_voucherCreate a voucher
brevo_loyalty_delete_balance_definitionDelete balance definition
brevo_loyalty_delete_balance_limitDelete balance limit
brevo_loyalty_delete_contact_membersDelete subscription member
brevo_loyalty_delete_contact_subscriptionDelete subscription
brevo_loyalty_delete_programDelete Loyalty Program
brevo_loyalty_delete_tierDelete tier
brevo_loyalty_delete_tier_groupDelete tier group
brevo_loyalty_get_balance_definitionGet balance definition
brevo_loyalty_get_balance_definition_listGet balance definition list
brevo_loyalty_get_balance_limitGet balance limits
brevo_loyalty_get_code_countGet code count
brevo_loyalty_get_contact_balancesGet balance list
brevo_loyalty_get_list_of_tier_groupsList tier groups
brevo_loyalty_get_lplistGet loyalty program list
brevo_loyalty_get_offer_programs_by_pid_rewards_by_ridGet reward information
brevo_loyalty_get_parameter_subscription_infoGet Subscription Data
brevo_loyalty_get_program_infoGet loyalty program Info
brevo_loyalty_get_program_tierList tiers
brevo_loyalty_get_subscription_balancesGet subscription balances
brevo_loyalty_get_tier_groupGet tier group
brevo_loyalty_list_loyalty_balance_programs_by_pid_active_balanceGet Active Balances API
brevo_loyalty_list_loyalty_balance_programs_by_pid_transaction_historyGet Transaction History API
brevo_loyalty_list_loyalty_offer_programs_by_pid_offersGet Reward Page API
brevo_loyalty_list_loyalty_offer_programs_by_pid_vouchersGet voucher for a contact
brevo_loyalty_partially_update_loyalty_programPartially update loyalty program
brevo_loyalty_publish_loyalty_programPublish loyalty program
brevo_loyalty_redeem_voucherCreate redeem voucher request
brevo_loyalty_revoke_vouchersRevoke vouchers
brevo_loyalty_subscribe_member_to_asubscriptionCreate subscription member
brevo_loyalty_subscribe_to_loyalty_programCreate subscription
brevo_loyalty_update_balance_definitionUpdate balance definition
brevo_loyalty_update_balance_limitUpdates balance limit
brevo_loyalty_update_loyalty_programUpdate loyalty program
brevo_loyalty_update_tierUpdate tier
brevo_loyalty_update_tier_groupUpdate tier group
brevo_loyalty_validate_rewardValidate a reward

brevo_loyalty_add_subscription_to_tier

Assign a tier Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
cidstringYesContact ID
tidstringYesTier ID

brevo_loyalty_begin_transaction

Create new transaction Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
amountnumberYesTransaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided).
autoCompletebooleanNoWhether the transaction should be automatically completed.
balanceDefinitionIdstringYesUnique identifier (UUID) of the associated balance definition.
balanceExpiryInMinutesintegerNoExpiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true.
contactIdintegerNoUnique identifier of the contact involved in the transaction. Required unless LoyaltySubscriptionId is provided.
eventTimestringNoTimestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format).
LoyaltySubscriptionIdstringNoUnique identifier for the loyalty subscription. Required unless contactId is provided.
metaobjectNoOptional metadata associated with the transaction.
transactionTypestringNoExplicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit).
ttlintegerNoTime-to-live for the transaction in seconds. Must be at least 10 seconds if provided.

brevo_loyalty_cancel_transaction

Cancel transaction Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
tidstringYesTransaction Id

brevo_loyalty_complete_redeem_transaction

Complete redeem voucher request Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
tidstringYesRedeem transaction ID

brevo_loyalty_complete_transaction

Complete transaction Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
tidstringYesTransaction Id

brevo_loyalty_create_balance_limit

Create balance limits Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id
constraintTypestringYesDefines whether the limit applies to transaction count or amount.
durationUnitstringYesUnit of time for which the limit is applicable.
durationValueintegerYesNumber of time units for the balance limit.
slidingSchedulebooleanNoDetermines if the limit resets on a rolling schedule.
transactionTypestringYesSpecifies whether the limit applies to credit or debit transactions.
valueintegerYesMaximum allowed value for the specified constraint type.

brevo_loyalty_create_balance_order

Create balance order Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
amountnumberYesOrder amount (must be non-zero).
balanceDefinitionIdstringYesUnique identifier (UUID) of the associated balance definition.
contactIdintegerYesUnique identifier of the contact placing the order (must be ≥ 1).
dueAtstringYesRFC3339 timestamp specifying when the order is due.
expiresAtstringNoOptional RFC3339 timestamp defining order expiration.
metaobjectNoOptional metadata associated with the order.
sourcestringYesSpecifies the origin of the order.

brevo_loyalty_create_loyalty_balance_programs_by_pid_balance_definitions

Create balance definition Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
balanceAvailabilityDurationModifierstringNoDefines when the balance expires within the selected duration.
balanceAvailabilityDurationUnitstringNoUnit of time for balance validity.
balanceAvailabilityDurationValueintegerNoNumber of time units before the balance expires.
balanceExpirationDatestringNoFixed expiration date (dd/mm format) as an alternative to duration-based expiry.
balanceOptionAmountOvertakingStrategystringNoDefines whether partial credit is allowed when reaching max balance.
balanceOptionCreditRoundingstringNoDefines rounding strategy for credit transactions.
balanceOptionDebitRoundingstringNoDefines rounding strategy for debit transactions.
descriptionstringNoShort description of the balance definition.
imageRefstringNoURL of an optional image reference.
maxAmountnumberNoMaximum allowable balance amount.
maxCreditAmountLimitnumberNoMaximum credit allowed per operation.
maxDebitAmountLimitnumberNoMaximum debit allowed per operation.
metaobjectNoAdditional metadata for the balance definition.
minAmountnumberNoMinimum allowable balance amount.
namestringYesName of the balance definition.
unitstringYesUnit of balance measurement.

brevo_loyalty_create_loyalty_balance_programs_by_pid_subscriptions_by_cid_balances

Create subscription balances Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
cidstringYesContact Id
balanceDefinitionIdstringYesUnique identifier (UUID) of the balance definition associated with the new balance.

brevo_loyalty_create_new_lp

Create loyalty program Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoOptional description of the loyalty program (max 256 chars).
documentIdstringNoOptional unique document ID.
metaobjectNoOptional metadata related to the loyalty program.
namestringYesRequired name of the loyalty program (max 128 chars).

brevo_loyalty_create_reward

Create a reward Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
namestringYesInternal name of the reward
publicDescriptionstringNoPublic facing description of the reward
publicImagestringNoURL of the public image for the reward
publicNamestringNoPublic facing name of the reward

brevo_loyalty_create_tier_for_tier_group

Create a tier Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
gidstringYesTier group ID
accessConditionsobject[]YesAccess Conditions
imageRefstringNoImage of the tier
namestringYesName of the tier to be created
tierRewardsobject[]NoTier Rewards

brevo_loyalty_create_tier_group

Create a tier group Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
downgradeScheduleobjectNoSchedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy.
downgradeStrategystringNoSelect 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.
metaobjectNoAdditional metadata for the tier group.
namestringYesName of the tier group
tierOrderstring[]NoOrder of the tiers in the group in ascending order
upgradeScheduleobjectNoSchedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy.
upgradeStrategystringNoSelect 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.

brevo_loyalty_create_voucher

Create a voucher Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
codestringNoCode generated to attribute reward to a contact
contactIdintegerNoContact to attribute the reward
expirationDatestringNoReward expiration date
loyaltySubscriptionIdstringNoOne of contactId or loyaltySubscriptionId is required
metaobjectNoOffer meta information (key/value object)
rewardIdstringYesReward id
validFromstringNoDate from which the voucher becomes valid. Accepts RFC 3339 or DD/MM/YYYY HH:MM AM/PM format. Converted to UTC using the organization’s timezone.
valuenumberNoValue of the selected reward config

brevo_loyalty_delete_balance_definition

Delete balance definition Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id

brevo_loyalty_delete_balance_limit

Delete balance limit Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id
blidstringYesBalance Limit Id

brevo_loyalty_delete_contact_members

Delete subscription member Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
memberContactIdsstringYesComma-separated list of member contact IDs to delete from the subscription.

brevo_loyalty_delete_contact_subscription

Delete subscription Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
cidintegerYesContact ID.

brevo_loyalty_delete_program

Delete Loyalty Program Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.

brevo_loyalty_delete_tier

Delete tier Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
tidstringYesTier ID

brevo_loyalty_delete_tier_group

Delete tier group Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
gidstringYesTier group ID

brevo_loyalty_get_balance_definition

Get balance definition Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id
versionstringNoThe version value

brevo_loyalty_get_balance_definition_list

Get balance definition list Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
limitintegerNoLimit the number of records returned
offsetintegerNoOffset to paginate records
sortFieldstringNoField to sort by
sortstringNoSort direction
versionstringNoThe version value

brevo_loyalty_get_balance_limit

Get balance limits Parameters:
ParameterTypeRequiredDefaultDescription
versionstringNoThe version value
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id
blidstringYesBalance Limit Id

brevo_loyalty_get_code_count

Get code count Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
cpidstringYesCode Pool ID

brevo_loyalty_get_contact_balances

Get balance list Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
includeInternalbooleanNoInclude balances tied to internal definitions.
limitintegerNoLimit the number of records returned
offsetintegerNoSkip a number of records
sortstringNoSort order
sortFieldstringNoField to sort by
balanceDefinitionIdstringYesBalance Definition ID (required)

brevo_loyalty_get_list_of_tier_groups

List tier groups Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
versionstringNoSelect ‘active’ to retrieve list of all tier groups which are live for clients. Select draft to retrieve list of all non deleted tier groups.

brevo_loyalty_get_lplist

Get loyalty program list Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of documents per page
offsetintegerNoIndex of the first document in the page
sort_fieldstringNoSort documents by field
sortstringNoSort order

brevo_loyalty_get_offer_programs_by_pid_rewards_by_rid

Get reward information Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
ridstringYesReward ID
versionstringNoThe version value

brevo_loyalty_get_parameter_subscription_info

Get Subscription Data Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
contactIdstringNoThe contact ID to filter by.
paramsstringNoA list of filter parameters for querying the subscription info.
loyaltySubscriptionIdstringNoThe loyalty subscription ID to filter by.
includeInternalbooleanNoInclude balances tied to internal definitions.

brevo_loyalty_get_program_info

Get loyalty program Info Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.

brevo_loyalty_get_program_tier

List tiers Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
versionstringNoSelect ‘active’ to retrieve list of all tiers which are live for clients. Select draft to retrieve list of all non deleted tiers.

brevo_loyalty_get_subscription_balances

Get subscription balances Parameters:
ParameterTypeRequiredDefaultDescription
cidstringYesContact Id
pidstringYesLoyalty Program Id
includeInternalbooleanNoInclude balances tied to internal definitions.

brevo_loyalty_get_tier_group

Get tier group Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
gidstringYesTier group ID
versionstringNoSelect active to retrieve active version of tier group. Select draft to retrieve latest changes in tier group.

brevo_loyalty_list_loyalty_balance_programs_by_pid_active_balance

Get Active Balances API Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
sortFieldstringNoSort Field
sortstringNoSort Order
contactIdintegerYesContact ID
balanceDefinitionIdstringYesBalance Definition ID
includeInternalbooleanNoInclude balances tied to internal definitions.

brevo_loyalty_list_loyalty_balance_programs_by_pid_transaction_history

Get Transaction History API Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
limitintegerNoLimit the number of records returned
offsetintegerNoPage number to retrieve
sortFieldstringNoField to sort by
sortstringNoSort order
contactIdintegerYesContact ID
balanceDefinitionIdstringYesBalance Definition ID
statusstringNoTransaction status filter
transactionTypestringNoTransaction type filter
loyaltySubscriptionIdstringNoLoyalty Subscription ID filter

brevo_loyalty_list_loyalty_offer_programs_by_pid_offers

Get Reward Page API Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
limitintegerNoPage size
offsetintegerNoPagination offset
statestringNoState of the reward
versionstringNoThe version value

brevo_loyalty_list_loyalty_offer_programs_by_pid_vouchers

Get voucher for a contact Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
limitintegerNoPage size
offsetintegerNoPagination offset
sortstringNoSort order
sortFieldstringNoSort field
contactIdintegerYesContact ID
metadata_key_valuestringNoMetadata value for a Key filter
rewardIdstringNoReward ID

brevo_loyalty_partially_update_loyalty_program

Partially update loyalty program Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
descriptionstringNoLoyalty Program description
metaobjectNoLoyalty Program meta data
namestringNoLoyalty Program name

brevo_loyalty_publish_loyalty_program

Publish loyalty program Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.

brevo_loyalty_redeem_voucher

Create redeem voucher request Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
attributedRewardIdstringNoUnique identifier for the attributed reward
autoCompletebooleanNoWhether the redemption should be automatically completed
codestringNoRedemption code for the reward
contactIdintegerNoUnique identifier for the contact
loyaltySubscriptionIdstringNoIdentifier for the loyalty subscription
metaobjectNoAdditional metadata associated with the redeem request
orderobjectNoOrder details for the redemption
rewardIdstringNoUnique identifier for the reward
ttlintegerNoTime to live in seconds for the redemption request

brevo_loyalty_revoke_vouchers

Revoke vouchers Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
attributedRewardIdsstringNoReward Attribution IDs (comma seperated)

brevo_loyalty_subscribe_member_to_asubscription

Create subscription member Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
contactIdintegerNoRequired if LoyaltySubscriptionId is not provided, must be greater than 0
loyaltySubscriptionIdstringNoRequired if ContactId is not provided, max length 64
memberContactIdsinteger[]YesRequired, each item must be greater than or equal to 1

brevo_loyalty_subscribe_to_loyalty_program

Create subscription Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
contactIdintegerYesRequired contact ID; must be greater than 0.
creationDatestringNoOptional creation date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.ffffff+HH:MM). Must be in the past.
loyaltySubscriptionIdstringNoOptional subscription ID (max length 64).
metaobjectNoOptional metadata associated with the subscription.

brevo_loyalty_update_balance_definition

Update balance definition Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id
balanceAvailabilityDurationModifierstringNoDefines when the balance expires within the selected duration.
balanceAvailabilityDurationUnitstringNoUnit of time for balance validity.
balanceAvailabilityDurationValueintegerNoNumber of time units before the balance expires.
balanceExpirationDatestringNoExpiration date (dd/mm format) or empty if not applicable.
balanceOptionAmountOvertakingStrategystringNoDefines whether partial credit is allowed when reaching max balance.
balanceOptionCreditRoundingstringNoRounding strategy for credit transactions.
balanceOptionDebitRoundingstringNoRounding strategy for debit transactions.
descriptionstringNoShort description of the balance definition.
imageRefstringNoURL of an optional image reference.
maxAmountnumberNoMaximum allowable balance amount.
maxCreditAmountLimitnumberNoMaximum credit allowed per operation.
maxDebitAmountLimitnumberNoMaximum debit allowed per operation.
metaobjectNoOptional metadata for the balance definition.
minAmountnumberNoMinimum allowable balance amount.
namestringNoName of the balance definition.
unitstringNoUnit of balance measurement.

brevo_loyalty_update_balance_limit

Updates balance limit Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program Id
bdidstringYesBalance Definition Id
blidstringYesBalance Limit Id
constraintTypestringNoDefines whether the limit applies to transaction count or amount.
durationUnitstringNoUnit of time for which the limit is applicable.
durationValueintegerNoNumber of time units for the balance limit.
slidingSchedulebooleanNoDetermines if the limit resets on a rolling schedule.
transactionTypestringNoSpecifies whether the limit applies to credit or debit transactions.
valueintegerNoMaximum allowed value for the specified constraint type.

brevo_loyalty_update_loyalty_program

Update loyalty program Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID. A unique identifier for the loyalty program.
descriptionstringNoLoyalty Program description
metaobjectNoLoyalty Program meta data
namestringNoLoyalty Program name

brevo_loyalty_update_tier

Update tier Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
tidstringYesTier ID
accessConditionsobject[]NoAccess Conditions
imageRefstringNoImage of the tier
namestringNoName of the tier to be created
tierRewardsobject[]NoTier Rewards

brevo_loyalty_update_tier_group

Update tier group Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
gidstringYesTier group ID
downgradeStrategystringNoSelect 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.
metaobjectNoAdditional metadata for the tier group.
namestringNoName of the tier group
tierOrderstring[]NoOrder of the tiers in the group in ascending order
upgradeStrategystringNoSelect 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.

brevo_loyalty_validate_reward

Validate a reward Parameters:
ParameterTypeRequiredDefaultDescription
pidstringYesLoyalty Program ID
attributedRewardIdstringNoUnique identifier for the attributed reward
codestringNoValidation code for the reward
contactIdintegerNoUnique identifier for the contact
loyaltySubscriptionIdstringNoIdentifier for the loyalty subscription
pointOfSellIdstringNoIdentifier for the point of sale
rewardIdstringNoUnique identifier for the reward