Update Analysis
PATCH
/v1/analysis/{analysisId}
What this endpoint does
404 Analysis not found, not an empty analysis object.INFO
Quick start
sender for community API-key callers, same as create.Authentication and permission
sendMessage. Keep the key server-side.Complete examples
{ "status": "fail", "statusCode": 404, "message": "Analysis not found" }.Success and readback
Errors and recovery
| Status | When | Recovery |
|---|---|---|
404 Analysis not found | Unknown {analysisId} | Copy an id from the list. |
401 | Missing or invalid token | Replace the key. |
Retry safety
WARNING
Gotchas
{analysisId} is not a channel id or user id.Next steps
Request
Path Params
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request PATCH 'https://adss-integration.returning.ai/apis/v1/analysis/6978da419dfe29f77fbab39e' \
--header 'x-data-security-key: returning-ai' \
--header 'Content-Type: application/json' \
--data-raw '{
"metadata": {
"title": "EURUSD Updated Analysis"
},
"sender": "pangray2025+t5@gmail.com"
}'Response Response Example
200 - Success Example
{
"status": "success",
"message": "Analysis updated successfully",
"data": {
"analysisId": "507f1f77bcf86cd799439022",
"updatedFields": [
"title",
"preferenceText",
"expiry"
]
}
}Modified at 2026-08-19 13:46:27