I-i-stem

POST /v1/external/campaigns/{agent_id}/{campaign_id}/stop

Changed on

Stops an active campaign and marks it as PAUSED. Campaign status must be IN_PROGRESS.

Request

Path parameters

agent_idstring uuid required

The UUID of the AI agent that owns the campaign.

campaign_idstring uuid required

The UUID of the campaign.

Response

Campaign stopped successfully

messagestring required

Example response

{
  "data": {
    "retry_config": {
      "max_retries": 2,
      "retry_delay_minutes": 30,
      "retry_on": [
        "UNANSWERED",
        "REJECTED",
        "VOICEMAIL"
      ]
    }
  }
}

Changes

  • b9d6c9669dfaRevision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • c05ce18c8419Revision changes
    • info

      endpoint added