Contact Center CRM Services for Call Center Solutions

Customer Push API Customer Pull API Get Customer Update Customer

Customer Push API

PURPOSE

Customer push API will push the data of Customer details into the database. Name, phone & Email should be mandatory field, rest of the additional fields can be used based on required to push the data.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

Click on configuration > Partner configuration > API’s configurations > Select Customer API > Click on Customer Push API > enter the API name to create API request and Key expiry date.
Select Mandatory required fields along with additional required parameters to generate the URL.
Each API request will be created along with “Auth Key” to pass the URL

REQUEST PARAMETERS

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/add-update-customer-from-other-source.html

DATA FORMAT

[
        { 
            "name":"Cerk",
            "phone":"3698541248",
            "email":"cr@gmail.com",
            "city":"Bangalore",
            "country":"India",
            "customer_code":"1",
            "state":"Karanataka",
            "type":"t",
            "classification":"abc",
            "zone":"India",
            "address":"Domlur",
            "date_of_birth":"YYYY-MM-DD",
            "anniversary_date":"YYYY-MM-DD",
            "primary_source":"linkedin",
            "website":"https://www.kapturecrm.com/",
            "assigned_to":"ashish@adjetter.com",
            "board_line_no":"88-8808",
            "remarks":"test"
        }
]

SUCCESS RESPONSE

{
   "Message": "Customer Added Successfully",
   "Kapture Customer Id": "48338968",
   "Status": "Success"
};

FAILURE RESPONSE

