Create patient letter

Creates a new patient letter.

Note: This endpoint requires a user-scoped OAuth token. A pure client_credentials token without user context will be rejected. The treating user is automatically derived from the token and cannot be set manually.

Request

POST /api/oauth/v2/resource/patient-letters

Header

Header	Value
Authorization	Bearer {access_token}
Content-Type	application/json

Body parameters

Field	Type	Required	Description
customerUuid	string	Yes	UUID of the assigned customer
name	string	No	Name of the letter
text	string	No	Content of the letter
date	string	No	Date of the letter (YYYY-MM-DD, default: today)
printed	boolean	No	Whether the letter has been printed

Response

Success (201 Created)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Findings Report June 2026",
    "text": "Dear colleague, I am writing to report the following findings ...",
    "date": "2026-06-09",
    "printed": false,
    "customer": {
      "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "firstName": "Anna",
      "lastName": "Muster"
    },
    "treatingUser": {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "firstName": "Dr. Maria",
      "lastName": "Huber"
    }
  }
}

Response fields

See Get patient letter for the full field description.

Beispiele

bash

curl -X POST "https://my.offisy.at/api/oauth/v2/resource/patient-letters" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "customerUuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
    "name": "Muster GmbH",
    "text": "beispiel",
    "date": "2026-04-15T10:00:00",
    "printed": "beispiel"
  }'

Server

Client-ID

Client-Secret

Parameter

customerUuid *string

name string

text string

date string

printed boolean

Zuerst Token anfordern

Possible errors

Status	Code	Description
400	validation_error	Invalid request data (e.g. customerUuid missing)
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope medicals not present
404	not_found	Customer not found