Update Customer API
The Update Customer API will help you in updating the existing customer details in the Kapture Database.
Update Customer.
POST
https://<sub domain>.kapturecrm.com/ms/customer/customer/api/v1/add-update
Authentication:
To access this API endpoint, you need to include your API key in the request headers. For authentication, use the following header:
Request Body
The request body should be a JSON object containing the details of the customer to be updated. Here are the list of parameters.
Name | Mandatory | Type | Description |
---|---|---|---|
customer_id | Yes | Number | The Id of the customer which is generated in Kapture Database |
name | No | Text | Name of the customer |
No | String | Email Address of the customer | |
phone | No | Number | Phone number of the customer |
Please map in the request body if there's any extra associate body according to your use case.
Response Body
The API responds with a JSON object containing the details of the updated customer. If successful, the response will include the customer ID and the other relevant information.
Response | Response Messages |
---|---|
{ ..., "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. |
Error Codes
Error Codes | Description |
---|---|
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 |
Example of a working curl
Last updated