API Reference

Create a new shift swap

post
https://api.joinplanbase.com/api/v1/shift_swaps

Create a new shift swap with the given details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean | null
Defaults to false

Whether the shift swap has been requested to be cancelled

date-time | null

The new proposed end time (UTC) of the shift e.g 2023-07-27 06:30:00+00

boolean | null
Defaults to false

Whether a replacement is needed to be found.

string | null

The ID of the group the shift swap belongs to

boolean
Defaults to true

Temporary field to tell the client whether the person requesting the shift swap has update permissions

string | null

Notes

integer
required

The ID of the person who offered the shift

string
required

The type of change being requested

boolean | null
Defaults to true

How person who made swap request should get notified when status changes

boolean | null
Defaults to false

How person who made swap request should get notified when status changes

boolean | null
Defaults to true

How person who made swap request should get notified when status changes

boolean | null
Defaults to false

How person who made swap request should get notified when status changes

string | null

The reason for approving or denying a shift request

integer | null

The ID of the shift being swapped

date-time | null

The new proposed start time (UTC) of the shift e.g 2023-07-27 06:30:00+00

string | null

The status of the shift swap

time_entries
array of objects | null

Requested time entries

Time Entries
time_off_entries
array of objects | null

Requested time off entries

Time Off Entries
number | null

The value of the shift swap

Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?