Update a Schedule

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

Endpoint: PUT /schedules/{schedule_id}

Description: Update an existing schedule. Some fields become required based on configuration (e.g., repeating schedules or all-day events).

Note:

• Dates use MM/DD/YYYY format.
  
• Time uses HH:mm (24-hour format).
  
• If no timezone is provided, the company timezone will be used.
  

Request Body:

Parameter	Type	Description
assigned_by required	integer	ID of the active user updating the schedule.
event_pid required	string	Event or series identifier for the schedule.
title required	string	Schedule title.
description optional	string	Schedule description.
job_id optional	integer	Associated job ID.
timezone optional	string	Timezone for the schedule. Defaults to company timezone if not provided. Example: America/Phoenix.
repeat required	boolean	Indicates whether the schedule repeats.
all_day required	boolean	Whether the schedule lasts all day.
color required	string	Schedule color.
user_ids required	array	IDs of active users assigned to the schedule.
publish optional	boolean	Whether the schedule is published.
update_series optional	boolean	Whether to update all events in the series.
start_date required	string (date)	Schedule start date in MM/DD/YYYY format.
end_date required	string (date)	Schedule end date in MM/DD/YYYY format.
start_time optional	string (time)	Start time in HH:mm format. Required unless all_day is true.
end_time optional	string (time)	End time in HH:mm format. Required unless all_day is true.
use_different_address optional	boolean	Whether to use a custom address instead of the job address.
street optional	string	Street address when using a different address.
city optional	string	City when using a different address.
state optional	string	State when using a different address.
country optional	string	Country when using a different address.
zip_code optional	string	ZIP or postal code when using a different address.
repeat_type optional	string	Repeat type (e.g., daily, weekly). Required when repeat is true.
repeat_end_date optional	string (date)	End date for repetition in MM/DD/YYYY format. Required when repeat is true.
weeks optional	string	Comma-separated weekdays (e.g., monday,thursday). Required when repeat_type is weekly.

Request Body Sample

JSON

{
  "assigned_by": 679,
  "event_pid": "",
  "title": "Schedule 1",
  "description": "Description here",
  "job_id": 5118,
  "timezone": "America/Phoenix",
  "repeat": true,
  "all_day": false,
  "color": "red",
  "user_ids": [680],
  "publish": true,
  "update_series": false,
  "start_date": "01/01/2024",
  "end_date": "01/01/2024",
  "start_time": "06:00",
  "end_time": "08:00",
  "use_different_address": true,
  "street": "Street",
  "city": "City",
  "state": "State",
  "country": "Country",
  "zip_code": "Zipcode",
  "repeat_type": "weekly",
  "repeat_end_date": "01/29/2024",
  "weeks": "monday,thursday"
}