Skip to content

Mark Signals Read

POST
/api/signals/mark-read
curl --request POST \
--url http://localhost:8000/api/signals/mark-read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "signal_ids": [ "example" ] }'

Mark signals as read (within this workspace).

x-workspace-id
Any of:
string
Media typeapplication/json
MarkReadRequest
object
signal_ids
required
Signal Ids
Array<string>
Examplegenerated
{
"signal_ids": [
"example"
]
}

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}