Preview a freeze
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.roundrobinbot.eu/v1/rotations/example/freeze/preview"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"startsUtc\": \"2026-04-15T12:00:00Z\", \"endsUtc\": \"2026-04-15T12:00:00Z\", \"mode\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json-patch+json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.roundrobinbot.eu/v1/rotations/example/freeze/preview"
payload := strings.NewReader("{ \"startsUtc\": \"2026-04-15T12:00:00Z\", \"endsUtc\": \"2026-04-15T12:00:00Z\", \"mode\": \"example\" }")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>") req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json-patch+json");RequestBody body = RequestBody.create(mediaType, "{ \"startsUtc\": \"2026-04-15T12:00:00Z\", \"endsUtc\": \"2026-04-15T12:00:00Z\", \"mode\": \"example\" }");Request request = new Request.Builder() .url("https://api.roundrobinbot.eu/v1/rotations/example/freeze/preview") .post(body) .addHeader("Authorization", "Bearer <token>") .addHeader("Content-Type", "application/json-patch+json") .build();
Response response = client.newCall(request).execute();import axios from 'axios';
const options = { method: 'POST', url: 'https://api.roundrobinbot.eu/v1/rotations/example/freeze/preview', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'}, data: '{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example" }'};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}const url = 'https://api.roundrobinbot.eu/v1/rotations/example/freeze/preview';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'}, body: '{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example" }'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.roundrobinbot.eu/v1/rotations/example/freeze/preview \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json-patch+json' \ --data '{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example" }'Answers what the freeze would do without setting it: the handovers of the unchanged cadence it would drop, and for each lane and window who is on duty now, when the next regular handover comes and who takes it. Takes the same body as the freeze itself and is refused for the same reasons.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Body
Section titled “Request Body”Sets or changes a rotation’s freeze.
object
When the freeze starts. Now when left out; unchanged while a freeze is running.
When the freeze ends. After the start, in the future, and at most 365 days after the start.
keepOnDuty or nobodyOnDuty.
Example generated
{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example"}Sets or changes a rotation’s freeze.
object
When the freeze starts. Now when left out; unchanged while a freeze is running.
When the freeze ends. After the start, in the future, and at most 365 days after the start.
keepOnDuty or nobodyOnDuty.
Example generated
{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example"}Sets or changes a rotation’s freeze.
object
When the freeze starts. Now when left out; unchanged while a freeze is running.
When the freeze ends. After the start, in the future, and at most 365 days after the start.
keepOnDuty or nobodyOnDuty.
Example generated
{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example"}Sets or changes a rotation’s freeze.
object
When the freeze starts. Now when left out; unchanged while a freeze is running.
When the freeze ends. After the start, in the future, and at most 365 days after the start.
keepOnDuty or nobodyOnDuty.
Example generated
{ "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example"}Responses
Section titled “Responses”OK
What a freeze would do, without setting it.
object
A rotation’s freeze: from its start to its end every handover of the rotation is dropped, and the first handover after the end is the next one the unchanged cadence already had.
object
When the freeze starts.
When the freeze ends.
keepOnDuty (holders stay on duty) or nobodyOnDuty (nobody is on duty until the end).
The handovers of the unchanged cadence that fall inside the freeze and are dropped, in order.
One lane in one window that a freeze touches.
object
The lane in a window this entry is about. Name kept for the grid cell it identifies.
The lane’s name, absent on a rotation with one lane.
Who is on duty there now; absent when nobody is.
This lane’s next regular handover once the freeze is over; absent where nothing fires on its window.
Who is on duty from that first regular handover; absent when the plan has no name for it yet (a randomised plan).
The handovers of this window that the freeze drops.
In nobodyOnDuty mode, when nobody is on duty here from. Absent in keepOnDuty mode.
In nobodyOnDuty mode, when the person on duty before is back on duty. Absent in keepOnDuty mode.
In nobodyOnDuty mode, who is back on duty at the end: the person on duty now.
Example generated
{ "freeze": { "startsUtc": "2026-04-15T12:00:00Z", "endsUtc": "2026-04-15T12:00:00Z", "mode": "example", "droppedHandoversUtc": [ "2026-04-15T12:00:00Z" ] }, "seats": [ { "cellId": "example", "laneName": "example", "windowId": "example", "userId": "example", "nextHandoverUtc": "2026-04-15T12:00:00Z", "nextHolderUserId": "example", "droppedHandoversUtc": [ "2026-04-15T12:00:00Z" ], "nobodyOnDutyFromUtc": "2026-04-15T12:00:00Z", "nobodyOnDutyUntilUtc": "2026-04-15T12:00:00Z", "returnsUserId": "example" } ]}Bad Request
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}