Skip to main content
POST
/
v1
/
announcements
/
{id}
/
read
Mark announcement read
curl --request POST \
  --url https://api.truthlocks.com/v1/announcements/{id}/read \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'
{
  "id": "<string>",
  "is_read": true
}
Marks the specified announcement as read. This updates the is_read field to true and removes the unread indicator in the console.

​
Parameters

​
id
uuid
required
The announcement ID.

​
Responses

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

​
id
string
required

Body

application/json
​
reason
string

Optional reason or note for this action

Response

Marked as read

​
id
string
​
is_read
boolean