Skip to main content
POST

Authentication

Requires a key with the tasks:write scope.

Request body

string
required
UUID of the parent farm. Must be owned by the user.
string
required
UUID of an existing task template. Must be either user-owned or global.
string
required
One of daily, weekly, monthly, yearly, custom.
string
required
Calendar date as YYYY-MM-DD. A full ISO 8601 datetime is accepted too, but only its date part is kept. The first occurrence.
integer
Pattern interval (default 1). Range 1–365.
array
For weekly: array of 0–6 (0 = Sunday).
integer
For monthly: 1–31.
integer
For yearly: 1–12.
string
Calendar date as YYYY-MM-DD. A full ISO 8601 datetime is accepted too, but only its date part is kept. The schedule stops generating after this date.
integer
0–90. Generate the task this many days before its nextOccurrence.
string
Default assignee for generated tasks.
string
Free-text field reference (denormalized).

Response

Returns the created schedule wrapped under data. nextOccurrence is initialized to startDate.

Errors