Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
HIP Users API

Update Eka User

Overview

Update an existing Eka User. Only the fields included in the request body will be updated; all fields are optional.

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

Method: PATCH

Path Parameters

ParameterTypeDescriptionRequired
user_idstringEka User's Eka IDYes
patch/cdr/v1/ekauser/{user_id}/

Path parameters

user_idstring required
Example:176917697553584

Eka User's Eka 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.

Request body

firstnamestring
lastnamestring
mobilestring
emailstring email
auth_useridstring
gender'M' | 'F' | 'O'
dobstring date
is_adminboolean
seat_type'b' | 'p'
persona'S' | 'D'
doctor_idsstring[]
partner_doctor_idsstring[]
clinic_idsstring[]
partner_clinic_idsstring[]
partner_idstring

Example request

{
  "firstname": "Amit",
  "lastname": "Kumar",
  "mobile": "9876543210",
  "email": "amit.kumar@example.com",
  "auth_userid": "Prateek_@_123",
  "gender": "M",
  "dob": "1990-05-15",
  "is_admin": true,
  "seat_type": "p",
  "persona": "D",
  "doctor_ids": [
    "do1769174683513"
  ],
  "partner_doctor_ids": [
    "Part_doc_1"
  ],
  "clinic_ids": [
    "c-ab2c-34f2d-2gwd-2g2g"
  ],
  "partner_clinic_ids": [
    "Part_clinic_1"
  ],
  "partner_id": "Part_user_1"
}

Response

OK - Eka User updated successfully

statusstring
ekaidstring

Example response

{
  "status": "success",
  "ekaid": "176917697553584"
}