Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Deprecation (but no planned removal) of the External Contacts Merge v1 Endpoint

  • 1.  Deprecation (but no planned removal) of the External Contacts Merge v1 Endpoint

    Posted 07-21-2025 07:32
    Edited by Ananya Singh 07-21-2025 09:29

    Summary

    We are deprecating the older merge API: POST /api/v2/externalcontacts/merge/contacts.

    Due to this deprecation, we would like to encourage users to start using the new merge API (POST /api/v2/externalcontacts/contacts/merge) instead.

    Effective Date

    Monday, July 21, 2025

    Details

    The API to be deprecated (POST /api/v2/externalcontacts/merge/contacts) has some limitations (only allows 2 contacts to be merged, and they have to be of a certain type).

    The new API (POST /api/v2/externalcontacts/contacts/merge) does not have the same limitations (allows up to 25 contacts to be merged, and contacts can be any type), which expands the merge operation capabilities available to users.

    Customer Impact

    Consumers of the merge API are encouraged to take advantage of the new capabilities and switch existing code away from the old API, which we intend to remove at some point in the future.

    Impacted Resources

    Deprecated API

    POST /api/v2/externalcontacts/merge/contacts

    Replacement API

    POST /api/v2/externalcontacts/contacts/merge

    Issue References

    [RELATE-13428]

    [RELATE-16017]

    Contacts

    @Joyanne Njuguna  @Colin Reilly  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.