API FAQs

Absolutely! You’ve got both options with Giftbit 🚀

• You can receive a unique URL (“Giftbit link”) and deliver it however you like—through your own email service, text, Slack, CRM, social DM, or even QR code source.
• Or, you can create a custom email template in Giftbit and have Giftbit send the email (with the reward link and messaging) directly to the recipient for you source.

Both methods give you flexibility and full tracking! 🎉

You can specify the template in your API call using the
gift_template
field! ⚡
Just include the unique template ID in the
gift_template
parameter when creating your reward order via the API.
This tells Giftbit exactly which template (and all its associated branding, messaging, and reward options) to use for that order—so you don’t have to rebuild the content for every send source.
For example:

{
  "gift_template": "YOUR_TEMPLATE_ID",
  ...
}
It’s a super easy way to keep your content organized and consistent! 🎯

Yes! You can pass variables like recipient name in your API call, and Giftbit will automatically embed them in your template using tokens (like

) 😃
For example, include fields such as
firstname
or
email
in the contact data within your API call.
Giftbit will substitute these variables in the template wherever you use tokens—so your emails stay personal and dynamic source.
No extra magic needed—Giftbit does the merge for you! ✉️✨

You’ll include these fields as part of each contact object, inside the contacts array in your API request body! 👇
Each contact is an object within the
contacts
array, using keys like
email
,
firstname
, and
lastname
(if desired).
Example:
{
  "gift_template": "YOUR_TEMPLATE_ID",
  "contacts": [
    {
      "email": "jane@example.com",
      "firstname": "Jane",
      "lastname": "Doe"
    },
    {
      "email": "bob@example.com",
      "firstname": "Bob"
    }
  ]
}
Giftbit pulls these values and merges them into your template for each recipient! source 🎉

That’s exactly right—the

contacts

array lets you send the same reward to multiple recipients at once! 📧📧📧

• Each contact in the array receives their own customized reward email, using the template you specify.
• Personalized details (like name or custom message) are merged for each recipient, and delivery/tracking is managed individually for every contact source.

It’s super efficient for sending in bulk—one API call, multiple personalized rewards! 🚀

Creating an email template in Giftbit is super simple! 📝✨

• Log in to your Giftbit account and go to the Templates section.
• Click “New Template” and fill out the details: template name, subject, logo, company name, message body, reward selection, value, and region.
• Personalize the message with tokens like
  and even use emojis for extra flair!
• Save your template—this generates a unique template ID you’ll use in your API calls source.

You’re ready to use it for sending rewards or API automations! 🎉

No problem! You can set the reward value dynamically at send time, even if your template has a default value. ⚡️
When using the API, just specify the value you want for each recipient in your API call, instead of relying on the template’s default value.
The value you send in the request will override the template’s value for that particular send source.
This gives you complete flexibility to personalize reward amounts in real time! 💸🎯

Nope, you do not need to create a campaign first for direct link requests! 🚀

With Giftbit’s API, you can generate direct link rewards immediately by making a
POST
request to the
/direct_links
endpoint.
Just include the necessary info (e.g.,
price_in_cents
,
brand_codes
, or
region
, plus your unique
id
), and it will generate the links in real-time—no separate campaign setup required source.
Super fast and flexible! 🎯

Creating a campaign in Giftbit is as easy as making a
POST
request to the
/campaign
endpoint! 📨
Use
POST https://api.giftbit.com/papi/v1/campaign
(or the testbed equivalent).
Include required keys in your JSON body, such as:
contacts
: an array of recipient objects (with at least
email
)
Optionally,
gift_template
(the template ID)
Or, specify
price_in_cents
+
brand_codes
for your custom setup
Add optional settings like
expiry
,
subject
, or custom message
Here’s a simple example:

{
  "contacts": [
    {
      "email": "jane@example.com",
      "firstname": "Jane"
    }
  ],
  "gift_template": "YOUR_TEMPLATE_ID",
  "price_in_cents": 500,
  "brand_codes": ["amazonus"],
  "id": "youruniqueid123"
}
A campaign lets you send personalized reward emails using your chosen template and reward settings—it’s perfect for bulk and automated sending! 

Best practices for setting up expiration dates (“claim-by” dates) on Giftbit rewards 👇

• Use claim-by dates (“expiry”) for promotions: Promotions, demo incentives, or limited-time offers benefit from a set expiry, which creates urgency and helps manage costs if rewards go unclaimed source.
• Leave no expiry for earned rewards: For employee recognition, loyalty, or payouts earned by recipients, skip the expiry—this feels fair and builds trust source.
• Set realistic windows: Typical expiry periods range from 30–90 days, but you can choose from 1 to 365 days to fit your campaign.
• Send reminders: Giftbit automatically sends a reminder email 30 days before the expiry if the claim window is longer than 30 days source.
• Partial credit on unclaimed promotional rewards: With promotional rewards, you get partial credit back on unclaimed value, which helps stretch your budget source.

⚡ Choose expiries to match your goals—urgency for promos, endless access for appreciation!

The mandatory fields for creating a direct link with the Giftbit API are:
price_in_cents
: The reward value in cents (e.g., 500 = $5.00).
Either:
brand_codes
: An array of brand codes offered (for custom brand selection),
OR
region
: The region code (for full catalog choice in a given geographic area).
id
: A unique identifier for your request (ensures idempotency and tracking).
Here’s a minimal example:

{
  "price_in_cents": 1000,
  "brand_codes": ["amazonus"],
  "id": "unique-direct-link-id-001"
}
OR for a full-catalog region-based link:

{
  "price_in_cents": 1000,
  "region": "US",
  "id": "unique-direct-link-id-002"
}
These fields are required; all other fields are optional!

Yes, you can batch create direct links in a single API call! 🎉
Use the
link_count
field in your
/direct_links
POST request to specify how many direct links you want to generate at once.
You do not need to provide a contacts array—just set your desired
link_count
along with the usual fields like
price_in_cents
,
brand_codes
or
region
, and
id
.
Example:

{
  "price_in_cents": 500,
  "brand_codes": ["amazonus"],
  "link_count": 10,
  "id": "your-batch-id-001"
}
This will return 10 unique direct links, ready for you to deliver any way you like!