---
title: "Update Monitor"
method: PATCH
path: "/monitors/{id}"
tags: ["Monitors"]
---

# Update Monitor

`PATCH /monitors/{id}`

## Request

- Base URL: `https://api.croma.run`
- URL: `https://api.croma.run/monitors/{id}`
- Auth: HTTP bearer

Change any field but the endpoint. `status: "paused"` stops the schedule and `"active"` resumes it; a new schedule takes effect on the next run.

## Path parameters

- `id` string, required

## Headers

- `Idempotency-Key` string

## Request body

- MonitorUpdateRequest
  - `name` string
  - `query` object
  - `schedule` object: When the monitor runs. `source` (the default) runs right after the endpoint's own refresh completes, and is only available on endpoints with `served_from: "dataset"`; `hourly`, `daily` and `weekly` run on the clock, never faster than the source refreshes. An endpoint with `served_from: "live"` queries the source on every run, so it takes `daily` or `weekly`.
    - `cadence` 'source' | 'hourly' | 'daily' | 'weekly'
    - `at` string: Time of day for daily and weekly, HH:MM. Default 08:00.
    - `weekday` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday': Day for weekly. Default monday.
    - `timezone` string: IANA timezone for `at`. Defaults to the dataset's own.
  - `recipients` string[]: Up to three addresses that receive the results.
  - `notify` 'always' | 'on_new': `always` sends an email on every run, including one that found nothing new; `on_new` only when there is something to report.
  - `language` 'es' | 'en': Language of the emails.
  - `relevance` string, nullable: Optional instruction, in plain language, that filters new results by relevance before they are sent (e.g. "solo avisos sobre suspensión o caducidad del título"). Results the filter discards stay available under `GET /monitors/{id}/matches?relevant=false`.
  - `status` 'active' | 'paused': Pause or resume the monitor.

## Response `200`

The updated monitor.

- MonitorResponse
  - `data` Monitor, required
    - `id` string, required
    - `name` string, required
    - `endpoint` object, required
      - `id` string, required
      - `path` string, required
      - `source` string, required
      - `name` string, required
    - `query` object, required
    - `relevance` string, nullable, required
    - `schedule` object, required
      - `cadence` 'source' | 'hourly' | 'daily' | 'weekly', required
      - `at` string
      - `weekday` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
      - `timezone` string, required
      - `cron` string, required: The compiled schedule, five-field cron in `timezone`.
      - `next_run_at` string, date-time, nullable, required
    - `recipients` string[], required
    - `notify` 'always' | 'on_new', required
    - `language` 'es' | 'en', required
    - `status` 'active' | 'paused', required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `last_run` MonitorLastRun, nullable, required
      - `id` string, required
      - `at` string, date-time, required
      - `status` 'running' | 'completed' | 'failed' | 'skipped_plan_limit', required
      - `new_results` integer, required
      - `relevant_results` integer, required
      - `source_as_of` string, nullable, required
      - `source_stale` boolean, required

## Other responses

- `400`: Invalid body
- `401`: Missing or invalid API key
- `403`: Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)
- `404`: Monitor not found
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/usecroma/apis/croma-marketplace-api.md) · [All operations](https://skmtc.dev/usecroma/apis/croma-marketplace-api/llms.txt) · [OpenAPI document](https://skmtc.dev/usecroma/apis/croma-marketplace-api/revisions/df016cdb29d7?raw)