v1

latestOpenAPI 3.0.3Proprietary2026-07-13172948.0 KB

Cancels a campaign and cancels pending outbound calls for it. Campaign status must not be FINISHED, FAILED, or CANCELLED.

post/v1/external/campaigns/{agent_id}/{campaign_id}/cancel

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 cancelled successfully

messagestring required

Example response

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