Update Task Status
Method: PATCH
/api/v1/tasks/{id}/status
Description
This endpoint updates the status of a specific task. Users can also add supporting documentation links and update the task's description.
🔑 Authentication
This endpoint requires authentication via headers.
| Param | Value | Type |
|---|---|---|
tenantId | {{tenantId}} | string |
userId | {{userId}} | string |
countryCode | {{countryCode}} | string (optional) |
Path Parameter
| Name | Type | Description |
|---|---|---|
id | string | The unique ID of the task. |
Request Body
{
"status": "PENDING",
"docLinks": [
{
"name": "string",
"link": "string"
}
],
"description": "string"
}
Request Body Explanation
| Name | Type | Description |
|---|---|---|
status | string | The status of the task (e.g., PENDING, COMPLETED). |
docLinks | array | List of document links related to the task. |
docLinks[].name | string | The name or title of the document (e.g., "Progress Report"). |
docLinks[].link | string | A URL linking to the document. |
description | string | A description of the task or any status-related updates. |
Response: 200
{
"message": "Task status updated successfully.",
"taskId": "12345",
"status": "PENDING",
"updatedDescription": "The task is awaiting approval.",
"docLinks": [
{
"name": "Sustainability Report",
"link": "https://example.com/sustainability-report.pdf"
}
]
}
LANGUAGE
CURL REQUEST
curl --request PATCH \
--url /api/v1/tasks/{id}/status \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!