Add Customer API
The Add Customer API will help you in creating/adding customer in the Kapture Database.
Last updated
The Add Customer API will help you in creating/adding customer in the Kapture Database.
Last updated
POST https://<sub domain>.kapturecrm.com/ms/customer/customer/api/v1/add-update
To access this API endpoint, you need to include your API key in the request headers. For authentication, use the following header:
The request body should be a JSON object containing the details of the customer to be added. Here are the list of parameters. Note:- Combination of name and phone or name and email is required to push customer data.
| Name | Mandatory | Type | Description |
|---|---|---|---|
Please map in the request body if there's any extra associate body according to your use case.
The API responds with a JSON object containing the details of the created customer. If successful, the response will include the customer ID and the other relevant information.
| Response | Response Messages |
|---|---|
| Error Codes | Description |
|---|---|
name
Yes
Text
Name of the Customer
phone
Yes
Number
Phone Number of the customer
Yes
String
Email Address of the customer
contact_person_phone
Yes
Number
One of the contact info is needed among the email and phone inside the contact_info JSON
contact_person_email
Yes
String
One of the contact info is needed among the email and phone inside the contact_info JSON
{ ..., "status": "success"}
Customer data pushed successfully.
{"message": "Invalid Auth Key","status": "failed"}
Authorization key is either not passed in header, or incorrect, or expired/disabled
{"message": "Name, Email Id, and Phone Number required", "status": "failed"}
name and phone|email are either missing or empty in request body.
400
Bad Request - Invalid parameters or missing data
401
Unauthorized - Invalid or missing API key
403
Forbidden - Insufficient permissions
404
Not Found - Resource or endpoint not found
500
Internal Server Error - Server-side issue