POST
/
move_to_campaign
curl --request POST \
  --url https://firstpromoter.com/api/v1/promoters/move_to_campaign \
  --header 'X-API-KEY: <api-key>'
{
  "id": 6481069,
  "status": "active",
  "cust_id": "",
  "email": "[email protected]",
  "created_at": "2023-08-16T14:22:50.157Z",
  "temp_password": null,
  "default_promotion_id": 10122438,
  "pref": "2uvc08x",
  "default_ref_id": "tvo16",
  "note": null,
  "w8_form_url": null,
  "w9_form_url": null,
  "parent_promoter_id": null,
  "earnings_balance": null,
  "current_balance": null,
  "paid_balance": null,
  "auth_token": "xMx1xEzDAs_GPAxyBEMCGbEs1wGJsUzR",
  "profile": {
    "id": 6518856,
    "first_name": "Macaulay",
    "last_name": null,
    "website": null,
    "company_name": null,
    "phone_number": null,
    "address": null,
    "vat_id": null,
    "country": null,
    "paypal_email": null,
    "avatar_url": null,
    "description": null,
    "social_accounts": {}
  },
  "promotions": [
    {
      "id": 10122438,
      "status": "offer_running",
      "ref_id": "tvo16",
      "promo_code": null,
      "customer_promo_code": null,
      "target_reached_at": null,
      "promoter_id": 6481069,
      "campaign_id": 26127,
      "referral_link": "https://lastechworld.com?fpr=tvo16",
      "current_offer": {
        "id": 140358,
        "name": "1 free subscription months",
        "amount": 1,
        "unit": "free_months",
        "default_promo_code": ""
      },
      "current_referral_reward": {
        "id": 140359,
        "amount": 1,
        "type": "per_referral",
        "unit": "free_months",
        "name": "1 free subscription months",
        "per_of_sale": 0,
        "default_promo_code": ""
      },
      "current_promotion_reward": null,
      "current_target_reward": null,
      "campaign_name": "Make Campaign",
      "hidden": false,
      "visitors_count": 0,
      "leads_count": 0,
      "customers_count": 0,
      "refunds_count": 0,
      "cancellations_count": 0,
      "sales_count": 0,
      "sales_total": 0,
      "refunds_total": 0,
      "active_customers_count": 0
    },
    {
      "id": 7061492,
      "status": "offer_inactive",
      "ref_id": "2hpqscnv",
      "promo_code": null,
      "customer_promo_code": null,
      "target_reached_at": null,
      "promoter_id": 6481069,
      "campaign_id": 18747,
      "referral_link": "https://lastechworld.com?fpr=2hpqscnv",
      "current_offer": null,
      "current_referral_reward": {
        "id": 94230,
        "amount": 0,
        "type": "per_referral",
        "unit": "cash",
        "name": "20% recurring commission",
        "per_of_sale": 20,
        "default_promo_code": ""
      },
      "current_promotion_reward": null,
      "current_target_reward": null,
      "campaign_name": "Publishers & marketing Partners",
      "hidden": true,
      "visitors_count": 0,
      "leads_count": 1,
      "customers_count": 1,
      "refunds_count": 2,
      "cancellations_count": 3,
      "sales_count": 2,
      "sales_total": 72400,
      "refunds_total": -72400,
      "active_customers_count": 0
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

id
string

Promoter's ID inside FirstPromoter

promoter_email
string

Email of the promoter

cust_id
string

Assigned customer/user ID

ref_id
string

Referral ID

auth_token
string

Authentication token generated when the promoter was created

destination_campaign_id
string
required

ID of the campaign to switch/move to. It can be found on the url bar when editing the campaign

source_campaign_id
string
required

Only needed if the promoter is added to multiple campaigns. You can use this parameter to specify which campaign to change. If none is specified if will use as source the default campaign.

Response

200
application/json
Success response

The response is of type object.