Create Shift

post

https://api.7shifts.com/v2/company/{company_id}/shifts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Minimum Plan Required: The Works

Path Params

company_id

int64

required

Company ID

Body Params

location_id

integer

required

Shift ID

user_id

integer

User ID

department_id

integer | null

Department ID. Required if the location uses departments.

role_id

integer | null

Role ID. Required if the location uses roles.

station_id

integer | null

Station Number

start

date-time

required

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

end

date-time

required

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

boolean | null

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

business_decline

boolean | null

Set to true if the shift ends at business decline.

notes

string | null

Notes displayed on a shift.

draft

boolean | null

If true the shift is not published.

notified

boolean | null

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

open

boolean | null

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

open_offer_type

integer | null

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_network

boolean | null

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

job_network_wage

number | null

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

unassigned

boolean | null

Internal use only

unassigned_skill_level

integer | null

enum

The skill level required for this shift.

Allowed:

status

integer | null

enum

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

Allowed:

late_minutes

integer | null

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

breaks

array of objects or null | null

Breaks to be created with the shift

breaks

Headers

x-api-version

string

^\d{4}-\d{2}-\d{2}$

7shifts API version

x-company-guid

uuid

Company GUID

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Shift created

400Bad Request

403Forbidden

422Unprocessable Entity