Move/switch a promoter from one campaign to another
This endpoint will change the promoter’s campaign to another one, keeping the referral ID the same (the affiliate won’t need to update the referral link). It serves the same function as moving the promoter to another campaign from the UI.More details on how it works can be found here.
You can identify promoters by: id
, cust_id
, auth_token
, promoter_email
or ref_id
(referral id).
POST https://firstpromoter.com/api/v1/promoters/move_to_campaign
Authorizations
Query Parameters
Promoter's ID inside FirstPromoter
Email of the promoter
Assigned customer/user ID
Referral ID
Authentication token generated when the promoter was created
ID of the campaign to switch/move to. It can be found on the url bar when editing the campaign
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
The promoter's ID inside FirstPromoter
Promoter's status
approved
, pending
, denied
Your customer's user ID inside your application/system for the promoter. This will be included in the webhook event and can be used to identify the promoter in your system if you scribscibe for FirstPromoter's webhooks.
Promoter's email
ISO date string when the promoter signed up
A temporary password the promoter can use to log in to their dashboard if you don't use authentication tokens(auth_token
) to sign promoters in automatically.
Promoter's default promotion id
Promoter's parent referral id.
Promoter's default referral id
A note/description of promoter
The w8 form url
The w9 form url
Parent promoter id
Promoter's earnings balance. This object can contain cash
, credits
, discount_per
Promoter's current balance. This object can contain cash
, credits
, discount_per
Promoter's paid balance. This object can contain cash
, credits
, discount_per
Authentication token generated when the promoter was created