Skip to main content
POST
/
v1
/
regions
/
global
/
notifications
/
settings
/
test
Test notification settings
const options = {
  method: 'POST',
  headers: {cookie: 'session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({channel: 'inApp'})
};

fetch('https://api.example.com/v1/regions/global/notifications/settings/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "channel": "<string>",
    "sent": true
  },
  "meta": {}
}

Authorizations

session
string
cookie
required

Session-based authentication via HTTP-only cookie

Body

application/json
channel
enum<string>
required

Channel to test

Available options:
inApp,
email,
slack

Response

200 - application/json

Test notification sent

success
enum<boolean>
Available options:
true
data
object
meta
object