COconnecteam
Schedule:v2:Schedulers:Schedule:Shift Auto Assign (V2):Shift Auto Assign

Create auto-assign request

Initiate a request to auto-assign shifts by their IDs. If multiple IDs are provided, all corresponding shifts must occur within the same work week (e.g., Monday to Sunday). This endpoint only submits the request; processing may take a few minutes. The auto-assignment considers user preferences to work, unavailability, and approved time off. For assignment status, refer to the auto-assign status endpoint.

post/scheduler/v2/schedulers/{schedulerId}/shifts/auto-assign

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/scheduler/v2/schedulers/{schedulerId}/shifts/auto-assign
  • 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

Request body

shiftsIdsstring[] required

List of shift IDs to start a request to auto assign. The shifts must be within the same week period (according to the schedule settings).

isForceQualificationboolean nullable

Determines whether to take into consideration the qualifications of users.

isForceUnavailabilityboolean nullable

Determines whether to consider users' unavailabilities.

isForceLimitationsboolean nullable

Determines whether to consider users' limitations.

isForceOpenShiftRequestsboolean nullable

Determines whether to assign open shifts exclusively to requesters. If set to false, it first prioritizes requesters, then assigns the remaining.

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.