Introduction

Our API is designed to be flexible and adaptable, allowing for continuous improvement and innovation. While we don't follow a strict versioning scheme, below are our guidelines for API updates and compatibility.

Release and Environment Relationship

Each environment maintains its update schedule for features (see: Releases and Environments), API updates are released with each environment's release schedule and frequency.

• Standard Release: Updated regularly to incorporate new features and enhancements. This may involve changes to existing API structures or adding new fields and routes.

• Extended Release: Updated every 3-4 months. These updates are carefully planned and tested. Prior versions of the update are available in the Sandbox.

Compatibility Considerations

• Backward Compatibility: We strive to maintain backward compatibility whenever possible. This means that existing integrations should continue to function without modification, even after API updates.

• Breaking Changes: In some cases, API updates may introduce breaking changes.

• Documentation Updates: We regularly update our API documentation to reflect the latest changes.

Best Practices for API Integration

• Monitor Updates: Stay informed about API updates by opening a support ticket to request notifications about breaking updates or by regularly checking our API documentation.

• Test Changes: Regularly test your integrations against the latest API version to ensure compatibility and identify any potential issues.