PUT
/
update
curl --request PUT \
  --url https://firstpromoter.com/api/v1/rewards/update \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "status": "approved",
  "amount": 123,
  "unit": "cash",
  "created_at": "<string>",
  "lead": "<any>",
  "event_id": "<string>",
  "conversion_amount": 123,
  "tier_level": 123,
  "promoter": {
    "id": 123,
    "status": "<string>",
    "cust_id": "<any>",
    "email": "<string>",
    "created_at": "<string>",
    "temp_password": "<string>",
    "default_promotion_id": 123,
    "pref": "<string>",
    "default_ref_id": "<string>",
    "note": "<string>",
    "w8_form_url": "<any>",
    "w9_form_url": "<any>",
    "parent_promoter_id": "<string>",
    "earnings_balance": {},
    "current_balance": {},
    "paid_balance": {},
    "auth_token": "<string>"
  },
  "promotion": {
    "id": 123,
    "status": "<string>",
    "ref_id": "<string>",
    "promo_code": "<string>",
    "customer_promo_code": "<string>",
    "target_reached_at": "<string>",
    "promoter_id": 123,
    "campaign_id": 123,
    "referral_link": "<string>",
    "current_offer": {
      "id": 123,
      "name": "<string>",
      "amount": 123,
      "unit": "<string>",
      "default_promo_code": "<string>"
    },
    "current_referral_reward": {
      "id": 123,
      "amount": 123,
      "unit": "<string>",
      "name": "<string>",
      "per_of_sale": 123,
      "default_promo_code": "<string>"
    },
    "current_promotion_reward": {},
    "current_target_reward": {},
    "campaign_name": "<string>",
    "hidden": true,
    "visitors_count": 123,
    "leads_count": 123,
    "customers_count": 123,
    "refunds_count": 123,
    "cancellations_count": 123,
    "sales_count": 123,
    "sales_total": 123,
    "refunds_total": 123,
    "active_customers_count": 123
  }
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id
string

required if the event_id is null

Id of the reward inside FirstPromoter

​
event_id
string

required if the id is null

Id of the event that generated the reward

​
status
enum<string>

New status of the reward

Available options:
approved,
pending,
denied

Response

200
application/json
Update reward response
​
id
number

ID of the reward

​
status
enum<string>

status of the reward.

Available options:
approved,
pending,
denied
​
amount
integer

amount of the reward. For reward_type cash(monetary commission) the amount is in cents

​
unit
enum<string>

The reward unit.

Available options:
cash,
credits,
points,
free_months
​
created_at
string

ISO date string at which the reward is created

​
lead
any
​
event_id
string
​
conversion_amount
integer
​
tier_level
integer

The reward tier level

​
promoter
object
​
promotion
object
List rewards and commissionsList payouts