Links

Update campaign

Updates the specified campaign by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Request

Method
URL
PUT
https://api.getrewardful.com/v1/campaigns/:id

Parameters

Parameter
Required?
Description
name
No
The campaign's name
url
No
The base URL that will be used to generate affiliate links for the campaign
private
No
true if the campaign should be invite-only, false if it should be open to the public. (Default: false)
reward_type
No
The type of reward associated with this campaign - percent or amount
commission_percent
No
The commission percentage for this campaign
commission_amount_cents
No
The amount of the fixed commission for this campaign in cents
commission_amount_currency
No
ISO currency code in which the fixed commission for this campaign is denominated. Fixed commissions can be defined in any currency, but they will be converted to and displayed in your company's display currency when awarded.
minimum_payout_cents
No
The minimum amount of cumulative commissions required for an affiliate to receive a payout in cents denominated in your company's display currency. (Default: 0)
stripe_coupon_id
No
The ID of the Stripe coupon associated with this campaign, used for double-sided incentives. Since this feature is only enabled for customers on our Growth and Enterprise plans, attempts by other subscribers to set a value for this with result in an error.

Example

curl --request PUT \
--url https://api.getrewardful.com/v1/campaigns/ceaef6d9-767e-49aa-a6ab-46c02aa79604 \
-u YOUR_API_SECRET: \
-d "name=Best All Time Friends of Rewardful" \
-d minimum_payout_cents=1000

Response

Success
Failures
Response code
Body
200

Not found

Response code
Body
404
JSON object describing the error.
{ "error": "Campaign not found: " }

Authentication failure

Response code
Body
401
Description of the authentication failure.
{ "error": "Invalid API Secret." }