---
title: "Update a topic subscription"
method: PATCH
path: "/v2/topics/{topicKey}/subscriptions/{identifier}"
tags: ["Topics"]
---

# Update a topic subscription

`PATCH /v2/topics/{topicKey}/subscriptions/{identifier}`

## Request

- Base URL: `https://api.notifly.io`
- URL: `https://api.notifly.io/v2/topics/{topicKey}/subscriptions/{identifier}`
- Auth: API key in header `Authorization`

Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription.

## Path parameters

- `topicKey` string, required
- `identifier` string, required

## Request body

- UpdateTopicSubscriptionRequestDto
  - `name` string: The name of the subscription
  - `preferences` union[]: The preferences of the topic. Can be a simple workflow ID string, workflow preference object, or group filter object
    - union
      - string
      - WorkflowPreferenceRequestDto
        - `enabled` boolean: Whether the preference is enabled. Used when condition is not provided.
        - `condition` object: Optional JSON Logic condition evaluated at fan-out time against trigger payload, subscriber profile, actor, and context (for example, `{ "var": "payload.tier" }`, `{ "var": "subscriber.data.plan" }`, or `{ "var": "actor.data.role" }`)
        - `workflowId` string, required: The workflow identifier
      - GroupPreferenceFilterDto
        - `enabled` boolean: Whether the preference is enabled. Used when condition is not provided.
        - `condition` object: Optional JSON Logic condition evaluated at fan-out time against trigger payload, subscriber profile, actor, and context (for example, `{ "var": "payload.tier" }`, `{ "var": "subscriber.data.plan" }`, or `{ "var": "actor.data.role" }`)
        - `filter` GroupPreferenceFilterDetailsDto, required
          - `workflowIds` string[]: List of workflow identifiers
          - `tags` string[]: List of tags

## Response `200`

OK

- object
  - `data` SubscriptionResponseDto
    - `_id` string, required: The unique identifier of the subscription
    - `identifier` string: The identifier of the subscription
    - `name` string: The name of the subscription
    - `topic` TopicDto, required
      - `_id` string, required: The internal unique identifier of the topic
      - `key` string, required: The key identifier of the topic used in your application. Should be unique on the environment level.
      - `name` string: The name of the topic
      - `data` object: Additional custom data associated with the topic
    - `subscriber` SubscriberDto, required
      - `_id` string, required: The identifier of the subscriber
      - `subscriberId` string, required: The external identifier of the subscriber
      - `avatar` string, nullable: The avatar URL of the subscriber
      - `firstName` string, nullable: The first name of the subscriber
      - `lastName` string, nullable: The last name of the subscriber
      - `email` string, nullable: The email of the subscriber
    - `preferences` SubscriptionPreferenceDto[]: The preferences for workflows in this subscription
      - `subscriptionId` string, required: The unique identifier of the subscription
      - `workflow` WorkflowDto
        - `id` string, required: Unique identifier of the workflow
        - `identifier` string, required: Workflow identifier used for triggering
        - `name` string, required: Human-readable name of the workflow
        - `critical` boolean, required: Whether this workflow is marked as critical
        - `tags` string[]: Tags associated with the workflow
        - `data` object: Custom data associated with the workflow
        - `severity` 'high' | 'medium' | 'low' | 'none', required: Severity of the workflow
      - `enabled` boolean, required: Whether the preference is enabled
      - `condition` object: Optional JSON Logic condition evaluated against the trigger payload at fan-out time (for example, `{ "var": "payload.tier" }`)
    - `contextKeys` string[]: Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)
    - `createdAt` string, required: The creation date of the subscription
    - `updatedAt` string, required: The last update date of the subscription

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `405`: Method Not Allowed
- `409`: Conflict
- `413`: Payload Too Large
- `414`: URI Too Long
- `415`: Unsupported Media Type
- `422`: Unprocessable Entity
- `429`: The client has sent too many requests in a given amount of time.
- `500`: Internal Server Error
- `503`: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.

---

[API](https://skmtc.dev/notifly/apis/notifly-api.md) · [All operations](https://skmtc.dev/notifly/apis/notifly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/notifly/apis/notifly-api/revisions/af909b9e1e57?raw)