Update an existing shift swap

put

https://api.joinplanbase.com/api/v1/shift_swaps/{id}

Update an existing shift swap with the specified ID and details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the shift_swap to update

Body Params

archived

boolean | null

Defaults to false

Whether the shift swap has been archived

cancel_requested

boolean | null

Defaults to false

Whether the shift swap has been requested to be cancelled

end

date-time | null

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

find_replacement

boolean | null

Defaults to false

Whether a replacement is needed to be found.

group_id

string | null

The ID of the group the shift swap belongs to

has_update_permission_

boolean | null

Defaults to true

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

integer | null

The unique ID of the shift swap

notes

string | null

Notes

offer_id

integer | null

The ID of the person who offered the shift

offer_type

string | null

The type of change being requested

publish_calendar

boolean | null

Defaults to true

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

publish_email

boolean | null

Defaults to false

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

publish_slack

boolean | null

Defaults to true

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

publish_sms

boolean | null

Defaults to false

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

reason

string | null

The reason for approving or denying a shift request

shift_id

integer | null

The ID of the shift being swapped

start

date-time | null

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

status

string | null

The status of the shift swap

time_created

date-time | null

The time when the shift swap was created

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

time_updated

date-time | null

The time when the shift swap was last updated

value

number | null

The value of the shift swap

Responses

200Successful Response

422Validation Error