Campaigns
Update live campaign status
Changes status for a live campaign (running, paused, or stopped). Draft campaigns must use POST /launch instead. Emits campaign status webhooks.
PATCH
/v1/campaigns/{id}/statusAuthorization
bearerAuth AuthorizationBearer <token>
Use an account API key in the Authorization header: Authorization: Bearer f_....
In: header
Path Parameters
idstring
Campaign id.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
statusstring
Value in
- "running"
- "paused"
- "stopped"
curl -X PATCH "https://example.com/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/status" \ -H "Content-Type: application/json" \ -d '{ "status": "running" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "paused" }}{ "error": { "type": "invalid_request_error", "code": "invalid_flow", "message": "Flow validation failed" }, "details": [ { "path": "nodes[1].data.variants[0].id", "code": "invalid_variant_id", "message": "Email variants must have a stable UUID id." } ]}{ "error": { "type": "authentication_error", "code": "invalid_api_key", "message": "A valid Furnace API key is required" }}{ "error": { "type": "permission_error", "code": "smartlead_read_only", "message": "Smartlead campaigns are read-only via the API" }}{ "error": { "type": "invalid_request_error", "code": "campaign_not_found", "message": "Campaign not found" }}{ "error": { "type": "rate_limit_error", "code": "rate_limit_exceeded", "message": "Rate limit exceeded for this account" }}{ "error": { "type": "api_error", "code": "internal_error", "message": "Internal server error" }}