Add action

Add an action to an alarm. Actions include: "read", "unread", "close", "open".

Note: POST calls create new data, and do not affect existing data.

Request

Security:

bearerAuth

path Parameters

alarmId

required

string^[1-9]\d*$

The ID of the alarm. Obtain this from GET /alarms.

Example: 62

Request Body schema: application/json

type

required

string (Alarm action type)

Enum: "open" "close" "read" "unread"

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

post/alarms/{alarmId}/actions

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"type": "open"
}

Response samples

application/json

{"data": {"type": "open",
"id": 125,
"alarmId": 625,
"createdByAudienceName": "surfsight",
"createdById": 625,
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
},
"requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}