Deleting an email address Post

The API provides feature to delete an email address for a contact, in order to delete an email address pass the email address information along with the contact id, in case if it is primary email address the next email address will be marked as primary email.

Request Information

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.

pass the email object.

Name	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.

Request Format

Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.

{
  "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
}

Deleting an email address

In order to delete an email address pass the contact id and email address id, below is the sample:

{
    "EmailId": "zannie.enq@nonprofiteasy.net",
    "RelatedToId": 9831292,
    "Id":46092,
    "Usage": {
      "IsPrimary": true,
      "UsedForCommunication": true,
      "SameHousehold": false
    }
  }

Response Information

Resource Description

ITypedResponse with bool as true of false be wrapped inside.

ITypedResponseOfNullableOfBoolean

Name	Description	Type	Additional information
Result		boolean	None.
Category		string	None.

Response Formats

Sample not available.