Slots

Edit one Shift of a repeating schedule, and its place or Question

Edit the Series' plan for one Shift: shiftIndex (and weekday on a weekly rule) names it, start / end (HH:MM in the signup's timezone) are required even when unchanged, and label, capacity, location and question are optional (label: "" clears the name; question: null clears the Series Question). scope: "all" changes every Occurrence of the Shift; scope: "following" with a fromDate (YYYY-MM-DD) changes only Occurrences on or after it and leaves earlier ones as they were. Detached Occurrences keep their own edits. location is the Series' default place and does not obey scope. Lowering capacity below seats already taken is 400 bad_request and nothing is written. Participants whose time or place changes are notified; message is an optional note added to that email, and notified reports who was told. The account behind the credential must have a verified email, or the call is 403 forbidden. Moving the default place is behind a pre-GA rollout for the person an OAuth token acts as (403 forbidden when they are outside it); an API key is not checked.

patch/signups/{id}/slot_series/{seriesId}

Request

  • Base URL: https://thesignup.app/api/v1
  • URL: https://thesignup.app/api/v1/signups/{id}/slot_series/{seriesId}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
seriesIdstring uuid required

Request body

shiftIndexinteger required
startstring required
endstring required
labelstring
capacityinteger
locationstring nullable
scope'all' | 'following' required
fromDatestring nullable
messagestring nullable

Response

What the edit changed

updatedinteger required

Occurrences the edit changed.

earlierUnchangedinteger required

With scope: "following", the Occurrences before fromDate that were left as they were.

skippedExceptionsinteger required

Detached Occurrences, which keep their own edits and are not touched by a Series edit.

Changes

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