Update Analysis

PATCH

/apis/v1/analysis/{analysisId}

Update an existing analysis. Supports partial updates to:

Text fields (title, preferenceText, alternativeText, comments)

Expiry settings

Levels (must maintain ordering rules)

Drawings (replaces all drawings)

Links (remapped to persisted IDs)

Webhook Events

Triggers update_analysis webhook event with updated analysis payload.

Bot Notifications

Publishes to Redis channel bot:notification with change details.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Update text and expiryUpdate levels and drawings

{
    "metadata": {
        "title": "EURUSD Updated Analysis"
    },
    "sender": "pangray2025+t5@gmail.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Update text and expiryUpdate levels and drawings

curl --location --request PATCH 'https://integration.returning.ai/apis/v1/analysis/6960eaf9294dfdd00c5875bf' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "title": "EURUSD Updated Analysis"
    },
    "sender": "pangray2025+t5@gmail.com"
}'

Responses

🟢200

application/json

Analysis updated successfully

Body

Example

{
    "status": "success",
    "message": "Analysis updated successfully",
    "data": {
        "analysisId": "507f1f77bcf86cd799439022",
        "updatedFields": [
            "title",
            "preferenceText",
            "expiry"
        ]
    }
}

🟠404

🟠400BadRequest

🟠401Unauthorized

🔴500InternalServerError

Modified at 2026-01-09 13:45:46

Get Analysis

Delete Analysis