taskBundles

Updates a task template recurrence rule.

Changed on

Updates a task template recurrence rule. The template uses the submitted recurrence rule.

<Check title="Required Permissions" icon="key">The user must be an admin or have task-manage-config:write permissions.</Check>

post/tasktemplates/{taskTemplateId}/setrecurrency

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/tasktemplates/{taskTemplateId}/setrecurrency
  • Auth: HTTP bearer

Path parameters

taskTemplateIdstring uuid required

The id of the task template.

Request body

recurrencyRulestring nullable

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. Max value is 31540000 (1 year).

Response

No Content

object required

Changes

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      api operation id PostTaskTemplateSetRecurrencyByTaskTemplateId removed and replaced with taskBundles_PostTaskTemplateSetRecurrencyByTaskTemplateId