VEverbiflow
plays

Set Workflow Play Schedule Status

patch/api/plays/{play_id}/schedules/{schedule_id}/status

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/plays/{play_id}/schedules/{schedule_id}/status
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Path parameters

play_idstring required
schedule_idstring required

Request body

acknowledge_transient_failureboolean

Required true only when resuming a transient-threshold auto-pause.

expected_active_revision_idstring nullable

Current active revision id, or null when none is active.

expected_authority_grant_versioninteger required

Current authority grant version.

expected_health_changed_atstring date-time nullable required

Current health changed_at value, or null when unset.

expected_health_status'healthy' | 'needs_reauthorization' | 'needs_sync' | 'paused_authority' | 'paused_deterministic' | 'paused_transient' | 'paused_unknown_effect' required

Health state observed by the caller and required by the status compare-and-swap.

expected_status'enabled' | 'disabled' required

Current schedule status from plays.schedules.get.

idempotency_keystring required

Stable key reused only when retrying this exact status change.

status'enabled' | 'disabled' required

New schedule status: enabled resumes future claims; disabled stops future claims and skips queued ticks.

successful_manual_tick_idstring nullable

Exact completed manual-run tick required when the promoted revision is gated pending a successful live test.

Response

Successful Response

Changes

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