Parameters

Parameter

Type

Required

description

start

String

Yes

The date/time (UTC) of when the shift starts:
'2013-03-01 10:30:00'

end

String

Yes

The date/time (UTC) of when the shift end:
'2013-03-01 14:30:00'

user_id

Integer

Yes

The ID of the user that the shift is assigned to.

location_id

Integer

Yes

The ID of the location that the shift is assigned to.

department_id

Integer

No
(Only required if your location_id is leveraging department functionality)

The ID of the department that the shift is assigned to.

role_id

Integer

No
(Only required if your location_id is leveraging role functionality)

The ID of the role that the shift is assigned to.

close

Boolean

No

Whether or not this shift is going until close (thus, 'end' would not be used). Defaults to false.

notes

String

No

Any notes specific to this shift.

hourly_wage

Float

No

The hourly wage for this shift. If not set, it will use the hourly wage for the user. As an example, you can over-ride by setting it to something like "12.50".

open

Boolean

No

Whether or not this is an "Open Shift". Open shift means anyone can request to take it. It is not assigned to any individual, specifically.

open_offer_type

Integer

No

If the 'open' field above is being leveraged and open=true, then we either offered it to:

0: Offered to everyone
1: Offered to a specific role

bd

Boolean

No

If the shift ending time was scheduled until business decline.

Example response

{
  "status": "success",
  "data": {
    "shift": {
      "id": 11,
      "user_id": 123,
      "start": "2021-08-14 06:00:00",
      "end": "2021-08-14 07:00:00",
      "close": false,
      "bd": false,
      "hourly_wage": 0,
      "department_id": 556,
      "location_id": 445,
      "role_id": 0,
      "notes": "",
      "draft": false,
      "notified": false,
      "open": false,
      "unassigned": false,
      "unassigned_skill_level": 0,
      "open_offer_type": 0,
      "status": 0,
      "late_minutes": 0,
      "created": "2021-08-09 17:51:58",
      "modified": "2021-08-09 17:51:58",
      "deleted": false,
      "soft_deleted": null,
      "first_published": null,
      "last_published": "0000-00-00 00:00:00",
      "station": 0,
      "startISO8601": "2021-08-14T06:00:00-05:00",
      "endISO8601": "2021-08-14T07:00:00-05:00",
      "group_id": 26802,
      "schedule_type_id": 67785,
      "station_name": null
    },
    "station": []
  },
  "message": "Shift added."
}
Language
Authentication
Basic
base64
:
Response
Click Try It! to start a request and see the response here!