notification-preferences

Activate or deactivate global notification preferences for hiring roles and notification channels in bulk.

patch/global-preferences

Request

Base URL
https://api.smartrecruiters.com/notification-preferences
URL
https://api.smartrecruiters.com/notification-preferences/global-preferences
Auth
- OAuth 2
  Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
  Client credentials
  Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: notification_preferences:manage
- or API key in header x-smarttoken

Request body

updateMode'OVERRIDE' | 'SAVE_ONLY' required

Mode of applying preferences. "SAVE_ONLY: Updates global preferences but preserves individual preferences set by users. "OVERRIDE: Updates global preferences and overrides individual preferences for all users.

Example request

{
  "preferences": [
    {
      "notificationType": "CANDIDATE_APPLIED",
      "hiringTeamRole": "HIRING_MANAGER",
      "notificationChannel": "EMAIL",
      "enabled": true
    }
  ],
  "updateMode": "SAVE_ONLY"
}

Response

Successfully upserted global preferences

Example response

{
  "preferences": [
    {
      "notificationType": "CANDIDATE_APPLIED",
      "hiringTeamRole": "HIRING_MANAGER",
      "notificationChannel": "EMAIL",
      "enabled": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.