Delete Cohort

Deletes a cohort if the cohort is empty.

DELETE /medical/v1/cohort/{id}

Delete Cohort

cURL

curl --request DELETE \
  --url https://api.sandbox.metriport.com/medical/v1/cohort/{id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.metriport.com/medical/v1/cohort/{id}"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.metriport.com/medical/v1/cohort/{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.sandbox.metriport.com/medical/v1/cohort/{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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.sandbox.metriport.com/medical/v1/cohort/{id}"

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

	req.Header.Add("x-api-key", "<api-key>")

	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.sandbox.metriport.com/medical/v1/cohort/{id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/cohort/{id}")

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

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

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

Metriport SDK

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const cohortId = "00000000-0000-0000-0000-000000000000";
await metriport.deleteCohort(cohortId);

For more information, see the guide about Cohorts

Prerequisites: You must remove all patients from a cohort before deleting it. If there are still patients in the cohort, the API will return a 400 error.

Use the remove patients from cohort endpoint to clear all patients first.

Path Params

id · string · required

The ID of the cohort to delete.

Response

204 - No Content, upon successful delete.

Metriport SDK

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const cohortId = "00000000-0000-0000-0000-000000000000";
await metriport.deleteCohort(cohortId);