ELelevenlabs
Agents Platform

Stop An Outbound Campaign

Changed on

Stop an outbound campaign for good: queued calls are cancelled and no lead is called again. Returns 202 with the campaign stopping while calls already placed are still finishing.

post/v1/convai/outbound-campaigns/campaigns/{campaign_id}/stop

Request

Path parameters

campaign_idstring required

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

campaign_idstring required
call_namestring required

The campaign's name.

agent_idstring required
status'active' | 'paused' | 'stopping' | 'stopped' | 'completed' | 'failed' | 'attention' required
variant'simple' | 'advanced' required
source'ui' | 'api' required
created_at_unixinteger required
scheduled_time_unixinteger nullable required

When the campaign starts calling; unset to start once created.

updated_at_unixinteger required
branch_idstring nullable required

The agent branch the campaign calls with.

environmentstring nullable required

The environment the agent's environment variables resolve in.

target_concurrency_limitinteger nullable required

The most calls the campaign places at once.

channel'phone' | 'whatsapp' required
mode'voice' | 'message' required
agent_namestring required

Changes