For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Change when a series ends

Moves a series' end date in either direction. Use this to extend a series that is about to run out, to finish one early, or to remove the end date entirely.

Endpoint

POST /api/shift-series/{series_id}/reschedule-end/

Send exactly one intent

What you send
What happens

end_date (or ends_at) later than the current end

The series extends, and Vome generates the newly opened window straight away. Silent: nobody is notified about more shifts.

end_date (or ends_at) earlier

The series is brought in. Shifts past the new end are cancelled when cancel_future_shifts is true.

make_open_ended: true

The end date is removed and the series runs indefinitely.

Field
Default
Notes

cancel_future_shifts

true

Only applies when bringing a series in.

notify_users

false

Only applies when bringing a series in.

message

A note for that notification.

Notifications only apply when shortening because that is the only direction where people lose shifts they were booked onto. Extending gives people more, so it says nothing.

Payload samples

Extend to the end of next year:

{ "end_date": "2027-12-31" }

Remove the end date:

{ "make_open_ended": true }

Finish early and tell everyone affected:

Response sample

direction is grow, shrink or noop, worked out from the dates rather than from what you asked for, so you can confirm the effect. A large extension is queued and returns "queued": true.

Reopening an ended series

Extending works on a series that has already ended. It goes back to active and starts generating again, which is the way to undo an end that was a mistake.