Create work schedule
create_work_scheduleCreate a recurring work schedule from an existing work item to automatically generate new work items based on a defined recurrence pattern.
Instructions
Create a recurring work schedule from an existing work item. The schedule will automatically generate new work items on the recurrence you set — confirm the recurrence details with the user before calling. Note: RecurrenceFrequency cannot be changed after creation.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| AssigneeUserKey | No | UserKey to assign generated work items to | |
| ScheduleEndDate | No | ISO 8601 date the schedule stops; omit to run forever | |
| ScheduleStartDate | Yes | ISO 8601 date the schedule starts | |
| RecurrenceFrequency | Yes | ||
| ScheduleDueDateDays | No | The day count for the due date method (not used with LastDayOfMonth/NoDueDate) | |
| CustomFrequencyUnits | No | Only when RecurrenceFrequency is Custom | |
| ScheduleDueDateMethod | Yes | ||
| CreatedFromWorkItemKey | Yes | The WorkItemKey the schedule is created from | |
| CustomFrequencyMultiple | Yes | Multiple of the frequency unit; use 1 unless RecurrenceFrequency is Custom | |
| WorkItemTitleDefinition | Yes | Title format for generated work items; supports Karbon title tokens (e.g. period/date placeholders) | |
| PreventStartEndOnWeekend | Yes | If true, generated work items never start on a weekend | |
| ScheduleDueDateMonthMultiple | No | Only with DayOfSubsequentMonth: how many months later | |
| InitializeBeforeStartDateUnits | No | Create the work item this long before its start date | |
| InitializeBeforeStartDateMultiple | No | ||
| InitializeTasksBeforeStartDateUnits | Yes | Create the work item's tasks/budget this long before its start date | |
| InitializeTasksBeforeStartDateMultiple | Yes |