Stop campaign

POST

/v1/convai/outbound-campaigns/campaigns/:campaign_id/stop

POST

/v1/convai/outbound-campaigns/campaigns/:campaign_id/stop

curl -X POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/stop

{
  "campaign_id": "campaign_id",
  "call_name": "call_name",
  "agent_id": "agent_id",
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id",
    "mode_config": {
      "ringing_timeout_secs": 1,
      "twilio_call_recording_enabled": true,
      "mode": "voice"
    }
  },
  "status": "active",
  "policy": {
    "timezone": "timezone",
    "retry": {
      "retry_delay_seconds": 1,
      "max_short_retries": 1,
      "max_total_calls": 1,
      "max_callbacks": 1,
      "max_redirects": 1,
      "interval_placement": "start",
      "rotate_step_seconds": 1,
      "max_consecutive_failures_per_number": 1
    },
    "calling_periods": [
      {
        "weekdays": [
          1
        ],
        "intervals": [
          {
            "start": "start",
            "end": "end"
          }
        ]
      }
    ],
    "data_collection": {
      "callback_time": "callback_time",
      "redirect_phone_number": "redirect_phone_number",
      "stop": "stop",
      "mappings": {
        "key": "value"
      }
    },
    "followup_context": {
      "call_type": true,
      "previous_conversation_id": true,
      "previous_summary": true,
      "previous_transcript": true
    }
  },
  "variant": "simple",
  "created_at_unix": 1,
  "updated_at_unix": 1,
  "channel": "phone",
  "mode": "voice",
  "counts": {
    "leads": 1,
    "terminal_leads": 1,
    "open_attention": 1,
    "delivery": {
      "sent": 1,
      "delivered": 1,
      "read": 1,
      "replied": 1,
      "failed": 1
    }
  },
  "agent_name": "agent_name",
  "source": "ui",
  "outcome": {
    "type": "data_collection",
    "data_collection_id": "data_collection_id",
    "equals": [
      "equals"
    ]
  },
  "scheduled_time_unix": 1,
  "branch_id": "branch_id",
  "environment": "environment",
  "target_concurrency_limit": 1
}

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.

Path parameters

campaign_idstringRequired

Response

Successful Response

campaign_idstring

call_namestring

The campaign's name.

agent_idstring

channel_configobject

statusenum

attention means an open attention item holds back some of the campaign’s calls while the rest go ahead. stopping means queued calls are cancelled and calls already placed are finishing.

policyobject

The policy the campaign took when it was created.

variantenum

Allowed values:

created_at_unixinteger

updated_at_unixinteger

channelenum

Allowed values:

modeenum

Allowed values:

countsobject

agent_namestringDefaults to

sourceenumOptional

Whether the campaign was created in the app or through the API.

Allowed values:

outcomeobjectOptional

The result that counts as success for the campaign's calls.

scheduled_time_unixintegerOptional

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

branch_idstringOptional

The agent branch the campaign calls with.

environmentstringOptional

The environment the agent's environment variables resolve in.

target_concurrency_limitintegerOptional

The most calls the campaign places at once.

Errors

422

Outbound Campaigns Stop Request Unprocessable Entity Error

Path parameters

Headers

Response

Errors