Skip to main content
PATCH
/
api
/
v1
/
alerts
/
{id}
Update alert status
curl --request PATCH \
  --url https://shelfforce.ai/api/v1/alerts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snoozeDurationMs": 123
}
'
{
  "data": {
    "id": "<string>",
    "status": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Path Parameters

​
id
string
required

Alert ID

Body

application/json
​
status
enum<string>
required

New status for the alert

Available options:
read,
acknowledged,
dismissed,
snoozed
​
snoozeDurationMs
integer

Required when status is 'snoozed'. Duration in milliseconds.

Response

Alert updated.

​
data
object