Setting email list for a contact
The API provides feature to set list of email addresses for a contact, in order to set the email address list for a contact, pass the list of email address having RelatedToId as contact id with each email address item, we can set primary email address and usage information for a phone number in the list.
Request Information
URI Parameters
In order to make a call integrate the below parameters into Url while calling the API from an integration.
Name | Description | Type | Additional information |
---|---|---|---|
contactID | integer |
Required |
Body Parameters
Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.
List of Emails
None.
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
Sample not available.
Setting the list
In order to set the list of email address, refer the below sample:
[ { "EmailId": "zannie@nonprofiteasy.net", "RelatedToId": 9831292, "Usage": { "IsPrimary": false, "UsedForCommunication": true, "SameHousehold": false } }, { "EmailId": "zannie.sales@nonprofiteasy.net", "RelatedToId": 9831292, "Usage": { "IsPrimary": false, "UsedForCommunication": true, "SameHousehold": false } }, { "EmailId": "zannie.enq@nonprofiteasy.net", "RelatedToId": 9831292, "Usage": { "IsPrimary": true, "UsedForCommunication": true, "SameHousehold": false } } ]
Response Information
Resource Description
Wrapped result with value as True if emails are updated
ITypedResponseOfNullableOfBooleanName | Description | Type | Additional information |
---|---|---|---|
Result | boolean |
None. |
|
Category | string |
None. |
Response Formats
Sample not available.