Guide

Versioning and changelog

How the Partner API is versioned and how changes are announced.

View as markdown

Versions

The major version is in the path: every endpoint lives under /v1. The current specification is Partner API 1.1.0 — download it as OpenAPI JSON and use it with Postman, Insomnia or a client generator.

What we change without a new version

Within /v1 we only make additive changes:

  • new endpoints, event types or optional request fields
  • new fields in responses and webhook payloads
  • new error codes on existing endpoints

Write your client to ignore fields it doesn't know and to handle unknown enum values, event types and error codes gracefully.

Breaking changes

Removing or renaming fields, changing types, or changing behaviour your integration relies on happens only in a new major version. When that happens we email the technical contact on your partner account in advance and publish a migration guide here.

Staying up to date

The API reference and the OpenAPI file on this site are generated from the API code. The live spec is also served by the API at https://api.aiviue.com/v1/openapi.json.