API Reference

Update campaign

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

Updates a campaign. All fields can be updated on any non-archived campaign.

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

ID of the campaign to update

Body Params

All fields are optional. Only provided fields will be updated. Text fields support template variables: {{recipient_name}}, {{amount}}.

string

Campaign name

string
Defaults to Company name

Sender name shown in outgoing emails

string | null

Optional campaign description

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 to skip brand update; pass [] to assign 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