FirstPromoter icon

FirstPromoter

Interact with the official FirstPromoter APIs

Promoter → Add Promoters to Campaign

AI-generated

Summary

Add one or multiple promoters to a specified campaign in FirstPromoter, optionally sending drip emails to the promoters.

Inputs

  • Campaign ID (required) — The ID of the campaign to which the promoters will be added.
  • IDs (required) — A list of promoter IDs to add to the campaign. If more than 5 IDs are provided, the action is processed asynchronously with statuses such as 'pending', 'in_progress', 'completed', 'failed', and 'stopped'.
  • Drip Emails — Boolean flag to indicate whether to send drip emails to the promoters when they are added.

Output shape

a single JSON array containing the API response indicating the result of the add operation.

If more than 5 promoter IDs are submitted, the operation is handled asynchronously. The output includes statuses reflecting the processing state.

Examples

Example 1: Add promoters with drip emails enabled

Set 'Campaign ID' to the target campaign, provide promoter 'IDs' as multiple values, and set 'Drip Emails' to true.

Example 2: Add a single promoter without drip emails

Provide the campaign's ID and the single promoter ID, leave 'Drip Emails' as false or unset.

Links

Discussion