---
title: "PUT /v1/email-preferences"
method: PUT
path: "/v1/email-preferences"
tags: ["[v1] Email Preferences"]
---

# PUT /v1/email-preferences

`PUT /v1/email-preferences`

## Request

- Base URL: `https://nhse-${ENV}-innovation-service-user-functions.azurewebsites.net/api`
- URL: `https://nhse-${ENV}-innovation-service-user-functions.azurewebsites.net/api/v1/email-preferences`
- Auth: none declared

Updates the user email preferences

## Request body

- object
  - `preferences` union
    - object
      - `NEEDS_ASSESSMENT` 'YES' | 'NO', required
      - `TASK` 'YES' | 'NO', required
      - `MESSAGES` 'YES' | 'NO', required
      - `INNOVATION_MANAGEMENT` 'YES' | 'NO', required
      - `ANNOUNCEMENTS` 'YES' | 'NO', required
    - object
      - `SUPPORT` 'YES' | 'NO', required
      - `TASK` 'YES' | 'NO', required
      - `MESSAGES` 'YES' | 'NO', required
      - `INNOVATION_MANAGEMENT` 'YES' | 'NO', required
      - `AUTOMATIC` 'YES' | 'NO', required
      - `NOTIFY_ME` 'YES' | 'NO', required
      - `ANNOUNCEMENTS` 'YES' | 'NO', required
    - object
      - `ORGANISATION_SUGGESTIONS` 'YES' | 'NO', required
      - `SUPPORT` 'YES' | 'NO', required
      - `TASK` 'YES' | 'NO', required
      - `MESSAGES` 'YES' | 'NO', required
      - `INNOVATION_MANAGEMENT` 'YES' | 'NO', required
      - `AUTOMATIC` 'YES' | 'NO', required
      - `NOTIFY_ME` 'YES' | 'NO', required
      - `ANNOUNCEMENTS` 'YES' | 'NO', required
    - object
      - `SUPPORT` 'YES' | 'NO', required
      - `MESSAGES` 'YES' | 'NO', required
      - `TASK` 'YES' | 'NO', required
      - `DOCUMENTS` 'YES' | 'NO', required
      - `AUTOMATIC` 'YES' | 'NO', required
      - `USER_RESEARCH_SURVEYS` 'YES' | 'NO', required
      - `ANNOUNCEMENTS` 'YES' | 'NO', required

## Response `204`

The user email preferences were updated successfully

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Internal server error

## Changes

- **2024-09-16** `cc4dc40e33b6`: 1 breaking
  - added the new required request property `preferences/oneOf[subschema #2]/ANNOUNCEMENTS`
- **2024-08-26** `89342ccb01f2`: 1 breaking, 1 info
  - removed `subschema #1, subschema #3, subschema #4` from the `preferences` request property `oneOf` list
  - added `subschema #1, subschema #3, subschema #4` to the `preferences` request property `oneOf` list
- **2024-07-03** `172cebd79b0d`: 1 breaking
  - added the new required request property `preferences/oneOf[subschema #4]/USER_RESEARCH_SURVEYS`
- **2024-06-25** `b4392d49b04b`: 1 breaking, 1 info
  - removed `subschema #2, subschema #3` from the `preferences` request property `oneOf` list
  - added `subschema #2, subschema #3` to the `preferences` request property `oneOf` list
- **2023-11-28** `7bb0cfb7198b`: 1 breaking, 1 info
  - removed `subschema #2, subschema #3` from the `preferences` request property `oneOf` list
  - added `subschema #2, subschema #3` to the `preferences` request property `oneOf` list

[Operation history](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/changes/v1/email-preferences/put.md)

---

[API](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service.md) - [All operations](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/llms.txt) - [OpenAPI document](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/revisions/4c818edd79bf?raw)