Element Tasks
Manage standalone tasks nested under elements. Successful writes return the refreshed parent element snapshot.
Create task
Creates a task under the addressed story or event.
path Parameters
idCreate task › Request Body
confirmationStatusCodeTask confirmation status code.
Required on create. null is invalid.
formatIdWritable task content payload.
Omit or set null to create without task content.
Cost for this task.
Omit or set null to create without cost.
Task custom field values.
Omit, set null, or send [] to create without task custom field values.
customUploadLinkCustom upload link for this task.
Omit or set null to leave it unset on create.
Task deadline date and optional time.
Omit or set null to create without a deadline.
Task separate event.
Omit or set null to create without a separate event.
Link to assets connected to this task, also called Asset Link.
Omit or set null to create without an Asset Link.
noteSpecial note for the task.
Omit or set null to leave it unset on create.
statusIdTask status ID.
See Task Statuses for allowed values.
Omit or set null to create without a task status. Non-null values must be active for the organization.
Task text max length.
Omit or set null to create without an explicit text-length override.
Assigned user.
Omit or set null to create an unassigned task.
Create task › Responses
Task created; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Apply task done-state changes
Applies batch task done-state changes to tasks that belong to the addressed story or event.
path Parameters
idApply task done-state changes › Request Body
Task done-state changes.
Provide at least one item.
Apply task done-state changes › Responses
Task done-state changes applied; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Update task
Partially updates the addressed task.
path Parameters
idtaskIdUpdate task › Request Body
confirmationStatusCodeTask confirmation status code.
Omit to leave it unchanged. null is invalid. Cannot be changed while the task is done.
Task content.
Omit to leave it unchanged. Set null or send an empty object to clear it.
Cost for this task.
Omit to leave it unchanged. Set null to clear it.
Task custom field patch instructions.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
customUploadLinkCustom upload link for this task.
Omit to leave it unchanged. Set null to clear it.
Task deadline date and optional time.
Omit to leave it unchanged. Set null to clear it.
Changing the deadline date on a done task reopens the task and clears current assignee markers.
Task separate event.
Omit to leave it unchanged. Set null to clear it.
Link to assets connected to this task, also called Asset Link.
Omit to leave it unchanged. Set null to clear it.
formatIdnoteSpecial note for the task.
Omit to leave it unchanged. Set null to clear it.
statusIdTask status ID.
See Task Statuses for allowed values.
Omit to leave it unchanged. Set null to clear it. Non-null values must be active for the organization.
Task text max length.
Omit to leave it unchanged. Set null to clear it.
Assigned user.
Omit to leave it unchanged. Set null to clear it.
Changing the assignee on a done task reopens the task and clears production date/time metadata.
When the current assignee is a registered user inaccessible to the caller (cross-organization), the GET response exposes only the display name (firstName + " " + lastName) without id; treat that name as display-only metadata. Echoing it back via user.name byte-for-byte preserves the existing assignee; any difference replaces it with a non-registered user. To preserve such an assignee safely, omit user from the request.
Update task › Responses
Task updated; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Update task custom fields
Partially updates custom fields attached to the addressed task.
path Parameters
idtaskIdUpdate task custom fields › Request Body
Custom field patch instructions.
Send [] as an empty instruction list. null is invalid.
Update task custom fields › Responses
Task custom fields updated; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.