Update an editable task's rules (name, recipients, calling window, attempts, retry policy, expiry, duration, budget)

Updates an editable task's rules (name, recipients, callingWindow, maxAttempts, retryPolicy, expiresAt, maxDurationSecs, budgetHal) - agentId, taskType and source can't be changed after creation. revision is REQUIRED (optimistic concurrency). The policy can be enabled only before the first attempt; the same policy can be sent again later. Omitted maxAttempts, retryPolicy and expiresAt stay unchanged. maxAttempts: 4 requires the policy in this request or already stored on the task.

patch/v1/tasks/{id}

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/tasks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring

Name shown in task lists and history.

maxAttemptsinteger

Maximum automatic call attempts per recipient, including the first. Without retryPolicy: 1-3, creation default 1. With lorela_enterprise: 1-4, creation default 4 when omitted. On PATCH, a value of 4 requires the policy in the request or already stored on the task.

retryPolicy'lorela_enterprise'

Opt-in lorela_enterprise schedule: second attempt no earlier than 8 minutes after the first real attempt started, inside 08:00-22:00 Europe/Prague; third in the next other 08:00-09:00 or 17:00-19:00 window; fourth on the following calendar day in the opposite window. All attempts also respect callingWindow, expiry, budget, DNC and rate limits. Retries stop after 5 days from the first real attempt. Manual resolve retry is rejected with validation; only scheduled automatic attempts are allowed, so it cannot bypass the four-attempt cap, the age limit or a non-retryable result. Only no_answer, missed, busy or completed voicemail without human contact are retried; human contact, refusal and engine failure stop automatic retries, and ambiguous results need review. May be enabled only before any dispatch attempt; resending the same policy is allowed later. Omission preserves existing behavior at creation and the current policy on PATCH. PATCH does not reset maxAttempts when it is omitted.

dispatchOrder'first_attempts_first'

Optional first_attempts_first prioritizes due recipients with zero counted attempts before due retries in both cron and explicit processing. Pre-dispatch rejections marked countsAsAttempt:false retain first-attempt priority; future backoff remains enforced. Default preserves item order. Set before the first dispatch attempt.

expiresAtinteger

Optional campaign deadline as positive safe-integer Unix milliseconds. Checked at start and before every dial, including the first; at or after the deadline nothing new is dialed and no attempt is consumed. Calls already in progress finish normally. Omission preserves the current deadline on PATCH.

maxDurationSecsinteger

Maximum duration of each call in seconds.

budgetHalinteger

Maximum task spend in integer halere, excluding VAT. The task stops dispatching when the remaining budget cannot cover another call.

revisioninteger required

Current task revision from GET /v1/tasks/{id}. On revision_conflict reload and review the new state before retrying. Reconciliation accepts omission; other task changes require the current revision.

Response

Updated task

Changes

No recorded changes to this operation across all 1 revision of this API.