Setting phone numbers Post

The API provides feature to set phone numbers for a contact, in order to set the phone numbers for a contact, pass the list of phone numbers having RelatedToId as contact id with each phone item, we can set primary phone number and usage information for a phone number in the list.

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.

List of Phones

None.

Request Format

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

Setting the list

In order to set the list of phone number, refer the below sample:

[
  {
    "PhoneNumber": "9624468722",
    "CountryCode": "IN",
    "Extension": "93",
    "RelatedToId": 9831292,
    "Usage": {
      "IsPrimary": false,
      "UsedForCommunication": true,
      "SameHousehold": false
    }
  },
  {
    "PhoneNumber": "9510328028",
    "CountryCode": "IN",
    "Extension": "93",
    "RelatedToId": 9831292,
    "Usage": {
      "IsPrimary": false,
      "UsedForCommunication": true,
      "SameHousehold": false
    }
  },
  {
    "PhoneNumber": "888493636",
    "CountryCode": "IN",
    "Extension": "93",
    "RelatedToId": 9831292,
    "Usage": {
      "IsPrimary": true,
      "UsedForCommunication": true,
      "SameHousehold": false
    }
  }
]

Response Information

Resource Description

Wrapped result with value as True if phones are updated

Response Formats