API Workflows

Branded Reward Delivery

Deliver digital rewards with branding templates and personalized messaging for a consistent, on-brand experience.

Overview

Common branded delivery scenarios include:

  • Employer-branded wellness rewards
  • Healthcare program communications
  • Customer loyalty and engagement campaigns
  • Partner and affiliate reward programs
  • Platform-driven reward experiences

Instead of sending generic rewards, organizations can deliver gift cards within a branded and personalized experience.

How the API is Used

  • Apply predefined branding templates to digital rewards
  • Customize recipient messaging with To, From, and Message
  • Maintain a consistent brand experience across programs
  • Deliver rewards via email, SMS, or claim links
  • Track fulfillment and delivery status

Example Workflow

  • Organization defines branding templates within the platform
  • Your system selects the appropriate branding for the program
  • Your system triggers a reward via the API with branding applied
  • The recipient receives a branded reward experience

API Integration Flow

API Integration Flow

1
Authenticate
POST /v1/Tokens
2
Retrieve products
GET /v1/Products
3
Retrieve brandings
GET /v1/Brandings
4
Send reward with BrandingId
POST /v1/Orders
5
Track status
GET /v1/Orders/{id}or webhook

Example Request

JSON
{
  "Type": "DigitalDelivery",
  "LineItems": [
    {
      "ProductId": "CVS",
      "Value": 25,
      "Quantity": 1,
      "BrandingId": "BRAND-123",
      "DigitalDeliveryAddress": {
        "Email": "user@email.com"
      },
      "Personalization": {
        "To": "Participant",
        "FromName": "Wellness Program",
        "Message": "Thank you for participating in our program."
      }
    }
  ],
  "PONumber": "BRANDED-16001"
}

Delivery Options

  • DigitalDelivery – Send branded rewards via email or SMS
  • Links – Generate branded claim links for distribution
  • PhysicalShipment – Ship physical gift cards, where branding may vary by program

Benefits

  • Delivers a consistent, on-brand reward experience
  • Improves engagement and recipient trust
  • Enhances program identity across campaigns
  • Supports multi-program and multi-client environments

Compliance Considerations

  • Ensure branding and messaging align with organizational guidelines
  • Maintain consistency across programs and communications
  • Validate personalization content before delivery

Common Program Types

  • Employer wellness programs
  • Healthcare incentive programs
  • Customer engagement campaigns
  • Partner and affiliate programs