🎫Deal Codes
Deal codes allow Stampede users to uniquely send a code for each marketing email that gets sent out from Stampede. Customers can send a birthday campaign from Stampede which includes a 10%_OFF deal within this deal, a code will be sent within each email to prevent customers from using the same code multiple times. An example of how the deal structure works below:
Get a paginated response of all deals
GET
/v1/deal
Create a new deal
POST
/v1/deal
Request Body
Name | Type | Description |
---|---|---|
name* | String | The name of the voucher |
cash_value_amount | Number | Cash value amount in pennies |
expires_at | ISO 8601 | The expiry date of the voucher |
active | Boolean | If the voucher is active or inactive |
description | String | The description of the voucher |
days_code_valid_for | Number | How long is this code valid for from date of issue |
cash_value_currency | ISO 4217 | The currency code of the cash value (for example, GBP) |
Search for a code
GET
/v1/code/search
Query Parameters
Name | Type | Description |
---|---|---|
code* | String | The code you're looking to search |
Revoke a code
POST
/v1/code/revoke
Query Parameters
Name | Type | Description |
---|---|---|
code | String | The voucher code you're looking to revoke |
Last updated