End a duty arrangement

POST

/v1/rotations/{rotationId}/duty-arrangements/{arrangementId}/end

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/duty-arrangements/example/end"),
    Headers =
    {
        { "If-Match", "example" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"operationId\": \"example\", \"expectedRevision\": 1 }")
    {
        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/duty-arrangements/example/end"

  payload := strings.NewReader("{ \"operationId\": \"example\", \"expectedRevision\": 1 }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("If-Match", "example")
  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, "{ \"operationId\": \"example\", \"expectedRevision\": 1 }");
Request request = new Request.Builder()
  .url("https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/example/end")
  .post(body)
  .addHeader("If-Match", "example")
  .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/duty-arrangements/example/end',
  headers: {
    'If-Match': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json-patch+json'
  },
  data: '{ "operationId": "example", "expectedRevision": 1 }'
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/example/end';
const options = {
  method: 'POST',
  headers: {
    'If-Match': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json-patch+json'
  },
  body: '{ "operationId": "example", "expectedRevision": 1 }'
};

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/duty-arrangements/example/end \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'If-Match: example' \
  --data '{ "operationId": "example", "expectedRevision": 1 }'

Requires write:duty, rotation edit authority, If-Match and the current arrangement revision. Ends only the unserved portion of a direct assignment. Completed service stays unchanged. Accepted cover and swap legs return 409 with repairNotSupported; an elapsed interval returns 409 with arrangementEnded. Read the current arrangement before retrying a stale revision or rotation ETag. Reuse the operation ID only for an identical retry. Success returns 200 and the rotation ETag. The resulting duty is determined by the underlying schedule and availability.

Authorizations

ApiKey

Parameters

Path Parameters

rotationId

required

string

The rotation identifier.

arrangementId

required

string

The active direct assignment to end.

Header Parameters

If-Match

required

string

The ETag from your last read of this resource, sent back exactly as you received it, quotes included. The write happens only if nothing changed in between: a stale validator is answered 412 and nothing is written. Send * to write against whatever is current on purpose. Omitting the header is 428, never an unconditional write. https://docs.roundrobinbot.eu/api/conventions/#conditional-writes

Request Body^required

Request cancellation.

End the unserved portion of a direct assignment.

object

operationId

A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.

string

expectedRevision

The current revision of the arrangement being ended.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1
}

End the unserved portion of a direct assignment.

object

operationId

A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.

string

expectedRevision

The current revision of the arrangement being ended.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1
}

End the unserved portion of a direct assignment.

object

operationId

A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.

string

expectedRevision

The current revision of the arrangement being ended.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1
}

End the unserved portion of a direct assignment.

object

operationId

A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.

string

expectedRevision

The current revision of the arrangement being ended.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1
}

Responses

200

application/json

The committed assignment result for an operation.

object

operationId

required

The submitted operation identifier.

string

rotationVersion

required

The committed rotation version, also returned as an ETag.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

effectiveFrom

required

The actual prospective transition start.

string format: date-time

arrangements

required

The arrangements changed by the operation, including cancelled records and any replacement.

Array<object>

An interval assignment. Its recorded terms remain distinct from actual served history.

object

required

The arrangement identifier.

string

rotationId

required

The rotation identifier.

string

cellId

required

The rotation cell identifier.

string

userId

required

The assigned person’s Slack user identifier.

string

from

required

The inclusive UTC start.

string format: date-time

required

The exclusive UTC end.

string format: date-time

revision

required

The arrangement revision used when changing or ending it.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

state

required

active or cancelled. An active record can describe an interval that has already ended.

string

kind

required

directAssignment, acceptedCover or swapLeg. Direct-assignment writes change or end only directAssignment.

string

origin

One of:

null
object

null

originalSnapshot

One of:

null
object

null

Original duty segments on detail reads. Null on list reads or when no original record is available.

object

asOfUtc

required

The UTC time when the original duty was evaluated.

string format: date-time

from

required

The inclusive UTC start of the returned interval.

string format: date-time

required

The exclusive UTC end of the returned interval.

string format: date-time

complete

required

Whether every returned segment is resolved. An extension beyond the original recorded interval is unresolved.

boolean

segments

required

Original holders by interval, including periods with no assignee and unresolved periods.

Array<object>

Effective duty during part of an assignment interval.

object

from

required

The inclusive UTC start.

string format: date-time

required

The exclusive UTC end.

string format: date-time

userIds

required

Slack user identifiers of the effective holders. An empty list means no assignee only when resolved is true.

Array<string>

resolved

required

Whether the holders or absence of duty are known for this interval.

boolean

turnSelection

One of:

null
object

null

The recorded full or remaining turn, or null when no verified selection was saved. Use the arrangement’s From and To for the affected interval.

object

kind

required

fullTurn or remainingTurn.

string

from

required

The inclusive UTC start of the original turn, including any part already served.

string format: date-time

required

The exclusive UTC end of the original turn.

string format: date-time

deliveryState

required

pending or published for change-event publication. Neither value confirms that a Slack message has arrived.

string

Example^generated

{
  "operationId": "example",
  "rotationVersion": 1,
  "effectiveFrom": "2026-04-15T12:00:00Z",
  "arrangements": [
    {
      "id": "example",
      "rotationId": "example",
      "cellId": "example",
      "userId": "example",
      "from": "2026-04-15T12:00:00Z",
      "to": "2026-04-15T12:00:00Z",
      "revision": 1,
      "state": "example",
      "kind": "example",
      "origin": {
        "userIds": [
          "example"
        ],
        "complete": true
      },
      "originalSnapshot": {
        "asOfUtc": "2026-04-15T12:00:00Z",
        "from": "2026-04-15T12:00:00Z",
        "to": "2026-04-15T12:00:00Z",
        "complete": true,
        "segments": [
          {
            "from": "2026-04-15T12:00:00Z",
            "to": "2026-04-15T12:00:00Z",
            "userIds": [
              "example"
            ],
            "resolved": true
          }
        ]
      },
      "turnSelection": {
        "kind": "example",
        "from": "2026-04-15T12:00:00Z",
        "to": "2026-04-15T12:00:00Z"
      }
    }
  ],
  "deliveryState": "example"
}

End a duty arrangement

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated