Schemas

Profile handle used in links. This is not a resource ID; use the profile id (prf_...) in ID fields.

Profile handle used in links. This is not a resource ID; use the profile id (prf_...) in ID fields.

Optional organization from GET /v1/organizations. When omitted, the caller's single active owned organization is used.

Owning profile ID. Null when the profile is no longer visible to the caller.

RFC 5545 busy/free behavior: opaque blocks time; transparent does not.

Required when calling POST /v1/events; inferred from path when calling POST /v1/profiles/{profile_id}/events.

Event start time. Recommended: a naive local time (no offset) interpreted in start_timezone — e.g. "2026-06-06T09:30:00". An offset-bearing RFC 3339 value (e.g. "2026-06-06T09:30:00-04:00") is also accepted. Must be sent together with start_timezone. Omit for all-day events (use start_date).

Event end time, same formats as start_time. When present, must be sent together with end_timezone. Omit for all-day events (use end_date).

IANA timezone name (e.g. "America/New_York") for start_time. Required. Used for display, outbound calendar sync, and recurrence expansion; it does not reinterpret an explicit offset in start_time. Must not be null.

IANA timezone name for end_time. Independent of start_timezone (e.g. a NYC→LA flight). Must be sent together with end_time and must not be null. When omitted on create, the platform fills it from start_timezone.

All-day start date (YYYY-MM-DD, date only). Required when is_all_day is true; do not send with start_time/end_time.

All-day end date (YYYY-MM-DD), EXCLUSIVE — the event spans up to but not including this date. Optional; defaults to start_date + 1 day (single day) and must be after start_date (multi-day allowed).

Single RRULE text (optional RRULE: prefix), or null to clear recurrence. Must produce a first occurrence within a bounded work allowance using the effective event start. Invalid or excessively costly rules return 400 invalid_recurrence_rule. Advanced rules such as BYDAY=2TU are supported.

URL slug for the event. Optional — when omitted the platform derives one from the title and start time (evaluated in start_timezone). Reserved values (history, previous, s) are rejected.

RFC 5545 busy/free behavior: opaque blocks time; transparent does not.

Event start as an RFC 3339 date-time. When present, must be sent together with start_timezone.

Event end as an RFC 3339 date-time. When present, must be sent together with end_timezone.

IANA timezone name for start_time. Required when start_time is present (they must travel together). Used for display, outbound calendar sync, and recurrence expansion. Must not be null. Omit to leave unchanged.

IANA timezone name for end_time. Independent of start_timezone. Required when end_time is present. Must not be null. Omit to leave unchanged; no cascade from a start_timezone change.

All-day start date (YYYY-MM-DD, date only). Required when is_all_day is true; do not send with start_time/end_time.

All-day end date (YYYY-MM-DD), EXCLUSIVE — the event spans up to but not including this date. Optional; defaults to start_date + 1 day (single day) and must be after start_date (multi-day allowed).

Single RRULE text (optional RRULE: prefix), or null to clear recurrence. Must produce a first occurrence within a bounded work allowance using the effective event start. Invalid or excessively costly rules return 400 invalid_recurrence_rule. Advanced rules such as BYDAY=2TU are supported.

RFC 5545 busy/free behavior: opaque blocks time; transparent does not.

New event start as an RFC 3339 date-time. Must be sent together with start_timezone.

New event end as an RFC 3339 date-time. When present, must be sent together with end_timezone.

IANA timezone name for the new start_time. Required (reschedule always sets start_time). Must not be null.

IANA timezone name for the new end_time. Independent of start_timezone. Required when end_time is present. Must not be null.

Owning profile ID. Null when the profile is no longer visible to the caller.

Event containing this RSVP.

Personal calendar containing this event.

RFC 5545 busy/free behavior: opaque blocks time; transparent does not.

Event start time. Recommended: a naive local time (no offset) interpreted in start_timezone — e.g. "2026-06-06T09:30:00". An offset-bearing RFC 3339 value is also accepted. Must be sent together with start_timezone. Omit for all-day events (use start_date).

