Skip to main content
POST
/
outbound
/
campaigns
/
{id}
/
pause
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "agentId": "<string>",
    "callerNumberId": "<string>",
    "dialingMode": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "listId": "<string>",
    "schedule": {},
    "pacing": {},
    "retryPolicy": {},
    "voicemailPolicy": {},
    "greetingOverride": "<string>",
    "playbookId": "<string>",
    "goals": "<string>",
    "spendCapCents": 123,
    "consentAttestedAt": "2023-11-07T05:31:56Z",
    "launchedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "counts": {
      "total": 123,
      "scheduled": 123,
      "queued": 123,
      "dialing": 123,
      "inProgress": 123,
      "completed": 123,
      "noAnswer": 123,
      "voicemail": 123,
      "failed": 123,
      "suppressed": 123,
      "cancelled": 123
    },
    "spendCents": 123,
    "amdBreakdown": {
      "human": 123,
      "machine": 123,
      "notSure": 123,
      "unknown": 123
    }
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Clerk JWT (browser). Requires Authorization: Bearer <clerk_jwt> and the X-Organization-Id header. Validated by the ported Clerk middleware, which sets the app.current_organization_id RLS context.

Path Parameters

id
string
required

Response

The paused campaign.

success
boolean
required
data
object
required
message
string
errors
object[]