Module roles_api

Enums§

AddOrUpdateRoleSettingError: struct for typed errors of method add_or_update_role_setting
AddRoleAssignmentError: struct for typed errors of method add_role_assignment
AddRoleError: struct for typed errors of method add_role
DeleteRoleAssignmentError: struct for typed errors of method delete_role_assignment
DeleteRoleError: struct for typed errors of method delete_role
GetRoleAssignmentsError: struct for typed errors of method get_role_assignments
GetRoleError: struct for typed errors of method get_role
GetRolePipelinesError: struct for typed errors of method get_role_pipelines
GetRoleSettingsError: struct for typed errors of method get_role_settings
GetRolesError: struct for typed errors of method get_roles
UpdateRoleError: struct for typed errors of method update_role
UpdateRolePipelinesError: struct for typed errors of method update_role_pipelines

add_or_update_role_setting: Adds or updates the visibility setting for a role.
add_role: Adds a new role.
add_role_assignment: Assigns a user to a role.
delete_role: Marks a role as deleted.
delete_role_assignment: Removes the assigned user from a role and adds to the default role.
get_role: Returns the details of a specific role.
get_role_assignments: Returns all users assigned to a role.
get_role_pipelines: Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href="https://support.pipedrive.com/en/article/visibility-groups" target="_blank" rel="noopener noreferrer">Visibility groups article.
get_role_settings: Returns the visibility settings of a specific role.
get_roles: Returns all the roles within the company.
update_role: Updates the parent role and/or the name of a specific role.
update_role_pipelines: Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href="https://support.pipedrive.com/en/article/visibility-groups" target="_blank" rel="noopener noreferrer">Visibility groups article.