POST /loyalty/offer/programs/{pid}/rewards/redeem
Creates a request to redeem a voucher.
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
pid |
String | Yes |
Loyalty Program ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ttl |
Integer | No |
Time to live in seconds for the redemption request |
attributedRewardId |
String | No |
Unique identifier for the attributed reward |
loyaltySubscriptionId |
String | No |
Identifier for the loyalty subscription |
rewardId |
String | No |
Unique identifier for the reward |
meta |
Object | No |
Additional metadata associated with the redeem request |
code |
String | No |
Redemption code for the reward |
contactId |
Integer | No |
Unique identifier for the contact |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.