Deleting a phone number Post

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

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 phone object.

Phone

Name	Description	Type	Additional information
SharingInfo	Provide sharing Information if this phone number is shared	Sharing	None.
Usage	Provide usage information	Use	Required
PhoneTypes	List of Phone Types.	Collection of GenericKeyValueOfNullableOfInt32AndString	None.
PhoneNumber	Phone Number of the Contact	string	Required
FormattedPhoneNumber		string	None.
CountryCode		string	None.
Extension		string	None.
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.

{
  "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
  },
  "PhoneTypes": [
    {
      "Id": 1,
      "Value": "String Parameter 1"
    },
    {
      "Id": 1,
      "Value": "String Parameter 1"
    }
  ],
  "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
}

Deleting a phone number

In order to delete a phone number pass the contact id and phone number id, below is the sample:

 {
    "PhoneNumber": "9624468722",
    "CountryCode": "IN",
    "Extension": "93",
    "Id":23582,
    "RelatedToId": 9831292,
    "Usage": {
      "IsPrimary": false,
      "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.