API Reference
Home

v1/shifts/{id}

put
https://shyftplan.com/api/v1/shifts/

Updates existing shift

Path Params
int32
required
Query Params
assignment_group_ids[]
array of int32s

Array of AssignmentGroup ID

assignment_group_ids[]
shift_rotation_group_ids[]
array of int32s

List of shift-sytesm group IDs.

shift_rotation_group_ids[]
Body Params
string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

date-time
required

End of the shift

int32
required

Updating locations_position_id of a shift will unassign all employees from the shift and their evaluations will be deleted

date-time
required

Start of the shift

int32
required

Number of workers

string
enum

Auto accept shift requests as long as there are open slots on the shift

Allowed:
int32

Break duration in minutes (Required unless untimed_break_time is present)

boolean
Defaults to true

Employees can create evaluations

evaluation_tag_ids
array of int32s

Array of EvaluationTag IDs (including from shift presets)

evaluation_tag_ids
string
Defaults to true

Either true to ignore all conflicts listed below or an Array of specific conflicts to ignore. Only warnings can be ignored, enforced conflicts will persist. Possible values are:

  • shifts_collision
  • absences_collision
  • locations_position_changed
  • minimum_break
  • maximum_working_hours
  • minimum_rest
  • maximum_earning
  • outside_employment_period
  • maximum_consecutive_working_days
  • restricted_shift_presets
  • unavailable
  • not_available
  • minimum_qualification_level
  • not_in_shift_preset
  • punch_timing_reassignment

string

Manager note for the Shift

string

Shift metadata as json

string

Note for the shift

qualifications
array of objects

Array of qualifications (type and number)

qualifications
shift_breaks
array of objects

Array of timed shift breaks

shift_breaks
int32

ID of an exisiting shift preset

tag_ids
array of int32s

Array of Shift Tag IDs (including from shift presets)

tag_ids
boolean
Defaults to false

Standby shift

int32

Untimed breaks in minutes (Required unless break_time is present)

boolean
Defaults to false

Update connected shifts if value is true

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?