List of email address
The API provides the feature to get the list of email address for a contact. In order to get the list pass the contacts id as reference id.
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 |
pass the contact id to get the list of email addresses. |
integer |
Required |
Get the list
In order to get the list of email address for a contact, pass a valid contact id as URL parameter, below is the sample:`
admin/contact/emails/9831292
Response Information
Resource Description
List of email addresses.
Collection of EmailName | Description | Type | Additional information |
---|---|---|---|
EmailTypes |
Categorize this email into email types |
Collection of GenericKeyValueOfNullableOfInt32AndString |
None. |
SharingInfo |
Provide sharing Information if this Email is shared |
Sharing |
None. |
Usage |
Provide usage information |
Use |
Required |
IsVerified |
Gets the Value indicating if Email-Address is verified. Explicitly setting value for this field has No-Effect. |
boolean |
None. |
EmailId |
Email Address |
string |
Required |
Id | integer |
None. |
|
RelatedToId | integer |
None. |
|
MergedWith_Or_Secondary_Id | integer |
None. |
|
MergeType | string |
None. |
|
SortOrder | integer |
None. |
Response Formats
[ { "EmailTypes": [ { "Id": 1, "Value": "String Parameter 1" }, { "Id": 1, "Value": "String Parameter 1" } ], "SharingInfo": { "SharedWith": [ { "ContactId": 1, "ContactName": "String Parameter 2", "IsRemoved": true, "IsRecordOwner": true }, { "ContactId": 1, "ContactName": "String Parameter 2", "IsRemoved": true, "IsRecordOwner": true } ] }, "Usage": { "IsPrimary": true, "UsedForCommunication": true, "SameHousehold": true }, "IsVerified": true, "EmailId": "String Parameter 1", "Id": 2, "RelatedToId": 1, "MergedWith_Or_Secondary_Id": 1, "MergeType": "String Parameter 3", "SortOrder": 1 }, { "EmailTypes": [ { "Id": 1, "Value": "String Parameter 1" }, { "Id": 1, "Value": "String Parameter 1" } ], "SharingInfo": { "SharedWith": [ { "ContactId": 1, "ContactName": "String Parameter 2", "IsRemoved": true, "IsRecordOwner": true }, { "ContactId": 1, "ContactName": "String Parameter 2", "IsRemoved": true, "IsRecordOwner": true } ] }, "Usage": { "IsPrimary": true, "UsedForCommunication": true, "SameHousehold": true }, "IsVerified": true, "EmailId": "String Parameter 1", "Id": 2, "RelatedToId": 1, "MergedWith_Or_Secondary_Id": 1, "MergeType": "String Parameter 3", "SortOrder": 1 } ]