---
title: "Save employee notifications preferences."
method: POST
path: "/employee-preferences"
tags: ["notification-preferences"]
---

# Save employee notifications preferences.

`POST /employee-preferences`

## Request

- Base URL: `https://api.smartrecruiters.com/notification-preferences`
- URL: `https://api.smartrecruiters.com/notification-preferences/employee-preferences`
- Auth: one of:
  - 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`
  - API key in header `x-smarttoken`

## Query parameters

- `channel` 'SLACK' | 'TEAMS' | 'EMAIL', required

## Request body

- EmployeePreferenceSaveExternal
  - `hiringTeamRole` string, required: Hiring team role
  - `notificationType` 'ADDED_TO_HIRING_TEAM' | 'ASSESSMENT_RESULTS' | 'ASSESSMENT_UPDATED' | 'CANDIDATE_APPLIED' | 'CANDIDATE_DEFERRED' | 'CANDIDATE_OFFERED' | 'CANDIDATE_RATED' | 'CANDIDATE_RE_ENGAGED' | 'CANDIDATE_REPLIED_TO_EMAIL' | 'CANDIDATE_REPLIED_TO_SMART_MESSAGE' | 'CANDIDATE_WITHDRAWN' | 'COMMENTS_ON_MENTIONED_POSTS' | 'COMMENTS_ON_MY_POSTS' | 'EMAIL_FROM_COLLEAGUE_TO_CANDIDATE_WITHIN_CONVERSATION' | 'EVENT_MANAGEMENT_DAILY_DIGEST' | 'EVENT_MANAGEMENT_SESSION_SCHEDULED' | 'FEEDBACK_IS_SUBMITTED_BY_INTERVIEWER' | 'INTERVIEW_ACCEPTED_BY_CANDIDATE' | 'INTERVIEW_CANCELLED_BY_CANDIDATE' | 'INTERVIEW_FEEDBACK' | 'INTERVIEW_INVITATION' | 'INTERVIEW_REMINDER' | 'NEW_HIRES' | 'NEW_HIRING_TEAM_MEMBERS' | 'SELF_SCHEDULING_NO_SLOTS_AVAILABLE_INTERVIEWER' | 'SELF_SCHEDULING_NO_SLOTS_AVAILABLE_JOB_CREATOR' | 'UPCOMING_INTERVIEWS' | 'WEEKLY_DIGEST', required: Type of notification
  - `enabled` boolean, required: Whether notification is enabled

## Response `200`

Employee preferences saved successfully

- EmployeePreferenceWithIdExternal[]
  - `id` string, uuid, required: Unique identifier of the preference
  - `hiringTeamRole` string, required: Hiring team role
  - `notificationType` 'ADDED_TO_HIRING_TEAM' | 'ASSESSMENT_RESULTS' | 'ASSESSMENT_UPDATED' | 'CANDIDATE_APPLIED' | 'CANDIDATE_DEFERRED' | 'CANDIDATE_OFFERED' | 'CANDIDATE_RATED' | 'CANDIDATE_RE_ENGAGED' | 'CANDIDATE_REPLIED_TO_EMAIL' | 'CANDIDATE_REPLIED_TO_SMART_MESSAGE' | 'CANDIDATE_WITHDRAWN' | 'COMMENTS_ON_MENTIONED_POSTS' | 'COMMENTS_ON_MY_POSTS' | 'EMAIL_FROM_COLLEAGUE_TO_CANDIDATE_WITHIN_CONVERSATION' | 'EVENT_MANAGEMENT_DAILY_DIGEST' | 'EVENT_MANAGEMENT_SESSION_SCHEDULED' | 'FEEDBACK_IS_SUBMITTED_BY_INTERVIEWER' | 'INTERVIEW_ACCEPTED_BY_CANDIDATE' | 'INTERVIEW_CANCELLED_BY_CANDIDATE' | 'INTERVIEW_FEEDBACK' | 'INTERVIEW_INVITATION' | 'INTERVIEW_REMINDER' | 'NEW_HIRES' | 'NEW_HIRING_TEAM_MEMBERS' | 'SELF_SCHEDULING_NO_SLOTS_AVAILABLE_INTERVIEWER' | 'SELF_SCHEDULING_NO_SLOTS_AVAILABLE_JOB_CREATOR' | 'UPCOMING_INTERVIEWS' | 'WEEKLY_DIGEST', required: Type of notification
  - `enabled` boolean, required: Whether notification is enabled

## Other responses

- `400`: Invalid configuration for notification preference
- `401`: Unauthorized

---

[API](https://skmtc.dev/smartrecruiters/apis/notifications-engine-public-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/notifications-engine-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/notifications-engine-public-api/revisions/ff109dcd0e22?raw)