Genesys Cloud - Developer Announcements!

Summary

The endpoint POST /api/v2/externalcontacts/identifierlookup is being deprecated following the release of the Identifiers for External Organizations feature. We encourage users to migrate to the new, more specific endpoint for looking up Contact records.

Effective Date

Friday, May 23, 2025

Issue References

[RELATE-12831]

Details

With the introduction of Identifiers for External Organizations, it became necessary to differentiate the endpoint used for looking up Contact identifiers from a potential future endpoint for looking up Organization identifiers. Therefore, the identifier lookup functionality specifically for Contacts has been moved to a new URI.

POST /api/v2/externalcontacts/identifierlookup

• Old endpoint:
• https://developer.genesys.cloud/devapps/api-explorer#post-api-v2-externalcontacts-identifierlookup
• This endpoint has no behavioral changes. It will still perform identifier lookups of only Contact records.
• New endpoint, POST /api/v2/externalcontacts/identifierLookup/contacts:
• https://developer.genesys.cloud/devapps/api-explorer#post-api-v2-externalcontacts-identifierlookup-contacts
• Exact same functionality as the old endpoint, just a new name (to make way for a new sibling endpoint POST ../identifierLookup/organizations)
• Associated Dev Center article about this endpoints and associated functionality: https://developer.genesys.cloud/commdigital/externalcontacts/identifiers
• Note that we are not pursuing removal of the old endpoint at this time.

Impacted Resources

POST /api/v2/externalcontacts/identifierlookup

Customer Impact

• No immediate impact on existing API clients.
• There is no functional difference between the old and new endpoints.
• The old endpoint (POST /api/v2/externalcontacts/identifierlookup) is intended for removal at some currently unplanned point in the future. Consumers of the External Contacts API are encouraged to transition to the new endpoint.

Contacts

@Fatemeh Toyserkani