Update a patient
curl --request PATCH \
--url https://api.healos.ai/ext-api/v1/patients/{patientId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Maria Santos",
"first_name": "Maria",
"last_name": "Santos",
"date_of_birth": "1990-03-15",
"gender": "female",
"phone": "+14155550123",
"email": "maria@example.com",
"address": "<unknown>",
"mrn": "MRN-12345",
"pronouns": "she/her",
"notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
"consent": true,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001"
}
'import requests
url = "https://api.healos.ai/ext-api/v1/patients/{patientId}"
payload = {
"name": "Maria Santos",
"first_name": "Maria",
"last_name": "Santos",
"date_of_birth": "1990-03-15",
"gender": "female",
"phone": "+14155550123",
"email": "maria@example.com",
"address": "<unknown>",
"mrn": "MRN-12345",
"pronouns": "she/her",
"notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
"consent": True,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Maria Santos',
first_name: 'Maria',
last_name: 'Santos',
date_of_birth: '1990-03-15',
gender: 'female',
phone: '+14155550123',
email: 'maria@example.com',
address: '<unknown>',
mrn: 'MRN-12345',
pronouns: 'she/her',
notes: 'History of generalized anxiety disorder. Currently on sertraline 50mg.',
consent: true,
provider_id: 'aaaaaaa1-0000-0000-0000-000000000001'
})
};
fetch('https://api.healos.ai/ext-api/v1/patients/{patientId}', 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.healos.ai/ext-api/v1/patients/{patientId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Maria Santos',
'first_name' => 'Maria',
'last_name' => 'Santos',
'date_of_birth' => '1990-03-15',
'gender' => 'female',
'phone' => '+14155550123',
'email' => 'maria@example.com',
'address' => '<unknown>',
'mrn' => 'MRN-12345',
'pronouns' => 'she/her',
'notes' => 'History of generalized anxiety disorder. Currently on sertraline 50mg.',
'consent' => true,
'provider_id' => 'aaaaaaa1-0000-0000-0000-000000000001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.healos.ai/ext-api/v1/patients/{patientId}"
payload := strings.NewReader("{\n \"name\": \"Maria Santos\",\n \"first_name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"date_of_birth\": \"1990-03-15\",\n \"gender\": \"female\",\n \"phone\": \"+14155550123\",\n \"email\": \"maria@example.com\",\n \"address\": \"<unknown>\",\n \"mrn\": \"MRN-12345\",\n \"pronouns\": \"she/her\",\n \"notes\": \"History of generalized anxiety disorder. Currently on sertraline 50mg.\",\n \"consent\": true,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.healos.ai/ext-api/v1/patients/{patientId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Maria Santos\",\n \"first_name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"date_of_birth\": \"1990-03-15\",\n \"gender\": \"female\",\n \"phone\": \"+14155550123\",\n \"email\": \"maria@example.com\",\n \"address\": \"<unknown>\",\n \"mrn\": \"MRN-12345\",\n \"pronouns\": \"she/her\",\n \"notes\": \"History of generalized anxiety disorder. Currently on sertraline 50mg.\",\n \"consent\": true,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.healos.ai/ext-api/v1/patients/{patientId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Maria Santos\",\n \"first_name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"date_of_birth\": \"1990-03-15\",\n \"gender\": \"female\",\n \"phone\": \"+14155550123\",\n \"email\": \"maria@example.com\",\n \"address\": \"<unknown>\",\n \"mrn\": \"MRN-12345\",\n \"pronouns\": \"she/her\",\n \"notes\": \"History of generalized anxiety disorder. Currently on sertraline 50mg.\",\n \"consent\": true,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "481926357104938271",
"name": "Maria Santos",
"first_name": "Maria",
"last_name": "Santos",
"date_of_birth": "1990-03-15",
"gender": "female",
"phone": "+14155550123",
"email": "maria@example.com",
"mrn": "MRN-12345",
"created_at": "2026-03-15T09:30:00.000Z",
"pronouns": "she/her",
"notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
"consent": true,
"external_id": "PARTNER-12345",
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"address": "<unknown>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets."
}Patients
Update a patient
PATCH
/
patients
/
{patientId}
Update a patient
curl --request PATCH \
--url https://api.healos.ai/ext-api/v1/patients/{patientId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Maria Santos",
"first_name": "Maria",
"last_name": "Santos",
"date_of_birth": "1990-03-15",
"gender": "female",
"phone": "+14155550123",
"email": "maria@example.com",
"address": "<unknown>",
"mrn": "MRN-12345",
"pronouns": "she/her",
"notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
"consent": true,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001"
}
'import requests
url = "https://api.healos.ai/ext-api/v1/patients/{patientId}"
payload = {
"name": "Maria Santos",
"first_name": "Maria",
"last_name": "Santos",
"date_of_birth": "1990-03-15",
"gender": "female",
"phone": "+14155550123",
"email": "maria@example.com",
"address": "<unknown>",
"mrn": "MRN-12345",
"pronouns": "she/her",
"notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
"consent": True,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Maria Santos',
first_name: 'Maria',
last_name: 'Santos',
date_of_birth: '1990-03-15',
gender: 'female',
phone: '+14155550123',
email: 'maria@example.com',
address: '<unknown>',
mrn: 'MRN-12345',
pronouns: 'she/her',
notes: 'History of generalized anxiety disorder. Currently on sertraline 50mg.',
consent: true,
provider_id: 'aaaaaaa1-0000-0000-0000-000000000001'
})
};
fetch('https://api.healos.ai/ext-api/v1/patients/{patientId}', 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.healos.ai/ext-api/v1/patients/{patientId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Maria Santos',
'first_name' => 'Maria',
'last_name' => 'Santos',
'date_of_birth' => '1990-03-15',
'gender' => 'female',
'phone' => '+14155550123',
'email' => 'maria@example.com',
'address' => '<unknown>',
'mrn' => 'MRN-12345',
'pronouns' => 'she/her',
'notes' => 'History of generalized anxiety disorder. Currently on sertraline 50mg.',
'consent' => true,
'provider_id' => 'aaaaaaa1-0000-0000-0000-000000000001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.healos.ai/ext-api/v1/patients/{patientId}"
payload := strings.NewReader("{\n \"name\": \"Maria Santos\",\n \"first_name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"date_of_birth\": \"1990-03-15\",\n \"gender\": \"female\",\n \"phone\": \"+14155550123\",\n \"email\": \"maria@example.com\",\n \"address\": \"<unknown>\",\n \"mrn\": \"MRN-12345\",\n \"pronouns\": \"she/her\",\n \"notes\": \"History of generalized anxiety disorder. Currently on sertraline 50mg.\",\n \"consent\": true,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.healos.ai/ext-api/v1/patients/{patientId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Maria Santos\",\n \"first_name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"date_of_birth\": \"1990-03-15\",\n \"gender\": \"female\",\n \"phone\": \"+14155550123\",\n \"email\": \"maria@example.com\",\n \"address\": \"<unknown>\",\n \"mrn\": \"MRN-12345\",\n \"pronouns\": \"she/her\",\n \"notes\": \"History of generalized anxiety disorder. Currently on sertraline 50mg.\",\n \"consent\": true,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.healos.ai/ext-api/v1/patients/{patientId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Maria Santos\",\n \"first_name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"date_of_birth\": \"1990-03-15\",\n \"gender\": \"female\",\n \"phone\": \"+14155550123\",\n \"email\": \"maria@example.com\",\n \"address\": \"<unknown>\",\n \"mrn\": \"MRN-12345\",\n \"pronouns\": \"she/her\",\n \"notes\": \"History of generalized anxiety disorder. Currently on sertraline 50mg.\",\n \"consent\": true,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "481926357104938271",
"name": "Maria Santos",
"first_name": "Maria",
"last_name": "Santos",
"date_of_birth": "1990-03-15",
"gender": "female",
"phone": "+14155550123",
"email": "maria@example.com",
"mrn": "MRN-12345",
"created_at": "2026-03-15T09:30:00.000Z",
"pronouns": "she/her",
"notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
"consent": true,
"external_id": "PARTNER-12345",
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"address": "<unknown>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets."
}Authorizations
API key obtained from /api/v1/ext-api-keys
Path Parameters
Patient ID
Example:
"481926357104938271"
Body
application/json
Patient name
Minimum string length:
1Example:
"Maria Santos"
Patient first name
Example:
"Maria"
Patient last name
Example:
"Santos"
Date of birth (YYYY-MM-DD)
Example:
"1990-03-15"
Patient gender
Example:
"female"
Patient phone number
Example:
"+14155550123"
Patient email
Example:
"maria@example.com"
Structured address JSON
Medical record number (optional). Send null/empty to clear it.
Maximum string length:
64Example:
"MRN-12345"
Pronouns
Example:
"she/her"
Clinical notes or context about this patient
Example:
"History of generalized anxiety disorder. Currently on sertraline 50mg."
Whether the patient has consented to treatment documentation
Example:
true
Reassign this patient to a different provider (see GET /providers). Must be a provider in your organization.
Minimum string length:
1Example:
"aaaaaaa1-0000-0000-0000-000000000001"
Response
Updated patient
Show child attributes
Show child attributes
Was this page helpful?
⌘I