Skip to main content

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.

ParamValueType
tenantId{{tenantId}}string
userId{{userId}}string
countryCode{{countryCode}}string (optional)

Path Parameter

NameTypeDescription
idstringThe unique ID of the task.

Request Body

{
"status": "PENDING",
"docLinks": [
{
"name": "string",
"link": "string"
}
],
"description": "string"
}

Request Body Explanation

NameTypeDescription
statusstringThe status of the task (e.g., PENDING, COMPLETED).
docLinksarrayList of document links related to the task.
docLinks[].namestringThe name or title of the document (e.g., "Progress Report").
docLinks[].linkstringA URL linking to the document.
descriptionstringA 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

AUTHORIZATION

Bearer

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!