{
   "Message": "Invalid Auth Key",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages	Description
AuthKeyInvalid	Please use correct Authkey
ServerFailure	Server error while processing this request
ReqFieldMissing	Mandatory field missing
APIExpired	API Request is Expired

ADDITIONAL NOTES

While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
You must have permission to access API service
You must have a valid Auth Key to send the Request, Auth key should not be expired

CUSTOMER PULL API

PURPOSE

Customer Pull API is used to push the data from Kapture to customer database. Name, phone & Email should be mandatory field, rest of the additional fields can be used based on required to push the data.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

Click on configuration > Partner configuration > API’s configurations > Select Customer API > Click on Customer Pull API > enter the API name to create API request and Key expiry date.
Select Mandatory required fields along with additional required parameters to generate the URL.
Each API request will be created along with “Auth Key” to pass the URL

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/select-customer-between-start-and-end-dates.html

DATA FORMAT

{
   "start_date":"2016-03-31",
   "end_date":"2016-03-31"
}

SUCCESS RESPONSE

{
   "message": [
      {
      "id": 287230,
      "cmId": 396,
      "isOrganization": false,
      "name": "Chandran",
      "address": "No. 25,Virrudhi Complex, Leela Palace Road, Domlur , ",
      "state": "Karnataka",
      "currentStatus": "N",
      "generationDate": "Apr 29, 2016 10:37:14 PM",
      "creatorId": 0,
      "channelPartnerId": 0,
      "ratePlanId": 0,
      "isChannelPartner": false,
      "pinCode": "560009",
      "campaignId": 0,
      "campaignItemId": 0,
      "campaignActivityId": 0,
      "totalNoOfEnquiries": 1,
      "feedbackOnCustomer": "0",
      "contacts": [
               {
                     "id": 365799,
                     "cmId": 396,
                     "leadId": 287230,
                     "contactPerson": "Chandran ",
                     "gender": "Male",
                     "phone": "999999100",
                     "email": "help@adjetter.in",
                     "isPrimaryContact": true,
                     "isActive": true,
                     "generationDate": {
                           "year": 2016,
                           "month": 3,
                           "dayOfMonth": 29,
                           "hourOfDay": 22,
                           "minute": 37,
                           "second": 14
                     },
                     "parentContactId": 0,
                     "subOfficeId": 0,
                     "creatorId": 0,
                     "age": 0,
                     "maritalStatus": " ",
                     "isGuest": false,
                     "enquiryId": 0
               }
      ],
      "imageReferenceId": "CUS_2016-04-29 22:37:14.259",
      "customerLevel": 0,
      "zone": 0,
      "companyParentId": 0,
      "assignedToId": 0,
      "maxCreditAmt": 0.0,
      "maxCreditPeriod": 0,
      "historyEmpId": 0,
      "channelPartnerEmpId": 0,
      "deleted": false,
      "companyStatus": "A",
      "isExistingCustomer": false,
      "isExistingContact": false,
      "syncStatus": false,
      "syncdLocationId": "0",
      "crossRemarks": "",
      "syncedStepNumber": 0,
      "outStandingAmount": 0.0,
      "salesAdminZone": 0,
      "referralId": 0
      },
   ],
   "status": "success"
}

FAILURE RESPONSE

{
   "Message": "No customer between dates.",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages	Description
AuthKeyInvalid	Please use correct Authkey
ServerFailure	Server error while processing this request
ReqFieldMissing	Mandatory field missing
APIExpired	API Request is Expired

ADDITIONAL NOTES

While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
You must have permission to access API service
You must have a valid Auth Key to send the Request, Auth key should not be expired

GET CUSTOMER API

PURPOSE

Retrieve a list of customers. To get the details of a customer referred to by a specified fields the customer object provides access to customer details stored in the system. To retrieve information on a specific customer, you should ideally use the customer ID in a. In this case, the customer information will be returned as “customer” in the JSON response.

If you do not have the customer ID stored, you can also look up customers based on indexed field, Customer Code. These must be an exact match, but can return multiple results on non-unique fields such as the customer name. The results will be stored in the “customers” object in the JSON response.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

Click on configuration > Partner configuration > API’s configurations > Select Customer API > Click on Get customer > enter the API name to create API request and Key expiry date.
Select Mandatory required fields along with additional required parameters to generate the URL.
Each API request will be created along with “Auth Key” to pass the URL

REQUEST PARAMETERS

Parameter	Data Type	Description
Customer ID *	String	Required field to Search the Customer data

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/search-customer-by-customer-id.html

DATA FORMAT

[
   {
         "kapture_customer_id":"123232",
         "customer_id":"",
         "email_id":"abc@gmail.com",
         "phone":"123456789"
   }
]

SUCCESS RESPONSE

{
   "Cutomer Details":{
      "id":"48330579",
      "cmId":"7168",
      "isOrganization":"false",
      "name":"Andrew Shaw",
      "companyPhone":"",
      "website":"",
      "address":"T72/A Hauz Khas Village new Delhi",
      "state":"New Delhi",
      "city":"Delhi",
      "country":"India"
   },
   "status":"success"
}

FAILURE RESPONSE

{
   "Customer Details": "Information given by you does not exist in our sytsem.",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages	Description
AuthKeyInvalid	Please use correct Authkey
ServerFailure	Server error while processing this request
ReqFieldMissing	Mandatory field missing
APIExpired	API Request is Expired

ADDITIONAL NOTES

While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
You must have permission to access API service
You must have a valid Auth Key to send the Request, Auth key should not be expired

UPDATE CUSTOMER API

PURPOSE

Update customer API is to pass the information to update existing customer details . Name, phone & Email should be mandatory field, rest of the additional fields can be used based on required to push the data.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

Click on configuration > Partner configuration > API’s configurations > Select Customer API > Click on update customer > enter the API name to create API request and Key expiry date.
Select Mandatory required fields along with additional required parameters to generate the URL.
Each API request will be created along with “Auth Key” to pass the URL

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/add-update-customer-from-other-source.html

DATA FORMAT

{
   "customer_id":"272930",
   "name":"rahul",
   "email":"xyz@gmail.com",
   "phone":"1234567890",
   "city":"Bangalore",
   "country":"India",
   "customer_code":"1",
   "state":"Karanataka",
   "type":"t",
   "classification":"abc",
   "zone":"India",
   "address":"Domlur",
   "date_of_birth":"YYYY-MM-DD",
   "anniversary_date":"YYYY-MM-DD",
}

SUCCESS RESPONSE

{
      "message":"Customer Updated Successfully",
      "Kapture Customer Id":"48047507",
      "status":"success"
}

FAILURE RESPONSE

{
   "message":"Name, Email Id, and Phone Number required",
   "status":"failed"
};

ERROR MESSAGES

Error Messages	Description
AuthKeyInvalid	Please use correct Authkey
ServerFailure	Server error while processing this request
ReqFieldMissing	Mandatory field missing
APIExpired	API Request is Expired

ADDITIONAL NOTES

While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
You must have permission to access API service
You must have a valid Auth Key to send the Request

SCHEDULE A DEMO

Start Ups

Large Enterprise

Hotels

Travel

E-Commerce

Healthcare

Education

Real Estate

Retail

FMCG

Pharma

Media

BFSI

Cruise Management

Airlines Management

By Business Type

By Industry

Retail

Service

Operations

Sales

Customer Push API

PURPOSE

API CONFIGURATION

REQUEST PARAMETERS

SAMPLE REQUEST URL

DATA FORMAT

SUCCESS RESPONSE

FAILURE RESPONSE

ERROR MESSAGES

ADDITIONAL NOTES

CUSTOMER PULL API

PURPOSE

API CONFIGURATION

SAMPLE REQUEST URL

DATA FORMAT

SUCCESS RESPONSE

FAILURE RESPONSE

ERROR MESSAGES

ADDITIONAL NOTES

GET CUSTOMER API

PURPOSE

API CONFIGURATION

REQUEST PARAMETERS

SAMPLE REQUEST URL

DATA FORMAT

SUCCESS RESPONSE

FAILURE RESPONSE

ERROR MESSAGES

ADDITIONAL NOTES

UPDATE CUSTOMER API

PURPOSE

API CONFIGURATION

SAMPLE REQUEST URL

DATA FORMAT

SUCCESS RESPONSE

FAILURE RESPONSE

ERROR MESSAGES

ADDITIONAL NOTES

Our Products

Resources

Features

Industries

Contact Us