Skip to main content
PUT
/
campaigns
/
{id}
Update a campaign
curl --request PUT \
  --url https://api.referralful.com/v1/campaigns/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "object": "campaign",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "url": "<string>",
  "private": true,
  "commission_percent": 123,
  "commission_amount_cents": 123,
  "commission_currency": "<string>",
  "minimum_payout_cents": 123,
  "days_before_referrals_expire": 123,
  "days_before_commissions_are_due": 123,
  "max_commissions": 123,
  "max_commission_period_in_months": 123
}
'
{
  "id": "<string>",
  "object": "campaign",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "url": "<string>",
  "private": true,
  "commission_percent": 123,
  "commission_amount_cents": 123,
  "commission_currency": "<string>",
  "minimum_payout_cents": 123,
  "days_before_referrals_expire": 123,
  "days_before_commissions_are_due": 123,
  "max_commissions": 123,
  "max_commission_period_in_months": 123
}

Authorizations

Authorization
string
header
required

Use your API secret as the username, with an empty password.

Path Parameters

id
string
required

Body

application/json
id
string
object
string
Example:

"campaign"

created_at
string<date-time>
updated_at
string<date-time>
name
string
url
string
private
boolean
reward_type
enum<string>
Available options:
percent,
amount
commission_percent
number | null
commission_amount_cents
integer | null
commission_currency
string
minimum_payout_cents
integer
days_before_referrals_expire
integer
days_before_commissions_are_due
integer
max_commissions
integer | null
max_commission_period_in_months
integer | null

Response

200 - application/json

OK

id
string
object
string
Example:

"campaign"

created_at
string<date-time>
updated_at
string<date-time>
name
string
url
string
private
boolean
reward_type
enum<string>
Available options:
percent,
amount
commission_percent
number | null
commission_amount_cents
integer | null
commission_currency
string
minimum_payout_cents
integer
days_before_referrals_expire
integer
days_before_commissions_are_due
integer
max_commissions
integer | null
max_commission_period_in_months
integer | null