Roles: CreateRole

Creates a new company role in Rooms Version 6.

Permissions

To use this method, you must have the canManageAccount permission set to true.

Request

HTTP request

POST /v2/accounts/{accountId}/roles

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Request Body

role

Responses

CodeDescriptionReference
201

Role successfully created.

Role
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Roles::CreateRole

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Nullable[Permissions]

Contains details about Rooms Version 6 permissions.

canAddUsersToRoomsboolean

When set to true, users can see the Invite button on the room's People tab and can invite people into a room.

canCreateRoomsboolean

When set to true, users can see the New button on the Rooms tab and can create a room.

canSubmitRoomsForReviewboolean

When set to true, users can submit rooms for review that are owned by them or someone they manage.

canCloseRoomsboolean

When set to true, users can review and close rooms that are owned by them or someone they manage.

canReopenRoomsboolean

When set to true, users can reopen rooms that are owned by them or someone they manage.

canDeleteOwnedRoomsboolean

When set to true, the user can delete rooms that are owned by them or someone they manage.

autoAccessToRoomsboolean

When set to true, users are automatically added to new rooms when someone with an internal role in their office or region creates or is invited to a room.

canExportRoomActivityDetailsPeopleboolean

When set to true, users can export the details, people, and history of a room to a PDF or CSV file.

isVisibleInRoomsboolean

When set to true, users who also have the autoAccessToRooms permission enabled are visible in those rooms.

canCopyRoomDetailsboolean

When set to true, users see a Copy room option in the room Actions menu, which copies the room's detail information to populate a new room.

canViewRoomDetailsboolean

When set to true, users can view all room detail fields that the company Admin has set to Use.

canViewAndEditRoomDetailsboolean

When set to true, users can view and make edits to any room detail fields.

canAddDocumentsboolean

When set to true, users can add documents to rooms and share the documents that they own with other people in the room.

canAddDocumentsFromFormGroupsboolean

When set to true, users can add documents from form groups to rooms.

canAddDocumentsFromFormLibrariesboolean

When set to true, users can add documents from form libraries to rooms.

documentsViewableByOthersInRoomFromOfficeboolean

When a user for whom this permission is set to true adds a document, the document is automatically shared with other room users that are in the user's office.

documentsAutoOwnedByPeersboolean

When a user for whom this permission is set to true adds a document, the document is automatically seen and owned by those users' peers. Peers are others in the same office or region who have the same access level as the user.

canDeleteOwnedDocumentsboolean

When set to true, users can delete documents that they own from rooms.

canManageSharedDocsboolean

When set to true, users can manage all documents, including ones that another user has shared with them.

canManageFormGroupsboolean

When set to true, users have access to Admin > Forms and can manage form groups and form libraries for the company.

canShareDocsNotOwnedboolean

When set to true, users can share documents that they do not own (documents that another user has shared with them).

canAddTasksToAnyTaskListsboolean

When set to true, users can add tasks to any task list, including lists that they do not own.

canEditEditableTasksboolean

When set to true, users can edit editable tasks.

canEditAnyTasksboolean

When set to true, users can edit tasks in rooms, even if the task owner has not marked the task as editable.

canDeleteDeletableTasksboolean

When set to true, users can delete deletable tasks.

canDeleteAnyTasksboolean

When set to true, users can delete tasks, even if the task owner has not marked the task as deletable.

canApplyTaskListboolean

When set to true, users see the Attach Task List option in the room's Actions menu and can apply task lists to rooms.

canRemoveAnyTaskListboolean

When set to true, users can use the Remove Task List option in the room's Actions menu to remove task lists owned by others.

Note: Users can already remove task lists that they own.

canSubmitTaskListboolean

When set to true, users can use the Submit Task List option in the room's Actions menu to submit task lists for review.

canAutoSubmitTaskListboolean

When set to true, users can use the Submit Task List option in the room's Actions menu to submit task lists for review.

canReviewTaskListboolean

When set to true, users can approve or decline a task list. Declining a task list sends it back to open status for the assignee to complete. The assignee also receives a notification.

canAutoApproveTaskListboolean

When set to true and a room is approved, the task lists associated with the room auto-approve if all of the tasks are approved.

canManageTaskTemplatesForAllRegionsAllOfficesboolean

When set to true, users have access to the Admin > Company > Task List Templates menu so that they can create, edit, and delete task list templates for all regions and offices.

canApplyRoomTemplatesboolean

When set to true, users can apply a room template when they create a room.

canAddTasksToRoomsboolean

When set to true, users can add tasks to rooms.

canCreateAndManagePackagesboolean

