Setting an email address as primary Post

The API provides feature to mark an email address as primary, if there is more than one email address available, we can mark an email address as primary, please note we cannot have more than one email address as primary, so in that case previous primary email address will be marked as primary to alternate.

Request Information

URI Parameters

In order to make a call integrate the below parameters into Url while calling the API from an integration.

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.

Primary Email Address of this contact.

Request Format

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

{
  "EmailId": "String Parameter 1",
  "Id": 2,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 3",
  "SortOrder": 1
}

Marking an email address as primary

In order to mark an email address as primary, refer the below sample:

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

Marking an email address as primary which does not exist in the system

In order to mark an email address as primary, which does not exist we need to pass the createIfNotFound flag as true, refer the below sample:

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

and Url as

admin/contact/update/primaryemail/true

Response Information

Resource Description

Wrapped response with Result as True if the Primary Email Address was updated/created

Response Formats