Creating an organization contact Post

The API provides the feature to create an organization with more extended information like address, email, phone and profile information, in order to create an organization we need to pass at least profile information. The API works as per duplicate prevention and if there is one exist, the new information will be attached to that existing organization.

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.

Contact Information of Organization

OrganizationContactInfo

Name	Description	Type	Additional information
ContactImageBase64		string	None.
ProfileInfo	Profile Information of the Organization	OrganizationContactProfile	None.
Employees		Collection of OrganizationEmployee	None.
PrimaryNPContact	Specifiy the Primary Non Profit Contact Information.	SearchableContact	None.
Salutations	Salutations for the Contact. Ignore setting values for 'Id' and 'RelatedToId' field.	Salutations	None.
PhotoUrl	Dont Set the Value for this field explicitly.	string	None.
MemorialDate	Memorial Date	date	None.
ContactSourceId	The Contact Source Id	integer	None.
CommonAddresses	Addresses for this contact	CommonAddresses	None.
CrucialInformation	Crucial Information	string	None.
ContactTags	List of Contact Tags. List of Tags can be obtained from Lookup query. For creating new tags, pass the same tag-name in 'Id' and 'Value' records of this collection object.	Collection of Object	None.
Communications	The Communication Media	CommunicationMedia	None.
SocialMedias	List of Social Medias associated with the Contact	Collection of Object	None.
ContactEngagements		Collection of EngagementDetail	None.
FinancialDetails		FinancialDetails	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.

