Update a schedule item

put

https://api.safetyculture.io/schedules/v1/schedule_items/{id}

Path Params

string

required

The id of the schedule item to update

Body Params

The new schedule item

description

string

Description of the schedule item

must_complete

string

enum

Defaults to MUST_COMPLETE_UNSPECIFIED

Whom must complete a given schedule, either one assignee or all assignees

Allowed:

can_late_submit

boolean

Can the inspections be started after the due date

recurrence

string

RRule formatted recurrence string.
Example: FREQ=WEEKLY;BYDAY=MO;INTERVAL=1 represents weekly on Monday.

start_time

object

The time the schedule item starts on each occurrence e.g. 9:10AM

duration

string

ISO8601 duration string, e.g. PT1H. How long inspection can be started after the start_date.

timezone

string

@deprecated, this field is not being used to dictate the timezone of the schedule item. The timezone of the schedule item is based on the authenticated user's profile timezone.

from_date

date-time

When this schedule will begin appearing

to_date

date-time

When the schedule will end

reminders

array of objects

Reminders that will be sent to assignees

reminders

assignees

array of objects

The users or groups that are assigned to complete the schedule

assignees

document

object

The document that is assigned to this schedule items

location_id

string

The location assigned to this schedule item

asset_id

string

The asset assigned to this schedule item

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.