deleteCustomerByCustomerId

DELETE

/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}$

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

Deactivate customer

updateCustomer