{
  "ContactImageBase64": "String Parameter 1",
  "ProfileInfo": {
    "OrganizationName": "String Parameter 1",
    "WebsiteUrl": "String Parameter 2",
    "NoOfEmployees": 1,
    "YearFounded": 1,
    "JobContactInfo": {
      "JobTitle": "String Parameter 1",
      "ContactFor": "String Parameter 2"
    },
    "ContactSourceId": 1,
    "PrimaryNonProfitContactId": 1
  },
  "Employees": [
    {
      "Active": true,
      "ContactFor": "String Parameter 2",
      "ContactID": 3,
      "ContactName": "String Parameter 4",
      "CurrentOrganization": true,
      "Designation": "String Parameter 6",
      "Email": "String Parameter 7",
      "OrganizationName": "String Parameter 8",
      "OrgContactId": 9,
      "Phone": "String Parameter 10",
      "PhotoUrl": "String Parameter 11",
      "PrimaryContact": true
    },
    {
      "Active": true,
      "ContactFor": "String Parameter 2",
      "ContactID": 3,
      "ContactName": "String Parameter 4",
      "CurrentOrganization": true,
      "Designation": "String Parameter 6",
      "Email": "String Parameter 7",
      "OrganizationName": "String Parameter 8",
      "OrgContactId": 9,
      "Phone": "String Parameter 10",
      "PhotoUrl": "String Parameter 11",
      "PrimaryContact": true
    }
  ],
  "PrimaryNPContact": {
    "MiddleName": "String Parameter 1",
    "LastName": "String Parameter 2",
    "NickName": "String Parameter 3",
    "PrefixId": 1,
    "SuffixId": 1,
    "GenderId": 1,
    "BirthDate": "2024/08/29 13:43:12",
    "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
  },
  "Salutations": {
    "FormalSalutation": {
      "Id": "String Parameter 1",
      "Value": "String Parameter 2"
    },
    "InformalSalutation": {
      "Id": "String Parameter 1",
      "Value": "String Parameter 2"
    },
    "Id": 1,
    "RelatedToId": 1
  },
  "PhotoUrl": "String Parameter 3",
  "MemorialDate": "2024/08/29 13:43:12",
  "ContactSourceId": 1,
  "CommonAddresses": {
    "MailingAddress": {
      "VerificationDetails": {
        "Latitude": 1.1,
        "Longitude": 1.1,
        "CarrierRoute": "String Parameter 1",
        "DeliveryPointBarcode": "String Parameter 2",
        "AddressCensusStatistics": "String Parameter 4",
        "AddressJurisdictions": "String Parameter 5"
      },
      "AddressType": "Mailing",
      "AddressLine1": "String Parameter 2",
      "AddressLine2": "String Parameter 3",
      "AddressLine3": "String Parameter 4",
      "AddressLine4": "String Parameter 5",
      "PostalCode": "String Parameter 6",
      "City": "String Parameter 7",
      "County": "String Parameter 8",
      "Country": "String Parameter 9",
      "StateRegionProvince": "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
    },
    "BillingAddress": {
      "VerificationDetails": {
        "Latitude": 1.1,
        "Longitude": 1.1,
        "CarrierRoute": "String Parameter 1",
        "DeliveryPointBarcode": "String Parameter 2",
        "AddressCensusStatistics": "String Parameter 4",
        "AddressJurisdictions": "String Parameter 5"
      },
      "AddressType": "Billing",
      "AddressLine1": "String Parameter 2",
      "AddressLine2": "String Parameter 3",
      "AddressLine3": "String Parameter 4",
      "AddressLine4": "String Parameter 5",
      "PostalCode": "String Parameter 6",
      "City": "String Parameter 7",
      "County": "String Parameter 8",
      "Country": "String Parameter 9",
      "StateRegionProvince": "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
    },
    "OtherAddress": [
      {
        "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
      },
      {
        "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
      }
    ]
  },
  "CrucialInformation": "String Parameter 4",
  "ContactTags": null,
  "Communications": {
    "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
      }
    ],
    "Phones": [
      {
        "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
      },
      {
        "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
      }
    ],
    "Communication": {
      "PhoneCallPreference": true,
      "MailPreference": true,
      "EmailPreference": true,
      "Id": 1,
      "RelatedToId": 1,
      "MergedWith_Or_Secondary_Id": 1,
      "MergeType": "String Parameter 2",
      "SortOrder": 1
    }
  },
  "SocialMedias": null,
  "ContactEngagements": [
    {
      "TypeId": 1,
      "InteractionType": "String Parameter 1",
      "InteractionId": 2,
      "Title": "String Parameter 3",
      "Date": "2024/08/29 13:43:12",
      "Category": "String Parameter 5",
      "CategoryValue": "String Parameter 6",
      "ReferenceCategoryId": "String Parameter 7",
      "StatusId": 8,
      "StatusValue": "String Parameter 9",
      "UserId": "String Parameter 10",
      "User": "String Parameter 11",
      "ParentInteractionId": 1,
      "ReminderSet": true,
      "CommunicationType": "String Parameter 13",
      "ReminderDateTime": "2024/08/29 13:43:12",
      "ReminderValue": 1,
      "ReminderDurationId": 1,
      "ReminderDurationIdValue": "String Parameter 14",
      "ReminderOccurs": "String Parameter 15",
      "NotifyViaEmail": true,
      "Notes": [
        {
          "Id": 1,
          "Description": "String Parameter 2",
          "RelatedToId": 1,
          "Date": "2024/08/29 13:43:12",
          "User": "String Parameter 4"
        },
        {
          "Id": 1,
          "Description": "String Parameter 2",
          "RelatedToId": 1,
          "Date": "2024/08/29 13:43:12",
          "User": "String Parameter 4"
        }
      ],
      "InteractionContacts": [
        {
          "ContactId": 1,
          "RelatedToId": 1
        },
        {
          "ContactId": 1,
          "RelatedToId": 1
        }
      ],
      "PriorityId": 17
    },
    {
      "TypeId": 1,
      "InteractionType": "String Parameter 1",
      "InteractionId": 2,
      "Title": "String Parameter 3",
      "Date": "2024/08/29 13:43:12",
      "Category": "String Parameter 5",
      "CategoryValue": "String Parameter 6",
      "ReferenceCategoryId": "String Parameter 7",
      "StatusId": 8,
      "StatusValue": "String Parameter 9",
      "UserId": "String Parameter 10",
      "User": "String Parameter 11",
      "ParentInteractionId": 1,
      "ReminderSet": true,
      "CommunicationType": "String Parameter 13",
      "ReminderDateTime": "2024/08/29 13:43:12",
      "ReminderValue": 1,
      "ReminderDurationId": 1,
      "ReminderDurationIdValue": "String Parameter 14",
      "ReminderOccurs": "String Parameter 15",
      "NotifyViaEmail": true,
      "Notes": [
        {
          "Id": 1,
          "Description": "String Parameter 2",
          "RelatedToId": 1,
          "Date": "2024/08/29 13:43:12",
          "User": "String Parameter 4"
        },
        {
          "Id": 1,
          "Description": "String Parameter 2",
          "RelatedToId": 1,
          "Date": "2024/08/29 13:43:12",
          "User": "String Parameter 4"
        }
      ],
      "InteractionContacts": [
        {
          "ContactId": 1,
          "RelatedToId": 1
        },
        {
          "ContactId": 1,
          "RelatedToId": 1
        }
      ],
      "PriorityId": 17
    }
  ],
  "FinancialDetails": {
    "FirstGiftAmount": 1.0,
    "FirstGiftDate": "2024/08/29 13:43:12",
    "LastGiftAmount": 2.0,
    "LastGiftDate": "2024/08/29 13:43:12",
    "TotalGiftAmount": 3.0,
    "AverageGiftAmount": 4.0,
    "MostCommonGiftAmount": 5.0,
    "DonorRecencyInDays": 6,
    "DonorRecencyInMonths": 7,
    "LargetsGiftAmount": 8.0,
    "NoOfGifts": 9,
    "TotalAmount": 10.0,
    "TotalCredit": 11.0,
    "TotalPaid": 12.0,
    "TotalDue": 13.0,
    "TotalDiscount": 14.0
  },
  "Id": 6,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 7",
  "SortOrder": 1
}

