---
title: "POST /api/v1/organizations/{OrganizationId}/subscriptions"
method: POST
path: "/api/v1/organizations/{OrganizationId}/subscriptions"
---

# POST /api/v1/organizations/{OrganizationId}/subscriptions

`POST /api/v1/organizations/{OrganizationId}/subscriptions`

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see [Setting up notifications for an IAM user or role](https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html) in the _Amazon WorkDocs Developer Guide_.

## Path parameters

- `OrganizationId` string, required

## Request body

- object
  - `Endpoint` string, required — The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with <code>https</code>.
  - `Protocol` 'HTTPS' | 'SQS', required — The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.
  - `SubscriptionType` 'ALL', required — The notification type.

## Response `200`

Success

- CreateNotificationSubscriptionResponse
  - `Subscription` object — The subscription.
    - `SubscriptionId` string — The ID of the subscription.
    - `EndPoint` string — The endpoint of the subscription.
    - `Protocol` 'HTTPS' | 'SQS' — The protocol of the subscription.

## Other responses

- `480` — UnauthorizedResourceAccessException
- `481` — TooManySubscriptionsException
- `482` — ServiceUnavailableException
- `483` — InvalidArgumentException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)
