Skip to main content
POST
Add promoters to campaign

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
campaign_id
integer
required

The ID of the campaign promoter will be added 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

Response

Operation completed successfully

id
integer

Batch ID

status
enum<string>

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

meta
object

Additional metadata

progress
integer

Progress of the batch operation

processing_errors
string[]

List of processing errors if any