REST API
Plan Slots
Plan slot object

Plan slot object

Plan slot

The plan slot object represents a recurring posting slot in the authenticated caller's posting plan.

Timezone and local-time semantics

Plan slots store recurring start and end times internally as UTC ISO datetimes, but the public API reads and writes slot times using a durable slot timezone so local wall-clock times remain stable.

Public slot responses return start_time and end_time as local HH:MM values in the slot timezone. The next_occurrence_at field is always an ISO 8601 UTC datetime.

  • If timezone is provided on create, that timezone is persisted on the slot.
  • If timezone is omitted on create, the owner settings timezone is used.
  • If no owner timezone is configured, UTC is used as the fallback.
  • Legacy slots without a stored timezone still fall back to the owner settings timezone and then UTC.
FieldTypeDescription
idstringUnique slot identifier.
start_timestringRecurring local start time in HH:MM 24-hour format.
end_timestringRecurring local end time in HH:MM 24-hour format.
timezonestringPersisted IANA timezone string for the slot.
labelsLabel[]Hydrated label objects in the shape { id, title }. Internal label color is not exposed.
recurrenceRecurrenceRecurrence configuration for the slot.
next_occurrence_atstring | nullNext future occurrence start datetime in ISO 8601 UTC format.
is_activebooleanWhether the slot is active. Legacy records without this field default to true.

Recurrence

FieldTypeDescription
intervaldaily | weekly | monthlyRecurrence interval.
repeat_everyintegerRepeat frequency. For example, 1 means every interval.