notification-preferences

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

patch/employee-preferences

Request

  • Base URL
    https://api.smartrecruiters.com/notification-preferences
  • URL
    https://api.smartrecruiters.com/notification-preferences/employee-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

Example request

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

Response

Successfully upserted employee 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.