Add a schedule

post

https://api.timeero.app/api/public/schedules

Add a new schedule for a user or resource by defining the date, time, and related configuration. This endpoint is used to plan future work, shifts, or events.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

The title or name of the schedule.

description

string

Additional details or notes about the schedule.

assigned_by

string

required

The ID of the user who created or assigned the schedule.

start_date

date

required

The start date of the schedule. Format: MM/DD/YYYY

end_date

date

required

The end date of the schedule. Format: MM/DD/YYYY

start_time

string

required

The start time of the schedule on each day. Format: HH:mm

end_time

string

required

The end time of the schedule on each day. Format: HH:mm

timezone

string

The timezone in which the schedule times are defined. For more details, see the Timezone Guide.

job_id

integer

The ID of the job associated with the schedule.

all_day

boolean

Defaults to false

Indicates whether the schedule applies to the entire day.

color

string

enum

Defaults to orange

Color used to visually represent the schedule in the calendar. For more details, see the Color Guide.

user_ids

array of integers

required

List of user IDs assigned to this schedule.

user_ids*

publish

boolean

Defaults to true

Determines whether the schedule is published and visible to assigned users.

use_different_address

boolean

Indicates whether the schedule uses an address different from the job’s default address.

street

string

Street address for the schedule location (required if use_different_address is true).

city

string

City for the schedule location.

state

string

State or province for the schedule location.

country

string

Country for the schedule location.

zip_code

string

ZIP or postal code for the schedule location.

repeat

boolean

Defaults to false

Indicates whether the schedule should repeat. For more details, see the Repeating Schedules Guide.

repeat_type

string

enum

Defines how the schedule repeats.

Allowed:

repeat_end_date

date

The date on which the repeating schedule ends. Format: MM/DD/YYYY

weeks

string

Days of the week on which the schedule repeats (required when repeat_type is weekly). Value should be a comma-separated of weekdays . e.g sunday,monday,tuesday

Responses

200

400Bad Request

404Not Found

500Internal Server Error