Syncs list of contacts for a client in bulk.

The API provides feature to sync contact associated with a client, the API requires no other parameter than pagination parameter and hence will return all the contact as once or depends on pagination, we recommend to use 1000 as maximum page size and divide the sync in multiple calls.

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.

NameDescriptionTypeAdditional information
PageNo

integer

None.

PageSize

integer

None.

TotalRecords

integer

None.

Criteria

SearchContact

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": {
    "ContactTypeIds": [
      1,
      2
    ],
    "ContactGroupType": 0,
    "ContactId": 1
  },
  "ActiveRecords": 4,
  "InActiveRecords": 5
}

Response Information

Resource Description

A list of contacts with basic info

ITypedResponseOfListOfContactBasic
NameDescriptionTypeAdditional information
Result

Collection of ContactBasic

None.

Category

string

None.

Response Formats

Sample not available.