SIsignnow

Update document group role

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.
put/v2/document-groups/{document_group_id}/roles/{user_id}

Request

Path parameters

Document group ID.

ID of the user whose role is being changed.

Request body

rolestring required

New role to assign. Allowed values: viewer, sender.

Example request

{
  "role": "sender"
}

Response

Role successfully updated.

idstring

Unique identifier of the user.

rolestring

User's new role in the document group (e.g., viewer, sender).

emailstring

Email address of the user.

Changes

No recorded changes to this operation across all 1 revision of this API.