---
title: "PUT /v1/notify-me/{subscriptionId}"
method: PUT
path: "/v1/notify-me/{subscriptionId}"
tags: ["[v1] Notify Me"]
---

# PUT /v1/notify-me/{subscriptionId}

`PUT /v1/notify-me/{subscriptionId}`

## 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/notify-me/{subscriptionId}`
- Auth: none declared

Notify me subscription update

## Path parameters

- `subscriptionId` string, uuid, required

## Request body

- union
  - object
    - `eventType` 'SUPPORT_UPDATED', required
    - `subscriptionType` 'INSTANTLY' | 'ONCE'
    - `preConditions` object, required
      - `units` string[], required
    - `notificationType` 'SUPPORT_UPDATED' | 'SUGGESTED_SUPPORT_UPDATED'
  - object
    - `eventType` 'PROGRESS_UPDATE_CREATED', required
    - `subscriptionType` 'INSTANTLY'
    - `preConditions` object, required
      - `units` string[], required
  - object
    - `eventType` 'INNOVATION_RECORD_UPDATED', required
    - `subscriptionType` 'INSTANTLY'
    - `preConditions` object, required
      - `sections` string[]
  - object
    - `eventType` 'DOCUMENT_UPLOADED', required
    - `subscriptionType` 'INSTANTLY'
  - object
    - `eventType` 'REMINDER', required
    - `subscriptionType` 'SCHEDULED'
    - `customMessage` string, required
    - `date` string, date-time, required

## Response `204`

Subscription created

## Other responses

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

## Changes

- **2024-11-21** `95cc69ec3f5a`: 1 info
  - added `subschema #4` to the request body `anyOf` list
- **2024-07-09** `e2afba260e04`: 2 info
  - added the new optional request property `anyOf[subschema #1]/notificationType`
  - added the new `ONCE` enum value to the request property `anyOf[subschema #1]/subscriptionType`
- **2024-07-08** `beb16311849a`: 1 info
  - added `subschema #4` to the request body `anyOf` list
- **2024-06-27** `b9383980538b`: 1 info
  - added `subschema #3` to the request body `anyOf` list
- **2024-06-25** `d58355c87067`: 1 info
  - added `subschema #2` to the request body `anyOf` list

[Operation history](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/changes/v1/notify-me/:subscriptionId/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)