Tremendous ID of the order this reward is part of.
created_at
string (date-time)
Date the reward was created
campaign_id
string
ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
products
array of strings
List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.
Providing a products array will override the products made available by the campaign specified using the campaign_id property unless the products array is empty. It will not override other campaign attributes, like the message and customization of the look and feel.
value
object
Show object properties
Property
Type
Description
denomination
number (double)
Amount of the reward
currency_code
string
Currency of the reward
recipient
object
Show object properties
Property
Type
Description
name
string
Name of the recipient
email
string
Email address of the recipient
phone
string
Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).
deliver_at
string (date)
Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
custom_fields
array
Show array item type
Property
Type
Description
id
string
Tremendous ID of the custom field
value
string
Value of the custom field
label
string
Label of the custom field
delivery
object
Show object properties
Property
Type
Description
method
string
How to deliver the reward to the recipient.
Delivery Method
Description
EMAIL
Deliver the reward to the recipient by email
LINK
Deliver the reward via a link, retrieved from /rewards or /rewards/{id} endpoint and delivered out-of-band.
PHONE
Deliver the reward to the recipient by SMS
status
string
Current status of the delivery of the reward:
SCHEDULED - Reward is scheduled for delivery and will be delivered soon.
FAILED - Delivery of reward failed (e.g. email bounced).
SUCCEEDED - Reward was successfully delivered.
PENDING - Delivery is pending but not yet scheduled.
