ADD CUSTOMER API

PURPOSE

Add customer 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 > API Configuration > Select Customer API > Click on Add Customer API > enter the API name to create API request
  • Select Mandatory required field as mentioned above along with additional required parameters to generate the URL.
  • Assign the Auth Key to API before generating the code
  • Created API will be added in “API Information” Section
  • Each API request will be created along with “Auth Key” to pass the URL

REQUEST PARAMETERS

Parameter Data Type Description
Name* varchar Required field to update the Customer Name
Email* varchar Required field in specified data type to update customer Email address
Phone* string Required field in specified format to Mobile number / Phone Number Details
Country varchar Country of the Customer
Customer Code string Customer Code
State string State of the Customer
City string City of the Customer
Type char
Classification string
Zone string
Address string
DateOfBirth Date(YYYY-MM-DD)
AnniversaryDate Date(YYYY-MM-DD)

SAMPLE REQUEST URL

http://sales1.kapturecrm.com/add-update-customer-from-other-source.html

DATA FORMAT

JSON Format

{"name":"rahul","phone":"1234567890","email":"abc@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"}

SUCCESS RESPONSE

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

FAILURE RESPONSE

{ 
"Message": "Message Key Expired",
"Status": "Fail"
}

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

SELECT CUSTOMER API

PURPOSE

To retrieve information on a specific customer, you should feed requests must specify a beginning date and ending date range, the customer information will be returned as “customer” in the JSON response.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > API Configuration > Select Customer API > Click on Add Customer API > enter the API name to create API request
  • Select Mandatory required field as mentioned above along with additional required parameters to generate the URL.
  • Assign the Auth Key to API before generating the code
  • Created API will be added in “API Information” Section
  • Each API request will be created along with “Auth Key” to pass the URL

REQUEST PARAMETERS

Parameter Data Type Description
Start Date* datetime Start Date to be used to filter the customer added dated. Date which should be in following format. YYYY-MM-DD hh:mm:ss and its mandatory field
End Date* datetime End Date to be used to search the customer data. Date which should be in following format. YYYY-MM-DD hh:mm:ss and its mandatory field
Customer ID* String Required field to Search the Customer data

SAMPLE REQUEST URL

http://sales1.kapturecrm.com/select-customer-between-start-and-end-dates.html

DATA FORMAT

JSON 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": "Auth Key Expired",
"Status": "Fail"
}

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

SEARCH 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 > API Configuration > Select Customer API > Click on Search Customer Menu > enter the API name to create API request
  • Assign the Auth Key to API before generating the code
  • Created API will be added in “API Information” Section
  • 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

http://sales1.kapturecrm.com/search-customer-by-customer-id.html

DATA FORMAT

JSON Format

{"customer_id":"272930"}

SUCCESS RESPONSE

{"message":[{"id":286829,"cmId":396,"isOrganization":false,"name":"Nikesh", "address":"","state":"karnataka","city":"bangalore","country":"india","currentStatus":"N","generationDate":"Mar 3, 2016 1:38:59 PM","creatorId":0,"channelPartnerId":0,"ratePlanId":0, "isChannelPartner":false,"pinCode":"","campaignId":0, "campaignItemId":0,"campaignActivityId":0,"totalNoOfEnquiries":1, "feedbackOnCustomer":"0","contacts":[{"id":365384,"cmId":396,"leadId":286829, "contactPerson ":"nikesh","gender":" ","phone":"999999911","email":"help@kapturecrm.com","isPrimaryContact":true,"isActive":true, "generationDate":{"year":2016, "month":2,"dayOfMonth":3, "hourOfDay":13,"minute":38,"second":59}, "parentContactId":0,"subOfficeId":0, "creatorId":0, "age":0,"maritalStatus":" ","isGuest":false, "enquiryId":0},{"id":365448,"cmId":396,"leadId":286829,"contactPerson":"nikesh","gender":" ","phone":"8867148604", "email":"test@kapturecrm.com", "isPrimaryContact":true,"isActive":true,"generationDate":{"year":2016, "month":3,"dayOfMonth":15,"hourOfDay":13,"minute":43,"second":33}, "parentContactId":0,"subOfficeId":0,"creatorId":0,"age":0,"maritalStatus":" ","isGuest":false,"enquiryId":0}],"imageReferenceId":"CUS_2016-03-03 13:38:59.631","classification":"","customerType":"t", "customerLevel":0,"zone":2,"companyParentId":0,"assignedToId":0, "maxCreditAmt":0,"maxCreditPeriod":0,"historyEmpId":0,"channelPartnerEmpId":0, "deleted":false,"companyStatus":"A","isExistingCustomer":false, "syncStatus":false, "syncdLocationId":"0","crossRemarks":"","syncedStepNumber":0,"outStandingAmount":0,"salesAdminZone":0,"referralId":0,"status":"success"}]}

FAILURE RESPONSE

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

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

UPDATE CUSTOMER API

PURPOSE

To update customer data points to widgets using our customer push API. Data is sent using an HTTP POST request with data in JSON format. you should ideally use the customer ID in a. In this case, after successful updated will give the Updated information status in JSON response.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > API Configuration > Select Customer API > Click on Update Customer Menu > enter the API name to create API request
  • Select Mandatory required field as mentioned above along with additional required parameters to generate the URL.
  • Assign the Auth Key to API before generating the code
  • Created API will be added in “API Information” Section
  • 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 update the Customer data, should specify the Customer ID
Name* varchar Customer Name (optional)
Email* varchar Customer Email address should be in specified data type (optional)
Phone* string Customer Mobile number / Phone Number Details (optional)
Country varchar Country of the Customer (optional)
State varchar State of the Customer (optional)
City varchar City of the Customer (optional)
Type char Customer type (optional)
Zone Integer Zone to push update the Country Detail (optional)

SAMPLE REQUEST URL

http://sales.adjetter.com/add-update-customer-from-other-source.html

DATA FORMAT

JSON Format

{
"customer_id":"272930","name":"rahul","phone":"1234567890","email":"abc@gmail.com","city":"bangalore","country":"india","customer_code ":"1","state":"karanataka","Field 1":"","ad":"","role":"","Field 2":""
}

SUCCESS RESPONSE

{
{"message": "Customer Updated Successfully""status": "success"
}

FAILURE RESPONSE

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

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

ADD MORE CUSTOMER API

PURPOSE

Add more customer 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 > API Configuration > Select Customer API > Click on Add more Customer API > enter the API name to create API request
  • Select Mandatory required field as mentioned above along with additional required parameters to generate the URL.
  • Assign the Auth Key to API before generating the code
  • Created API will be added in “API Information” Section
  • Each API request will be created along with “Auth Key” to pass the URL

REQUEST PARAMETERS

Parameter Data Type Description
Contact Person* varchar Required field to update the Customer Name
Email* varchar Required field in specified data type to update customer Email address
Phone* string Required field in specified format to Mobile number / Phone Number Details
Additional Email varchar Country of the Customer
Additional Phone varchar State of the Customer
Designation varchar City of the Customer
Gender Char Gender of the Customer
Age Integer Age of the Customer
Marital Status Char Marital Status of the Customer

SAMPLE REQUEST URL

http://sales1.kapturecrm.com/add-more-contacts-for-existing-customer.html

DATA FORMAT

JSON Format

{"name":"adjetter","phone":"1234567890","email":"help@adjetter.com"}

SUCCESS RESPONSE

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

FAILURE RESPONSE

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

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