Versioning

The major version is part of the URL: /api/partner/v1. Within a major version, Thea only makes backwards-compatible changes.

Changes that can happen within v1

• New endpoints.
• New optional request fields and query parameters.
• New fields in responses.
• New values in enums that responses may contain, such as message sender.type.
• New webhook event types. You only receive events you subscribe to.
• New error types.
• Changes to detail wording and to the length or format of opaque IDs and cursors.

Build your integration to tolerate these. In particular, ignore unknown fields rather than failing on them, and treat unknown enum values gracefully.

Breaking changes

Anything that could break a correct integration ships as a new major version (/v2), such as removing or renaming a field, changing its type, or making an optional field required. When that happens:

• We email your technical contact.
• v1 keeps working for at least 12 months after v2 is released.

Staying informed

The OpenAPI spec always describes the current API.