Creating organization Individual

Below is the sample to create an organization contact:

{
  "ProfileInfo": {
    "OrganizationName": "Fundly",
    "WebsiteUrl": "http://www.fundly.com",
    "NoOfEmployees": 100,
    "YearFounded": 2005,
    "JobContactInfo": {
    "JobTitle": "Attender",
    "ContactFor": "Meena J S V",
     "RelatedToId":0
    }
  },
  "ContactSourceId": 2,
  "CommonAddresses": {
    "MailingAddress": {
      "AddressType": "Mailing",
      "AddressLine1": "Address 1",
      "AddressLine2": "Address 2",
      "AddressLine3": "Address 3",
      "PostalCode": "380008",
      "City": "Ahmedabad",
      "Country": "India",
      "StateRegionProvince": "GJ",
        "RelatedToId":0
    },
    "BillingAddress": {
      "SameAsMailing": true,
      "AddressType": "Mailing",
      "AddressLine1": "Address 1",
      "AddressLine2": "Address 2",
      "AddressLine3": "Address 3",
      "PostalCode": "380008",
      "City": "Ahmedabad",
      "Country": "India",
      "StateRegionProvince": "GJ",
      "RelatedToId":0
    }
  },
  "Communications": {
    "Emails": [
      {
        "EmailTypes": [
          {
            "Id": 66,
            "Value": "Office"
          }
        ],
        "Usage": {
          "IsPrimary": true,
          "UsedForCommunication": true
        },
        "EmailId": "fundly.iqr@gmail.com",
        "RelatedToId":0
      }
    ],
    "Phones": [
      {
        "Usage": {
          "IsPrimary": true,
          "UsedForCommunication": true,
          "SameHousehold": true
        },
        "PhoneTypes": [
          {
            "Id": 2090,
            "Value": "Business"
          },
          {
            "Id": 2091,
            "Value": "Mobile"
          }
        ],
        "PhoneNumber": "079-25878887",
        "CountryCode": "IN",
        "Extension": "0422",
        "RelatedToId":0
      }
    ],
    "Communication": {
      "PhoneCallPreference": true,
      "MailPreference": true,
      "EmailPreference": true,
      "RelatedToId":0
    }
  }
}

Response Information

Resource Description

ITypedResponse with list of all IDs and their respective Values that were generated while saving this contact be wrapped inside.

ITypedResponseOfListOfGenericKeyValueOfStringAndString

Name	Description	Type	Additional information
Result		Collection of GenericKeyValueOfStringAndString	None.
Category		string	None.

Response Formats

Sample not available.