Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
HIP Users API

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

ParameterTypeDescriptionRequired
user_idstringEka User's Eka ID or partner-provided IDYes
delete/cdr/v1/ekauser/{user_id}/

Path parameters

user_idstring required
Example:176917697553584

Eka User's Eka ID or partner-provided ID

Headers

authstring required
Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM

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

Response

OK - Eka User deleted successfully

statusstring
messagestring

Example response

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