Genesys Cloud
API default profile change for gamification metrics

Announced on Effective date
2022-06-22 2022-10-26

With the launch of the custom gamification profiles capability in December 2021, Genesys introduced new APIs. These new APIs include the gamification profile ID when retrieving or adding metrics. On the deprecation / end of life date Genesys will remove the older APIs since they will become obsolete and duplicates of the new API.

APIs to be deprecated Deprecation / End of life date
GET /api/v2/gamification/metrics September 28, 2022
POST /api/v2/gamification/metrics September 28, 2022
GET /api/v2/gamification/metrics/{metricId} October 26, 2022
PUT /api/v2/gamification/metrics/{metricId} October 26, 2022
New APIs
GET /api/v2/gamification/profiles/{profileId}/metrics
POST /api/v2/gamification/profiles/{profileId}/metrics
GET /api/v2/gamification/profiles/{profileId}/metrics/{metricId}
PUT /api/v2/gamification/profiles/{profileId}/metrics/{metricId}
GET /api/v2/gamification/profiles/{profileId}/metrics/objectivedetails

For more information, see Gamification APIs in the Developer Center.


What are the benefits of these new APIs?

The new APIs allow for more customization since they work with new custom gamification profiles. The new custom gamification profiles enable you to create metrics for custom agent groups that have shared performance goals.

The new custom profiles launch includes added gamification functionalities that are included in the new API set. These new functionalities include Add & Retrieve metrics for specific custom profiles.

What does this mean?

Between the announcement date and the API change, Genesys will no longer address bugs or minor issues specific to the current APIs.

Genesys will continue to resolve any major breakage until the deprecation / end of life date.

Am I affected?

After the final removal date, organizations will no longer be able to use the existing supported APIs. 

What do I need to do before the removal date?

After the removal date, organizations using the existing APIs must migrate to the new APIs. 

What if I need help or have questions?

Contact My Support.