dashboards

Deactivate — clear this schedule's activation pin and driver (DVT-4794, ADR-0069 Amendment 5).

A ROW WRITE, not Snowflake DDL: clears the activation pin (revision, page, recipients, cadence, activatedBy/activatedAt) and the driver back to unset. No engine call, no caller token. IF EXISTS-equivalent: deactivating a schedule that was never activated is not an error.

Requires dashboard:write (narrowing — turning automatic sending off is not the widening act Activate is; NO schedule:activate capability needed). Same 404-feature-disabled gate as the rest of this group. No request body.

A LEGACY per-report task retired by this call is not touched in Snowflake: the response's retiredTaskName names the deterministic task an admin can now DROP TASK.

post/v1/dashboards/{id}/email-schedules/{sid}/deactivate

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/dashboards/{id}/email-schedules/{sid}/deactivate
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Response

Deactivated. The updated schedule, plus retiredTaskName when a legacy task was just retired.

Changes

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