PUT
/
tenants
/
{env_id}
/
schedule

Authorizations

x-api-key
string
headerrequired

Path Parameters

env_id
string
required

ID of environment

Query Parameters

mode
enum<string>

By default, the toggle endpoint only applies to tenants who already have (or had) schedules. Passing ?mode=upsert will apply schedules to tenants whether or not they currently have schedules

Available options:
upsert

Body

application/json
toggle
enum<string>

Used to toggle all schedules in this environment

Available options:
enable,
disable
flows
string[]

List of flow ids to apply this operation for

tenants
string[]

List of tenants to apply this operation for

expression
string

Can be "default" to use the admin schedule or a cron expression. Will be applied for all tenants

Response

200 - application/json
toggle
string
updated
integer
default: 0
Retrieve tenantsDelete Snapshot