Platitun · API · The deal · Set the work mode

Set the work mode

PUT /api/v1/work-mode

Key scope: orders · changes data, the Idempotency-Key header is required

Capacity, do-not-disturb and quiet hours can be set by a program. Hours are in UTC, like all time on the marketplace; converting them to the server’s local time is forbidden.

Quiet hours are set both or neither: a single hour would mean an interval with no end — you could not leave it, and the silence would be forever.

Request fields

FieldTypeWhat it is
capacity requiredintegerHow many orders to take at once, from 1 to 50.
doNotDisturbbooleanA request not to be called.
quietFromHourintegerQuiet hours start, UTC, 0–23.
quietToHourintegerQuiet hours end, UTC, 0–23.

Response fields

FieldTypeWhat it is
capacityintegerWhat it became.

Refusal reasons

A rule refusal arrives as {"error":"rejected","refusal":{"kind":"…"}} with status 409. Refusals common to all endpoints are in the rules section.

CodeWhat happened and what to do
capacity_badThe capacity is outside the allowed range.
quiet_hours_badQuiet hours are set both or neither, and they must differ: a single hour would mean an interval with no end.

Nearby in this section