API Reference

Create campaign

post
https://{environment}.gifq.com/api/campaigns

With a campaign you can define how gift card payouts are presented and delivered to recipients. It also lets you configure which brands (gift cards, etc.) recipients can choose from.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Campaign creation details. Text fields support template variables: {{recipient_name}}, {{amount}}.

string
required

Campaign name

string

Sender name shown in outgoing emails (defaults to company name)

string
Defaults to You've received a gift, {{recipient_name}}!

Headline displayed on the redeem page

string
Defaults to Claim your {{amount}} gift card below.

Body text displayed on the redeem page

string
Defaults to Your reward is here, {{recipient_name}}

Subject line of the redeem email

string
Defaults to Hi {{recipient_name}}, you have {{amount}} waiting.

Body text of the redeem email

excluded_brand_ids
array of strings

Brand IDs to exclude (omit or pass [] to include all available brands)

excluded_brand_ids
Responses

Updated 9 days ago

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

Updated 9 days ago