Skip to content

Create a swap request

POST
/v1/rotations/{rotationId}/swap-requests
curl --request POST \
--url https://api.roundrobinbot.eu/v1/rotations/example/swap-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/*+json' \
--header 'If-Match: example' \
--data '{ "acknowledgedConflictIds": [ "example" ], "legs": [ { "cellId": "example", "from": "2026-04-15T12:00:00Z", "holderUserId": "example", "key": "example", "to": "2026-04-15T12:00:00Z" } ], "operationId": "example", "reason": "example", "recipientUserId": "example" }'

Requires a Slack member access token and If-Match from the latest preview. Creates a pending request. Duty remains unchanged until acceptance. Reuse operationId and the same body when retrying an uncertain result. A missing If-Match returns 428. On 412, refresh the preview before retrying.

rotationId
required
string
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

Two full future shifts to exchange with another Slack member in the same rotation.

object
acknowledgedConflictIds

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

Array<string>
legs

Exactly two full shifts: one held by the requester and one held by the recipient. Both must start after the current time.

Array<object>

One duty interval offered by a swap participant.

object
cellId

The cell identifier from the rotation plan.

string
from

The full shift’s inclusive start, with UTC offset zero. Must be after the current time when proposing a swap.

string format: date-time
holderUserId

The Slack user identifier of the person who holds this interval.

string
key

A nonempty identifier unique to this interval within the request.

string
to

The full shift’s exclusive end, with UTC offset zero. Must be no more than six months after the current time.

string format: date-time
operationId

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

string
reason

An optional explanation of at most 2000 characters. Use an empty string to omit it.

string
recipientUserId

The other participant’s Slack user identifier. Must differ from the requester.

string
Examplegenerated
{
"acknowledgedConflictIds": [
"example"
],
"legs": [
{
"cellId": "example",
"from": "2026-04-15T12:00:00Z",
"holderUserId": "example",
"key": "example",
"to": "2026-04-15T12:00:00Z"
}
],
"operationId": "example",
"reason": "example",
"recipientUserId": "example"
}

OK

Media typeapplication/json

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

object
arrangements
required
Array<object>

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

object
cellId
required

The rotation cell identifier.

string
changesAtUtc
required

The next instant at which phase changes, or null once it has ended.

null | string format: date-time
from
required

The inclusive UTC start.

string format: date-time
id
required

The arrangement identifier.

string
kind
required

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

string
origin
One of:
null
originalSnapshot
One of:
null
phase
required

upcoming, running or ended, from from and to at the time the response is built.

string
revision
required

The arrangement revision used when changing or ending it.

integer format: int64
rotationId
required

The rotation identifier.

string
state
required

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

string
to
required

The exclusive UTC end.

string format: date-time
turnSelection
One of:
null
userId
required

The assigned person’s Slack user identifier.

string
deliveryState
required
string
effectiveFrom
required
string format: date-time
operationId
required
string
request
required

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

object
actionable
required

True when the caller may accept, decline or cancel the request.

boolean
active
required

True while the request is pending or accepted.

boolean
asOfUtc
required

The instant the state, phase and capabilities were evaluated.

string format: date-time
capability
required

The actions available to the caller.

object
canAccept
required

Whether the caller may accept the request.

boolean
canCancel
required

Whether the caller may cancel the request.

boolean
canDecline
required

Whether the caller may decline the request.

boolean
reason
required

The reason the actions are unavailable. Absent when they are available.

null | string
reasonCode
required

The same word as reason, or null when the actions are available.

null | string
changesAtUtc
required

The earliest later instant at which the state, a phase, active or actionable changes by the clock alone. Null when none will.

null | string format: date-time
request
required

The request.

object
id
required

The request identifier.

string
legs
required

The offered intervals.

Array<object>

An offered duty interval and its accepted assignment identifier, when present. phase is upcoming, running or ended for this leg at the time the response is built.

object
arrangementId
required

The accepted assignment identifier. Absent until the request is accepted.

null | string
cellId
required

The cell identifier.

string
from
required

The inclusive interval start.

string format: date-time
holderUserId
required

The user who holds the interval.

string
key
required

The key of this leg within the request.

string
phase
required

upcoming, running or ended for this leg at the instant the response is built.

string
rotationId
required

The rotation identifier.

string
to
required

The exclusive interval end.

string format: date-time
phase
required

upcoming before the earliest leg starts, ended once the latest leg has ended, running between, at the instant the response is built.

string
reason
required

The reason given with the request.

string
recipientUserId
required

The user asked to swap.

string
requesterUserId
required

The user who made the request.

string
revision
required

The revision of the request.

integer format: int64
rotationId
required

The rotation identifier.

string
state
required

The lifecycle state of the request.

string
rotationName
required

The name of the rotation.

string
rotationVersion
required
integer format: int64
Examplegenerated
{
"arrangements": [
{
"cellId": "example",
"changesAtUtc": "2026-04-15T12:00:00Z",
"from": "2026-04-15T12:00:00Z",
"id": "example",
"kind": "example",
"origin": {
"complete": true,
"userIds": [
"example"
]
},
"originalSnapshot": {
"asOfUtc": "2026-04-15T12:00:00Z",
"complete": true,
"from": "2026-04-15T12:00:00Z",
"segments": [
{
"from": "2026-04-15T12:00:00Z",
"resolved": true,
"to": "2026-04-15T12:00:00Z",
"userIds": [
"example"
]
}
],
"to": "2026-04-15T12:00:00Z"
},
"phase": "example",
"revision": 1,
"rotationId": "example",
"state": "example",
"to": "2026-04-15T12:00:00Z",
"turnSelection": {
"from": "2026-04-15T12:00:00Z",
"kind": "example",
"to": "2026-04-15T12:00:00Z"
},
"userId": "example"
}
],
"deliveryState": "example",
"effectiveFrom": "2026-04-15T12:00:00Z",
"operationId": "example",
"request": {
"actionable": true,
"active": true,
"asOfUtc": "2026-04-15T12:00:00Z",
"capability": {
"canAccept": true,
"canCancel": true,
"canDecline": true,
"reason": "example",
"reasonCode": "example"
},
"changesAtUtc": "2026-04-15T12:00:00Z",
"request": {
"id": "example",
"legs": [
{
"arrangementId": "example",
"cellId": "example",
"from": "2026-04-15T12:00:00Z",
"holderUserId": "example",
"key": "example",
"phase": "example",
"rotationId": "example",
"to": "2026-04-15T12:00:00Z"
}
],
"phase": "example",
"reason": "example",
"recipientUserId": "example",
"requesterUserId": "example",
"revision": 1,
"rotationId": "example",
"state": "example"
},
"rotationName": "example"
},
"rotationVersion": 1
}