Skip to main content
POST
Move referrals to promoter

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations → Manage API Keys

Headers

Account-ID
string
required

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

Body

application/json
promoter_campaign_id
integer
required

Destination promoter campaign ID

move_associated_commissions
enum<boolean>

Move associated commissions

Available options:
true,
false
ids
integer[]

Array of selected referral ids. If there are more than 5 ids on this param/field, the action will be processed asynchronously. The response for the batch status will most likely be in_progress. The available statuses are pending, in_progress, completed, failed and stopped

Response

Batch operation completed successfully.

id
integer
status
enum<string>
Available options:
completed
total
integer
selected_total
integer
processed_count
integer
failed_count
integer
action_label
string
created_at
string<date-time>
updated_at
string<date-time>
meta
object
progress
integer
processing_errors
string[]