Skip to main content
Deactivate a monitor (idempotent; sets is_active=false)
Audience: signed-in organization administrator.

Deactivation

This operation sets isActive=false and is idempotent. It does not erase the monitor record or assert that previously emitted events were recalled. Keep the returned monitor state as the audit record of the requested change.

Canonical metadata

  • requestId
  • traceparent

Example request

This organization control-plane action requires a signed-in WorkOS browser session. Do not give an API key or an autonomous agent authority to create, change, test, replay, rotate, or delete it.

Example response

Give this prompt to your agent

Failure posture

  • treat non-2xx responses as contract-aware failures, not free-form errors
  • preserve requestId and traceparent in logs and downstream reports
  • if provenance or freshness metadata is present, return it unchanged so trust is not lost in the handoff