Summary
An update is being made to the response contracts of the following REST API endpoints:
• GET Get Conversation Message
• GET Get Message
• POST Get Messages in Batch
• POST Send Message
• POST Send Agentless Outbound Message
The following legacy response fields are being deprecated and will be removed:
• textBody
• media
• stickers
Effective Date
Deprecation effective Friday, November 7, 2025
Removal planned on Tuesday, March 31, 2026
Details
The removal of these fields addresses issues caused by maintaining duplicate message data in multiple formats. Returning message content through both legacy and normalized structures can create inconsistencies, synchronization errors, and confusion for API consumers.
The fields textBody, media, and stickers are legacy representations of message content. The equivalent data is already available in the normalizedMessage field, which provides a consistent structure for all message types.
Examples of Field Mapping
textBody = normalizedMessage.text
media[0].url = normalizedMessage.content[0].attachment.url
media[0].mediaType = normalizedMessage.content[0].attachment.mime
media[0].name = normalizedMessage.content[0].attachment.filename
media[0].id = normalizedMessage.content[0].attachment.id
media[0].contentLengthBytes = normalizedMessage.content[0].attachment.contentSizeBytes
stickers[0].url = normalizedMessage.content[0].attachment.url
stickers[0].id = normalizedMessage.content[0].attachment.id
Customer Impact
The legacy message format fields will be permanently removed by March 31, 2026.
All API consumers must migrate to using the useNormalizedMessage=true query parameter before this date to ensure continued compatibility and avoid service disruptions.
After removal, attempts to access textBody, media, or stickers fields will result in Null Pointer Exceptions.
Impacted Resources
GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
GET /api/v2/conversations/messages/{messageId}/details
POST /api/v2/conversations/messages/{conversationId}/messages/bulk
POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages
POST /api/v2/conversations/messages/agentless
Contacts
@Brijeshkumar Patel
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.