Create a patient

POST/patients

Creates a patient, or returns the existing one that matches by MRN, then phone, then email. A new patient returns 201; a match returns 200 with matched_by and doesn’t change the existing record.

Credentials: API key, or an OAuth access token
Scope: patients.write
Idempotent: With Idempotency-Key

Run in Postman: import the collection, set api_key, and find this request in its folder.

Query parameters

org_idUUID

The organization the call acts on, from List organizations. Required when an account API key reaches more than one organization; an organization key or a key limited to one organization can leave it out.

Headers

Idempotency-KeyUUIDRequired

A UUID you generate for each write. Retrying with the same key returns the original result for 24 hours. Reusing a key with a different method, path, or body returns 409.

Body parameters

Provide a phone number, an email address, or both.

first_namestring

First name.

last_namestring

Last name.

date_of_birthdate

Date of birth.

phonestring

Mobile number. Any common format; BloomText stores it as E.164.

emailstring

Email address.

mrnstring

The patient’s ID in your system. Matched first.

Any other field returns 422 unknown_field. See Unknown fields are rejected.

Returns

Returns 200 OK with the Patient object.

Errors

Failed requests return application/problem+json problem details. The errors specific to this endpoint:

Status	Code	Meaning
400	`invalid_request`	The request is malformed, such as invalid JSON.
400	`org_id_required`	The key reaches more than one organization: pass `org_id`.
401	`invalid_token`	The API key is missing or malformed, or isn’t a BloomText key.
401	`key_revoked`	The API key was revoked.
401	`key_expired`	The API key’s expiry has passed.
403	`insufficient_scope`	The key doesn’t have the scope this endpoint needs.
403	`org_not_reachable`	The key can’t reach the organization in `org_id`.
409	`idempotency_key_reused`	The Idempotency-Key was already used with a different request.
409	`idempotency_request_in_progress`	A request with this Idempotency-Key is still running. Retry shortly.
422	`validation_failed`	A field failed validation. See `field_errors`.
429	`rate_limited`	Too many requests. Retry after `Retry-After` seconds.

cURL

Request


curl -X POST "https://api.bloomtext.com/v1/patients" \
  -H "Authorization: Bearer $BLOOMTEXT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Jane","last_name":"Doe","date_of_birth":"1986-04-12","phone":"(512) 555-0143","mrn":"MRN-20931"}'

JavaScript

Request


const response = await fetch('https://api.bloomtext.com/v1/patients', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.BLOOMTEXT_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"first_name":"Jane","last_name":"Doe","date_of_birth":"1986-04-12","phone":"(512) 555-0143","mrn":"MRN-20931"}),
})
 
if (!response.ok) throw new Error(`BloomText API error: ${response.status}`)
const data = await response.json()

Python

Request


import os
import uuid
 
import requests
 
response = requests.post(
    "https://api.bloomtext.com/v1/patients",
    headers={
        "Authorization": f"Bearer {os.environ['BLOOMTEXT_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={"first_name":"Jane","last_name":"Doe","date_of_birth":"1986-04-12","phone":"(512) 555-0143","mrn":"MRN-20931"},
)
response.raise_for_status()
data = response.json()

Go

Request


package main
 
import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
 
	"github.com/google/uuid"
)
 
func main() {
	body := bytes.NewBufferString(`{"first_name":"Jane","last_name":"Doe","date_of_birth":"1986-04-12","phone":"(512) 555-0143","mrn":"MRN-20931"}`)
	req, err := http.NewRequest("POST", "https://api.bloomtext.com/v1/patients", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("BLOOMTEXT_API_KEY"))
	req.Header.Set("Idempotency-Key", uuid.NewString())
	req.Header.Set("Content-Type", "application/json")
 
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
 
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

Ruby

Request


require "net/http"
require "json"
require "securerandom"
 
uri = URI("https://api.bloomtext.com/v1/patients")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("BLOOMTEXT_API_KEY")}"
request["Idempotency-Key"] = SecureRandom.uuid
request["Content-Type"] = "application/json"
request.body = { first_name: "Jane", last_name: "Doe", date_of_birth: "1986-04-12", phone: "(512) 555-0143", mrn: "MRN-20931" }.to_json
 
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
data = JSON.parse(response.body)

Response · 200 OK


{
  "id": "5a1c9e2b-7d44-4f1a-9c3e-2b8d6f0a1e77",
  "first_name": "Jane",
  "last_name": "Doe",
  "date_of_birth": "1986-04-12",
  "phone": "+15125550143",
  "email": "jane.doe@example.com",
  "mrn": "MRN-20931",
  "sms_opted_out": false,
  "sms_undeliverable_reasons": [],
  "conversation_count": 2,
  "created_at": "2026-02-03T17:22:10Z",
  "matched_by": null
}