Login Contact Us Support Partner With Us
INTRODUCTION API AUTHENTICATION CUSTOMER LEADS TICKETS ORDER API PRODUCT API WEBHOOKS API FAQ CATEGORY API
Enquiry Push API Enquiry PULL API Update Enquiry API Enquiry Reject API

Enquiry Push API

PURPOSE

Enquiry push API will push the data of Enquiry 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 Enquiry API > Click on Enquiry 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
Enquiry API 3 Enquiry API 1 Enquiry API 2 Enquiry API 2

SAMPLE REQUEST URL

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

DATA FORMAT

[
   {
         "customer_name":"rahul",
         "phone":"1234567890",
         "email_id":"abc@gmail.com",
         "customer_id":"",
         "campaign_name":"website",
         "secSource":"",
         "tertSource":"",
         "product_details":[
               {
                  "product_name":"abc",
                  "rate":"100",
                  "quantity":"1"
               }
         ]
   }
];

DUPLICATE LEAD RESPONSE

{
   "message":"Lead already exists, Customer ID :45759542, Enquiry ID :10934634, Contact ID : 49560612",
   "status":"failed"
};

SUCCESS RESPONSE

{
   "Enquiry Id":"11606498",
   "Assigned Employee Code":"3476",
   "message":"Duplicate Enquiry Name : N/A , Phone : 1234567890 , Email : N/A !! ",
   "Kapture Customer Id":"48047507",
   "status":"success"
};

FAILURE RESPONSE

{
   "Message": "Name, Email Id,  and Phone Number, Or Enquiry Id 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, Auth key should not be expired

Enquiry PULL API

PURPOSE

Enquiry pull API used to push the data from Kapture to customer database. Start date and end date to be mandatory if the enquiry id is not passed.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Enquiry API > Click on Enquiry 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
Select API 1 Select API 4 Select API 2 Select API 3

SAMPLE REQUEST URL

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

DATA FORMAT

[
   {
         "enquiry_id":"293312",
         "start_date":"2016-03-31",
         "end_date":"2016-03-31",
         "sortOnModificationDate":"false",
         "numberOfRecords":"10",
         "startPosition":"10",
         "includeHistory":"false"
   }
];

SUCCESS RESPONSE

{
   "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

Update Enquiry API

PURPOSE

Update Enquiry API used to pass the information to update existing customer details. Name, Enquiry id, 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 Enquiry API > Click on Update Enquiry 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
Search API 1 Search API 2 Search API 3 Search API 4

SAMPLE REQUEST URL

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

DATA FORMAT

[
   {
      "customer_name":"rahul",
      "phone":"1234567890",
      "email_id":"abc@gmail.com",
      "enquiry_id":"12345",
      "city":"Bangalore",
      "country":"India",
      "customer_code":"1",
      "state":"Karanataka",
      "type":"t",
      "classification":"abc",
      "zone_id":"2",
      "product_details":[
            {
               "product_name":"abc",
               "product_type":"",
               "rate":"100",
               "quantity":"1",
               "discount":""
            }
      ]
   }
];

SUCCESS RESPONSE

{
   "status":"success"
}

FAILURE RESPONSE

{
   "Message": "Error in executing this... Please try again later...",
   "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

Enquiry Reject API

PURPOSE

Enquiry Reject API used to reject the existing leads from the system. Enquiry id and remarks to be mandatory field

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Enquiry API > Click on Enquiry Reject 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
Update API 1 update API 2 Update API 3 Update API 4

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/reject-enquiry.html

DATA FORMAT

[
   {
      "enquiry_id":"11514210",
      "remark":"test enquiry"
   }
]

SUCCESS RESPONSE

{
   "message": "The enquiry has been rejected successfully.",
   "status": "success"
}

FAILURE RESPONSE

{
   "Message": "Enquiry Id Not Provided",
   "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
  • Andriod Application
  • I-Phone Application
  • Review Kapture CRM on G2
  • GDPR
  • HIPAA
  • ISO
Google Launch Pad
© 2023 KAPTURE - ALL RIGHTS RESERVED Privacy Policy
SCHEDULE A DEMO