Description
Email ‘send reply’ endpoint was previously returning an object of type EmailMessage. This included some generic fields (e.g. 'id', name'), which are often inherited by entities in Public API. These fields were not actually populated in the response body of this endpoint.
EmailMessage has been duplicated to a new entity, EmailMessageReply. This is a duplicate of the EmailMessage entity, but with the following superfluous inherited fields removed:
- id
- name
- fields
Change Category
API
Change Context
The values were not actually set in the response body of this endpoint. This could be misleading, as the ‘id’ field is often used in other email endpoints. However, with this endpoint, the message ID is not yet available.
This is because the endpoint is sending the mail, and the ID is not available until the asynchronous send process is over. Therefore, including message ID in the response body of this endpoint was inaccurate.
Change Impact
These fields would not have been populated anyways, so this shouldn’t be a breaking change, just a change in the documentation, which is generated based on the fields.
Date of Change
Jan 20, 2023
Impacted APIs
/api/v2/conversations/emails/{conversationId}/messages
References
[POSTINO-1267]