id
| string | |
name
| string | Name of the campaign |
description
| string | Description of the campaign |
products
| array string | List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. |
fee_charged_to
| string | Determines whether fees for premium products are added to the order total (SENDER) or deducted from the recipient's reward amount (RECIPIENT). Campaigns with RECIPIENT must include at least one fee-free product. |
auto_add_product_rule
| object | When enabled, newly activated gift card products that match the optional country and currency filters are added to this campaign automatically. Applies to gift cards only — premium options, prepaid cards, and merchant cards with vendor fees are excluded. Affects future rewards only and does not retroactively add products to unredeemed rewards. On read, enabled is true whenever a rule is configured; countries and currencies are only present when the rule actually filters on them — an absent filter matches all values. On write:
* Omit the field on PUT to leave the existing rule unchanged.
* Send null or { "enabled": false } to clear any existing rule.
* Send { "enabled": true, ... } to upsert. countries and currencies are
optional; when present they must contain at least one entry. To match all
countries (or all currencies), simply omit the key.
* An empty object ({}) is rejected because enabled is required — use
{ "enabled": false } or null to clear the rule. |
|
Show object properties
| Property |
Type |
Description |
enabled
| boolean | Whether the auto-add rule is active. |
countries
| array string | ISO 3166-1 alpha-2 country codes (uppercase). When omitted, the rule matches all countries; when present, must contain at least one entry. Each code must be covered by at least one active Tremendous product — requests filtering on a country we don't currently sell into are rejected with a 422. |
currencies
| array string | ISO 4217 currency codes (uppercase). When omitted, the rule matches all currencies; when present, must contain at least one entry. Each code must be covered by at least one active Tremendous product — requests filtering on a currency we don't currently sell are rejected with a 422. |
|
webpage_style
| object | Definition of the webpage style |
|
Show object properties
| Property |
Type |
Description |
headline
| string | Headline for the reward page |
message
| string | Message for the reward page |
logo_image_url
| string | URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location. |
logo_image_height_px
| integer | Image height in pixels |
logo_background_color
| string | Logo background color code (hex, rgb, or rgba) |
background_color
| string | Background color code (hex, rgb, or rgba) |
|
email_style
| object | Definition of the email style |
|
Show object properties
| Property |
Type |
Description |
sender_name
| string | If sending via email, this is how the email will appear to be sent from |
subject_line
| string | Email subject line |
logo_image_url
| string | URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location. |
logo_image_height_px
| integer | Image height in pixels |
logo_background_color
| string | Logo background color code (hex, rgb, or rgba) |
button_color
| string | Button color code (hex, rgb, or rgba) |
|