When set to true, the following functionality is enabled:

  • Users can create and manage all packages in a room, including the ability to update, void, correct, delete, copy, and rename packages. When they click on the New button on a room's Envelopes tab, users see an option to create a package. Without this permission, users can only create a new envelope.

  • All newly-created packages add all users in the room with this permission as facilitators (people who can create and manage packages).

  • Users without this permission only see sent packages in the room where they are a signer. They can click a package to enter the signing experience.

  • Users who are signers on unsent packages see all their envelopes, including regular envelopes and package envelopes in the Envelopes tab, but they do not see the packages.

  • Users in the room who are not a signer on a package and are not managers of a package do not see the Packages section on the Envelopes tab.

canAddMemberAndSetRoleLowerAccessLevelboolean

When set to true, users can add other users with a lower access level than their own to offices or regions that they oversee and set those users' roles.

canAddMemberAndSetRoleSameAccessLevelboolean

When set to true, users can add other users with the same access level as their own to offices or regions that they oversee and set those users' roles.

canChangeMemberRoleLowerAccessLevelboolean

When set to true, users can edit the roles of other users who have a lower access level than their own and that belong to offices or regions that they oversee.

canChangeMemberRoleSameAccessLevelboolean

When set to true, users can edit the roles of other users who have the same access level as their own and that belong to offices or regions that they oversee.

canManageMemberLowerAccessLevelboolean

When set to true, users can change the access level, office, region, and eSignature permission set of other users who have a lower access level than their own.

canManageMemberSameAccessLevelboolean

When set to true, users can change the access level, office, region, and eSignature permission set of other users who have the same access level as their own.

canRemoveCompanyMemberLowerAccessLevelboolean

When set to true, users can remove other users who have a lower access level than their own and that belong to offices or regions that they oversee from the company account.

canRemoveCompanyMemberSameAccessLevelboolean

When set to true, users can remove other users who have the same access level as their own and that belong to offices or regions that they oversee from the company account.

canManageAccountboolean

When set to true, users can access the Company Settings tab under Rooms > Admin > Company to manage company account settings and change the company name, contact information, currency, offices, and regions.

canManageLogoboolean

When set to true, users can access the Company Logo section in Company Settings to add or change the company logo.

canManageRoomDetailsboolean

When set to true, users see the Room Details tab under Rooms > Admin > Company and can use it to configure room details. They can also add additional contact fields.

canManageRoomTemplatesboolean

When set to true, users see the Room Templates option in the Rooms > Admin menu, which enables them to add, edit, and delete room templates.

Permissions

Contains details about permissions.

canAddUsersToRoomsboolean

When set to true, users can see the Invite button on the room's People tab and can invite people into a room.

canCreateRoomsboolean

When set to true, users can see the New button on the Rooms tab and can create a room.

canSubmitRoomsForReviewboolean

When set to true, users can submit rooms for review that are owned by them or someone they manage.

canCloseRoomsboolean

When set to true, users can review and close rooms that are owned by them or someone they manage.

canReopenRoomsboolean

When set to true, users can reopen rooms that are owned by them or someone they manage.

canDeleteOwnedRoomsboolean

When set to true, the user can delete rooms that are owned by them or someone they manage.

autoAccessToRoomsboolean

When set to true, users are automatically added to new rooms when someone with an internal role in their office or region creates or is invited to a room.

canExportRoomActivityDetailsPeopleboolean

When set to true, users can export the details, people, and history of a room to a PDF or CSV file.

isVisibleInRoomsboolean

When set to true, users who also have the autoAccessToRooms permission enabled are visible in those rooms.

canCopyRoomDetailsboolean

When set to true, users see a Copy room option in the room Actions menu, which copies the room's detail information to populate a new room.

canViewRoomDetailsboolean

When set to true, users can view all room detail fields that the company Admin has set to Use.

canViewAndEditRoomDetailsboolean

When set to true, users can view and make edits to any room detail fields.

canAddDocumentsboolean

When set to true, users can add documents to rooms and share the documents that they own with other people in the room.

canAddDocumentsFromFormGroupsboolean

When set to true, users can add documents from form groups to rooms.

canAddDocumentsFromFormLibrariesboolean

When set to true, users can add documents from form libraries to rooms.

documentsViewableByOthersInRoomFromOfficeboolean

When a user for whom this permission is set to true adds a document, the document is automatically shared with other room users that are in the user's office.

documentsAutoOwnedByPeersboolean

When a user for whom this permission is set to true adds a document, the document is automatically seen and owned by those users' peers. Peers are others in the same office or region who have the same access level as the user.

canDeleteOwnedDocumentsboolean

When set to true, users can delete documents that they own from rooms.

canManageSharedDocsboolean

When set to true, users can manage all documents, including ones that another user has shared with them.

canManageFormGroupsboolean

When set to true, users have access to Admin > Forms and can manage form groups and form libraries for the company.

canShareDocsNotOwnedboolean

When set to true, users can share documents that they do not own (documents that another user has shared with them).

canAddTasksToAnyTaskListsboolean

When set to true, users can add tasks to any task list, including lists that they do not own.

canEditEditableTasksboolean

When set to true, users can edit editable tasks.

canEditAnyTasksboolean

When set to true, users can edit tasks in rooms, even if the task owner has not marked the task as editable.

