---
title: "Add a new watch list"
method: POST
path: "/watch-lists/"
tags: ["watch-lists"]
---

# Add a new watch list

`POST /watch-lists/`

Use this method to add a new watch list.

## Request body

- WatchListRequest
  - `active` boolean — `true` if a watch list is enabled
  - `name` string, required — Short watch list name, up to 256 characters
  - `comment` string — Extended description, up to 2048 characters
  - `color` string — Color of the object label in hex
  - `notify` boolean — `true` if the notifications on the watch list enabled
  - `acknowledge` boolean — Require manual acknowledgment of the events that match with the watch list
  - `camera_groups` integer[] — List of the camera groups used to monitor the watch list
  - `face_threshold` number, float, nullable — Watch list face confidence threshold
  - `body_threshold` number, float, nullable — Watch list body confidence threshold
  - `car_threshold` number, float, nullable — Watch list car confidence threshold
  - `ignore_events` boolean — Events won't be created if set to True
  - `send_events_to_external_vms` boolean — `true` if events matched with this watch list should be sent to an external VMS
  - `active_after` string, date-time, nullable
  - `active_before` string, date-time, nullable
  - `disable_schedule` ScheduleRequest — Serializer mixin that raises ValidationError if excess fields are presented. Can be used in nested serializers
    - `monday` array[]
      - string[]
    - `tuesday` array[]
      - string[]
    - `wednesday` array[]
      - string[]
    - `thursday` array[]
      - string[]
    - `friday` array[]
      - string[]
    - `saturday` array[]
      - string[]
    - `sunday` array[]
      - string[]
  - `origin` string — bit
  - `collect_location` boolean — `true` to enable daily search for cards from this watch list

## Response `201`

- WatchList
  - `id` integer, required
  - `created_date` string, date-time, required — Object creation date
  - `modified_date` string, date-time, required — Object modification date
  - `active` boolean — `true` if a watch list is enabled
  - `name` string, required — Short watch list name, up to 256 characters
  - `comment` string — Extended description, up to 2048 characters
  - `color` string — Color of the object label in hex
  - `notify` boolean — `true` if the notifications on the watch list enabled
  - `acknowledge` boolean — Require manual acknowledgment of the events that match with the watch list
  - `camera_groups` integer[] — List of the camera groups used to monitor the watch list
  - `face_threshold` number, float, nullable — Watch list face confidence threshold
  - `body_threshold` number, float, nullable — Watch list body confidence threshold
  - `car_threshold` number, float, nullable — Watch list car confidence threshold
  - `ignore_events` boolean — Events won't be created if set to True
  - `send_events_to_external_vms` boolean — `true` if events matched with this watch list should be sent to an external VMS
  - `active_after` string, date-time, nullable
  - `active_before` string, date-time, nullable
  - `disable_schedule` Schedule — Serializer mixin that raises ValidationError if excess fields are presented. Can be used in nested serializers
    - `monday` array[]
      - string[]
    - `tuesday` array[]
      - string[]
    - `wednesday` array[]
      - string[]
    - `thursday` array[]
      - string[]
    - `friday` array[]
      - string[]
    - `saturday` array[]
      - string[]
    - `sunday` array[]
      - string[]
  - `recount_schedule_on` string, date-time, required
  - `origin` string — bit
  - `collect_location` boolean — `true` to enable daily search for cards from this watch list

---

[API](https://skmtc.dev/ntechlab/apis/internal-api-documentation.md) · [All operations](https://skmtc.dev/ntechlab/apis/internal-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ntechlab/internal-api-documentation/revisions/fe217a895bc7/schema)