Cleanse

Send a test notification email

Sends a test email via GOV.UK Notify to verify configuration.

post/cleanse/test-notification

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/cleanse/test-notification
  • Auth
    API key in header X-API-Key

Response

Test notification sent

successboolean
recipientstring
notificationIdstring nullable
messagestring
sentAtUtcstring date-time

Changes

No recorded changes to this operation across all 5 revisions of this API.