Skip to main content
POST
A retry policy says, per outcome, how long to wait and how many times to redial, and can cap how often any one number is called. Assign one to an agent as defaultRetryPolicyId, or pass its id as retry_policy_id when triggering a call. See Retry Policies for how a chain of attempts behaves. GET /v1/retry-policies returns every policy on the account. POST creates one.

Request Body (POST)

string
required
Unique within the account. Up to 100 characters.
object
Per-outcome rules, keyed no_answer, busy, voicemail and failed. An omitted outcome is never retried, and completed can never be retried. Unknown keys are rejected.Each rule:
object | null
Hard caps per destination number, enforced across the account: max_attempts_per_day (1–50), max_attempts_per_week (1–200), min_seconds_between_attempts (0–604800). A trigger that would break one is refused with 409 policy_violation; a retry that would is cancelled.
string
default:"end"
What happens when a chain uses up its attempts without reaching a person: end, webhook (POST a retries_exhausted event), or notify_email.
string | null
Required unless on_exhausted is end: an https:// URL for webhook, an email address for notify_email.
boolean
default:"false"
When an agent with calling hours is asked to call outside them, queue the call for the next window (202, status scheduled) instead of refusing it with 409 out_of_window.

Response

Each policy carries id, name, rules, contact_policy, on_exhausted, on_exhausted_target, reschedule_out_of_window, created_at and updated_at.