Update Task Upload Result
Method: PATCH
/api/v1/tasks/{id}/upload-result
Description
This endpoint updates the result of a specific task by uploading document links for that task. It is used to associate additional documents with a task.
🔑 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
{
"userId": "string",
"docLinks": [
{
"name": "string",
"link": "string"
}
]
}
Request Body Explanation
| Name | Type | Description |
|---|---|---|
userId | string | The ID of the user uploading the document. |
docLinks | array | An array of document links associated with the task. |
docLinks[].name | string | The name of the document. |
docLinks[].link | string | A URL linking to the document. |
Example Response
{
"message": "Task result updated successfully.",
"taskId": "12345",
"updatedDocLinks": [
{
"name": "Inspection Report",
"link": "https://example.com/inspection-report.pdf"
}
]
}
LANGUAGE
CURL REQUEST
curl --request PATCH \
--url /api/v1/tasks/{id}/upload-result \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!