Sign in
WAREHOUSE_SCHEDULE

Update Series

Edit a recurring series' template ("this and following events").

from_schedule_id scopes the edit: that occurrence and every later one change, everything before it is left as it is. Omitting it scopes the edit from the current instant instead.

Time/config-only edits update the in-scope approved occurrences in place on their own dates. Sending days_of_week and/or end_date reschedules the series: the in-scope approved occurrences are replaced with a set materialized from the new cadence (user-deleted occurrences stay deleted). timezone is immutable. Occurrences whose window conflicts are skipped and reported in skipped.

patch/warehouse/schedules/series/{series_id}

Path parameters

series_idinteger required

Headers

x-tenantstring required

Request body

schedule_type'manual' | 'block' required

One of: manual, block

start_time_localstring required

Local wall-clock "HH:MM"

duration_minutesinteger required
days_of_weekstring[] nullable

New weekday cadence; omit to keep the current days.

end_datestring date nullable

New end date (at most 90 days from today); omit to keep the current end date.

from_schedule_idinteger nullable

The occurrence the edit was launched from. The edit applies to it and every later occurrence; earlier ones keep the schedule they already have. Omit to apply from now.

Response

Successful Response

series_idinteger required
warehouse_namestring required
instance_idstring nullable
schedule_type'manual' | 'block' required
days_of_weekstring[] required
start_time_localstring required
duration_minutesinteger required
timezonestring required
end_datestring date nullable
status'active' | 'cancelled' required

Lifecycle of a recurring warehouse-schedule series.

A series that would materialize zero occurrences is never persisted (creation fails with 400), so there is no rejected state here.

created_byinteger required
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

Changed in 2 of the 28 revisions of this API.126

  • 6aa0788aa5dc4See the full diff
    • ○

      added the new optional request property days_of_week

      new-optional-request-property

    • ○

      added the new optional request property end_date

      new-optional-request-property

    • ○

      added the new optional request property from_schedule_id

      new-optional-request-property

    • ○

      added the optional property updated/items/series_timezone to the response with the 200 status

      response-optional-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 103580dad816122See the full diff
    • ▲

      removed the required property created from the response with the 200 status

      response-required-property-removed

    • ●

      added the new active enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cancelled enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property skipped/items/conflict to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property updated to the response with the 200 status

      response-required-property-added