Slots

Update a time slot

Partial update — supplied fields only. Use null to clear nullable fields. The slot must belong to the signup in the path (a slot of another signup is 404 not_found, and nothing is written). customField is the slot's own question (null removes it, so a date of a repeating schedule asks the schedule's question again). maxParticipants below the number of spots already taken is refused with 400. A date of a repeating schedule (its seriesId is set) cannot have its startTime edited onto another day of the signup's timezone: that is 409 conflict and nothing is written — move it with POST /signups/{id}/slots/{slotId}/move instead. A time edit that keeps the start on the same local day (including any endTime change) is allowed, as is any edit of a slot that is not part of a schedule.

patch/signups/{id}/slots/{slotId}

Request

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

Path parameters

idstring uuid required
slotIdstring uuid required

Request body

startTimestring date-time
endTimestring date-time
maxParticipantsinteger
maxPerPersoninteger
titlestring nullable
descriptionstring nullable
locationstring nullable

Response

Updated time slot

idstring uuid required
eventIdstring uuid required
startTimestring date-time required
endTimestring date-time required
maxParticipantsinteger required
maxPerPersoninteger required

The most spots one person may take on this slot. 1 (the default) is one spot per person; 0 is no per-person limit.

titlestring nullable required
descriptionstring nullable required
locationstring nullable required
questionSource'own' | 'series' | 'null' nullable required

"own" when question is the slot's own; "series" when inherited from its repeating shift; null when nothing is asked.

createdAtstring date-time required

Changes

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