Delete Doctor

Overview

Soft-delete a doctor by their Eka ID or partner-provided ID. Once deleted, the doctor will no longer appear in list or get responses.

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

Method: DELETE

Path Parameters

Parameter	Type	Description	Required
doc_id	string	Doctor’s Eka ID or partner-provided ID	Yes

DELETE /cdr/v1/doctor/{doc_id}/

Delete Doctor

cURL

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

import requests

url = "https://api.eka.care/cdr/v1/doctor/{doc_id}/"

headers = {"auth": "<auth>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {auth: '<auth>'}};

fetch('https://api.eka.care/cdr/v1/doctor/{doc_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/cdr/v1/doctor/{doc_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "auth: <auth>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/cdr/v1/doctor/{doc_id}/"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("auth", "<auth>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.eka.care/cdr/v1/doctor/{doc_id}/")
  .header("auth", "<auth>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/cdr/v1/doctor/{doc_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["auth"] = '<auth>'

response = http.request(request)
puts response.read_body

200

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

{
  "status": "error",
  "message": "Doctor not found"
}

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

doc_id · string · required

Doctor's Eka ID or partner-provided ID

Example:

"do1769174683513"

Response

200

application/json

OK - Doctor deleted successfully

status · string

Example:

"success"

message · string

Example:

"Doctor Deleted Successfully"