Relesys API Docs

Task Management

Create

POST /taskmanagementmodules/{moduleId}/tasks

https://api.relesystest.net/api/v1.3/taskmanagementmodules/{moduleId}/tasks

Create a task in a module with moduleId if the model is valid.

availableFrom and availableUntil should be provided in the following format: "yyyy-MM-ddTHH:mm:ss".

In order to send notifications, the following optional properties may be set:

reminderDueSoonInterval - specifies the number of days before the task's end date (availableUntil) when the notification will be sent.
reminderInterval - specifies the number of days after the task's end date (availableUntil) when the notification will be sent.
notifyManagerOfDepartmentType - specifies the department type of the manager.

There are the following assignee types:

Everyone - all users that have access to the task are required to complete it. Both assigneeIds and assignedDepartmentType properties should not be populated in such cases.
NOTE: assigneeIds property is not populated in such scenario in the response model.
ByDepartmentType - at least one user per department type is required, with hierarchical departments included if they exist. assignedDepartmentType property must be provided in such cases.
SelectedUsers_AtLeastOne - at least one user listed in assigneeIds is required to complete the task. assigneeIds must be populated.
SelectedUsers_RequireAll - all users listed in assigneeIds are required to complete the task. assigneeIds must be populated.

If no assigneeType is provided, default value Everyone is used.

If boolean values are not provided, false or the default values from the module settings are used.

If recurrence is provided, availableFrom should be the same as the recurrence rule's DTSTART date, availableFromTimeZone must match availableUntilTimeZone, and availableUntil should be on the same day, since it is used for task's duration.

Both tasks and subtasks contain their own locales objects. If provided, the summary field within each locales entry must use Markdown syntax.

Details for created subtasks can be queried via Get List of Subtasks endpoint.

For more information on permissions, Markdown syntax and recurrence rules visit their respective concept pages.

Scopes: relesys.api, relesys.api:write, relesys.api.taskmanagement, relesys.api.taskmanagement:write

URL Path

moduleId

string / guid

The module's unique identifier

required

Request Body

application/json

object
assignedDepartmentType	string		optional
assigneeIds	array[string / guid]		optional
assigneeType	string		optional
availableFrom	string		required
availableFromTimeZone	string		optional
availableUntil	string		required
availableUntilTimeZone	string		optional
categoryIds	array[string / guid]		optional
disableComments	boolean		optional
hideAuthor	boolean		optional
⯈ locales	array[object]		required
culture	string		required
summary	string		optional
title	string	Max length: 256	required
lockByAvailableFrom	boolean		optional
lockByAvailableUntil	boolean		optional
mediaIds	array[string / guid]		optional
name	string	Max length: 256	required
notifyManagerOfDepartmentType	string		optional
⯈ permissions	array[object]		required
departments	array[string / guid]		required
requireAllUserGroups	boolean		optional
userGroups	array[string / guid]		required
publishOnCreate	boolean		optional
recurrence	string		optional
reminderDueSoonIntervalInDays	integer		optional
reminderIntervalInDays	integer		optional
serviceFormId	string / guid		optional
⯈ subtasks	array[object]		optional
⯈ locales	array[object]		required
culture	string		required
summary	string		optional
title	string	Max length: 256	required
mediaIds	array[string / guid]		optional
name	string	Max length: 256	required

Responses

application/json

Schema Example

JSON

{"data":{"id":"b2b468e9-5e75-4d0a-b692-8bdb595a1ddc","name":"Internal name","recurrence":"FREQ=DAILY;DTSTART=20251010T130000;INTERVAL=1;COUNT=1","parentId":null,"locales":[{"culture":"en-GB","title":"Title 1","summary":"Summary 1"},{"culture":"en-GB","title":"Title 2","summary":"Summary 2"}],"categoryIds":["58f3f470-3efa-4d0d-8620-d97dae0ce07d","bb4b094f-321e-4750-90d6-3d25df2a56c8"],"availableFrom":"2025-10-10T13:00:00","availableFromTimeZone":"FLE Standard Time","availableUntil":"2025-10-10T14:00:00","availableUntilTimeZone":"FLE Standard Time","subtaskIds":["1b3a04c3-8724-4040-8276-0795e3286e24","c82aa41c-109e-4ed5-bbd5-e3f5e1535616"],"serviceFormId":null,"medias":[{"id":"0474d230-db9d-458d-8934-55a399b9c883","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"FileName.png"},{"id":"c3591246-07c3-4ee4-8af7-d41fdc4e9703","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"FileName.png"}],"permissions":[{"departments":[{"url":null,"name":"Department 1","id":"b727b81f-fcb5-47cb-a5b4-e3c863b7d43a"},{"url":null,"name":"Department 2","id":"7a2bd9ec-e28d-428f-b87e-4800e792fe29"}],"userGroups":[{"url":null,"name":"User group 1","id":"a97f75e9-f476-4931-a7d3-402862588c52"},{"url":null,"name":"User group 2","id":"87fa0fb4-f658-41be-a222-f70983435599"}],"requireAllUserGroups":false}],"status":"Published","assigneeType":"SelectedUsers_AtLeastOne","assigneeIds":["62137f1e-b966-4bfb-9c6b-9fe554ec3ac0","91fb8625-cdb8-4c3d-9c0f-3a471b1952d6"],"assignedDepartmentType":null,"notifyManagerOfDepartmentType":"Country","reminderDueSoonIntervalInDays":1,"reminderIntervalInDays":null,"lockByAvailableFrom":false,"lockByAvailableUntil":true,"hideAuthor":false,"disableComments":false,"isUnsynchronizedWithParent":null,"creationDateTime":"2025-10-09T13:00:00+00:00","lastModifiedDateTime":null}}

object
⯈ data	object
assignedDepartmentType	string
assigneeIds	array[string / guid]
assigneeType	string
availableFrom	string
availableFromTimeZone	string
availableUntil	string
availableUntilTimeZone	string
categoryIds	array[string / guid]
creationDateTime	datetimeoffset
disableComments	boolean
hideAuthor	boolean
id	string / guid
isUnsynchronizedWithParent	boolean
lastModifiedDateTime	datetimeoffset
⯈ locales	array[object]
culture	string
summary	string
title	string
lockByAvailableFrom	boolean
lockByAvailableUntil	boolean
⯈ medias	array[object]
contentType	string
downloadUrl	string
fileName	string
id	string / guid
referenceUrl	string
name	string
notifyManagerOfDepartmentType	string
parentId	string / guid
⯈ permissions	array[object]
⯈ departments	array[object]
id	string / guid
name	string
url	string
requireAllUserGroups	boolean
⯈ userGroups	array[object]
id	string / guid
name	string
url	string
recurrence	string
reminderDueSoonIntervalInDays	integer
reminderIntervalInDays	integer
serviceFormId	string / guid
status	string
subtaskIds	array[string / guid]

Relesys API Docs

v1.3

Welcome

Concepts

Endpoints

Task Management

URL Path

Request Body

Responses