Q3 Roadmap: Embedded Notifications, Embedded Commissions, Tips and more!

Create schedule entry

POST

/api/organizations/{organization_id}/locations/{location_id}/schedules

Creates a new schedule entry.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/organizations//locations//schedules' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "start": "string",
    "end": "string",
    "locationId": "string",
    "employeeId": "string",
    "roleName": "string",
    "timezone": "string",
    "utcOffset": 0,
    "colors": {
        "draft": {
            "background": "string",
            "text": "string",
            "borderColor": "string"
        },
        "background": "string",
        "text": "string",
        "borderColor": "string"
    },
    "breaks": [
        "string"
    ],
    "payrollId": "string"
}'

Response Example

{}

Request

Path Params

location_id

string

required

organization_id

string

required

Body Params application/json

string

optional

The unique identifier of the schedule

start

string

required

The start date of the schedule

end

string

required

The end date of the schedule

locationId

string

required

The location id of the schedule

employeeId

string

required

The employee id of the schedule

roleName

string

optional

The role name of the schedule

timezone

string

required

The timezone of the schedule

utcOffset

number

required

The utc offset of the schedule

colors

object

optional

The colors of the schedule

draft

object

required

The colors of the draft schedule

background

string

required

text

string

required

borderColor

string

required

breaks

array[string]

optional

The breaks of the schedule

payrollId

string

optional

The payroll id of the schedule

Examples

Responses

🟢201Created

application/json

Body

object {0}

Modified at 2025-03-24 12:56:58

Get details for a schedule

Bulk copy schedule shifts