---
title: "Subscribe to a notification type"
method: POST
path: "/users.notificationsSubscribe"
tags: ["Users"]
---

# Subscribe to a notification type

`POST /users.notificationsSubscribe`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/users.notificationsSubscribe`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getoutline.com/oauth/authorize`
    - Token URL: `https://app.getoutline.com/oauth/token` scopes: `read`, `write`

Enable a specific type of notification for the authenticated user. This controls which events the user receives email and in-app notifications for.

## Request body

- object
  - `eventType` 'documents.publish' | 'documents.update' | 'documents.add_user' | 'collections.add_user' | 'revisions.create' | 'collections.create' | 'comments.create' | 'comments.resolve' | 'reactions.create' | 'documents.mentioned' | 'comments.mentioned' | 'documents.group_mentioned' | 'comments.group_mentioned' | 'emails.invite_accepted' | 'emails.onboarding' | 'emails.features' | 'emails.export_completed' | 'access_requests.create': The notification event type to subscribe to.

## Response `200`

OK

- object
  - `data` User
    - `id` string, uuid: Unique identifier for the object.
    - `name` string: The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
    - `avatarUrl` string, uri: The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
    - `color` string: A color representing the user, used in the UI for avatars without an image.
    - `email` string, email: The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
    - `role` 'admin' | 'member' | 'viewer' | 'guest'
    - `isSuspended` boolean: Whether this user has been suspended.
    - `lastActiveAt` string, date-time, nullable: The last time this user made an API request, this value is updated at most every 5 minutes.
    - `timezone` string, nullable: The timezone this user has registered.
    - `createdAt` string, date-time: The date and time that this user first signed in or was invited as a guest.
    - `updatedAt` string, date-time: The date and time that this user was last updated.
    - `deletedAt` string, date-time, nullable: The date and time that this user was deleted, if applicable.
    - `invitedBy` User (recursive)

## Other responses

- `400`: The request failed one or more validations.
- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `429`: The request was rate limited.

## Changes

- **2026-09-05** `6287bce7caad`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/users.notificationsSubscribe/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)