Create campaign

Body Params

Campaign details

With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.

string
required

Name of the campaign

string | null
required

Description of the campaign

products
array of strings
required

List of IDs of products (different gift cards, charity, etc.) that are available in this campaign.

products*
string | null
enum

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.

Allowed:
auto_add_product_rule
object | null

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.
webpage_style
object

Definition of the webpage style

email_style
object

Definition of the email style

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json