diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 52e6772fdc..1569a6774c 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -186,13 +186,24 @@ Sets retain to true for the event id. Sets retain to false for the event id (event may be deleted quickly after removing). +### `POST /api/events//sub_label` + +Set a sub label for an event. For example to update `person` -> `person's name` if they were recognized with facial recognition. +Sub labels must be 20 characters or shorter. + +```json +{ + "subLabel": "some_string" +} +``` + ### `GET /api/events//thumbnail.jpg` Returns a thumbnail for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio. ### `GET /api//