How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Brevo Reward API

The reward API from Brevo — 9 operation(s) for reward.

Brevo Reward API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Reward. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 10 operations across 9 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

10 operations 9 paths 31 schemas 1 DELETE4 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo Reward API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

  • api-key — The API key should be passed in the request headers as api-key for authentication.

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

reward 10
GET
/loyalty/offer/programs/{pid}/code-pools/{cpid}/codes-count
Get code count
getCodeCount 3 params → 200400401403422500
GET
/loyalty/offer/programs/{pid}/vouchers
Get voucher for a contact
getVoucherForAContact 9 params → 200401403404422500
GET
/loyalty/offer/programs/{pid}/offers
Get Reward Page API
getRewardPageApi 6 params → 200401403404422424500
POST
/loyalty/offer/programs/{pid}/offers
Create a reward
createReward 2 params body → 200401403422500
GET
/loyalty/offer/programs/{pid}/rewards/{rid}
Get reward information
getRewardInformation 4 params → 200401403404422424500
POST
/loyalty/offer/programs/{pid}/rewards/attribute
Create a voucher
createVoucher 2 params body → 200400401403404422500
POST
/loyalty/offer/programs/{pid}/rewards/redeem
Create redeem voucher request
redeemVoucher 2 params body → 200400401403404412417422
POST
/loyalty/offer/programs/{pid}/rewards/redeem/{tid}/complete
Complete redeem voucher request
completeRedeemTransaction 3 params → 200400401403404412417422
DELETE
/loyalty/offer/programs/{pid}/rewards/revoke
Revoke vouchers
revokeVouchers 3 params → 204404500
POST
/loyalty/offer/programs/{pid}/rewards/validate
Validate a reward
validateReward 2 params body → 200401403404422424500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Reward_getRewardInformation_Response_200 (40 properties), redeem (14 properties), LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaRule (13 properties), Reward_createVoucher_Response_200 (12 properties). Each schema is shown below with its type and property counts.

LoyaltyOfferProgramsPidRewardsRedeemPostRequestBodyContentApplicationJsonSchemaOrder
object
Order details for the redemption
12 properties
Reward_getCodeCount_Response_200
object
1 property
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaRewardConfigs
object
object
3 properties
ruleConditionResponse
object
5 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaRuleResultsItemsParametersItems
object
2 properties
LoyaltyOfferProgramsPidOffersGetParametersVersion
string
Reward_getVoucherForAContact_Response_200
object
5 properties
Reward_createReward_Response_200
object
8 properties
LoyaltyOfferProgramsPidVouchersGetParametersSortField
string
LoyaltyOfferProgramsPidRewardsRidGetParametersVersion
string
LoyaltyOfferProgramsPidOffersGetResponsesContentApplicationJsonSchemaItemsItems
object
9 properties
Reward_createVoucher_Response_200
object
12 properties
valueResponse
object
8 properties
LoyaltyOfferProgramsPidRewardsRedeemPostRequestBodyContentApplicationJsonSchemaOrderProductsItems
object
5 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaGenerator
object
object
6 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaProductsItems
object
4 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaExpirationModifier
string
Select startOfPeriod to configure rewards expiry on start of day/week/month/year. Select endOfPeriod to configure reward expiry on end of day/week/month/year,…
redeem
object
14 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaLimitsItems
object
8 properties
nodeResponse
object
8 properties
Reward_getRewardPageApi_Response_200
object
2 properties
LoyaltyOfferProgramsPidVouchersGetParametersSort
string
errorModel
object
2 properties 1 required
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaRuleResultsItems
object
3 properties
LoyaltyOfferProgramsPidRewardsRedeemPostRequestBodyContentApplicationJsonSchemaOrderBilling
object
Billing information for the order
7 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaRule
object
Rule to define the reward
13 properties
LoyaltyOfferProgramsPidRewardsRedeemPostRequestBodyContentApplicationJsonSchemaOrderIdentifiers
object
Additional identifiers for the order
2 properties
Reward_getRewardInformation_Response_200
object
40 properties
LoyaltyOfferProgramsPidRewardsRidGetResponsesContentApplicationJsonSchemaRuleEvent
object
Selected event in the rule
2 properties
LoyaltyOfferProgramsPidVouchersGetResponsesContentApplicationJsonSchemaContactRewardsItems
object
11 properties
Reward_validateReward_Response_200
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-reward-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
brevo Automated Messages API
brevo Campaign Statistics API
brevo Categories API
brevo Contact Attributes API
brevo Contact Lists API
brevo Contacts API
brevo Email Activity API
brevo Email Campaigns API
brevo Email Templates API
brevo Folders API
brevo Import API
Where this information came from

This is an independent, third-party profile of Brevo Reward API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.