Versioning

The Genesys Cloud Platform API is currently on major revision 2, referred to simply as "v2". v2 is currently the only supported version of the Platform API. As the Genesys Cloud product grows, additions will be made to the API to support the new features in the form of:

• New resources
• New HTTP methods for existing resources
• Additional properties on data models

At times, changes to the API may be required that are not backwards compatible. When breaking changes are necessary, they are deferred to be included in the next major revision of the API, v3, whenever possible. Although there is not currently a specific timeline for when v3 will be released, when it is released, v2 will continue to be supported for 12-24 months. Breaking changes include things such as:

• Removed and replaced resources
• Removed data models or properties from data models

The timeline will vary depending on what breaking changes are needed in v3 and how many external developers are using v2. Information about version releases will be available here on the Developer Center and from our twitter account @GenesysCloudDev. Additionally, general product release information can be found in the Genesys Cloud Release notes.

The Platform API SDKs are regenerated against the Platform API after each deployment of the API to production. Because of this generation and deployment pipeline, the latest version of the SDK should always be used because it is the only version that exactly matches the contract of the API that's live in production.

The SDKs are versioned using slightly more aggressive logic than the API, meaning that a change to the API that only causes a minor version revision of the API may actually cause a major version revision for the SDK. An example of this is adding optional query parameters to an API resource. The API sees this as a minor change because existing requests will still continue to function without the newly added optional parameter. However, the SDKs generate method signatures that include the optional parameters. This means that adding a new parameter, even an optional one, will cause the method signature to change in the SDK in a non-forward compatible way. This requires the SDK's major version to be incremented because the method's signature was broken.

Using the form below, select a From version (the older version) and a To version (the newer version) and click the Compare Versions button to see the changes between the two versions. Using the SDK versioning rules causes certain minor changes to be considered major changes, see above for the explanation. For full details on how this diff is generated, see the swagger diff script on github.