Creating a children relationship Post

The API provides feature for creating a children relationship with some existing contact or new contact, in order to create a relationship with the contact which does not exist in the system, pass the full information(middle name, last name and contact name is required) including phone, email and address. Please note the API works based on duplicate prevention setting and if there is existing information in system, the relationship will be established with that existing contact only and no new contact will be created.

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.

A Generic List with Ids as RelationIDs of every relationship record

None.

Request Format

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

Creating children relationships with new contact

In order to create children relationships with a new contacts, we need to pass at least last name, middle name(Full information can be added to new contact and that all will be attached to contact, for more information refer creating a quick individual contact) and contact name, below is the sample:

[{
  "RelationshipContact": {
    "MiddleName": "Vinu",
    "LastName": "Laurence",
    "ContactName": "Vinu Laurence",
    "RelatedToId": 9831292
  },
  "SharingInfo": {
    "SharedWithPrimaryContact": true,
    "ShareWithHousehold": true
  }
}]

Creating children relationships with existing contacts

In order to create children relationships with existing contact, we need to pass the existing contact id in MergedWith_Or_Secondary_Id in RelationshipContact object, below is the example:

[{
    "RelationshipContact": {
    "MiddleName": "Vinu",
    "MergedWith_Or_Secondary_Id":9831261, -- Secondary contact
    "LastName": "Laurence",
     "ContactName": "Vinu Laurence",
    "RelatedToId": 9831292 -- Primary contact
  },
  "SharingInfo": {
    "SharedWithPrimaryContact": true,
    "ShareWithHousehold": true
  }
}]

Response Information

Resource Description

ITypedResponse with list of key value as child relation id(If any new created) be wrapped inside

Response Formats