Skip to main content
POST
Create a schedule

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
name
string
required
starts_at
string
required

For an all-day schedule, a date (YYYY-MM-DD). Otherwise a date and time (2026-10-03T09:00:00Z).

description
string | null
location_unit_id
string | null

One of your locations.

ends_at
string | null

The same shape as starts_at, and not before it. For an all-day schedule, the last day it runs.

status
enum<string>
default:scheduled

A draft schedule is not shown on the calendar.

Available options:
draft,
scheduled,
active,
completed,
cancelled
event_kind
enum<string> | null

What kind of occasion it is. Null means not said.

Available options:
adoption,
fundraiser,
clinic,
transport,
training,
meeting,
events,
other,
null
all_day
boolean
default:false

Whether the schedule runs whole days rather than set hours.

signup_form_config
object

An object kept with the schedule and returned as sent.

metadata
object

An object kept with the schedule and returned as sent.

custom_fields
object

Your own schedule fields, by key. See Shift custom fields.

Response

The schedule, as it was created.

name
string
required
starts_at
string
required

For an all-day schedule, a date (YYYY-MM-DD). Otherwise a date and time (2026-10-03T09:00:00Z).

status
enum<string>
required

A draft schedule is not shown on the calendar.

Available options:
draft,
scheduled,
active,
completed,
cancelled
all_day
boolean
required

Whether the schedule runs whole days rather than set hours.

id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
location_unit_id
string | null

One of your locations.

ends_at
string | null

The same shape as starts_at, and not before it. For an all-day schedule, the last day it runs.

event_kind
enum<string> | null

What kind of occasion it is. Null means not said.

Available options:
adoption,
fundraiser,
clinic,
transport,
training,
meeting,
events,
other,
null
signup_form_config
object

An object kept with the schedule and returned as sent.

metadata
object

An object kept with the schedule and returned as sent.

custom_fields
object

Your own schedule fields, by key. See Shift custom fields.

tenant_id
string

Your organization's ID.