VEverbiflow
plays

Upsert Workflow Play Schedule

post/api/plays/{play_id}/schedules

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/plays/{play_id}/schedules
  • 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

Request body

expected_revision_idstring nullable

Optional ready code revision compare-and-set guard for schedule definition and authority changes.

expected_updated_atstring date-time nullable

Exact updated_at timestamp from plays.schedules.get. The server rejects a stale edit instead of overwriting another operator's changes.

metadataobject

Caller-owned schedule metadata plus server-authored provenance fields.

next_run_atstring date-time nullable

Optional first due time for interval or once schedules as an ISO timestamp with timezone offset. Calendar schedules derive it and use schedule_spec.starts_at as the optional lower bound.

run_templateobject

Revision-defined occurrence input. Keys and values must match the active Play input schema; thread_id is reserved because every tick gets a fresh execution context.

schedule_slugstring nullable

Stable human-readable schedule key for idempotent upsert, for example daily-review. Keep it stable when editing the same schedule.

status'enabled' | 'disabled'

Initial schedule status. Direct HTTP requests default to enabled; the Python SDK sends disabled by default to allow review before activation.

Response

Successful Response

Changes

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