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-patch+json' \
--header 'If-Match: example' \
--data '{ "operationId": "example", "recipientUserId": "example", "legs": [ { "key": "example", "cellId": "example", "holderUserId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" } ], "reason": "example", "acknowledgedConflictIds": [ "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
operationId

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

string
recipientUserId

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

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
key

A nonempty identifier unique to this interval within the request.

string
cellId

The cell identifier from the rotation plan.

string
holderUserId

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

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
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
reason

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

string
acknowledgedConflictIds

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

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

OK

Media typeapplication/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
id
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
to
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
id
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
to
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
originalSnapshot
One of:
null
turnSelection
One of:
null
deliveryState
required
string
Examplegenerated
{
"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"
}