Send a test notification to the current user on a single channel

POST

/api/notifications/test

curl --request POST \
  --url https://api.getvespy.com/api/notifications/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "channel": "in_app" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

channel

required

string

Allowed values: in_app email sms

Responses

200

Default Response

Media typeapplication/json

object

channel

required

string

Allowed values: in_app email sms

error

required

string

nullable

messageId

required

string

nullable

provider

required

string

nullable

status

required

string

Allowed values: sent skipped error

Example

{
  "channel": "in_app",
  "status": "sent"
}

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"
}