Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Doctor and clinic API

Update Doctor

Overview

Update an existing doctor's profile. Only the fields included in the request body will be updated; all fields are optional.

Endpoint: {{HOST}}/cdr/v1/doctor/{doc_id}/

Method: PATCH

Path Parameters

ParameterTypeDescriptionRequired
doc_idstringDoctor's Eka IDYes
patch/cdr/v1/doctor/{doc_id}/

Path parameters

doc_idstring required
Example:do1769174683513

Doctor'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
gender'M' | 'F' | 'O'
dobstring
specialisationsstring[]
qualificationsstring[]
aboutstring
profile_image_urlstring uri
clinic_idsstring[]

Add these Eka clinic IDs to the doctor's existing clinic associations

partner_clinic_idsstring[]

Add clinics matching these partner IDs to the doctor's existing clinic associations

partner_idstring

Example request

{
  "firstname": "Rajesh",
  "lastname": "Sharma",
  "mobile": "0000011111",
  "email": "dr.rajesh@example.com",
  "gender": "M",
  "dob": "1999-01-01",
  "specialisations": [
    "Cardiology"
  ],
  "qualifications": [
    "MBBS",
    "MD"
  ],
  "about": "Updated bio",
  "profile_image_url": "https://example.com/images/dr-rajesh.jpg",
  "clinic_ids": [
    "c-ab2c-34f2d-2gwd-2g2g"
  ],
  "partner_clinic_ids": [
    "Part_clinic_1"
  ],
  "partner_id": "Part_doc"
}

Response

OK - Doctor updated successfully

statusstring
ekaidstring

Example response

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