Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Deprecation of parameters in Favor of bodyParameters for Message Template Substitutions

  • 1.  Deprecation of parameters in Favor of bodyParameters for Message Template Substitutions

    Posted 2 hours ago

    Summary

    The parameters field used for message template substitutions is being deprecated and replaced by bodyParameters.

    The new bodyParameters field provides a clearer and more consistent structure for template substitutions across supported messaging channels.

    Affected APIs (request body):

    • POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages
    • POST /api/v2/conversations/messages/agentless
    • POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/users/{userId}/messages (Unstable)

    During the deprecation period, both fields will be supported. The parameters field will be removed in a future release.

    Effective Date

    Monday, July 13, 2026

    Details

    Support for WhatsApp templated messages introduced more specific attributes for template substitutions. Replacing parameters with bodyParameters unifies the substitution model across all supported message types and aligns with the updated template structure.

    Customer Impact

    Customers using the parameters field in request payloads must migrate to bodyParameters before the deprecation period ends.

    During the transition:

    • Both parameters and bodyParameters are supported.
    • Existing integrations will continue to function without interruption.

    After the deprecated field is removed:

    • Requests using parameters will no longer apply template substitutions correctly.

    Customer Action Required

    Customers should update their integrations to:

    • Replace the parameters field with bodyParameters in request payloads.
    • Validate that template substitutions continue to function as expected after migrating.

    Migrating during the deprecation period will ensure continued compatibility after the parameters field is removed.

    Impacted Resources

    • POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages
    • POST /api/v2/conversations/messages/agentless
    • POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/users/{userId}/messages (Unstable)

    Issue References

    MSG-6418

    MSG-7299

    Contacts

    @Diego Barrios Contreras  

    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