v1/staff_shifts

post

https://shyftplan.com/api/v1/staff_shifts

Create a new StaffShift.

Body Params

user_email

string

required

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

E-mail address of the API user.

authentication_token

string

required

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

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

assign_to_connected

boolean

Defaults to false

Assign to other connected shifts

employment_id

int32

required

ID of an Employment

idempotency_key

string

Optional MCP-safety idempotency key. When present with API-token auth, repeated calls with the same fingerprint within the TTL window replay the cached response instead of re-creating the shift preset. Ignored for session auth.

ignore_conflicts

string

Defaults to false

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

metadata

json

Metadata in JSON format.

unassign_conflicting_shifts

boolean

Defaults to false

Remove the Employment from the shifts it collides with. Only possible when every conflicting shift can be unassigned and shifts_collision conflicts are ignored.

shift_id

int32

required

ID of the shift.

Responses

201Succesfully created a StaffShift

403Forbidden

404Company not found, Shift not found, Employment cannot be blank

422Unable to add Employment