/brevo-loyalty | Type: Application | PCID required: Yes
Tools
brevo_loyalty_add_subscription_to_tier
Assign a tier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
cid | string | Yes | — | Contact ID |
tid | string | Yes | — | Tier ID |
brevo_loyalty_begin_transaction
Create new transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
amount | number | Yes | — | Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided). |
autoComplete | boolean | No | — | Whether the transaction should be automatically completed. |
balanceDefinitionId | string | Yes | — | Unique identifier (UUID) of the associated balance definition. |
balanceExpiryInMinutes | integer | No | — | Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true. |
contactId | integer | No | — | Unique identifier of the contact involved in the transaction. Required unless LoyaltySubscriptionId is provided. |
eventTime | string | No | — | Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format). |
LoyaltySubscriptionId | string | No | — | Unique identifier for the loyalty subscription. Required unless contactId is provided. |
meta | object | No | — | Optional metadata associated with the transaction. |
transactionType | string | No | — | Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). |
ttl | integer | No | — | Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided. |
brevo_loyalty_cancel_transaction
Cancel transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
tid | string | Yes | — | Transaction Id |
brevo_loyalty_complete_redeem_transaction
Complete redeem voucher request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
tid | string | Yes | — | Redeem transaction ID |
brevo_loyalty_complete_transaction
Complete transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
tid | string | Yes | — | Transaction Id |
brevo_loyalty_create_balance_limit
Create balance limits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
constraintType | string | Yes | — | Defines whether the limit applies to transaction count or amount. |
durationUnit | string | Yes | — | Unit of time for which the limit is applicable. |
durationValue | integer | Yes | — | Number of time units for the balance limit. |
slidingSchedule | boolean | No | — | Determines if the limit resets on a rolling schedule. |
transactionType | string | Yes | — | Specifies whether the limit applies to credit or debit transactions. |
value | integer | Yes | — | Maximum allowed value for the specified constraint type. |
brevo_loyalty_create_balance_order
Create balance order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
amount | number | Yes | — | Order amount (must be non-zero). |
balanceDefinitionId | string | Yes | — | Unique identifier (UUID) of the associated balance definition. |
contactId | integer | Yes | — | Unique identifier of the contact placing the order (must be ≥ 1). |
dueAt | string | Yes | — | RFC3339 timestamp specifying when the order is due. |
expiresAt | string | No | — | Optional RFC3339 timestamp defining order expiration. |
meta | object | No | — | Optional metadata associated with the order. |
source | string | Yes | — | Specifies the origin of the order. |
brevo_loyalty_create_loyalty_balance_programs_by_pid_balance_definitions
Create balance definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
balanceAvailabilityDurationModifier | string | No | — | Defines when the balance expires within the selected duration. |
balanceAvailabilityDurationUnit | string | No | — | Unit of time for balance validity. |
balanceAvailabilityDurationValue | integer | No | — | Number of time units before the balance expires. |
balanceExpirationDate | string | No | — | Fixed expiration date (dd/mm format) as an alternative to duration-based expiry. |
balanceOptionAmountOvertakingStrategy | string | No | — | Defines whether partial credit is allowed when reaching max balance. |
balanceOptionCreditRounding | string | No | — | Defines rounding strategy for credit transactions. |
balanceOptionDebitRounding | string | No | — | Defines rounding strategy for debit transactions. |
description | string | No | — | Short description of the balance definition. |
imageRef | string | No | — | URL of an optional image reference. |
maxAmount | number | No | — | Maximum allowable balance amount. |
maxCreditAmountLimit | number | No | — | Maximum credit allowed per operation. |
maxDebitAmountLimit | number | No | — | Maximum debit allowed per operation. |
meta | object | No | — | Additional metadata for the balance definition. |
minAmount | number | No | — | Minimum allowable balance amount. |
name | string | Yes | — | Name of the balance definition. |
unit | string | Yes | — | Unit of balance measurement. |
brevo_loyalty_create_loyalty_balance_programs_by_pid_subscriptions_by_cid_balances
Create subscription balances Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
cid | string | Yes | — | Contact Id |
balanceDefinitionId | string | Yes | — | Unique identifier (UUID) of the balance definition associated with the new balance. |
brevo_loyalty_create_new_lp
Create loyalty program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Optional description of the loyalty program (max 256 chars). |
documentId | string | No | — | Optional unique document ID. |
meta | object | No | — | Optional metadata related to the loyalty program. |
name | string | Yes | — | Required name of the loyalty program (max 128 chars). |
brevo_loyalty_create_reward
Create a reward Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
name | string | Yes | — | Internal name of the reward |
publicDescription | string | No | — | Public facing description of the reward |
publicImage | string | No | — | URL of the public image for the reward |
publicName | string | No | — | Public facing name of the reward |
brevo_loyalty_create_tier_for_tier_group
Create a tier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
gid | string | Yes | — | Tier group ID |
accessConditions | object[] | Yes | — | Access Conditions |
imageRef | string | No | — | Image of the tier |
name | string | Yes | — | Name of the tier to be created |
tierRewards | object[] | No | — | Tier Rewards |
brevo_loyalty_create_tier_group
Create a tier group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
downgradeSchedule | object | No | — | Schedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy. |
downgradeStrategy | string | No | — | Select 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. |
meta | object | No | — | Additional metadata for the tier group. |
name | string | Yes | — | Name of the tier group |
tierOrder | string[] | No | — | Order of the tiers in the group in ascending order |
upgradeSchedule | object | No | — | Schedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy. |
upgradeStrategy | string | No | — | Select 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
code | string | No | — | Code generated to attribute reward to a contact |
contactId | integer | No | — | Contact to attribute the reward |
expirationDate | string | No | — | Reward expiration date |
loyaltySubscriptionId | string | No | — | One of contactId or loyaltySubscriptionId is required |
meta | object | No | — | Offer meta information (key/value object) |
rewardId | string | Yes | — | Reward id |
validFrom | string | No | — | Date 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. |
value | number | No | — | Value of the selected reward config |
brevo_loyalty_delete_balance_definition
Delete balance definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
brevo_loyalty_delete_balance_limit
Delete balance limit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
blid | string | Yes | — | Balance Limit Id |
brevo_loyalty_delete_contact_members
Delete subscription member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
memberContactIds | string | Yes | — | Comma-separated list of member contact IDs to delete from the subscription. |
brevo_loyalty_delete_contact_subscription
Delete subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
cid | integer | Yes | — | Contact ID. |
brevo_loyalty_delete_program
Delete Loyalty Program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
brevo_loyalty_delete_tier
Delete tier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
tid | string | Yes | — | Tier ID |
brevo_loyalty_delete_tier_group
Delete tier group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
gid | string | Yes | — | Tier group ID |
brevo_loyalty_get_balance_definition
Get balance definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
version | string | No | — | The version value |
brevo_loyalty_get_balance_definition_list
Get balance definition list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
limit | integer | No | — | Limit the number of records returned |
offset | integer | No | — | Offset to paginate records |
sortField | string | No | — | Field to sort by |
sort | string | No | — | Sort direction |
version | string | No | — | The version value |
brevo_loyalty_get_balance_limit
Get balance limits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
version | string | No | — | The version value |
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
blid | string | Yes | — | Balance Limit Id |
brevo_loyalty_get_code_count
Get code count Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
cpid | string | Yes | — | Code Pool ID |
brevo_loyalty_get_contact_balances
Get balance list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
includeInternal | boolean | No | — | Include balances tied to internal definitions. |
limit | integer | No | — | Limit the number of records returned |
offset | integer | No | — | Skip a number of records |
sort | string | No | — | Sort order |
sortField | string | No | — | Field to sort by |
balanceDefinitionId | string | Yes | — | Balance Definition ID (required) |
brevo_loyalty_get_list_of_tier_groups
List tier groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
version | string | No | — | Select ‘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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of documents per page |
offset | integer | No | — | Index of the first document in the page |
sort_field | string | No | — | Sort documents by field |
sort | string | No | — | Sort order |
brevo_loyalty_get_offer_programs_by_pid_rewards_by_rid
Get reward information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
rid | string | Yes | — | Reward ID |
version | string | No | — | The version value |
brevo_loyalty_get_parameter_subscription_info
Get Subscription Data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
contactId | string | No | — | The contact ID to filter by. |
params | string | No | — | A list of filter parameters for querying the subscription info. |
loyaltySubscriptionId | string | No | — | The loyalty subscription ID to filter by. |
includeInternal | boolean | No | — | Include balances tied to internal definitions. |
brevo_loyalty_get_program_info
Get loyalty program Info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
brevo_loyalty_get_program_tier
List tiers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
version | string | No | — | Select ‘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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cid | string | Yes | — | Contact Id |
pid | string | Yes | — | Loyalty Program Id |
includeInternal | boolean | No | — | Include balances tied to internal definitions. |
brevo_loyalty_get_tier_group
Get tier group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
gid | string | Yes | — | Tier group ID |
version | string | No | — | Select 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
sortField | string | No | — | Sort Field |
sort | string | No | — | Sort Order |
contactId | integer | Yes | — | Contact ID |
balanceDefinitionId | string | Yes | — | Balance Definition ID |
includeInternal | boolean | No | — | Include balances tied to internal definitions. |
brevo_loyalty_list_loyalty_balance_programs_by_pid_transaction_history
Get Transaction History API Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
limit | integer | No | — | Limit the number of records returned |
offset | integer | No | — | Page number to retrieve |
sortField | string | No | — | Field to sort by |
sort | string | No | — | Sort order |
contactId | integer | Yes | — | Contact ID |
balanceDefinitionId | string | Yes | — | Balance Definition ID |
status | string | No | — | Transaction status filter |
transactionType | string | No | — | Transaction type filter |
loyaltySubscriptionId | string | No | — | Loyalty Subscription ID filter |
brevo_loyalty_list_loyalty_offer_programs_by_pid_offers
Get Reward Page API Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
limit | integer | No | — | Page size |
offset | integer | No | — | Pagination offset |
state | string | No | — | State of the reward |
version | string | No | — | The version value |
brevo_loyalty_list_loyalty_offer_programs_by_pid_vouchers
Get voucher for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
limit | integer | No | — | Page size |
offset | integer | No | — | Pagination offset |
sort | string | No | — | Sort order |
sortField | string | No | — | Sort field |
contactId | integer | Yes | — | Contact ID |
metadata_key_value | string | No | — | Metadata value for a Key filter |
rewardId | string | No | — | Reward ID |
brevo_loyalty_partially_update_loyalty_program
Partially update loyalty program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
description | string | No | — | Loyalty Program description |
meta | object | No | — | Loyalty Program meta data |
name | string | No | — | Loyalty Program name |
brevo_loyalty_publish_loyalty_program
Publish loyalty program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
brevo_loyalty_redeem_voucher
Create redeem voucher request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
attributedRewardId | string | No | — | Unique identifier for the attributed reward |
autoComplete | boolean | No | — | Whether the redemption should be automatically completed |
code | string | No | — | Redemption code for the reward |
contactId | integer | No | — | Unique identifier for the contact |
loyaltySubscriptionId | string | No | — | Identifier for the loyalty subscription |
meta | object | No | — | Additional metadata associated with the redeem request |
order | object | No | — | Order details for the redemption |
rewardId | string | No | — | Unique identifier for the reward |
ttl | integer | No | — | Time to live in seconds for the redemption request |
brevo_loyalty_revoke_vouchers
Revoke vouchers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
attributedRewardIds | string | No | — | Reward Attribution IDs (comma seperated) |
brevo_loyalty_subscribe_member_to_asubscription
Create subscription member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
contactId | integer | No | — | Required if LoyaltySubscriptionId is not provided, must be greater than 0 |
loyaltySubscriptionId | string | No | — | Required if ContactId is not provided, max length 64 |
memberContactIds | integer[] | Yes | — | Required, each item must be greater than or equal to 1 |
brevo_loyalty_subscribe_to_loyalty_program
Create subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
contactId | integer | Yes | — | Required contact ID; must be greater than 0. |
creationDate | string | No | — | Optional creation date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.ffffff+HH:MM). Must be in the past. |
loyaltySubscriptionId | string | No | — | Optional subscription ID (max length 64). |
meta | object | No | — | Optional metadata associated with the subscription. |
brevo_loyalty_update_balance_definition
Update balance definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
balanceAvailabilityDurationModifier | string | No | — | Defines when the balance expires within the selected duration. |
balanceAvailabilityDurationUnit | string | No | — | Unit of time for balance validity. |
balanceAvailabilityDurationValue | integer | No | — | Number of time units before the balance expires. |
balanceExpirationDate | string | No | — | Expiration date (dd/mm format) or empty if not applicable. |
balanceOptionAmountOvertakingStrategy | string | No | — | Defines whether partial credit is allowed when reaching max balance. |
balanceOptionCreditRounding | string | No | — | Rounding strategy for credit transactions. |
balanceOptionDebitRounding | string | No | — | Rounding strategy for debit transactions. |
description | string | No | — | Short description of the balance definition. |
imageRef | string | No | — | URL of an optional image reference. |
maxAmount | number | No | — | Maximum allowable balance amount. |
maxCreditAmountLimit | number | No | — | Maximum credit allowed per operation. |
maxDebitAmountLimit | number | No | — | Maximum debit allowed per operation. |
meta | object | No | — | Optional metadata for the balance definition. |
minAmount | number | No | — | Minimum allowable balance amount. |
name | string | No | — | Name of the balance definition. |
unit | string | No | — | Unit of balance measurement. |
brevo_loyalty_update_balance_limit
Updates balance limit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program Id |
bdid | string | Yes | — | Balance Definition Id |
blid | string | Yes | — | Balance Limit Id |
constraintType | string | No | — | Defines whether the limit applies to transaction count or amount. |
durationUnit | string | No | — | Unit of time for which the limit is applicable. |
durationValue | integer | No | — | Number of time units for the balance limit. |
slidingSchedule | boolean | No | — | Determines if the limit resets on a rolling schedule. |
transactionType | string | No | — | Specifies whether the limit applies to credit or debit transactions. |
value | integer | No | — | Maximum allowed value for the specified constraint type. |
brevo_loyalty_update_loyalty_program
Update loyalty program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID. A unique identifier for the loyalty program. |
description | string | No | — | Loyalty Program description |
meta | object | No | — | Loyalty Program meta data |
name | string | No | — | Loyalty Program name |
brevo_loyalty_update_tier
Update tier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
tid | string | Yes | — | Tier ID |
accessConditions | object[] | No | — | Access Conditions |
imageRef | string | No | — | Image of the tier |
name | string | No | — | Name of the tier to be created |
tierRewards | object[] | No | — | Tier Rewards |
brevo_loyalty_update_tier_group
Update tier group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
gid | string | Yes | — | Tier group ID |
downgradeStrategy | string | No | — | Select 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. |
meta | object | No | — | Additional metadata for the tier group. |
name | string | No | — | Name of the tier group |
tierOrder | string[] | No | — | Order of the tiers in the group in ascending order |
upgradeStrategy | string | No | — | Select 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pid | string | Yes | — | Loyalty Program ID |
attributedRewardId | string | No | — | Unique identifier for the attributed reward |
code | string | No | — | Validation code for the reward |
contactId | integer | No | — | Unique identifier for the contact |
loyaltySubscriptionId | string | No | — | Identifier for the loyalty subscription |
pointOfSellId | string | No | — | Identifier for the point of sale |
rewardId | string | No | — | Unique identifier for the reward |

