Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
tasks

Adds or updates a recurrence rule for a task.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/tasks/{taskId}/setrecurrency

Path parameters

taskIdstring uuid required

The id of the task.

Headers

Authorizationstring required

Bearer authentication

Request body

recurrencyRulestring required

The recurrence rule as cron expression. We support all expressions which cronos supports (https://github.com/HangfireIO/Cronos). The number of occurrences is limited to 24 a day.

recurrencyIntervalinteger nullable

The interval of the executed expression. If the value is 3, only the third time of the expression the recurrence is actually executed.

relativeDueOninteger nullable

The relative due date and time of the task created from this recurrence rule, in seconds, from the moment of creating the task by a recurrence rule.

recurrencyStartOnstring date-time nullable

DateTime when recurring task creation will start, considering the set Recurrency Rule and Recurrency Interval.

recurrencyTimezonestring nullable

The timezone of the Recurrency Rule. If not set, will use the requesting user's timezone.

Response

No Content

object required