Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
Maximum string length: 120
starts_at
string
required

A date, YYYY-MM-DD, for an all-day event, or a timestamp for a timed one.

summary
string | null

A line or two about it.

Maximum string length: 300
description
string | null
Maximum string length: 8000
kind
enum<string> | null

The same kinds Shifts uses. events is shown as Event.

Available options:
adoption,
fundraiser,
clinic,
transport,
training,
meeting,
events,
other
ends_at
string | null

A date or a timestamp, like starts_at. Refused if it is before a starts_at sent with it.

all_day
boolean
default:false

Whether it is an all-day event. Send bare dates in starts_at and ends_at for one.

location_unit_id
string | null

One of your own locations, when it is held at one.

venue_organization_id
string | null

One of your organizations, when it is held at one. Its name and address are copied into venue_name and venue_address. Clearing it leaves those as they are.

venue_name
string | null
Maximum string length: 200
venue_address
string | null

The address, on one line.

Maximum string length: 500
status
enum<string>
default:scheduled
Available options:
draft,
scheduled,
cancelled,
completed
is_public
boolean
default:true

Public unless you send false.

registration_url
string | null

Where people sign up, an http or https address. An address with no scheme is given https://.

form_slug
string | null

The address of one of your own published forms, for people to sign up with. Lowercase letters, digits and hyphens. Whether the form exists is not checked.

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,58}[a-z0-9])?$
shift_schedule_id
string | null

The Shifts schedule that covers it. Adding volunteer coverage sets this for you.

recurrence
object

How the event repeats. The occurrences are worked out once, when the series is created, up to 100 of them. With neither until nor count nor never_ends, the series runs a year ahead and stops there.

Response

The event, or the first of the series.

event
object
series_count
integer

How many events were created: 1 without a recurrence.