Create a new shift

post

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

Create a new shift with the given details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

activities

array of objects | null

The activities that are linked to the shift

Activities

allow_alternative_times

boolean | null

Defaults to false

Whether person can request changes to the timing of their shift

approved

boolean | null

Defaults to false

Whether timesheet associated with the shift has been approved

archived

boolean | null

Defaults to false

Whether shift has been archived

auto_approve_changes

boolean | null

Defaults to false

Whether shift change requests should be approved automatically

cascade_

boolean | null

Defaults to false

Whether to update joined objects that are linked to the shift

client_ids

array of integers | null

List of client IDs required for shift

Client Ids

clock_in_time

date-time | null

The time when the person clocked in (UTC)

clock_out_time

date-time | null

The time when the person clocked out (UTC)

created_at_clock_in

boolean | null

Defaults to false

Whether shift was created as a result of clocking-in

end

date-time

required

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

flex_hours

boolean | null

Defaults to false

Whether the shift has flexible hours

is_publishing_calendar

boolean | null

Defaults to false

Whether the shift is re-syncing to the user's calendar

is_publishing_email

boolean | null

Defaults to false

Whether the shift is re-sending email to the user

is_publishing_slack

boolean | null

Defaults to false

Whether the shift is re-publishing on slack

is_publishing_sms

boolean | null

Defaults to false

Whether the shift is re-sending sms to the user

license_type_ids

array of integers | null

List of license types IDs required for shift

License Type Ids

needs_publishing_calendar

boolean | null

Defaults to false

Whether the shift needs syncing to the user's calendar

needs_publishing_email

boolean | null

Defaults to false

Whether the shift needs re-sending email to the user

needs_publishing_slack

boolean | null

Defaults to false

Whether the shift needs publishing on slack

needs_publishing_sms

boolean | null

Defaults to false

Whether the shift needs re-sending sms to the user

notes

string | null

Any notes about the shift

payment_id

integer | null

The ID of the payment associated with the shift

people_required

integer | null

The number of people required for the shift if unassigned

person_id

integer | null

The ID of the person assigned to the shift (if any)

published_detail

object | null

Details the shift that was published

recurrence_details

object

The recurrence details for the shift

recurrence_id

integer | null

The ID of the recurrence the shift belongs to

request_id

integer | null

ID of the request that created the shift

role_id

integer | null

The ID of the role the shift belongs to (if any)

shift_type_id

integer | null

The ID of the shift type

start

date-time

required

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

status

string | null

Defaults to approved

The status of the shift

team_id

integer | null

The ID of the team the shift belongs to (if any)

time_published

date-time | null

When shift was last published

Responses

200Successful Response

422Validation Error