Skip to main content

GuidesConventions

Conventions

HTTPS, JSON, /api/v1 in the path, UUIDs, UTC timestamps.

RuleDetail
ProtocolHTTPS in production. UTF-8 JSON bodies.
VersionIn the path: /api/v1. Not in a header.
IDsResource id values are UUIDs.
TimestampsISO-8601 UTC (2026-08-20T15:00:00.000Z).
NullExplicit null means no value. Omitted on PATCH means leave unchanged.
Extra keysRejected on write (additionalProperties: false).
Unknown response keysIgnore them. Additive fields may appear on /api/v1.
MethodsGET list/get, POST create, PATCH update. DELETE only on webhooks and inbox tags/participants.