Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
start
curl -X POST "https://api.foxreach.io/api/v1/campaigns/cmp_abc123/start" \
  -H "X-API-Key: otr_your_key"

{
  "data": {
    "id": "cmp_abc123",
    "name": "Q1 Outreach",
    "status": "active",
    "startedAt": "2025-01-15T09:00:00",
    "..."
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.foxreach.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Path Parameters

​
campaign_id
string
required
The unique identifier of the campaign.

​
Prerequisites

Before starting a campaign, ensure it has:
  • At least one sequence step
  • Leads enrolled (added through the dashboard)
  • Email accounts assigned

​
Response

Returns the updated campaign object with status: "active". 
curl -X POST "https://api.foxreach.io/api/v1/campaigns/cmp_abc123/start" \
  -H "X-API-Key: otr_your_key"

{
  "data": {
    "id": "cmp_abc123",
    "name": "Q1 Outreach",
    "status": "active",
    "startedAt": "2025-01-15T09:00:00",
    "..."
  }
}

​
Errors

StatusDescription
400Campaign is already active
400Cannot start a completed campaign
400Campaign must have at least one sequence step
404Campaign not found

​
Rate Limit

  • 100 requests per minute, per API key. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).
For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.