---
title: "Stop campaign"
method: POST
path: "/api/v4/campaigns/{campaign_id}/stop"
tags: ["Campaigns"]
---

# Stop campaign

`POST /api/v4/campaigns/{campaign_id}/stop`

Stops the specified dialer campaign.

## Path parameters

- `campaign_id` integer, required

## Response `200`

OK

- Campaign
  - `id` integer — The unique identifier of the campaign.
  - `name` string — The name of the campaign.
  - `status` 'draft' | 'active' | 'paused' | 'stopping' | 'completed' | 'processing' | 'stopped' | 'auto_paused' | 'pausing' | 'auto_pausing' | 'import_error' — Current status of the campaign.
  - `strategy` 'simple' | 'predictive_ai' — Dialing strategy used by the campaign.
  - `dial_level` number, float — Number of simultaneous calls per agent.
  - `dial_level_override` object — Override dial level settings based on agent availability.
    - `enabled` boolean — Whether the dial level override is enabled.
    - `value` number, float — Override dial level value.
    - `active_agents_threshold` integer — Minimum number of active agents to trigger override.
  - `max_dial_time` integer — Maximum dial time in seconds before hanging up.
  - `max_wait_time` integer — Maximum wait time in seconds for agent availability.
  - `max_dial_attempts` integer — Maximum number of dial attempts per lead.
  - `voice_message` MediaVoiceMessage — Voice message Media object.
    - `type` 'voice_message' — The type of media.
    - `name` string — The name of the media.
  - `amd_voicemail_message` object — Configuration for voicemail playback when an answering machine is detected.
    - `enabled` boolean — Whether voicemail playback is enabled when an answering machine is detected.
    - `voice_message` MediaVoiceMessage — Voice message Media object.
      - `type` 'voice_message' — The type of media.
      - `name` string — The name of the media.
  - `amd_enabled` boolean — Whether answering machine detection is enabled.
  - `live` object — Whether the campaign uses live dialing mode.
    - `enabled` boolean — Whether adding leads to the running campaign is enabled.
    - `dialing_order` 'fifo' | 'lifo', nullable — The order in which new leads are dialed. Only available when live is enabled and the dialing order feature is enabled for the contact center. - `fifo` — oldest contacts are dialed first - `lifo` — newest contacts are dialed first
  - `calling_list` object, nullable — Configuration for the calling list source.
    - `method` 'file_import' | 'bitrix_crm' | 'falcon_crm' | 'hubspot_crm' | 'panda_crm' | 'salesforce_crm' | 'zoho_crm' | 'zenoti_crm' — Method used to populate the calling list.
  - `caller_id_sets` object[], nullable — Sets of caller IDs used for outbound calls.
    - `phone_numbers` string[] — List of phone numbers in the caller ID set.
  - `use_local_caller_id` boolean — Whether to use local caller ID matching the lead's area.
  - `asr_optimization_enabled` boolean — Whether ASR (Answer Seizure Ratio) optimization is enabled.
  - `allow_duplicate_numbers` boolean — Whether the same phone number can be added to the campaign more than once.
  - `follow_up_mode` 'timer' | 'lowest_attempts', nullable — Controls how the dialer prioritizes redial attempts within follow-up rules. - `timer` — contacts are prioritized strictly by their configured redial delay (default) - `lowest_attempts` — contacts with the fewest dial attempts are prioritized first, while still respecting redial delay timers
  - `follow_up_rules` object — Rules for follow-up actions based on call disposition.
    - `machine_answered` FollowupRuleRedial[] — Actions when call is answered by machine.
      - `type` 'redial' — Type of follow-up rule.
      - `wait_time` integer — Time to wait before executing the action.
      - `wait_time_unit` 'seconds' | 'minutes' | 'hours' — Unit of wait time.
      - `switch_caller_id_set` boolean — Whether to switch to a different caller ID set.
      - `actions` FollowupActionWhatsapp[] — Additional actions to perform with this rule.
        - `type` 'whatsapp' — Type of follow-up action.
        - `channel_profile` ChannelProfileShort
          - `id` integer — The unique identifier of the channel profile.
          - `channel` 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' — The channel associated with the profile.
          - `identifier` string, nullable — Channel profile identifier (for WhatsApp, the phone number).
          - `name` string — The name of the channel profile.
        - `whatsapp_template` WhatsappTemplateShort
          - `id` string, uuid — The unique identifier of the WhatsApp template.
          - `name` string — The name of the WhatsApp template.
    - `abandoned` FollowupRuleRedial[] — Actions when call is abandoned.
      - `type` 'redial' — Type of follow-up rule.
      - `wait_time` integer — Time to wait before executing the action.
      - `wait_time_unit` 'seconds' | 'minutes' | 'hours' — Unit of wait time.
      - `switch_caller_id_set` boolean — Whether to switch to a different caller ID set.
      - `actions` FollowupActionWhatsapp[] — Additional actions to perform with this rule.
        - `type` 'whatsapp' — Type of follow-up action.
        - `channel_profile` ChannelProfileShort
          - `id` integer — The unique identifier of the channel profile.
          - `channel` 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' — The channel associated with the profile.
          - `identifier` string, nullable — Channel profile identifier (for WhatsApp, the phone number).
          - `name` string — The name of the channel profile.
        - `whatsapp_template` WhatsappTemplateShort
          - `id` string, uuid — The unique identifier of the WhatsApp template.
          - `name` string — The name of the WhatsApp template.
    - `no_answer` FollowupRuleRedial[] — Actions when call is not answered.
      - `type` 'redial' — Type of follow-up rule.
      - `wait_time` integer — Time to wait before executing the action.
      - `wait_time_unit` 'seconds' | 'minutes' | 'hours' — Unit of wait time.
      - `switch_caller_id_set` boolean — Whether to switch to a different caller ID set.
      - `actions` FollowupActionWhatsapp[] — Additional actions to perform with this rule.
        - `type` 'whatsapp' — Type of follow-up action.
        - `channel_profile` ChannelProfileShort
          - `id` integer — The unique identifier of the channel profile.
          - `channel` 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' — The channel associated with the profile.
          - `identifier` string, nullable — Channel profile identifier (for WhatsApp, the phone number).
          - `name` string — The name of the channel profile.
        - `whatsapp_template` WhatsappTemplateShort
          - `id` string, uuid — The unique identifier of the WhatsApp template.
          - `name` string — The name of the WhatsApp template.
    - `rejected` FollowupRuleRedial[] — Actions when call is rejected.
      - `type` 'redial' — Type of follow-up rule.
      - `wait_time` integer — Time to wait before executing the action.
      - `wait_time_unit` 'seconds' | 'minutes' | 'hours' — Unit of wait time.
      - `switch_caller_id_set` boolean — Whether to switch to a different caller ID set.
      - `actions` FollowupActionWhatsapp[] — Additional actions to perform with this rule.
        - `type` 'whatsapp' — Type of follow-up action.
        - `channel_profile` ChannelProfileShort
          - `id` integer — The unique identifier of the channel profile.
          - `channel` 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' — The channel associated with the profile.
          - `identifier` string, nullable — Channel profile identifier (for WhatsApp, the phone number).
          - `name` string — The name of the channel profile.
        - `whatsapp_template` WhatsappTemplateShort
          - `id` string, uuid — The unique identifier of the WhatsApp template.
          - `name` string — The name of the WhatsApp template.
    - `failed` FollowupRuleRedial[] — Actions when call fails.
      - `type` 'redial' — Type of follow-up rule.
      - `wait_time` integer — Time to wait before executing the action.
      - `wait_time_unit` 'seconds' | 'minutes' | 'hours' — Unit of wait time.
      - `switch_caller_id_set` boolean — Whether to switch to a different caller ID set.
      - `actions` FollowupActionWhatsapp[] — Additional actions to perform with this rule.
        - `type` 'whatsapp' — Type of follow-up action.
        - `channel_profile` ChannelProfileShort
          - `id` integer — The unique identifier of the channel profile.
          - `channel` 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' — The channel associated with the profile.
          - `identifier` string, nullable — Channel profile identifier (for WhatsApp, the phone number).
          - `name` string — The name of the channel profile.
        - `whatsapp_template` WhatsappTemplateShort
          - `id` string, uuid — The unique identifier of the WhatsApp template.
          - `name` string — The name of the WhatsApp template.
    - `busy` FollowupRuleRedial[] — Actions when line is busy.
      - `type` 'redial' — Type of follow-up rule.
      - `wait_time` integer — Time to wait before executing the action.
      - `wait_time_unit` 'seconds' | 'minutes' | 'hours' — Unit of wait time.
      - `switch_caller_id_set` boolean — Whether to switch to a different caller ID set.
      - `actions` FollowupActionWhatsapp[] — Additional actions to perform with this rule.
        - `type` 'whatsapp' — Type of follow-up action.
        - `channel_profile` ChannelProfileShort
          - `id` integer — The unique identifier of the channel profile.
          - `channel` 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' — The channel associated with the profile.
          - `identifier` string, nullable — Channel profile identifier (for WhatsApp, the phone number).
          - `name` string — The name of the channel profile.
        - `whatsapp_template` WhatsappTemplateShort
          - `id` string, uuid — The unique identifier of the WhatsApp template.
          - `name` string — The name of the WhatsApp template.
  - `post_call_rating` object — Post-call survey configuration.
    - `enabled` boolean — Whether the post-call survey is enabled for contacts.
    - `notification_voice_message` MediaVoiceMessage — Voice message Media object.
      - `type` 'voice_message' — The type of media.
      - `name` string — The name of the media.
    - `instructions_voice_message` MediaVoiceMessage — Voice message Media object.
      - `type` 'voice_message' — The type of media.
      - `name` string — The name of the media.
    - `complete_voice_message` MediaVoiceMessage — Voice message Media object.
      - `type` 'voice_message' — The type of media.
      - `name` string — The name of the media.
  - `contact_local_time` object, nullable — Time restrictions for calling contacts based on their local time. Available only if the contact local time feature is enabled for the contact center.
    - `start_time` string — Start time for calls (HH:MM format).
    - `end_time` string — End time for calls (HH:MM format).
    - `days_of_week` integer[] — Days of the week when calls are allowed.
  - `created_at` string, date-time — Timestamp when the campaign was created (ISO 8601).
  - `updated_at` string, date-time — Timestamp when the campaign was last updated (ISO 8601).

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `409` — Conflict
- `429` — Too many requests

---

[API](https://skmtc.net/voiso/apis/voiso-api.md) · [All operations](https://skmtc.net/voiso/apis/voiso-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voiso/voiso-api/versions/3d34cfd8f064/schema)