call_settings is an optional object in the Initiate AI Call request that controls retries, working hours, and WhatsApp notifications. Omit it entirely and the call is placed immediately with no retries.
Retry Policy
Controls whether failed calls are retried and when.conditions
Array of call outcomes that should trigger a retry:intervals
Optional array describing the retry schedule. Each entry is either:- Delay — retry after a wait:
{ "type": "delay", "duration": 15, "unit": "minutes" }whereunitisminutes,hours, ordays - Specific time — retry at a fixed point:
{ "type": "specific_datetime", "datetime": "2026-05-27T10:15:00Z" }(ISO 8601)
intervals is omitted, retries use default timing.
If
retry_policy is omitted entirely, failed calls are never retried.Working Hours
Restricts when calls can be placed. Each day takes a shift withstart_time and end_time in 12-hour format.
enabled(defaulttrue) — setfalseto bypass working-hours checks- Omit a day to disallow calls on that day (the example above allows Mon–Fri only)
- If the call time falls outside all configured shifts, the call is delayed until the start of the next available shift
end_timemust be afterstart_timeschedule_atis always respected as-is — working hours never push it
WhatsApp Notifications
Sends approved WhatsApp templates to the candidate around the call. Each notification takes atemplate_name (must be an approved WhatsApp template) and optional template_variables.
WhatsApp notifications require setup — contact the support team at support@tidyhire.app to configure your templates and enable the option for your workspace.
template_variables values are either:
- Variable reference — exactly a variable like
{{candidate_first_name}}, filled in automatically - Literal text — anything else, passed to WhatsApp as-is