Event end time, same formats as start_time. When present, must be sent together with end_timezone. Omit for all-day events (use end_date).

IANA timezone name for start_time. Required. Used for display and recurrence; not used to reinterpret an explicit offset. Must not be null.

IANA timezone name for end_time. Independent of start_timezone. Required when end_time is present. Must not be null.

All-day start date (YYYY-MM-DD, date only). Required when is_all_day is true; do not send with start_time/end_time.

All-day end date (YYYY-MM-DD), EXCLUSIVE. Optional; defaults to start_date + 1 day (single day) and must be after start_date (multi-day allowed).

Single RRULE text (optional RRULE: prefix), or null to clear recurrence. Must produce a first occurrence within a bounded work allowance using the effective event start. Invalid or excessively costly rules return 400 invalid_recurrence_rule. Advanced rules such as BYDAY=2TU are supported.

RFC 5545 busy/free behavior: opaque blocks time; transparent does not.

Event start time (naive local + start_timezone recommended; offset-bearing also accepted). When present, must be sent together with start_timezone.

Event end time, same formats as start_time. When present, must be sent together with end_timezone. Omit for all-day events (use end_date).

IANA timezone name for start_time. Required when start_time is present. Used for display and recurrence; not used to reinterpret an explicit offset. Must not be null.

IANA timezone name for end_time. Independent of start_timezone. Required when end_time is present. Must not be null.

All-day start date (YYYY-MM-DD, date only). Required when is_all_day is true; do not send with start_time/end_time.

All-day end date (YYYY-MM-DD), EXCLUSIVE. Optional; defaults to start_date + 1 day (single day) and must be after start_date (multi-day allowed).

Single RRULE text (optional RRULE: prefix), or null to clear recurrence. Must produce a first occurrence within a bounded work allowance using the effective event start. Invalid or excessively costly rules return 400 invalid_recurrence_rule. Advanced rules such as BYDAY=2TU are supported.

RFC 5545 busy/free behavior: opaque blocks time; transparent does not.

Profile source for a profile subscription; otherwise null. A null value for a profile subscription means the source is no longer visible. Use subscription_type to identify the source type.

Series source for a series subscription; otherwise null. A null value for a series subscription means the source is no longer visible. Use subscription_type to identify the source type.

Connected external calendars returned by GET /v1/external-calendars. Personal cal_ IDs are not accepted. Omission means no external targets; personal calendar inclusion defaults to true.

Explicitly adopt matching manual/child-series sync intent into this subscription. Defaults to false. May retire redundant child subscriptions.

Prefixed identifier of the followed profile, series, or event. Null only when the original target is no longer visible.

Prefixed ID of the target resource.

Request id echoed from the JSON-RPC request. May be a string, integer, or null.

Method-specific result payload. Present on successful responses; mutually exclusive with error.

Present on failed responses; mutually exclusive with result.

Total events that were tagged in this series at delete time.

Events permanently deleted (only nonzero when cascade_exclusive_events=true).

Events that remain on the profile after deletion.

Total events tagged in this series.

Events that would be deleted in cascade mode.

Events that would be preserved (also tagged in other series).

Zuplo consumer name (request.user.sub on monetized routes).

Public organization ID accepted by profile creation.

The authenticated caller's role in this organization.

True only when this is the caller's single active owned organization and will be used when profile creation omits organization_id.

The organization selected explicitly or resolved from the caller's owned default.

Profile handle used in links. This is not a resource ID; use the profile id (prf_...) in ID fields.

Identifies this occurrence using the event ID and original slot. No write endpoint accepts it.

xcev_ IDs are read-only and stable while the stored row exists. Removing and reimporting an event may assign a new ID.

True only for non-recurring personal events, editable through the calendar-event PATCH route.

All-day events only; authoritative calendar date.

All-day events only; exclusive end date.

Present only with detail=full.

Whether the query and expansion returned all matching stored data. Does not guarantee provider coverage or freshness.