Messages API

Send message

Send a message through a patient's channel.

POST/v1/messages

capability messages.send · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

patientIdstring<uuid>
body
channel"patient_app"
bodydefault "patient_app"
bodystringrequired
bodymin length 1max length 4000

Response

Successful responses use Dawn's data envelope.

dataMessagerequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- patientIdstring<uuid>required
- channel"patient_app"required
- senderone of 2 shapesrequired
  - kind"member"required
  - idstring<uuid>required
- bodystringrequired
  min length 1max length 4000
- createdAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Messaging is disabled or the requested patient is unavailable.
422The message is invalid.
503The message could not be sent.

Request

import { createDawnClient } from "@dawn/api";
import { patientIdSchema } from "@dawn/domain";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["messages.send"]({
  "patientId": patientIdSchema.parse("33333333-3333-4333-8333-333333333333"),
  "channel": "patient_app",
  "body": "string",
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Created.

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspaceId": "22222222-2222-4222-8222-222222222222",
    "patientId": "33333333-3333-4333-8333-333333333333",
    "channel": "patient_app",
    "sender": {
      "kind": "member",
      "id": "11111111-1111-4111-8111-111111111111"
    },
    "body": "string",
    "createdAt": "2026-08-01T09:00:00.000Z"
  },
  "meta": {}
}