COconnecteam
Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts

Update shifts

Changed on

Update single or multiple shifts under a specific schedule

put/scheduler/v2/schedulers/{schedulerId}/shifts

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/scheduler/v2/schedulers/{schedulerId}/shifts
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: schedule.write

Path parameters

schedulerIdinteger required

The unique identifier of the schedule

Query parameters

notifyUsersboolean nullable

Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.

Request body

shiftIdstring required

The unique identifier of the shift

startTimeinteger nullable

Integer with minimum value of 1

endTimeinteger nullable

Integer with minimum value of 1

isOpenShiftboolean nullable

Indicates whether the shift is an open shift. Creates only with 1 open spot

timezonestring nullable

The timezone in Tz format (e.g. America/New_York)

titlestring nullable

The title of the shift

isPublishedboolean nullable

Indicates whether the shift is published

jobIdstring nullable

The ID of the associated job

isRequireAdminApprovalboolean nullable

Indicates whether admin approval is required for the shift. Can only be set if the shift is an open shift

assignedUserIdsinteger[] nullable

The list of assigned user IDs for the shift. Required for V2 Vision targeted base/group edits when isEditForAllUsers is explicitly false. When vision is enabled, multiple user IDs can be specified. Otherwise, only one user ID can be specified.

isEditForAllUsersboolean

Indicates whether the update should be applied to all users assigned to the shift

colorstring nullable

The color associated with the shift. Should be one of the following colors: ['#4B7AC5', '#801A1A', '#AE2121', '#DC7A7A', '#B0712E', '#D4985A', '#E4B37F', '#AE8E2D', '#CBA73A', '#D9B443', '#487037', '#6F9B5C', '#91B282', '#365C64', '#5687B3', '#7C9BA2', '#3968BB', '#85A6DA', '#225A8C', '#548CBE', '#81A8CC', '#4E3F75', '#604E8E', '#8679AA', '#983D73', '#A43778', '#D178AD', '#6B2E4C', '#925071', '#B57D9A', '#3a3a3a', '#616161', '#969696']

openSpotsinteger nullable

Integer with minimum value of 0

Response

Successful Response

requestIdstring

Changes

  • a01dde7c27fbRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status