Schemas

Human-readable error message describing the problem.

Machine-readable error code for programmatic handling.

Additional error context and troubleshooting information. Structure varies by error type.

Error occurrence timestamp in ISO8601 UTC format.

Response payload from the conduit operation

The street address line (e.g., '6315 W Yucca St')

The city name

State, province, or region code

Postal or ZIP code

Country name

Unique identifier for the generated report

Timestamp when the report was generated

The actual report data (structure varies by report type)

Parameters used to generate this report

HTML source to render. Must be non-blank after trimming — minLength: 1 admits a string of only whitespace, which the renderer rejects with INVALID_INPUT.

Renderer options. Omit the key entirely, or send null, for the default (LETTER portrait, 40pt margins) — null is accepted here even though the type below reads object, and is measured to render successfully.

Unknown keys are accepted and silently ignored by the renderer (measured: {"foo":1} renders 200), and Zuplo does not validate request bodies, so this object is deliberately open.

Human-readable message. Always 'Internal Server Error' for 5xx.

Absent on 5xx, and may be absent on 401 — requireKey throws unauthorized with no details.

Opaque hex activation identifier.

Descriptive status message

5-field CRON expression (minute hour day_of_month month day_of_week).

Format: minute hour day_of_month month day_of_week

• minute: 0-59
• hour: 0-23
• day_of_month: 1-31
• month: 1-12
• day_of_week: 0-7 (0 or 7 is Sunday)

Supported operators: *, -, ,, / Not supported: Quartz tokens (?, L, W, #), seconds field (6+ fields)

IANA timezone identifier for execution time calculation. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Starting time for next occurrence calculation in ISO8601 UTC format. Must end with 'Z' suffix. If not provided, defaults to current time.

Policy for handling DST ambiguity when local times are non-existent (spring-forward) or ambiguous (fall-back).

• first-valid: Use the first valid time (default)
• second-valid: Use the second valid time
• error: Return error for ambiguous times

Enable business macros processing. Currently not implemented in MVP. Future phases will support @EOM, @EOQ, @semi-monthly, etc.

Plain language schedule input (e.g., "Every Monday at 9am").

Not implemented in MVP - Sending this field returns 501 NOT_IMPLEMENTED. Will be supported in Phase 6.

Holiday configuration for filtering execution times. Currently only use: 'none' is supported.

DEPRECATED: This parameter is deprecated and ignored. Both nextIso and nextDate are always returned regardless of this parameter's value.

Previously specified which timestamp formats to include in the response:

• iso: Only nextIso field (ISO8601 with timezone offset)
• date: Only nextDate field (calendar date in target timezone)
• both: Both nextIso and nextDate fields (default)

For backwards compatibility, this field is still accepted but has no effect on the response format.

Next execution time in ISO8601 UTC format. Always returned regardless of deprecated 'return' parameter.

Next execution date in YYYY-MM-DD format in the requested timezone. Always returned regardless of deprecated 'return' parameter.

Canonical SCHEDL (Schedule Language) representation of the schedule. Format: " tz="

Normalized 5-field CRON string with single spaces when input is valid. Null if normalization cannot be produced, with warning added to warnings array.

Human-readable explanation of the schedule using 24-hour format. Format: "At HH:mm on "

Array of human-readable warning codes about schedule processing. May include DST adjustments, deprecated parameter warnings, normalization fallback, etc.