Plan a shift. The member behind the key must be allowed to plan shifts
POST
https://app.softsolz.uk/api/v1/services/tasks/shiftsRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Headers
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Body Params
namestringrequiredShift name, up to 200 characters.
starts_atstringrequiredWhen the shift starts.
ends_atstringrequiredWhen it ends. A shift lasts 24 hours or less.
lead_user_idinteger | nullMember who leads the shift.
member_user_idsarray of integersMembers on the shift, up to 200.
org_unit_idinteger | nullDepartment or location.
Response
Response Body
shiftobjectThe shift.open_itemsarray of objectsOpen work.handoverobject | nullIts handover, once closed.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/tasks/shifts \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "name": "Morning", "starts_at": "2026-12-01T07:00:00Z", "ends_at": "2026-12-01T15:00:00Z", "lead_user_id": 12, "member_user_ids": [ 12, 15 ]}'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 · 201
{ "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" } }}