Skip to main content

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.

ParamTypeDescription
tenantIdstringTenant ID associated with the task.
userIdstringUser ID of the person updating the task.
countryCodestringThe country code for the request.

Path Parameter

NameTypeDescription
idstringThe unique ID of the task request.

Request Body

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

Request Body Explanation

NameTypeDescription
statusstringThe new status of the task request (e.g., "PENDING").
docLinksarrayList of document links related to the status update.
docLinks[].namestringThe name of the document (e.g., "Supporting Document").
docLinks[].linkstringThe URL link to the document.
descriptionstringA 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

AUTHORIZATION

Bearer

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!