v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Promoter Campaigns

Update promoter campaign

With this endpoint you can update a promoter campaign. <Tip>HTTP Request <br/>PUT https://api.firstpromoter.com/api/v2/company/promoter_campaigns/{id}</Tip>

put/promoter_campaigns/{id}

Path parameters

idinteger required

Promoter campaign ID. This ID is not the promoter’s ID or the campaign’s ID. It’s the linking record that defines the promoter’s participation in that campaign. You can find this id in each object in the promoter_campaigns array when you get the details of the promoter.

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Request body

ref_tokenstring

state'pending' | 'accepted' | 'rejected' | 'blocked' | 'inactive'

couponstring

display_couponstring

direct_urlstring

promoter_rewards_customizedboolean

referral_rewards_customizedboolean

Response

Updated promoter campaign

idinteger

Id of the promoter campaign

campaign_idinteger

Id of the campaign

promoter_idinteger

Id of the promoter

created_atstring date-time

Date and time when the promoter campaign was created

Example response

{
  "promoter": {
    "id": 3920164,
    "status": "active",
    "email": "peluwydo@mailinator.com",
    "created_at": "2022-04-26T15:28:24.800Z",
    "temp_password": "xxxxxxxxxx",
    "default_promotion_id": 4210919,
    "pref": "db1znwe",
    "default_ref_id": "8yi2epelut",
    "note": "This is a note",
    "parent_promoter_id": 577918,
    "earnings_balance": {
      "cash": 50744
    },
    "current_balance": {
      "cash": 20044
    },
    "paid_balance": {
      "cash": 30700
    },
    "auth_token": "xxxxxxxxxxxxxx"
  }
}