Genesys Cloud
Deprecation of contact.mergeOperation field in External Contacts API

Announced on Effective date Aha! idea
2025-07-21 2025-11-17 -

On the effective date, Genesys Cloud will deprecate the contact.mergeOperation field from all API responses. Developers and administrators used this field, which only allows for a two-way contact merge, via the old merge endpoint: POST /api/v2/externalcontacts/merge/contact. Genesys Cloud will no longer populate the contact.mergeOperation field and any system that relies on that information will receive a null value.

As enhancements, Genesys Cloud introduces two new fields, contact.mergedFrom and contact.mergedTo, which allow users to merge multiple contacts (for example, two-way, three-way, four-way merges) and will eventually replace the contact.mergeOperation field.

FAQs

Am I affected?

You are affected by this deprecation if your systems or integrations rely on the contact.mergeOperation field.

What do I need to do before the removal date?

Genesys recommends that you review and use the contact.mergedFrom and contact.mergedTo fields now.

How can I prepare for this deprecation?

Follow these steps:

  • Review your current integrations and update your software to use the new merge fields contact.mergedFrom and contact.mergedTo for detailed merge tracking.
  • Test your integrations and make sure that the new fields work before deprecating the old field.
  • To test the merged contacts, use the existing fields: contact.mergeSet[] and contact.canonicalContact.

What if I need help or have questions?

Contact your Genesys account team. You can also visit My Support for more assistance.