---
title: "Create a subscription"
method: POST
path: "/subscriptions.create"
tags: ["Subscriptions"]
---

# Create a subscription

`POST /subscriptions.create`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/subscriptions.create`
- 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`

Subscribe the authenticated user to a document or collection so that they receive notifications when it changes. Provide exactly one of `documentId` or `collectionId`.

## Request body

- object
  - `event` 'documents', required: The type of event to subscribe to.
  - `documentId` string, uuid: The document to subscribe to. Provide exactly one of documentId or collectionId.
  - `collectionId` string, uuid: The collection to subscribe to. Provide exactly one of documentId or collectionId.

## Response `200`

OK

- object
  - `data` Subscription
    - `id` string, uuid: Unique identifier for the object.
    - `userId` string, uuid: Identifier for the subscribed user.
    - `documentId` string, uuid, nullable: Identifier for the subscribed document, if any.
    - `collectionId` string, uuid, nullable: Identifier for the subscribed collection, if any.
    - `event` string: The type of event that is subscribed to.
    - `createdAt` string, date-time: Date and time when this subscription was created.
    - `updatedAt` string, date-time: Date and time when this subscription was last updated.
  - `policies` Policy[]
    - `id` string, uuid: Unique identifier for the object this policy references.
    - `abilities` object: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.

## 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.
- `404`: The specified resource was not found.
- `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/subscriptions.create/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)