Skip to content
Omazy CX
ProductBlogOpen console
API

Mark a single notification as read

PATCH
/notifications/{id}/read
curl --request PATCH \
  --url https://mw.omazy.ai/api/v1/notifications/example/read \
  --header 'Authorization: <Authorization>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Notification ID

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
error
object
code
string
message
string
meta
object
next_cursor
string
page
integer
per_page
integer
total
integer
success
boolean
data
object
id
string
is_read
boolean
read_at
string
Examplegenerated
{
  "data": {
    "id": "example",
    "is_read": true,
    "read_at": "example"
  },
  "error": {
    "code": "example",
    "message": "example"
  },
  "meta": {
    "next_cursor": "example",
    "page": 1,
    "per_page": 1,
    "total": 1
  },
  "success": true
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
object
code
string
message
string
meta
object
next_cursor
string
page
integer
per_page
integer
total
integer
success
boolean
error
object
code
string
message
string
Examplegenerated
{
  "data": "example",
  "error": {
    "code": "example",
    "message": "example"
  },
  "meta": {
    "next_cursor": "example",
    "page": 1,
    "per_page": 1,
    "total": 1
  },
  "success": true
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
object
code
string
message
string
meta
object
next_cursor
string
page
integer
per_page
integer
total
integer
success
boolean
error
object
code
string
message
string
Examplegenerated
{
  "data": "example",
  "error": {
    "code": "example",
    "message": "example"
  },
  "meta": {
    "next_cursor": "example",
    "page": 1,
    "per_page": 1,
    "total": 1
  },
  "success": true
}