---
title: "Update document group role"
method: PUT
path: "/v2/document-groups/{document_group_id}/roles/{user_id}"
---

# Update document group role

`PUT /v2/document-groups/{document_group_id}/roles/{user_id}`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/document-groups/{document_group_id}/roles/{user_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/document-groups/:document_group_id/roles/:user_id/put.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to change the role of a user who already has sharing access to the document group.

**Notes**

* **Viewer** - can view, download, and make copies of documents in a document group; **sender** - can view, download, make copies, invite to sign, and manage document invites.
* Only the owner of the document group can change roles.
* The previous role is replaced with the new one.

## Request body

- object
  - `role` string, required: New role to assign. Allowed values: `viewer`, `sender`.

## Response `200`

Role successfully updated.

- object
  - `id` string: Unique identifier of the user.
  - `role` string: User's new role in the document group (e.g., `viewer`, `sender`).
  - `email` string: Email address of the user.

## Other responses

- `400`: Bad request. Possible errors: * Document group not found. * User role not found. * Role is required. * Role must be string. * Invalid role value.
- `401`: Incorrect or missing bearer token.
- `403`: Forbidden. Only the document group owner can change roles.

---

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