Toggle email notifications

POST /accounts/{account_id}/toggle-email-notifications

Sets the email notifications to be turned on or off for the given account.

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

Body Required

Send false to turn off email notifications

  • active boolean

    Flag to set email notifications to active

Responses

  • Successful operation

    Hide response attribute Show response attribute object
    • message string

      Simple message describing the action taken

POST /accounts/{account_id}/toggle-email-notifications
curl \
 -X POST https://api.clickguard.com/accounts/{account_id}/toggle-email-notifications \
 -H "X-API-KEY: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '"{\n  \"active\": true\n}"'
Request example
"{\n  \"active\": true\n}"
Request examples
{
  "active": true
}
Response examples (200)
"{\n  \"message\": \"Operation successful\"\n}"
Response examples (200)
{
  "message": "string"
}