Mark a notification as read

POST

/api/notifications/{id}/read

curl --request POST \
  --url https://api.getvespy.com/api/notifications/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/read \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

notification

required

object

actorUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

actorUserId

required

string format: uuid

nullable

body

required

string

nullable

channel

required

string

Allowed values: in_app email sms push

channels

Array<string>

Allowed values: in_app email sms push

createdAt

required

string format: date-time

entityId

required

string format: uuid

nullable

entityType

required

string

nullable

id

required

string format: uuid

priority

required

string

Allowed values: low normal high urgent

readAt

required

string format: date-time

nullable

title

required

string

>= 1 characters

type

required

string

>= 1 characters

Example

{
  "notification": {
    "channel": "in_app",
    "channels": [
      "in_app"
    ],
    "priority": "low"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}