series

Add times to a class's calendar, or a calendar appointment's: a date, a start and end (or all day, or overnight), how it repeats and who teaches. Its sessions are made about a year ahead.

post/series

Request

  • Base URL: https://daybag.io/api/v1
  • URL: https://daybag.io/api/v1/series
  • Auth: HTTP bearer

Request body

starts_onstring date required

The first time's local date (YYYY-MM-DD) in the org's time zone

start_timestring nullable

Local start, HH:MM. Leave start_time and end_time out for all day

end_timestring nullable

Local end, HH:MM; before the start with span_days 1 runs overnight

span_daysinteger

Days from a time's date to the date it ends (default 0): 1 runs overnight; all day, the extra whole days

repeat'none' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'weekdays'

How it repeats (default none)

capacityinteger nullable

Classes only: seats for these times; null uses the class's

teacherstring uuid nullable

Who teaches it: a member's user id (Settings → Team); null for nobody. Anyone not on your team answers 400 not_a_member. Copied to each of its times; a change reaches every time to come

ends_onstring date nullable

Local calendar date (YYYY-MM-DD) in the org's time zone

offering_idstring uuid required

Response

Success

idstring required
org_idstring required
offering_idstring required
starts_onstring required

The first time's local date

start_timestring nullable required

Local HH:MM:SS; null with end_time null is all day

end_timestring nullable required
span_daysinteger required

Days from a time's date to the date it ends

repeat'none' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'weekdays' required

none · daily · weekly (its first date's weekday) · monthly (that weekday of the month, e.g. the last Tuesday) · yearly · weekdays (Monday to Friday)

capacityinteger nullable required

A class's seats for these times; null uses the class's

ends_onstring nullable

A repeat's last local date, that day included; null repeats on

made_untilstring required

Its sessions exist through this local date; repeats are kept about a year ahead

created_atstring required

ISO 8601 timestamp (UTC)

Changes

No recorded changes to this operation across all 1 revision of this API.