Partial update Task

PATCH {{url}}/{{tenantName}}/{{instanceName}}/tasks/{{task_id}}

Example overview

Updated name, dueDate, status, priority fields

HTTP Request

Method: PATCH

Endpoint: {url}/{tenantName}/{instanceName}/tasks/{taskId}

in our example it would be: https://api.live.welkincloud.io/gh/sb-demo/tasks/28b38060-db66-4183-bcaa-34751308573a

Parameters

NameLocated inDescriptionRequiredType
tenantNamepathName of tenantYesstring
instanceNamepathName of instanceYesstring
taskIdpathTask identifierYesUUID
namebodyShort name of the taskYesstring
descriptionbodyDetailed text description of the taskNostring
prioritybodytask priorityYesLOWMEDIUMHIGHURGENT
statusbodytask statusYesTODOIN_PROGRESSCOMPLETEDCANCELED
dueDatebodydeadline for the taskNoDatetime in ISO-8601 format
assigneebodyuser responsible for the taskYes{"id": ""}
patientbodytask-related patientNo{"id": ""}

Responses

CodeDescription
200OK
401Unauthorized
403Forbidden
404Not Found

Request Body

{"name"=>"Updated task", "description"=>"Create new patient profile", "dueDate"=>"2021-12-01T12:16:38.514Z", "priority"=>"URGENT", "status"=>"IN_PROGRESS", "assignee"=>{"id"=>"03a87f5b-3a04-4be8-b0ad-7a34a5b2892d"}, "patient"=>{"id"=>"fff8d36d-01ef-4bf4-ba92-bacfa954c178"}}