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

website
object

Redeem page copy

email
object

Redeem email copy

excluded_brand_ids
array of strings

Brand IDs to exclude. Omit to skip brand update; pass [] to assign all available brands.

excluded_brand_ids
excluded_crypto_currency_ids
array of strings

Crypto currency ISO symbols to exclude. Omit to skip update; pass [] to assign all enabled crypto currencies.

excluded_crypto_currency_ids
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?