PUT /api/v1/schedules/:id
Update a schedule.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the schedule to be updated.

Validations:

  • Must be a String
schedule
optional , nil allowed

Validations:

  • Must be a Hash
schedule[name]
optional

Name of the template.

Validations:

  • Must be a String
schedule[start_at]
optional

The time to start the schedule.

Validations:

  • Must be a String
schedule[stop_at]
optional

The time to stop the schedule.

Validations:

  • Must be a String
schedule[active]
optional , nil allowed
true | false

Indicates whether the schedule is active and should be processed.

Validations:

  • Must be a String