---
title: "POST /api/v1/resources/{ResourceId}/permissions"
method: POST
path: "/api/v1/resources/{ResourceId}/permissions"
---

# POST /api/v1/resources/{ResourceId}/permissions

`POST /api/v1/resources/{ResourceId}/permissions`

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

## Path parameters

- `ResourceId` string, required

## Headers

- `Authentication` string, password

## Request body

- object
  - `Principals` SharePrincipal[], required — The users, groups, or organization being granted permission.
    - `Id` string, required — The ID of the recipient.
    - `Type` 'USER' | 'GROUP' | 'INVITE' | 'ANONYMOUS' | 'ORGANIZATION', required — The type of the recipient.
    - `Role` 'VIEWER' | 'CONTRIBUTOR' | 'OWNER' | 'COOWNER', required — The role of the recipient.
  - `NotificationOptions` object — Set of options which defines notification preferences of given action.
    - `SendEmail` boolean — Boolean value to indicate an email notification should be sent to the recipients.
    - `EmailMessage` string, password — Text value to be included in the email body.

## Response `201`

Success

- AddResourcePermissionsResponse
  - `ShareResults` ShareResult[] — The share results.
    - `PrincipalId` string — The ID of the principal.
    - `InviteePrincipalId` string — The ID of the invited user.
    - `Role` 'VIEWER' | 'CONTRIBUTOR' | 'OWNER' | 'COOWNER' — The role.
    - `Status` 'SUCCESS' | 'FAILURE' — The status.
    - `ShareId` string — The ID of the resource that was shared.
    - `StatusMessage` string, password — The status message.

## Other responses

- `480` — UnauthorizedOperationException
- `481` — UnauthorizedResourceAccessException
- `482` — FailedDependencyException
- `483` — ServiceUnavailableException
- `484` — ProhibitedStateException

---

[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)