canDeleteDeletableTasksboolean

When set to true, users can delete deletable tasks.

canDeleteAnyTasksboolean

When set to true, users can delete tasks, even if the task owner has not marked the task as deletable.

canApplyTaskListboolean

When set to true, users see the Attach Task List option in the room's Actions menu and can apply task lists to rooms.

canRemoveAnyTaskListboolean

When set to true, users can use the Remove Task List option in the room's Actions menu to remove task lists owned by others.

Note: Users can already remove task lists that they own.

canSubmitTaskListboolean

When set to true, users can use the Submit Task List option in the room's Actions menu to submit task lists for review.

canAutoSubmitTaskListboolean

When set to true, users can use the Submit Task List option in the room's Actions menu to submit task lists for review.

canReviewTaskListboolean

When set to true, users can approve or decline a task list. Declining a task list sends it back to open status for the assignee to complete. The assignee also receives a notification.

canAutoApproveTaskListboolean

When set to true and a room is approved, the task lists associated with the room auto-approve if all of the tasks are approved.

canManageTaskTemplatesForAllRegionsAllOfficesboolean

When set to true, users have access to the Admin > Company > Task List Templates menu so that they can create, edit, and delete task list templates for all regions and offices.

canApplyRoomTemplatesboolean

When set to true, users can apply a room template when they create a room.

canAddTasksToRoomsboolean

When set to true, users can add tasks to rooms.

canCreateAndManagePackagesboolean

When set to true, the following functionality is enabled:

  • Users can create and manage all packages in a room, including the ability to update, void, correct, delete, copy, and rename packages. When they click on the New button on a room's Envelopes tab, users see an option to create a package. Without this permission, users can only create a new envelope.

  • All newly-created packages add all users in the room with this permission as facilitators (people who can create and manage packages).

  • Users without this permission only see sent packages in the room where they are a signer. They can click a package to enter the signing experience.

  • Users who are signers on unsent packages see all their envelopes, including regular envelopes and package envelopes in the Envelopes tab, but they do not see the packages.

  • Users in the room who are not a signer on a package and are not managers of a package do not see the Packages section on the Envelopes tab.

canAddMemberAndSetRoleLowerAccessLevelboolean

When set to true, users can add other users with a lower access level than their own to offices or regions that they oversee and set those users' roles.

canAddMemberAndSetRoleSameAccessLevelboolean

When set to true, users can add other users with the same access level as their own to offices or regions that they oversee and set those users' roles.

canChangeMemberRoleLowerAccessLevelboolean

When set to true, users can edit the roles of other users who have a lower access level than their own and that belong to offices or regions that they oversee.

canChangeMemberRoleSameAccessLevelboolean

When set to true, users can edit the roles of other users who have the same access level as their own and that belong to offices or regions that they oversee.

canManageMemberLowerAccessLevelboolean

When set to true, users can change the access level, office, region, and eSignature permission set of other users who have a lower access level than their own.

canManageMemberSameAccessLevelboolean

When set to true, users can change the access level, office, region, and eSignature permission set of other users who have the same access level as their own.

canRemoveCompanyMemberLowerAccessLevelboolean

When set to true, users can remove other users who have a lower access level than their own and that belong to offices or regions that they oversee from the company account.

canRemoveCompanyMemberSameAccessLevelboolean

When set to true, users can remove other users who have the same access level as their own and that belong to offices or regions that they oversee from the company account.

canManageAccountboolean

When set to true, users can access the Company Settings tab under Rooms > Admin > Company to manage company account settings and change the company name, contact information, currency, offices, and regions.

canManageLogoboolean

When set to true, users can access the Company Logo section in Company Settings to add or change the company logo.

canManageRoomDetailsboolean

When set to true, users see the Room Details tab under Rooms > Admin > Company and can use it to configure room details. They can also add additional contact fields.

canManageRoomTemplatesboolean

When set to true, users see the Room Templates option in the Rooms > Admin menu, which enables them to add, edit, and delete room templates.

Role

Contains details about a company role.

roleIdinteger

In Rooms v6, this is the id of the company role assigned to the user.

legacyRoleIdstring

The legacy name of the role in Rooms Version 5.

namestring

The name of the role.

isDefaultForAdminboolean

When true, the role is the default for account administrators.

isExternalboolean

When set to true, the role is an external role. You assign external roles to people from outside your company when you invite them into a room.

createdDatestring

The UTC date and time when the item was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

isAssignedboolean

When set to true, indicates that this role is currently assigned to a user.

permissionsNullable[Permissions]

An object that contains details about a manager user's permissions.

Note: These permissions only apply to Rooms v5.

RoleForCreate

Contains details about the role that you want to create.

namestring

The name of the role.

isExternalboolean

When set to true, the role is an external role. You assign external roles to people from outside your company when you invite them into a room.

permissionsPermissions

An object that contains details about the permissions associated with the role.

}} />