Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Deprecation of /replace/external and /consult/external APIs

  • 1.  Deprecation of /replace/external and /consult/external APIs

    Posted 3 hours ago

    Summary

    The following APIs are deprecated and will be removed (subject to zero usage):

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/external

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external

    The related permissions will first be deprecated and then removed:

    • conversation -> communication -> blindTransferExternal

    • conversation -> communication -> consultTransferExternal

    Deprecation : Effective Immediately

    Removal : May 1, 2028 (subject to 0 usage)

    Effective Date

    Monday, February 23, 2026

    Details

    These APIs were originally introduced to support blind and consult transfers to external contacts. However, due to edge cases where the implementation cannot reliably ensure that the transfer destination is a valid external contact, they are being deprecated.

    Customers should migrate to the following replacement APIs, which enforce proper external contact handling and address the limitations of the previous implementation:

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external

    Customer Impact

    • Genesys Cloud UI, CRM integrations, and other Genesys Cloud products have already migrated to the new endpoints.

    • Customers using the deprecated APIs must update their integrations to use the replacement endpoints prior to removal.

    • The deprecated permissions will be removed following their deprecation phase.

    Impacted Resources

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/external

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external

    Issue References

    CS-4762

    Contacts

    @Carlo Dimonti  

    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.



Related Content