Move promoters to campaign

curl --request POST \
  --url https://api.firstpromoter.com/api/v2/company/promoters/move_to_campaign \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    123
  ],
  "from_campaign_id": 123,
  "to_campaign_id": 123,
  "drip_emails": true,
  "soft_move_referrals": true
}'

{
  "id": 123,
  "status": "completed",
  "total": 123,
  "selected_total": 123,
  "processed_count": 123,
  "failed_count": 123,
  "action_label": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "meta": {},
  "progress": 123,
  "processing_errors": [
    "<string>"
  ]
}

POST

promoters

move_to_campaign

Move promoters to campaign

curl --request POST \
  --url https://api.firstpromoter.com/api/v2/company/promoters/move_to_campaign \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    123
  ],
  "from_campaign_id": 123,
  "to_campaign_id": 123,
  "drip_emails": true,
  "soft_move_referrals": true
}'

{
  "id": 123,
  "status": "completed",
  "total": 123,
  "selected_total": 123,
  "processed_count": 123,
  "failed_count": 123,
  "action_label": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "meta": {},
  "progress": 123,
  "processing_errors": [
    "<string>"
  ]
}

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 section → 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

from_campaign_id

integer

required

The ID of the campaign promoter will be moved from

to_campaign_id

integer

required

The ID of the campaign promoter will be moved to

ids

integer[]

Array of promoter 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

drip_emails

boolean

If true, it will send an email to the promoter for this action

soft_move_referrals

boolean

If true, move referrals to NEW campaign and future commissions from existing referrals will be tracked in the NEW campaign. However, if false, keep referrals in the old campaign and future commissions from existing referrals will be tracked in the OLD campaign.

Response

Operation completed successfully

integer

Batch ID

status

enum<string>

Status of the batch operation Status of the batch operation (always completed for synchronous operations)

Available options:

completed

total

integer

Total number of promoters

selected_total

integer

Total number of selected promoters

processed_count

integer

Number of processed promoters

failed_count

integer

Number of failed promoters

action_label

string

Label for the action

created_at

string<date-time>

Creation date of the batch operation

updated_at

string<date-time>

Last update date of the batch operation

API Documentation

Batch Processes

Tracking Api

Referrals

Promoters

Promoter Campaigns

Commissions

Promo Codes

Payouts

Reports

Move promoters to campaign

Authorizations

Headers

Body

Response