Start Campaign

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",
    "..."
  }
}

POST

https://api.foxreach.io

api

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",
    "..."
  }
}

Path Parameters

campaign_id

string

required

The unique identifier of the campaign.

Before starting a campaign, ensure it has:

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",
    "..."
  }
}

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

⌘I