Delete Eka User

Overview

Soft-delete an Eka User by Eka ID or partner-provided ID. Deleted users no longer appear in list or get responses.

Endpoint: {{HOST}}/cdr/v1/ekauser/{user_id}/

Method: DELETE

Path Parameters

Parameter	Type	Description	Required
user_id	string	Eka User’s Eka ID or partner-provided ID	Yes

DELETE /cdr/v1/ekauser/{user_id}

Delete Eka User

cURL

curl --request DELETE \
  --url https://api.eka.care/cdr/v1/ekauser/{user_id}/ \
  --header 'auth: <auth>'

200

{
  "status": "success",
  "message": "EkaUser Deleted Successfully"
}

Headers

auth · string · required

The auth token of the business. It is used to authenticate the client. This should be fetched from auth api.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM"

Path Parameters

user_id · string · required

Eka User's Eka ID or partner-provided ID

Example:

"176917697553584"

Response

200

application/json

OK - Eka User deleted successfully

status · string

Example:

"success"

message · string

Example:

"EkaUser Deleted Successfully"