Respond to a swap request

POST

/v1/rotations/{rotationId}/swap-requests/{requestId}/{responseAction}

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/swap-requests/example/example"),
    Headers =
    {
        { "If-Match", "example" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"operationId\": \"example\", \"expectedRevision\": 1, \"acknowledgedConflictIds\": [ \"example\" ], \"acknowledgedStartedLegKeys\": [ \"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/swap-requests/example/example"

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

  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, \"acknowledgedConflictIds\": [ \"example\" ], \"acknowledgedStartedLegKeys\": [ \"example\" ] }");
Request request = new Request.Builder()
  .url("https://api.roundrobinbot.eu/v1/rotations/example/swap-requests/example/example")
  .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/swap-requests/example/example',
  headers: {
    'If-Match': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json-patch+json'
  },
  data: '{ "operationId": "example", "expectedRevision": 1, "acknowledgedConflictIds": [ "example" ], "acknowledgedStartedLegKeys": [ "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/swap-requests/example/example';
const options = {
  method: 'POST',
  headers: {
    'If-Match': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json-patch+json'
  },
  body: '{ "operationId": "example", "expectedRevision": 1, "acknowledgedConflictIds": [ "example" ], "acknowledgedStartedLegKeys": [ "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/swap-requests/example/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'If-Match: example' \
  --data '{ "operationId": "example", "expectedRevision": 1, "acknowledgedConflictIds": [ "example" ], "acknowledgedStartedLegKeys": [ "example" ] }'

Requires a Slack member access token, the current expectedRevision and If-Match. Use an action offered by the request capability. Actions are accept, decline and cancel. Acceptance exchanges both remaining duty intervals together. Cancelling accepted duty preserves completed service. Reuse operationId and the same body when retrying an uncertain result. A missing If-Match returns 428. On 412, refresh the preview before retrying.

Authorizations

Participant

Parameters

Path Parameters

rotationId

required

string

requestId

required

string

responseAction

required

string

/^(accept|decline|cancel)$/

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

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

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

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

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

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

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

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

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

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

Responses

200

application/json

The saved result. deliveryState reports publication progress, not confirmed Slack receipt.

object

operationId

required

string

rotationVersion

required

integer | string format: int64

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

effectiveFrom

required

string format: date-time

request

required

A swap request, its rotation name and the actions available to this caller.

object

request

required

The participants, offered intervals and current state of a swap request.

object

required

string

rotationId

required

string

requesterUserId

required

string

recipientUserId

required

string

legs

required

Array<object>

An offered duty interval and its accepted assignment identifier, when present.

object

key

required

string

rotationId

required

string

cellId

required

string

holderUserId

required

string

from

required

string format: date-time

required

string format: date-time

arrangementId

required

null | string

reason

required

string

revision

required

integer | string format: int64

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

state

required

string

capability

required

Actions available to this caller. Each action rechecks permissions and duty.

object

canAccept

required

boolean

canDecline

required

boolean

canCancel

required

boolean

reason

required

null | string

rotationName

required

string

arrangements

required

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

string

Example^generated

{
  "operationId": "example",
  "rotationVersion": 1,
  "effectiveFrom": "2026-04-15T12:00:00Z",
  "request": {
    "request": {
      "id": "example",
      "rotationId": "example",
      "requesterUserId": "example",
      "recipientUserId": "example",
      "legs": [
        {
          "key": "example",
          "rotationId": "example",
          "cellId": "example",
          "holderUserId": "example",
          "from": "2026-04-15T12:00:00Z",
          "to": "2026-04-15T12:00:00Z",
          "arrangementId": "example"
        }
      ],
      "reason": "example",
      "revision": 1,
      "state": "example"
    },
    "capability": {
      "canAccept": true,
      "canDecline": true,
      "canCancel": true,
      "reason": "example"
    },
    "rotationName": "example"
  },
  "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"
}

Respond to a swap request

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