Update Task Request Status
Method: PATCH
/api/v1/task-requests/{id}/status
Description
This endpoint updates the status of a specific task request. Users can change the status, add supporting documentation links, and provide a description for the update.
🔑 Authentication
This endpoint requires authentication via headers.
| Param | Type | Description |
|---|---|---|
tenantId | string | Tenant ID associated with the task. |
userId | string | User ID of the person updating the task. |
countryCode | string | The country code for the request. |
Path Parameter
| Name | Type | Description |
|---|---|---|
id | string | The unique ID of the task request. |
Request Body
{
"status": "PENDING",
"docLinks": [
{
"name": "string",
"link": "string"
}
],
"description": "string"
}
Request Body Explanation
| Name | Type | Description |
|---|---|---|
status | string | The new status of the task request (e.g., "PENDING"). |
docLinks | array | List of document links related to the status update. |
docLinks[].name | string | The name of the document (e.g., "Supporting Document"). |
docLinks[].link | string | The URL link to the document. |
description | string | A description of the reason for the status update. |
Response: 200
{
"message": "Task request status updated successfully.",
"taskRequestId": "12345",
"status": "PENDING",
"updatedAt": "2025-02-12T12:30:00.000Z"
}
LANGUAGE
CURL REQUEST
curl --request PATCH \
--url /api/v1/task-requests/{id}/status \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!