Creating a quick contact Post

The API provides the feature to create an Individual contact with minimal information required for the contact, in order to create an individual contact pass the name(Middle and last) at least, we can also pass the email address, phone number and address information for the contact. The API uses the duplicate prevention setting and all depends on what is configured from the CRM application.

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.

Individual Contact

QuickIndividualContact

Name	Description	Type	Additional information
MiddleName	Middlename of Individual	string	String length: inclusive between 0 and 510
LastName	LastName of Individual	string	String length: inclusive between 0 and 510
NickName		string	None.
PrefixId	Prefix ID of the Individual. The Id should be either null or existing Prefix-Id	integer	None.
SuffixId	Suffix ID of the Individual. The Id should be either null or existing Suffix-Id	integer	None.
GenderId		integer	None.
BirthDate		date	None.
ContactUniqueId	Gets ot Sets the unique contact Id from the client end.	string	None.
ContactSourceId	Contact Source Id	integer	None.
ContactName	Name of the Contact (Individual First Name or the Organization Name)	string	Required
Emails		Collection of Email	None.
ShippingAddress		Address	None.
Email	Email Address	string	None.
Fax	Fax	string	None.
Phone	Phone Number	string	None.
CountryCode		string	None.
Extension		string	None.
AddressLine1	Address Line 1	string	None.
AddressLine2	Address Line 2	string	None.
AddressLine3	Address Line 3	string	None.
AddressLine4	Address Line 4	string	None.
City	City	string	None.
State	State	string	None.
Zip	Zip	string	None.
County	County	string	None.
Country	Country	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.

{
  "MiddleName": "String Parameter 1",
  "LastName": "String Parameter 2",
  "NickName": "String Parameter 3",
  "PrefixId": 1,
  "SuffixId": 1,
  "GenderId": 1,
  "BirthDate": "2024/08/29 14:32:45",
  "ContactUniqueId": "String Parameter 4",
  "ContactSourceId": 1,
  "ContactName": "String Parameter 5",
  "Emails": [
    {
      "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
    },
    {
      "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
    }
  ],
  "ShippingAddress": {
    "AddressLine1": "String Parameter 1",
    "AddressLine2": "String Parameter 2",
    "AddressLine3": "String Parameter 3",
    "AddressLine4": "String Parameter 4",
    "PostalCode": "String Parameter 5",
    "City": "String Parameter 6",
    "County": "String Parameter 7",
    "Country": "String Parameter 8",
    "StateRegionProvince": "String Parameter 9",
    "AddressType": "String Parameter 10",
    "Plus4Code": "String Parameter 11",
    "SetAsMailing": true,
    "SameAsMailing": true,
    "AddressCategory": "String Parameter 14",
    "FormattedAddress": "String Parameter 15",
    "Id": 16,
    "RelatedToId": 1,
    "MergedWith_Or_Secondary_Id": 1,
    "MergeType": "String Parameter 17",
    "SortOrder": 1
  },
  "Email": "String Parameter 6",
  "Fax": "String Parameter 7",
  "Phone": "String Parameter 8",
  "CountryCode": "String Parameter 9",
  "Extension": "String Parameter 10",
  "AddressLine1": "String Parameter 11",
  "AddressLine2": "String Parameter 12",
  "AddressLine3": "String Parameter 13",
  "AddressLine4": "String Parameter 14",
  "City": "String Parameter 15",
  "State": "String Parameter 16",
  "Zip": "String Parameter 17",
  "County": "String Parameter 18",
  "Country": "String Parameter 19",
  "Id": 20,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 21",
  "SortOrder": 1
}

Create an Individual without address and contact information

In order to create an Individual without email, phone and address information pass the middle name, last name and contact name information, below is the sample:

{
  "MiddleName": "Sufuzi",
  "LastName": "Katyal",
  "ContactName":"Sufuzi katyal"
}

Create an Individual with extended information

We can create an individual with email, phone and address information, below is the sample:

{
  "MiddleName": "Ranjit",
  "LastName": "Katyal",
  "ContactSourceId": 17572,
  "ContactName": "Ranjit Katyal",
  "Email": "katyal.ranji@gmail.com",
  "Phone": "9624468722",
  "AddressLine1": "Block 101, 1205, near hawamahal",
  "AddressLine2": "Dheeraj",
  "City": "Ahmedabad",
  "State": "GJ",
  "Zip": "380008",
  "Country": "India"
}

Response Information

Resource Description

Contact Id

ITypedResponseOfNullableOfInt32

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

Response Formats

Sample not available.