[beta] Update Safety Events

patch

https://api.samsara.com/safety-events/batch

Asynchronously update eventState, context labels, and/or behavior labels for one or more Safety Events. Returns 202 Accepted immediately. State changes propagate asynchronously; use GET /safety-events to confirm updated state. If any safetyEventIds are not found, the entire request fails with 404 before any mutations are executed.If both eventState and label fields are provided, the two mutations execute serially and are not transactional — a label mutation failure will not roll back a successful state change.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Write Safety Events & Scores under the Safety & Cameras category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for updating Safety Events. At least one of eventState, contextLabelsToAdd, contextLabelsToRemove, behaviorLabelsToAdd, or behaviorLabelsToRemove must be provided. Maximum 200 IDs per request.

behaviorLabelsToAdd

array of strings

Behavior labels to add to the Safety Events.

behaviorLabelsToAdd

behaviorLabelsToRemove

array of strings

Behavior labels to remove from the Safety Events.

behaviorLabelsToRemove

contextLabelsToAdd

array of strings

Context labels to add to the Safety Events.

contextLabelsToAdd

contextLabelsToRemove

array of strings

Context labels to remove from the Safety Events.

contextLabelsToRemove

dismissalReason

object

Dismissal reason. Required when eventState is dismissed. Must not be provided for other states.

eventState

string

enum

The new state to apply to all specified Safety Events. Valid values: needsReview, reviewed, needsCoaching, coached, dismissed, needsRecognition, recognized

Allowed:

safetyEventIds

array of strings

required

IDs of the Safety Events to update. Maximum 200.

safetyEventIds*

Responses

202Accepted response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.