Campaigns API
Create, manage, and monitor campaigns via the REST API.
Create Campaign
POST /v1/campaigns
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{
"name": "Q1 Outreach",
"type": "cold-email-outreach",
"brandUrl": "https://acme.com",
"targetAudience": "CTOs at SaaS companies, 50-200 employees",
"targetOutcome": "Book sales demos",
"valueForTarget": "Access to enterprise analytics at startup pricing",
"urgency": "Early-adopter pricing ends March 31st",
"scarcity": "Onboarding limited to 20 companies this quarter",
"riskReversal": "14-day free trial, cancel anytime, no commitment",
"socialProof": "Used by 500+ SaaS companies including Vercel and Linear",
"maxBudgetDailyUsd": 10,
"maxBudgetWeeklyUsd": 50
}Response
{
"campaign": {
"id": "camp_abc123",
"name": "Q1 Outreach",
"type": "cold-email-outreach",
"brandId": "brand_xyz",
"status": "ongoing",
"targetAudience": "CTOs at SaaS companies, 50-200 employees",
"targetOutcome": "Book sales demos",
"valueForTarget": "Access to enterprise analytics at startup pricing",
"urgency": "Early-adopter pricing ends March 31st",
"scarcity": "Onboarding limited to 20 companies this quarter",
"riskReversal": "14-day free trial, cancel anytime, no commitment",
"socialProof": "Used by 500+ SaaS companies including Vercel and Linear"
}
}List Campaigns
GET /v1/campaigns
GET /v1/campaigns?status=ongoing
GET /v1/campaigns?status=stoppedResponse
{
"campaigns": [
{
"id": "camp_abc123",
"name": "Q1 Outreach",
"status": "ongoing",
"targetAudience": "CTOs at SaaS companies",
"targetOutcome": "Book sales demos",
"valueForTarget": "Access to enterprise analytics at startup pricing",
"urgency": "Early-adopter pricing ends March 31st",
"scarcity": "Onboarding limited to 20 companies this quarter",
"riskReversal": "14-day free trial, cancel anytime",
"socialProof": "Used by 500+ SaaS companies",
"maxBudgetDailyUsd": "10"
}
]
}Get Campaign
GET /v1/campaigns/:idResponse
{
"campaign": {
"id": "camp_abc123",
"name": "Q1 Outreach",
"status": "ongoing",
"targetAudience": "CTOs at SaaS companies",
"targetOutcome": "Book sales demos",
"valueForTarget": "Access to enterprise analytics at startup pricing",
"urgency": "Early-adopter pricing ends March 31st",
"scarcity": "Onboarding limited to 20 companies this quarter",
"riskReversal": "14-day free trial, cancel anytime",
"socialProof": "Used by 500+ SaaS companies",
"maxBudgetDailyUsd": "10",
"createdAt": "2026-01-30T10:00:00Z"
}
}Stop Campaign
POST /v1/campaigns/:id/stopResponse
{
"campaign": {
"id": "camp_abc123",
"status": "stopped"
}
}Resume Campaign
POST /v1/campaigns/:id/resumeResponse
{
"campaign": {
"id": "camp_abc123",
"status": "ongoing"
}
}Campaign Statuses
| Status | Description |
|---|---|
ongoing | Campaign is active and running |
stopped | Campaign has been stopped |