SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Change a shift, or cancel it with status cancelled

PATCHhttps://app.softsolz.uk/api/v1/services/tasks/shifts/{id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Body Params

namestring

Shift name, up to 200 characters.

starts_atstring

When the shift starts.

ends_atstring

When it ends. A shift lasts 24 hours or less.

lead_user_idinteger | null

Member who leads the shift.

member_user_idsarray of integers

Members on the shift, up to 200.

org_unit_idinteger | null

Department or location.

statusstring

Send cancelled to cancel the shift.

expected_updated_atstring

The updated_at you last read. A newer change gives 409 STALE_VERSION.

Response

Response Body

shiftobjectThe shift.
open_itemsarray of objectsOpen work.
handoverobject | nullIts handover, once closed.

Request

curl --request PATCH \
--url https://app.softsolz.uk/api/v1/services/tasks/shifts/{id} \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Morning"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"shift": {
"id": 7,
"name": "Morning",
"org_unit": {
"id": 1,
"name": "your-name"
},
"starts_at": "2026-01-01T09:00:00.000Z",
"ends_at": "2026-01-01T09:00:00.000Z",
"status": "planned",
"lead": {
"id": 12,
"name": "Sam Lee"
},
"members": [
{
"id": 1,
"name": "your-name",
"role": "your-role"
}
],
"open_count": 1,
"handover_status": "your-handover-status"
},
"open_items": [
{}
],
"handover": {
"id": 3,
"status": "waiting",
"from_shift": {},
"to_shift": {},
"notes": "your-notes",
"items": [
{}
],
"acknowledged_at": "2026-01-01T09:00:00.000Z"
}
}
}