Create auto-assign request

post https://api.connecteam.com/scheduler/v1/schedulers/{schedulerId}/shifts/auto-assign

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.

Path Params

schedulerId

integer

required

The unique identifier of the scheduler

Body Params

shiftsIds

array of strings

required

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

Shiftsids*

isForceQualification

boolean

Defaults to true

Determines whether to take into consideration the qualifications of users.

isForceUnavailability

boolean

Defaults to true

Determines whether to consider users' unavailabilities.

isForceLimitations

boolean

Defaults to true

Determines whether to consider users' limitations.

isForceOpenShiftRequests

boolean

Defaults to false

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

Responses

Language

Credentials

Header


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.connecteam.com/scheduler/v1/schedulers/schedulerId/shifts/auto-assign \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "isForceQualification": true,
8
  "isForceUnavailability": true,
9
  "isForceLimitations": true,
10
  "isForceOpenShiftRequests": false
11
}
12
'

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

application/json

200Successful Response

422Validation Error