POST /v1/admin/notifications
Service: comms · operationId: (none)
Record an in-app notification on behalf of another platform service. Service-to-service only — callers (e.g. community mention fanout) own their own idempotency before invoking this endpoint.
Required scopes
(no scope declared — review service config)
Request body
{
"type": "object",
"properties": {
"brand_id": {
"type": "string",
"minLength": 1
},
"patient_id": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"body": {
"type": [
"string",
"null"
]
},
"link": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"brand_id",
"patient_id",
"kind",
"title"
]
}Responses
201 Notification recorded
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"brand_id": {
"type": "string"
},
"patient_id": {
"type": "string"
},
"kind": {
"type": "string"
},
"title": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"link": {
"type": [
"string",
"null"
]
},
"read_at": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"id",
"brand_id",
"patient_id",
"kind",
"title",
"body",
"link",
"read_at",
"created_at",
"metadata"
]
}500 Recording failed
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}Example
curl -X POST https://comms.platform.loop.health/v1/admin/notifications \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'Related
services/comms— service overview- All endpoints — directory across services
- Auth model — how scopes are enforced