Add Additional Email via API v3 - hs_additional_emails

Develop, Build & Integrate APIs & Integrations
1

Hi. I see in previous posts that the only way to add secondary emails was to use the legacy v1 endpoint. However, I also see that there is some documentation of about using the property hs_additional_emails in the current docs.

However, trying to patch the contact with the property

hs_additional_emails fails with the following message.

{
 "status": "error",
 "message": 'Property values were not valid: [{"isValid":false,"message":"\\"hs_additional_emails\\" is a calculated property; its value cannot be set.","error":"READ_ONLY_VALUE","name":"hs_additional_emails"}]',
 "correlationId": "9e699278-b9f1-4f14-a756-fdb2b6ffe03a",
 "errors": [
 {
 "message": '"hs_additional_emails" is a calculated property; its value cannot be set.',
 "code": "READ_ONLY_VALUE",
 "context": {"propertyName": ["hs_additional_emails"]},
 }
 ],
 "category": "VALIDATION_ERROR",
}
2

Hi @PabloOsorio and welcome, it’s a pleasure to have you here! :hugs:
Thanks for asking the HubSpot Community!
I have found for you the solution from @HubSpot_Corey on this similar post “Not possible to add secondary email in Contacts API Batch Upsert”.
I have asked the Team to update the documentation accordingly, sorry about this.
Hi @sylvain_tirreau, @zach_threadint and @Anton do you know of other ways to add secondary emails via API to help @PabloOsorio, please?
Have a beautiful day and thanks so much for your help! :star:
Bérangère

3

Hi @PabloOsorio :waving_hand:

You’ve rightly pointed out the documentation needs to be updated. It currently states:

To add secondary emails to a contact, when creating or editing the contact, in your request body, include emails in the hs_additional_emails field. Multiple emails can be separated by a semi-colon.

Given this property is “read only” (i.e. modificationMetadata.readOnlyValue = true), updating it via the relevant API V3 endpoints is not possible. As far as I know, the V1 endpoints are still operational, so I think you’ll have to use them for now.

I hope this proves helpful. Please let me know if you have any follow-up questions.

4

Hi @zach_threadint and @PabloOsorio, I hope that you are well!
I am glad to let you know that, thanks to your feedback, the Team has updated the documentation “Additional emails” :raising_hands:
I hope this will help future Community Members!
And thanks so much @zach_threadint for pointing @PabloOsorio to another documentation, really appreciate your help! :heart:
Have a fantastic weekend! :sun_with_face:
Bérangère