Schedule Events

Last Updated: May 16, 2017

Following is a list of the properties that belong to a schedule event object, and a description of each.

id:
Integer. Read-only. Id of the event.
schedule_calendar_id:
Integer. Id of the calendar that contains this event.
start:
String (ISO8601 format). Date/time that represents the start time of this schedule event (i.e. 2004-02-12T15:19:21+00:00).
end:
String (ISO8601 format). Date/time that represents the end time of this schedule event (i.e. 2004-02-12T15:19:21+00:00).
all_day:
Boolean. If true, the event duration is all day on the day specified in start. If false, the event duration is determined by date/time specified in end.
user_id:
Integer. Read-only/deprecated. Id of the user that this event belongs to. Note: user_id is deprecated and may be removed from a future release. New applications should use assigned_user_ids.
unassigned:
Boolean. Read-only/deprecated. If true, this event is unassigned. If false, the event is assigned to the user specified in user_id. Note: unassigned is deprecated and may be removed from a future release. New applications should use assigned_user_ids.
assigned_user_ids:
Array. Ids of the user(s) assigned to this event. Empty array if the event is unassigned. Changing the assigned user IDs of an event may result in multiple event modifications. Check for a 201 status code and the supplemental data portion of the response for additional event modifications.
jobcode_id:
Integer. Id of the jobcode associated with this event.
active:
Boolean. If true, the event is active. If false, the event has been deleted/archived.
draft:
Boolean. If true, the event is a draft. If false, the event is published. Saving a published event will send the appropriate event published notifications to the assigned users.
timezone:
String. Timezone of the schedule event. (i.e. America/Denver)
title:
String. Title or name of this event.
notes:
String. Notes associated with the event.
location:
String. Location of the event. Location can be an address, business name, GPS coordinate, etc., so when users click on the location it will open it up in their mapping application.
color:
String. Hex color code assigned to this schedule event.
customfields:
JSON object. Only present if the Advanced Tracking Add-on is installed. This is a key / value map of customfield ids to the customfield items that are associated with the event.
last_modified:
String (ISO8601 format). Read-only. Date/time when this schedule event was last modified (i.e. 2015-07-15T19:31:43+00:00).
created:
String (ISO8601 format). Read-only. Date/time when this schedule event was created (i.e. 2015-07-15T19:16:19+00:00).