Returning.AIDevelopers
v1

API reference / Chart Analysis

.md

Delete analysis

Delete one chart analysis for good and hide the channel post that shows it.

Last updated 26 Sep 2026API v1

Method
DELETE
Path
https://api.returning.ai/v1/analysis/{analysisId}
Permission
sendMessage
Retries
Safe to repeat; a repeat returns 404

When to use this

  • An analysis was posted by mistake, or with the wrong symbol or levels, and should come down.
  • Your own tool removes an idea, and the community card should go with it.
  • Clean up test cards from a chart channel.

Authentication#

Header
Authorization: Bearer <API_KEY>
Permission
sendMessageShown in the dashboard as “Send Messages”

Use a Community API key with sendMessage, shown in the dashboard as Send Messages, and keep it on your server. This endpoint takes no sender and doesn't check who created the analysis, so only send IDs from your own community's analyses. Personal API keys are not accepted here and return 401.

Behaviour#

Deleting removes the analysis for good and marks its channel post as deleted. No live update is sent, so members who already have the channel open may keep seeing the card until they reload. An analysis can be deleted in any status, not only Pending.

Request#

Path parameters#

analysisId#stringREQUIRED
The analysis ID from Create analysis or List analyses.

Rule24 hex characters

Eg"66f000000000000000000b01"

Headers#

Authorization#stringREQUIRED
Community API key with sendMessage.

RuleBearer <API_KEY>

curl --request DELETE \
  --url https://api.returning.ai/v1/analysis/66f000000000000000000b01 \
  --header 'Authorization: Bearer <API_KEY>'

Response#

A 200 means the analysis is gone. The body repeats the ID in data.analysisId.

status#stringALWAYS
Result of the request.

Rulesuccess

statusCode#integerALWAYS
The HTTP status, repeated.
message#stringALWAYS
Human-readable summary. Do not branch on it.

Eg"Analysis deleted successfully"

data#objectALWAYS
The deleted analysis.
analysisId#stringALWAYS
The ID you deleted, as sent in the path.
{
  "status": "success",
  "statusCode": 200,
  "message": "Analysis deleted successfully",
  "data": {
    "analysisId": "66f000000000000000000b01"
  }
}

Errors#

These errors have no machine-readable code; branch on the HTTP status. The 401 for a missing or unknown key has detail and a meta object; the 401 for a missing permission has only message. Other errors carry status, statusCode and message.

Fix the request02

400Fix the request
analysisId isn't a valid ID. Send the 24-character ID from Create analysis or List analyses.
401Fix the request
The key is missing (Token is require.) or unknown (Token is wrong.), it's a personal key, or it lacks sendMessage (Your API key does not have permission to access this action). Send Authorization: Bearer <API_KEY> with a Community API key, and add Send Messages in Settings > Integration > API Keys.

Retry with backoff01

500Retry with backoff
The delete failed part way. Call Get analysis: if it returns 404 the analysis is gone; otherwise retry the delete with backoff.

Do not retry01

404Do not retry
No analysis has this ID. If you deleted it already, including on an earlier attempt that timed out, there is nothing left to do.
{
  "status": "fail",
  "statusCode": 400,
  "message": "Invalid analysis ID format"
}

Next step#

Confirm with List analysesGET/v1/analysis/communities/{communityId}/channels/{channelId}Check that the analysis no longer appears in its channel.