RecruitAffiliates.ai

Create a draft campaign

A draft, with who's in checked straight away. Nothing sends: someone reviews and approves the emails, then starts it, in the app.

Scope: finder:write

post/v1/finder/campaigns

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/finder/campaigns
  • Auth: HTTP bearer

Request body

brand_idstring

Which brand. Defaults to the organization's oldest.

namestring required
inbox_idstring required

One of your connected inboxes, from GET /settings

list_idstring

Who to email: a list. Leave out for everyone saved and not yet contacted.

segment_idstring

Who to email: a segment, as it matches when the campaign is checked. Send list_id or segment_id, not both.

Example request

{
  "brand_id": "fbr_7uSyy9FqVLCFWrdPeZaK",
  "inbox_id": "fin_7uSyy9FqVLCFWrdPeZaK",
  "list_id": "fls_7uSyy9FqVLCFWrdPeZaK",
  "segment_id": "fseg_7uSyy9FqVLCFWrdPeZaK"
}

Response

The draft

idstring required

Prefixed id (fca_…)

object'finder_campaign' required
brand_idstring required

Prefixed id (fbr_…)

inbox_idstring nullable required
namestring required
state'draft' | 'running' | 'paused' | 'stopped' | 'finished' required
approvedboolean required

True once someone approved the current emails in the app

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "fca_7uSyy9FqVLCFWrdPeZaK",
  "brand_id": "fbr_7uSyy9FqVLCFWrdPeZaK",
  "audience": {
    "checked_at": "2026-08-21T10:15:30.000Z"
  },
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.