Skip to main content

Upload Task Request Result

Method: PATCH
/api/v1/task-requests/{id}/upload-result


Description​

This endpoint allows uploading documents related to a specific task request. Users can attach multiple document links as part of the task’s results.


πŸ”‘ 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.

Request Body​

{
"userId": "string",
"docLinks": [
{
"name": "string",
"link": "string"
}
]
}

Request Body Explanation​

NameTypeDescription
userIdstringThe ID of the user uploading the task result.
docLinksarrayA list of document links associated with the task result.
docLinks[].namestringThe name or description of the document (e.g., "Inspection Report").
docLinks[].linkstringA URL linking to the document.

Response: 200​

{
"message": "Task result uploaded successfully.",
"taskRequestId": "12345",
"uploadedBy": "user123"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v1/task-requests/{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!