Property Type Description
id
string

Tremendous ID of the reward

order_id
string

Tremendous ID of the order this reward is part of.

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 string

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 campaign_id property.

value
object
Show object properties
Property Type Description
denomination
integer

Amount of the reward

currency_code
string

Currency of the reward

delivery
object

Details on how the reward is delivered to the recipient.

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 to the recipient via a link.

The link can be retrieved on a successfully ordered reward via the /rewards or /rewards/{id} endpoint. That link must then be delivered to the recipient out-of-band.

PHONE Deliver the reward to the recipient by SMS (US phone numbers, only)
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 (email or text message delivered or reward link opened).
  • PENDING - Delivery is pending but not yet scheduled.
link
string

Link to redeem the reward at. You need to deliver this link to the recipient.

Only available when the method for delivery is set to PHONE.

recipient
object

Details of the recipient of the reward

Show object properties
Property Type Description
name
string

Name of the recipient

email
string email

Email address of the recipient

phone
string

Phone number of the recipient (US phone numbers only)