Shifts

Create Shift

post/v2/company/{company_id}/shifts

Path parameters

company_idinteger required

Company ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

location_idinteger required

Shift ID

user_idinteger

User ID

department_idinteger nullable

Department ID. Required if the location uses departments.

role_idinteger nullable

Role ID. Required if the location uses roles.

station_idinteger nullable

Station Number

startstring date-time required

Start date time of the shift. UTC in ISO8601 format.

endstring date-time required

End date time of the shift. UTC in ISO8601 format.

closeboolean nullable

Set to true if the shift ends at closing time. If set, end is not used.

business_declineboolean nullable

Set to true if the shift ends at business decline.

notesstring nullable

Notes displayed on a shift.

draftboolean nullable

If true the shift is not published.

notifiedboolean nullable

If true the user has been notified of the published shift.

openboolean nullable

Set to true if the shift is not assigned to any user. Open shifts can be requested by users.

open_offer_typeinteger nullable

Set when open is true. Set to 1 for everyone can request an open shift; set to 1 if only offered to specified role.

list_in_job_networkboolean nullable

Set to true if the shift should be made available to the 7shifts job network.

job_network_wagenumber nullable

The wage to offer the shift at in the 7shifts job network.

unassignedboolean nullable

Internal use only

unassigned_skill_level1 | 2 | 3 nullable

The skill level required for this shift.

status0 | 1 | 2 | 3 | 4 | 5 nullable

Shift status type. 0 - none, 1 - sick, 2 - no show, 3 - late, 4 - call out, 5 - left late.

late_minutesinteger nullable

Number of minutes a user can clock in late after the shift starts.

Response

Shift created

object'shift' required