API

Create a schedule

post
https://api.safetyculture.io/scheduling/v1/schedules

Creates a new schedule that generates recurring work items.

Body Params

CreateNewSchedule creates a schedule that generates recurring work items (e.g., inspections).

Schedules can target:

  • Specific users (no target, just assignment.users)
  • Sites (target.sites) - creates sub-schedules per site
  • Assets (target.assets) - creates sub-schedules per asset

For site/asset targets, sub-schedules are created asynchronously.

string
required

Title of the schedule.

work_type

The type of work to be done as part of the schedule. Exactly one must be set.

recurrence
object
required

ScheduleRecurrence defines when and how often the schedule repeats.

RFC 5545 recurrence definition combining DTSTART and RRULE properties. DTSTART specifies the start time and timezone. RRULE defines the recurrence pattern. Timezone defaults to UTC if unspecified, or if use_site_timezone is true.

Expected format: "DTSTART;TZID=America/New_York:20240101T140000\nRRULE:FREQ=DAILY;INTERVAL=1"

string
enum
Defaults to COMPLETION_RULE_UNSPECIFIED

Completion rule enum.

  • COMPLETION_RULE_UNSPECIFIED: Unspecified completion rule.
  • COMPLETION_RULE_ANY: Any assignee can complete the schedule.
  • COMPLETION_RULE_ALL: All assignees must complete the schedule.
Allowed:
target

Specifies which sites or assets this schedule applies to. Exactly one must be set.

assignment
required

Specifies which users are assigned to complete the scheduled work. Exactly one rule must be set.

Responses

Updated 19 days 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 19 days ago