Skip to Content
API access is available to organizations with a signed BAA. Request API access →
Changelog

Changelog

This page lists changes to the BloomText API and these docs. The API is versioned in the URL (/v1). Additive changes, such as new endpoints, fields, or search operators, ship within v1, so build clients that ignore fields they don’t recognize. Breaking changes ship as a new version, announced here first.

September 26, 2026

BloomText API v1

The first version of the BloomText API, with two ways in: the Patient API for servers, and OAuth for an org admin’s own conversations.

Authentication

  • API keys belong to the organization and reach patient operations.
  • OAuth 2.0, using the authorization code flow with PKCE, lets an org admin connect an app to their own conversations and to patient operations.
  • Scopes: messages.read, messages.write, patients.read, and patients.write, shared by keys and OAuth, plus offline_access for OAuth.

Patient API

  • Send messages to patients by patient ID or phone number. Messages go by secure link unless you ask for SMS, and report delivery status.
  • Patients: find by phone or MRN; create, update, delete, and import.
  • Campaigns: send one message to many patients from a clinic phone number, with delivery status for every recipient.
  • Phone numbers: the clinic numbers messages come from.

Reading and search

  • Read messages in a time range with GET /patient-messages (Patient API) or GET /me/messages (OAuth), one by one or grouped by conversation.
  • Search with q, including operators like from:patient, mrn:, and is:unread.

Conventions

Last updated on
Security and BAA