Setting a phone number as primary Post

The API provides feature to mark a phone number as primary phone number, if there is more than one phone number available, we can mark a phone number as primary, please note we cannot have more than one phone number as primary, so in that case previous primary phone number 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 phone number 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.

{
  "PhoneNumber": "String Parameter 1",
  "FormattedPhoneNumber": "String Parameter 2",
  "CountryCode": "String Parameter 3",
  "Extension": "String Parameter 4",
  "Id": 6,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 7",
  "SortOrder": 1
}

Marking a phone number as primary

In order to mark a phone number as primary, refer the below sample:

 {
    "PhoneNumber": "9510328028",
    "CountryCode": "IN",
    "Extension": "93",
     "Id":23581,
    "RelatedToId": 9831292,
    "Usage": {
      "IsPrimary": true,
      "UsedForCommunication": true,
      "SameHousehold": false
    }
  }

Marking a phone number as primary which does not exist in the system

In order to mark a phone number as primary, which does not exist we need to pass the createIfNotFound flag as true, refer the below sample:

 {
    "PhoneNumber": "9799636324",
    "CountryCode": "IN",
    "Extension": "93",
    "RelatedToId": 9831292,
    "Usage": {
      "IsPrimary": true,
      "UsedForCommunication": true,
      "SameHousehold": false
    }
  }

and Url as

admin/contact/update/primaryphone/true

Response Information

Resource Description

ITypedResponse with bool as true of false be wrapped inside.

Response Formats