admin/contact/syncrelations
Gets a list of relations for contacts.
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.
pass the paging parameter inside.
| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNo | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalRecords | integer |
None. |
|
| Criteria | PageInfo |
None. |
|
| ActiveRecords | integer |
None. |
|
| InActiveRecords | integer |
None. |
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
{
"PageNo": 1,
"PageSize": 2,
"TotalRecords": 3,
"Criteria": {},
"ActiveRecords": 4,
"InActiveRecords": 5
}
Response Information
Resource Description
A list of relationship group by contact id
ITypedResponseOfListOfContactRelationship| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | Collection of ContactRelationship |
None. |
|
| Category | string |
None. |
Response Formats
Sample not available.