Versioning & stability | ParsChat Docs

The URL version

https://api-chat.parstechai.com/v1

v1 changes only on a breaking change. We do not bump it for additions.

What is not breaking

Added fields are not a breaking change. Your integration must ignore fields it does not recognise. This rule is what lets us improve the API without forcing you to re-integrate. It is also the most common cause of a partner integration breaking on an upgrade that broke nobody else.

Change	Breaking?
A new field in a response	No
A new optional field in a request	No
A new event type	No
A new value in an existing enum	No
A new endpoint	No
Removing or renaming a field	Yes
Changing a field’s type	Yes
Removing an endpoint	Yes

Write your parsers so a new enum value or event type does not throw. Log it and move on.

Webhook payload versioning

Every event carries schema_version, in semver:

{ "schema_version": "1.1.0", "event": "message", "…": "…" }

Fields are added with a minor bump. Nothing is removed or repurposed without a major bump and advance notice.

What is still pre-release

v1 is live. Every route in the reference is callable, with one exception: the Instagram breakdown=source option on Usage reports. That section carries a pre-release banner, and passing the parameter today returns the standard payload. The banner is a commitment to the shape, not to a date, and it comes off when the option ships.

Getting notice

Breaking changes and deprecations are announced to your account manager before they ship. If your contact details change, tell us. This is the channel we use.