Update open shift

curl --location --request PATCH '/api/organizations//locations//open-shifts/' \ --header 'Content-Type: application/json' \ --data-raw '{ "roleName": "Cashier", "startDate": "2024-04-01T09:00:00Z", "endDate": "2024-04-01T17:00:00Z", "breaks": "[{\"start\": \"2024-04-01T12:00:00Z\", \"end\": \"2024-04-01T13:00:00Z\"}]", "staffCountRequired": 2, "requireApproval": true, "timezone": "America/New_York", "utcOffset": "-5", "roleId": "123e4567-e89b-12d3-a456-426614174000", "staffCount": 2, "requiresApproval": true }'

Request

Path Params

organizationId

string

required

locationId

string

required

string

required

Body Params application/json

roleName

string

optional

The name of the role for the open shift

Example:

Cashier

startDate

string

optional

The start date and time of the open shift

Example:

2024-04-01T09:00:00Z

endDate

string

optional

The end date and time of the open shift

Example:

2024-04-01T17:00:00Z

breaks

array[string]

optional

JSON array of breaks for the shift

Example:

[{"start": "2024-04-01T12:00:00Z", "end": "2024-04-01T13:00:00Z"}]

staffCountRequired

number

optional

Number of staff members required for this role

Example:

requireApproval

boolean

optional

Whether approval is required for claiming this shift

Example:

true

timezone

string

optional

The timezone of the open shift

Example:

America/New_York

utcOffset

number

optional

The UTC offset of the open shift

Example:

-5

roleId

string

optional

The ID of the role for the open shift

Example:

123e4567-e89b-12d3-a456-426614174000

staffCount

number

optional

Number of staff members required for this role

Example:

requiresApproval

boolean

optional

Whether approval is required for claiming this shift

Example:

true

Examples

Request

Responses