API Workflows
Claim Link Distribution
Generate claim links for flexible reward distribution through your own channels, systems, and workflows.
Overview
Common claim link distribution scenarios include:
- Bulk campaigns where recipients are not pre-identified
- Survey or event-based reward distribution
- Internal distribution via platforms or portals
- Marketing campaigns and promotions
- Partner or affiliate reward distribution
Instead of sending rewards directly, the system generates claim links that can be shared flexibly.
How the API is Used
- Generate claim links for rewards
- Distribute links via your own channels such as email, SMS, or apps
- Decouple reward creation from delivery
- Track redemption and fulfillment status
Example Workflow
- Your system requests reward links via the API
- The API returns claim links
- Your system distributes the links to recipients
- Recipients claim and redeem their rewards
API Integration Flow
API Integration Flow
1
Authenticate
POST /v1/Tokens→
2
Retrieve products
GET /v1/Products→
3
Generate reward links
POST /v1/Orders (Type: Links)→
4
Track status
GET /v1/Orders/{id}or webhookExample Request
JSON
{
"Type": "Links",
"LineItems": [
{
"ProductId": "CVS",
"Value": 10,
"Quantity": 5
}
],
"PONumber": "LINKS-14001"
}
Delivery Options
- Links – Generate claim links for flexible distribution
- DigitalDelivery – Direct delivery via email or SMS
- PhysicalShipment – Ship physical gift cards
Benefits
- Enables flexible reward distribution
- Separates reward creation from delivery
- Supports anonymous or unknown recipients
- Ideal for bulk campaigns and promotions
Compliance Considerations
- Ensure secure distribution of claim links
- Monitor link usage and redemption
- Maintain tracking for audit and reporting
Common Program Types
- Survey reward distribution
- Event-based incentives
- Marketing campaigns
- Partner reward programs