Send a test notification

POST 
/sites/:siteId/configuration/notification/test

Queues a test email using the site's saved notification configuration

Request

Path Parameters

siteId stringrequired

Site Identifier

application/json

Body

required

to emailrequired

Recipient of the test email

Responses

202

Test notification queued

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message stringrequired

Queueing result

Example (from schema)

{
  "message": "string"
}

400

Invalid request or notification configuration

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...