Creates a new schedule task with employee/department assignments, optional patient association, and notes.

post

https://integrationhub.wellsky.io/commands/v4/scheduletasks

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

api-version

string

The requested API version

Body Params

The request containing task details.

Request contract for creating a new schedule task in V4 API.

subject

string

required

length ≥ 1

Gets or sets the subject of the task.
This is a required field and represents the main description or title of the task.

taskType

string | null

Gets or sets the type of task.
Must match a valid value from the TaskType lookup table.

startDateTime

date-time

required

Gets or sets the start date and time for the task (in UTC).
This is a required field.

endDateTime

date-time | null

Gets or sets the end date and time for the task (in UTC).
Either EndDateTime or DurationMinutes must be provided.
If both are provided, they must be consistent (EndDateTime = StartDateTime + DurationMinutes).

durationMinutes

int32 | null

Gets or sets the duration of the task in minutes.
Either DurationMinutes or EndDateTime must be provided.
If both are provided, they must be consistent.

employeeIds

array of int64s | null

Gets or sets the list of employee IDs to assign this task to.
At least one of EmployeeIds or DepartmentIds must be provided.
If both are provided, employees will be deduplicated.

employeeIds

departments

array of strings | null

Gets or sets the list of department IDs to assign this task to.
The task will be assigned to all active employees in these departments.
At least one of EmployeeIds or DepartmentIds must be provided.

departments

medicalRecordNo

string | null

Gets or sets the patient medical record number (MRN) to associate with this task.
This is recommended but not required.

notes

string | null

Gets or sets optional notes or additional information about the task.
These notes will be stored in the TaskMessage table.
Maximum length: 4000 characters.

reminderMinutes

int32 | null

Gets or sets the reminder time in minutes before the task start time.
This will trigger a reminder notification to assigned employees.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized - missing or invalid authentication token.

201Task created successfully.

400Invalid request data or validation failure.

404TaskType, Employee, Department, or Patient not found.

500Internal server error.