Update a watch (pause / resume / close / notifications)

Free. Patch name, status, notify_email, notify_chat, imagery_alerts or close_reason. status "paused" pauses the watch AND its bound resources (monitored metrics stop being measured and charged; standing orders stop checking); "active" resumes them, with standing orders due immediately. Resuming counts against the active-watch plan limit, and a bound monitored area is resumed under the same rules as creating one (the monitored-area limit; no second active area measuring the same thing) — a refused resume changes nothing. status "closed" ends the question: it requires close_reason, stops notifications and bound resources, and frees an active slot while keeping the record.

patch/api/v1/watches/{watchId}

Request

  • Base URL: https://offnadir-delta.com
  • URL: https://offnadir-delta.com/api/v1/watches/{watchId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

watchIdstring required

The watch id.

Request body

status'active' | 'paused' | 'saved' | 'closed'

"active", "paused", "saved" or "closed". Closing requires close_reason.

close_reason'resolved' | 'lapsed' | 'false_alarm'

Required when status is "closed": "resolved" (an answer was reached), "lapsed" (interest moved on without an answer) or "false_alarm" (never a watchable event). They point at different things to fix, so they are not collapsed into one.

notify_emailboolean

Email on meaningful changes.

notify_chatboolean

Also deliver this watch’s notifications to your connected channel — Slack, Discord or a signed webhook (default false). The channel is connected once (Slack and Discord in account settings; a webhook there or with POST /api/v1/notification-channel/webhook); while none is connected the setting is kept and nothing is sent. See GET /api/v1/notification-channel.

imagery_alertsboolean

Area watches only: notify when a NEW scene covering this area is published (Sentinel-2 optical and Sentinel-1 SAR). Default false. It reports that a look is now possible — never what is in the scene. Free on every plan: no tokens, no LLM.

Response

The updated watch.

watchobject

Changes

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