Monitors

Update Monitor

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

patch/monitors/{id}

Request

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

Path parameters

idstring required

Monitor id, as returned on creation (mon_…).

Headers

Idempotency-Keystring
Example:0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Request body

namestring
queryobject
recipientsstring[]

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.

relevancestring 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.

Example request

{
  "schedule": {
    "at": "08:00",
    "timezone": "America/Bogota"
  }
}

Response

The updated monitor.

Example response

{
  "data": {
    "id": "mon_5f1c2c0a-9d1e-4a3b-8c7d-1e2f3a4b5c6d",
    "endpoint": {
      "id": "anm-notices-search",
      "path": "/co/anm/notices-search/v1",
      "source": "ANM"
    },
    "schedule": {
      "cron": "30 7 * * *"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.