API

Create a schedule item

post
https://api.safetyculture.io/schedules/v1/schedule_items
📘

New Schedules endpoints are now available

Schedules legacy endpoints will continue to be supported. Any deprecation will be communicated with a minimum 6-month notice. See Schedules to get started.

Body Params

The schedule item to be created. The schedule will be created in the timezone of the authenticated user's profile timezone.

The parameters for creating or updating a schedule item

string

Description of the schedule item

string
enum
Defaults to MUST_COMPLETE_UNSPECIFIED
  • MUST_COMPLETE_UNSPECIFIED: Unspecified must complete value
  • ONE: Schedule must be completed by one assignee
  • ALL: Schedule must be completed by all assignees
Allowed:
boolean

Can the inspections be started after the due date

string

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

start_time
object

StartTime represents the start time of a schedule item

string

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

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.

date-time

When this schedule will begin appearing

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

Document represents the document in a schedule

string

The location assigned to this schedule item

string

The asset assigned to this schedule item

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago