tasks

Schedule a task for an entity.

Pre-checks run against the warehouse config and target entity properties before the task is enqueued. A failure surfaces as 400 with a specific error code (see the operator guide for the full set of pre-check codes).

When a task is already active for the same (warehouse, entity, queue) triple, the call returns 409 TaskAlreadyActive with the existing task-id in the body — chain to POST /task/control with run-now or run-at to retime it without an extra task/list round-trip.

post/management/v1/warehouse/{warehouse_id}/task-queue/expire_snapshots/schedule

Request

Path parameters

warehouse_idstring uuid required

Request body

scheduled-forstring date-time nullable

When the task should run. Omit (or pass null) to run on the next worker poll. RFC 3339 / ISO 8601 format. Must be within roughly one year of now; further-out values return 400 ScheduledForTooFarInFuture.

Example request

{
  "scheduled-for": "2026-12-31T23:59:59Z"
}

Response

Task scheduled

task-idstring uuid required

The id of the newly scheduled task.

Changes

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