Skip to main content
POST

Authorizations

​
Authorization
string
header
default:Bearer sandbox_any_token_works
required

A brand's server, one OAuth client per brand and environment. Get a token with the client_credentials grant and send it as Authorization: Bearer <token>. Tokens last 1 hour. A brand server reads status and ids only; it never reads clinical content. A platform partner holds one client for all its brands and gets one token per brand, naming it with tenant_id.

Headers

​
Idempotency-Key
string
required

A unique key per logical request, for example a UUID. Retrying with the same key and the same body within 24 hours returns the first response (with Idempotent-Replayed: true) instead of creating a duplicate. The same key with a different body is refused with 422 idempotency_key_reused.

Required string length: 8 - 255

Body

application/json
​
enrollment_id
string<uuid>
required
Example:

"0190f5c2-3a1b-7c4d-8e9f-a0b1c2d3e4f5"

​
kind
enum<string>
required
Available options:
export,
delete
Example:

"export"

Response

Received.

​
id
string<uuid>
required
Example:

"7a2e4c61-0b3d-4f58-9a17-2c4e6f8a0b13"

​
enrollment_id
string<uuid>
required
Example:

"0190f5c2-3a1b-7c4d-8e9f-a0b1c2d3e4f5"

​
external_patient_id
string
required

Your own identifier, printable ASCII without spaces.

Required string length: 1 - 128
Pattern: ^[\x21-\x7E]+$
Example:

"brand-pt-48213"

​
kind
enum<string>
required
  • export: a copy of the patient's coaching records for your brand, as a download.
  • delete: removes the patient's coaching records for your brand, except what the law requires TeraRx to keep (the audit log).
  • amend: the HIPAA right to amend. You decide within 60 days of requested_at.
Available options:
export,
delete,
amend
Example:

"export"

​
status
enum<string>
required
Available options:
received,
processing,
completed,
rejected
Example:

"processing"

​
requested_at
string<date-time>
required

ISO 8601 in UTC.

Example:

"2026-10-26T14:05:00Z"

​
completed_at
string<date-time> | null
Example:

null

​
export
object | null

Export requests, once completed.

​
amendment
object | null

Amend requests only.