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)

website
object

Redeem page copy

email
object

Redeem email copy

excluded_brand_ids
array of strings

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

excluded_brand_ids
excluded_crypto_currency_ids
array of strings

Crypto currency ISO symbols to exclude. Omit or pass [] to include all enabled crypto currencies. Only relevant when payout_types includes crypto.

excluded_crypto_currency_ids
payout_types
array of strings

Payout types accepted for this campaign

payout_types
Allowed:
Responses

Updated 4 months ago

Did this page help you?
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 4 months ago

Did this page help you?