Make a task repeat, or change how it repeats. The task becomes a repeating definition: each occurrence is a new task given to the chosen people. A task that was already given out is refused with 409 task_already_assigned
https://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/scheduleRecent Requests
Kept only in this browserPath Params
idstringrequiredHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Idempotency-KeystringOptional idempotency key for safe retries.
Body Params
freqstringrequiredHow often it repeats.
interval_nintegerRepeat every N periods, 1 to 365. Defaults to 1.
by_dayarray of stringsDays of the week. Weekly: the days it happens on. Monthly or yearly with by_set_pos: the day to count.
by_month_dayinteger | nullDay of the month, 1 to 31, or -1 for the last day. A day the month does not have moves to its last day.
by_set_posinteger | nullWith by_day: which one in the month, 1 to 5, or -1 for the last one.
by_monthinteger | nullYearly only: the month, 1 to 12.
business_days_onlybooleanDaily: count Monday to Friday only. Weekly: leave out Saturday and Sunday. Monthly and yearly: a weekend date moves to the next Monday.
skip_holidaysbooleanLeave out the days the business is closed (closed weekdays and holidays from the business calendar). Defaults to false.
starts_onstringFirst possible date.
ends_onstring | nullLast possible date.
count_limitinteger | nullStop after this many occurrences, 1 to 1000.
skip_datesarray of stringsDates that never get an occurrence (up to 200).
lead_daysintegerCreate each occurrence this many days early, 0 to 60.
due_timestring | nullDeadline time on the day, HH:MM. Empty means the end of the day.
timezonestringIANA time zone. Defaults to the workspace time zone.
assignee_user_idsarray of integersPeople who get each occurrence.
group_idsarray of integersGroups whose members get each occurrence.
rotationstringround_robin gives each occurrence to the next person in turn.
is_activebooleanTurn the repeat off without deleting it.
Response
Response Body
scheduleobject | nullHow the task repeats. Null when it does not repeat.next_datesarray of stringsThe next few dates an occurrence will be made for.Request
curl --request PUT \ --url https://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/schedule \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "freq": "weekly", "by_day": [ "mo" ], "starts_on": "2026-12-07", "due_time": "17:00", "assignee_user_ids": [ 31, 44 ], "rotation": "round_robin"}'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 200
{ "data": { "schedule": { "id": 1, "task_id": 1, "freq": "weekly", "interval_n": 2, "by_day": [ "mo", "th" ], "by_month_day": 15, "by_set_pos": 2, "by_month": 1, "business_days_only": true, "skip_holidays": true, "starts_on": "2026-01-01", "ends_on": "2026-01-01", "count_limit": 1, "skip_dates": [ "2026-01-01" ], "lead_days": 2, "due_time": "17:00", "timezone": "Europe/London", "assignee_user_ids": [ 1 ], "group_ids": [ 1 ], "rotation": "none", "is_active": true, "occurrences_made": 1, "next_run_on": "2026-01-01", "last_generated_at": "2026-01-01T09:00:00.000Z" }, "next_dates": [ "2026-01-01" ] }}