Add Shift Swap

post

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

Create a new shift swap with the given details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

end

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

find_replacement

Whether a replacement is needed to be found.

group_id

The ID of the group the shift swap belongs to

notes

Notes

offer_id

integer

required

The ID of the person who offered the shift

offer_type

string

required

The type of change being requested

publish_calendar

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

publish_slack

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

publish_email

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

publish_sms

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

reason

The reason for approving or denying a shift request

shift_id

The ID of the shift being swapped

status

The status of the shift swap

start

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

value

The value of the shift swap

cancel_requested

Whether the shift swap has been requested to be cancelled

time_off_entries

array | null

Requested time off entries

time_entries

array | null

Requested time entries

effective_from_date

The effective start date (YYYY-MM-DD) of the request in the requestor's timezone.

effective_to_date

The effective end date (YYYY-MM-DD) of the request in the requestor's timezone.

Responses

200Successful Response

422Validation Error