Skip to main content
PATCH
Change a schedule of an Automation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

automation_id
string<uuid>
required
Example:

"4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a"

schedule_id
string<uuid>
required
Example:

"4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a"

Body

application/json
status
enum<string>

Whether the schedule runs:

  • enabled: The next run is queued; see next_run_at.
  • disabled: Nothing is queued until the schedule is enabled again. Enabling it queues the next run in the future; runs missed while disabled are not caught up.
Available options:
enabled,
disabled
Example:

"enabled"

recurrence
object

When the schedule runs. Holds only the fields its type uses; a field the stored schedule has no value for is absent. When sent, a field that belongs to another type is rejected with 422.

Example:
inputs
object

The inputs each run of the schedule kicks the Automation off with.

Example:

Response

OK

data
object
required