API ReferenceCampaigns

Retry a campaign's failed recipients

Re-queues the campaign’s terminally-failed recipients (failed, plus exhausted no-answer / busy) for another dispatch pass and moves the campaign back to running. Suppression terminals (opted-out, DND, etc.) are NOT retried. Valid from completed or paused only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

campaign_idstringRequired

Response

Failed recipients re-queued; campaign is running

idstring

camp_{nanoid}

workspace_idstring
channelenum
agent_idstring
statusenum
configmap from strings to any

Channel payload template (caller-id, call window, webhook). Shape owned by the orchestrator.

schedulemap from strings to any
retry_policymap from strings to any

Retry attempts + backoff (max_attempts, backoff_seconds, backoff_multiplier). Absent = no retries.

countersobject

Live progress counts. total = queued + dispatched + succeeded + failed.

created_atdatetime
updated_atdatetime
started_atdatetime
completed_atdatetime
retryable_failedinteger

Count of targets the Retry failed action would re-queue (genuine dial failures, excluding suppression terminals). Present for completed/paused campaigns; omitted when 0.

Errors

401
Retry Failed Campaign Request Unauthorized Error
404
Retry Failed Campaign Request Not Found Error