POST /v1/notifications/\{id\}/read
Service: comms · operationId: (none)
Required scopes
(no scope declared — review service config)
Path parameters
id(string) required —
Responses
200 Notification marked as read
{
"type": "object",
"properties": {
"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",
"kind",
"title",
"body",
"link",
"read_at",
"created_at",
"metadata"
]
}403 Missing brand context
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}404 Notification not found
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}500 Notification read update failed
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}Example
curl -X POST https://comms.platform.loop.health/v1/notifications/{id}/read \
-H "Authorization: Bearer $ACCESS_TOKEN"Related
services/comms— service overview- All endpoints — directory across services
- Auth model — how scopes are enforced