Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2024.4 | To support managing region and tenant specific data we exposed the CPaaS Tenant API. To enable the POS system to define values for a particular Business Unit parameters we introduced the following endpoints: - POST /businessunits/parameters - enables the POS system to register a new business unit parameter. - DELETE /businessunits/{externalId}/parameters/{key} - enables the POS system to remove a specific business unit parameter. - GET /businessunits/{externalId}/parameters - enables the POS system to retrieve all business unit parameters associated with a specific business unit. - GET /businessunits/parameters - enables the POS system to get a paged list of business unit parameters, and to filter the business unit parameters list by providing a key-value. To support handling a particular Client Parameters we introduced the following endpoints: - POST /clients/parameters - enables the POS system to register a new client parameter. - DELETE /locations/{externalId}/clients/{clientId}/parameters/{key} - enables the POS system to delete a specific client parameter - GET /locations/{externalId}/clients/{clientId}/parameters - enables the POS system to retrieve all business unit and client parameters associated with a specific client. - GET /clients/parameters - enables the POS system to retrieve a paged list of client parameters. , - GET /healthcheck - enables service level health check. It allows the API client to check the status of the dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. | v1 |