Creating a quick organization

The API provides the feature to create an organization contact with minimal information required for the contact, in order to create an organization as contact pass the contact name with other information, we can 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.

Organization Contact

NameDescriptionTypeAdditional information
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.

{
  "ContactUniqueId": "String Parameter 1",
  "ContactSourceId": 1,
  "ContactName": "String Parameter 2",
  "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 3",
  "Fax": "String Parameter 4",
  "Phone": "String Parameter 5",
  "CountryCode": "String Parameter 6",
  "Extension": "String Parameter 7",
  "AddressLine1": "String Parameter 8",
  "AddressLine2": "String Parameter 9",
  "AddressLine3": "String Parameter 10",
  "AddressLine4": "String Parameter 11",
  "City": "String Parameter 12",
  "State": "String Parameter 13",
  "Zip": "String Parameter 14",
  "County": "String Parameter 15",
  "Country": "String Parameter 16",
  "Id": 17,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 18",
  "SortOrder": 1
}

Creating an organization with address and contact information

In order to add information like address, email and phone, see the below sample to create the one:

{
  "ContactName": "Vinayak Printies Media",
  "Email": "vinayak@printmedia.com",
  "Fax": "01478225533",
  "Phone": "01478225522",
  "AddressLine1": "Vinayak Plaza",
  "AddressLine2": "near shanti mandir",
  "AddressLine3": "Hawamahal Road",
  "City": "Udaipur",
  "State": "Rajasthan",
  "Zip": "312656",
  "Country": "India"
}

Response Information

Resource Description

Contact Id

ITypedResponseOfNullableOfInt32
NameDescriptionTypeAdditional information
Result

integer

None.

Category

string

None.

Response Formats

Sample not available.