RErecordedfuture
Alert

Update one or several alerts

Changed on

Updates one or several alerts. It's possible to update assignee, status and a note tied to the triggered alert.

There are two types of statuses, the recommended "statusInPortal" and the legacy "status". They are mapped, so changing one will change the other and it is not possible to update both independently.

post/update

Request

  • Base URL
    api.recordedfuture.com/alert/v2 (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-RFToken

Request body

idstring required

Id of the alert to update

assigneestring

New assignee. Can be an id, uhash, username or email.

notestring

New note text

status'unassigned' | 'assigned' | 'pending' | 'dismiss' | 'no-action' | 'actionable' | 'tuning'

New alert status (legacy)

statusInPortal'New' | 'Resolved' | 'Pending' | 'Dismissed' | 'Flag for Tuning'

New alert status

Example request

[
  {
    "id": "FNESDXvojsW"
  }
]

Response

A partial view of the updated alert(s). If any alert update fails, errors will be included as well.

Example response

{
  "success": [
    {
      "id": "Yo0T32",
      "assignee": "1ygPdSX9v7",
      "note": {
        "author": "1ygPdSX9v7",
        "date": "2025-04-16T13:00:00.000Z"
      },
      "reviewDate": "2025-04-16T13:00:00.000Z",
      "statusDate": "2025-04-16T13:00:00.000Z",
      "statusChangeBy": "1ygPdSX9v7"
    }
  ],
  "error": [
    {
      "id": "Lp5H17",
      "reason": "Invalid status 'test'",
      "statusCode": 400
    }
  ]
}

Changes