Enkash Developer Portal
Home
Home
Login
  1. Customer Apis
  • Back to home
  • Account Receivable APIs
  • Get Authentication Token Copy
    • Get Authentication Token
  • Customer Management
    • Customer Apis
      • Activate customer
        PUT
      • createBulkCustomer
        POST
      • bulkUpdate
        POST
      • Deactivate customer
        PUT
      • deleteCustomerByCustomerId
        DELETE
      • updateCustomer
        PATCH
  • Customer Contacts Management
    • Customer Apis
      • getCustomerContactDetails
  • Invoice Management
    • invoice-controller
      • createInvoice
      • invoiceBulkUpload
      • Dispatch Invoice Collection
      • Delete Invoice Collection
      • searchCollectionInvoices
      • getInvoice
      • updateInvoice
  • Payment Reminders
    • customer-reminder-controller
      • createCustomerReminder
      • getCustomerReminders
      • getCustomerReminder
      • deleteReminder
      • updateCustomerReminder
  • Bharat Connect 2.0 AR
    • Payment Confirmation Request
    • Change Invoice Status Request
    • Bulk Create Invoice
  1. Customer Apis

updateCustomer

PATCH
/api/v0/customer/{customerId}

Request

Path Params
customerId
string 
required
customerId
Match pattern:
^KC[A-Z0-9]{14}$
Query Params
parentCompanyId
string 
optional
parentCompanyId
Match pattern:
^CEK[A-Z0-9]{7}$
Body Params application/json
accountNumber
object (JsonNullable«string») 
optional
Unique account number for the customer
address
object (JsonNullable«string») 
optional
Physical address of the customer
assignedAgent
object (JsonNullable«string») 
optional
Name of the agent assigned to the customer
branchCodes
object (JsonNullable«List«string»») 
optional
Codes of branches associated with the customer
contactNumber
object (JsonNullable«string») 
optional
Contact number of the customer
customerId
object (JsonNullable«string») 
optional
Unique identifier for the customer
customerKeyContacts
object (JsonNullable«List«CustomerKeyContactCreateDTO»») 
optional
Key contact persons for the customer
customerReminders
object (JsonNullable«List«CustomerReminderCreateDTO»») 
optional
Reminders for the customer
ifsc
object (JsonNullable«string») 
optional
IFSC code for the customer's bank
legalName
object (JsonNullable«string») 
optional
Legal name of the customer
panOrGstin
object (JsonNullable«string») 
optional
PAN or GSTIN of the customer
pinCode
object (JsonNullable«string») 
optional
PIN code of the customer's address
state
object (JsonNullable«string») 
optional
State of the customer's address
uniqueRefNo
object (JsonNullable«string») 
optional
Unique reference number for the customer
Example
{
    "accountNumber": {},
    "address": {},
    "assignedAgent": {},
    "branchCodes": {},
    "contactNumber": {},
    "customerId": {},
    "customerKeyContacts": {},
    "customerReminders": {},
    "ifsc": {},
    "legalName": {},
    "panOrGstin": {},
    "pinCode": {},
    "state": {},
    "uniqueRefNo": {}
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://test.your-api-server.com/api/v0/customer/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountNumber": {},
    "address": {},
    "assignedAgent": {},
    "branchCodes": {},
    "contactNumber": {},
    "customerId": {},
    "customerKeyContacts": {},
    "customerReminders": {},
    "ifsc": {},
    "legalName": {},
    "panOrGstin": {},
    "pinCode": {},
    "state": {},
    "uniqueRefNo": {}
}'

Responses

🟢200OK
application/json
Body
errorResponse
object (ErrorResponse) 
optional
apiSubErrors
array[object (ApiSubError)] 
optional
errorMessage
string 
optional
errorType
enum<string> 
optional
Allowed values:
CLIENT_REQUEST_ABORTCLIENT_REQUEST_ERRORINVALID_ACCESSRECORD_NOT_FOUNDSYSTEM_ERRORUNAUTHORIZEDUNKNOWN_ERRORUNPROCESSABLE_REQUESTVALIDATION_ERROR
requestId
string 
optional
timestamp
string 
optional
Example:
yyyy-MM-dd HH:mm:ss
payload
object (CustomerResponse) 
optional
accountNumber
string 
optional
active
boolean 
optional
address
string 
optional
assignedAgent
string 
optional
bankName
string 
optional
branchCodes
array[string]
optional
companyId
string 
optional
contactEmail
string 
optional
contactNumber
string 
optional
createdBy
string 
optional
createdByName
string 
optional
createdOn
string <date-time>
optional
customerId
string 
optional
customerKeyContacts
array[object (CustomerKeyContactResponse) {14}] 
optional
customerLogo
string 
optional
customerReminders
array[object (CustomerReminderConfigResponse) {7}] 
optional
dsoMedian
integer <int64>
optional
id
integer <int64>
optional
ifsc
string 
optional
legalName
string 
optional
modifiedBy
string 
optional
modifiedByName
string 
optional
modifiedOn
string <date-time>
optional
netAmount
number 
optional
panOrGstin
string 
optional
parentCompanyId
string 
optional
parentLegalName
string 
optional
pinCode
string 
optional
state
string 
optional
uniqueRefNo
string 
optional
warnings
array[string]
optional
response_code
integer <int32>
optional
response_message
string 
optional
Example
{
    "errorResponse": {
        "apiSubErrors": [
            {}
        ],
        "errorMessage": "string",
        "errorType": "CLIENT_REQUEST_ABORT",
        "requestId": "string",
        "timestamp": "yyyy-MM-dd HH:mm:ss"
    },
    "payload": {
        "accountNumber": "string",
        "active": true,
        "address": "string",
        "assignedAgent": "string",
        "bankName": "string",
        "branchCodes": [
            "string"
        ],
        "companyId": "string",
        "contactEmail": "string",
        "contactNumber": "string",
        "createdBy": "string",
        "createdByName": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "customerId": "string",
        "customerKeyContacts": [
            {
                "createdBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "customerId": "string",
                "customerName": "string",
                "deleted": "string",
                "email": "string",
                "keyContactPersonId": "string",
                "mail_enabled": true,
                "mobile": "string",
                "modifiedBy": "string",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "name": "string",
                "sms_enabled": true,
                "whatsapp_enabled": true
            }
        ],
        "customerLogo": "string",
        "customerReminders": [
            {
                "customerId": "string",
                "customerReminderId": "string",
                "dueDateDifference": 0,
                "reminderInterval": 0,
                "reminderTime": "HH:mm",
                "reminderType": "ONCE",
                "stage": "string"
            }
        ],
        "dsoMedian": 0,
        "id": 0,
        "ifsc": "string",
        "legalName": "string",
        "modifiedBy": "string",
        "modifiedByName": "string",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "netAmount": 0,
        "panOrGstin": "string",
        "parentCompanyId": "string",
        "parentLegalName": "string",
        "pinCode": "string",
        "state": "string",
        "uniqueRefNo": "string",
        "warnings": [
            "string"
        ]
    },
    "response_code": 0,
    "response_message": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Request
🔴500Server Error
Modified at 2025-07-07 18:44:30
Previous
deleteCustomerByCustomerId
Next
getCustomerContactDetails
Built with