---
title: "Update a monitor"
method: PATCH
path: "/v1/monitor/{monitor_id}"
tags: ["monitor"]
---

# Update a monitor

`PATCH /v1/monitor/{monitor_id}`

## Request

- Base URL: `http://localhost:3030`
- URL: `http://localhost:3030/v1/monitor/{monitor_id}`
- Auth: HTTP bearer

Pauses or resumes a monitor, or changes what it reports and who receives its daily email.

A paused monitor produces no events, and nothing that happened while it was paused is sent when
it resumes.

## Path parameters

- `monitor_id` string, required: The monitor's id, `mon_...`.

## Request body

- MonitorPatch: A partial update. Omitted fields are unchanged.
  - `active` boolean, nullable: Whether the monitor produces events.
  - `event_type` string[], nullable: The event types to report. Replaces the current set.
  - `email_recipient` string[], nullable: Email addresses of members to send a daily summary to. Replaces the current set. `[]` sends none.

## Response `200`

The monitor.

- Monitor
  - `object` 'monitor', required: The object's type. Always `monitor`.
  - `id` string, required: Unique identifier for the object.
  - `list` string, required: The id of the list watched.
  - `active` boolean, required: Whether the monitor produces events.
  - `event_type` string[], required: The event types the monitor reports. Any of `permit.created` and `case.created`.
  - `email_recipient` string[], required: Email addresses of the members who receive a daily summary of the monitor's events. Empty when no one does.
  - `created_at` string, date-time, required: Time at which the object was created.
  - `updated_at` string, date-time, required: Time at which the object was last updated.
  - `href` string, required: The object's path in the API.

## Other responses

- `401`: `credential_missing`, `credential_invalid` or `credential_expired`. The request has no valid credential.
- `403`: `scope_missing`, `person_required`, `api_key_not_accepted` or `entitlement_missing`. The credential or plan does not allow this request. `detail` names the reason.
- `404`: `no_such_resource`. No object has that id.
- `422`: `parameter_invalid`, `id_malformed` or a cursor code. A parameter is missing or invalid. `errors` lists each one.
- `429`: `rate_limited`. Too many requests. Retry after the `Retry-After` interval. Nothing is charged.

---

[API](https://skmtc.dev/placestack/apis/placestack-api.md) · [All operations](https://skmtc.dev/placestack/apis/placestack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/placestack/apis/placestack-api/revisions/0ccdf0882668?raw)