The Conversations API (currently in beta) is used to read and send HubSpot conversations inbox messages. We're making 2 changes to the message recipient portion of the API response, and one of the changes may require you to make changes if your integration leverages this API.
Currently this is what an email message recipient would look like:
actorIdis becoming an optional field, and we're removing the Email Actor Type, which is prefixed with "E-". ActorIds represent the entity within the HubSpot account that performed an action or is assigned to an object. An email address does not fit that definition of an Actor so we have decided to remove the "E-[actorId]". Going forward, messages will simply have noactorId, instead of an email ActorId. It still might be possible for message recipients on email messages to have otheractorIds(For example "V-123456" if the recipient is a known contact in the CRM); However, if there isn't a knownactorId, the field will just be empty. If your integration needs the email address, it will continue to be provided in thedeliveryIdentifiers.
ThedeliveryIdentifiersfield is being changed to a single, optional field calleddeliveryIdentifier(without the end 's'). This does not affect the ability to have multiple recipients, it merely changes the field based on how it's actually used. Each recipient has at most 1 delivery identifier, so no information will be lost, but the structure of the data for the field will be changing from an array of objects to just an object.
After these changes, the recipients data will look like this (note the exclusion of the now optional actorId field):
We have already begun including the newdeliveryIndentifierfield in-addition to the olddeliveryIdentifiersfield. If you have an app using this API you should migrate from thedeliveryIdentifiersfield to thedeliveryIdentifierfield.
OnApril 10th, 2023,the deliveryIdentifiers field will stop being returned in the API. So if you're using the data in that field, you'll want to migrate to thedeliveryIdentifierfield before then.