Archive patient profile

Note: The patient profile is not deleted permanently — it is only archived. Archived profiles can still be retrieved using the arc=true query parameter in the retrieve API.

DELETE /profiles/v1/patient/{oid}

Archive patient profile

cURL

curl --request DELETE \
  --url https://api.eka.care/profiles/v1/patient/{oid} \
  --header 'Authorization: Bearer <token>' \
  --header 'client-id: <client-id>'

import requests

url = "https://api.eka.care/profiles/v1/patient/{oid}"

headers = {
    "client-id": "<client-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'client-id': '<client-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.eka.care/profiles/v1/patient/{oid}', 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/profiles/v1/patient/{oid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "client-id: <client-id>"
  ],
]);

$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/profiles/v1/patient/{oid}"

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

	req.Header.Add("client-id", "<client-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	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/profiles/v1/patient/{oid}")
  .header("client-id", "<client-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/profiles/v1/patient/{oid}")

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

request = Net::HTTP::Delete.new(url)
request["client-id"] = '<client-id>'
request["Authorization"] = 'Bearer <token>'

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

200

{
  "message": "Profile archived successfully"
}

{
  "message": "Not found",
  "code": "profile_not_found"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

client-id · string · required

Example:

"EC_1431"

Path Parameters

oid · string · required

Example:

18661861868168

Query Parameters

arc · boolean · default: false

Example:

true

Response

200

application/json

Patient profile archived successfully

message · string

Example:

"Profile archived successfully"