--- title: "MasterRights.update" method: PATCH path: "/entities/MasterRights/{id}" tags: ["MasterRight"] --- # MasterRights.update `PATCH /entities/MasterRights/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/MasterRights/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the MasterRight record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateMasterRightInput: Field values to change on a MasterRight record; fields left out keep their values. - `access_account_relation_types` boolean: Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. - `access_accounts` boolean: Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by access_entity_account. - `access_ai_automatizer` boolean: Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. - `access_ai_online_forms` boolean: Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. - `access_ai_record_detail` boolean: Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. - `access_ai_record_enrichment` boolean: Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. - `access_ai_relationship_charts` boolean: Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. - `access_ai_reports` boolean: Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. - `access_ai_smart_field` boolean: Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. - `access_appointment_scheduler` boolean: Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. - `access_appointment_scheduler_management` boolean: Allows users with this role to manage appointment schedules of other users. - `access_approval_processes` boolean: Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. - `access_approval_processes_management` boolean: Allows users with this role to manage approval processes owned by other users. - `access_approvals` boolean: Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. - `access_archive` boolean: Allows users with this role to open the Archive screens listing lost, closed and archived records. - `access_audit` boolean: Allows users with this role to open the Audit screen. - `access_audit_log` boolean: Allows users with this role to view the audit log of changes made in the space. - `access_bottom_menu_customization` boolean: Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottom_menu_layout; a layout of their own (UISettings.bottom_menu_layout) is still stored but read as null until this is switched on. - `access_bulk_update` boolean: Allows users with this role to update many records at once with bulk update. - `access_calling` boolean: Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. - `access_calling_company_phone` 0 | 1 | 2: Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowed_company_phones (Selected) or all (All). Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_calling_purchase_phone` boolean: Allows users with this role to purchase and manage company phone numbers for the calling integration. - `access_company_emails` 0 | 1 | 2: Which shared company email accounts users with this role can send from: none (NoAccess), those in allowed_company_emails (Selected) or all (All). Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_contacts` boolean: Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by access_entity_contact. - `access_document_management` boolean: Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. - `access_document_management_company` boolean: Allows users with this role to manage company documents and folders that are not tied to a record. - `access_document_management_record` boolean: Allows users with this role to create and edit the document folders used for records. - `access_duplicate_checker` boolean: Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. - `access_email_notification_enforcement` boolean: When true, users with this role get the email notification preferences from access_email_notification_settings and cannot change their own. - `access_email_notification_settings` object: Default email notification preferences applied to users with this role (which events trigger an email and through which channel). - `access_entity_account` 0 | 1 | 2 | 3 | 4: Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_account_copy` boolean: Allows users with this role to create copies of existing accounts. - `access_entity_account_delete` boolean: Allows users with this role to delete accounts they can edit. - `access_entity_account_direction` 1 | 2 | 3 | 4 | 5 | 6: Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_account_private` boolean: Allows users with this role to own private accounts, which are visible only to their owner. - `access_entity_account_tag_create` boolean: Allows users with this role to create new tags for accounts. - `access_entity_account_types` 1 | 2: Whether users with this role can work with all account types (All) or only with those in allowed_account_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_appointment` 0 | 1 | 2 | 3 | 4: Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_appointment_delete` boolean: Allows users with this role to delete appointments they can edit. - `access_entity_appointment_direction` 1 | 2 | 3 | 4 | 5 | 6: Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_appointment_tag_create` boolean: Allows users with this role to create new tags for appointments. - `access_entity_appointment_types` 1 | 2: Whether users with this role can work with all appointment types (All) or only with those in allowed_appointment_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_better_navigator` 0 | 1 | 4: Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_better_navigator_delete_not_owned` boolean: Allows users with this role to delete Navigator screen layouts owned by other users. - `access_entity_better_navigator_delete_owned` boolean: Allows users with this role to delete Navigator screen layouts they own. - `access_entity_better_navigator_sharing_custom` boolean: Allows users with this role to share their Navigator screen layouts with selected users and sales units. - `access_entity_better_navigator_sharing_public` boolean: Allows users with this role to share their Navigator screen layouts with all users of the space. - `access_entity_contact` 0 | 1 | 2 | 3 | 4: Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_contact_copy` boolean: Allows users with this role to create copies of existing contacts. - `access_entity_contact_delete` boolean: Allows users with this role to delete contacts they can edit. - `access_entity_contact_direction` 1 | 2 | 3 | 4 | 5 | 6: Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_contact_private` boolean: Allows users with this role to own private contacts, which are visible only to their owner. - `access_entity_contact_tag_create` boolean: Allows users with this role to create new tags for contacts. - `access_entity_contact_types` 1 | 2: Whether users with this role can work with all contact types (All) or only with those in allowed_contact_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_dashboard` 0 | 1 | 4: Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while access_entity_report is NoAccess. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_dashboard_delete_not_owned` boolean: Allows users with this role to delete dashboards owned by other users. - `access_entity_dashboard_delete_owned` boolean: Allows users with this role to delete dashboards they own. - `access_entity_dashboard_sharing_custom` boolean: Allows users with this role to share their dashboards with selected users and sales units. - `access_entity_dashboard_sharing_public` boolean: Allows users with this role to share their dashboards with all users of the space. - `access_entity_email_access_level` 0 | 1: Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in access_entity_email_allowed (own and shared-with-me emails always stay visible). The Inbox is not affected. Integer enum value: 0 - Default, 1 - UsersAndSalesUnits - `access_entity_email_allowed` object: Allow-list for access_entity_email_access_level = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default. - `access_entity_email_content_share_mode` 0 | 1 | 2: How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly - `access_entity_email_delete_not_owned` boolean: Allows users with this role to delete emails they neither own nor sent. - `access_entity_email_link_to_accounts` 0 | 1 | 2: Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. Integer enum value: 0 - Custom, 1 - On, 2 - Off - `access_entity_email_link_to_accounts_by_domain` 0 | 1 | 2: Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. Integer enum value: 0 - Custom, 1 - On, 2 - Off - `access_entity_email_link_to_contacts` 0 | 1 | 2: Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. Integer enum value: 0 - Custom, 1 - On, 2 - Off - `access_entity_email_sequence` 1 | 2 | 3: Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_email_template` 0 | 1 | 4: Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_email_template_create_delete_folder` boolean: Allows users with this role to create and delete email template folders. - `access_entity_email_template_delete_not_owned` boolean: Allows users with this role to delete email templates owned by other users. - `access_entity_email_template_delete_owned` boolean: Allows users with this role to delete email templates they own. - `access_entity_email_template_sharing_custom` boolean: Allows users with this role to share their email templates with selected users and sales units. - `access_entity_email_template_sharing_public` boolean: Allows users with this role to share their email templates with all users of the space. - `access_entity_forecast` 0 | 1 | 4: Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_forecast_delete_not_owned` boolean: Allows users with this role to delete forecasts owned by other users. - `access_entity_forecast_delete_owned` boolean: Allows users with this role to delete forecasts they own. - `access_entity_forecast_edit_not_owned` boolean: Allows users with this role to edit forecasts owned by other users. - `access_entity_forecast_sharing_custom` boolean: Allows users with this role to share their forecasts with selected users and sales units. - `access_entity_forecast_sharing_public` boolean: Allows users with this role to share their forecasts with all users of the space. - `access_entity_form_view` 0 | 1 | 4: Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_form_view_delete_not_owned` boolean: Allows users with this role to delete form views owned by other users. - `access_entity_form_view_delete_owned` boolean: Allows users with this role to delete form views they own. - `access_entity_form_view_sharing_custom` boolean: Allows users with this role to share their form views with selected users and sales units. - `access_entity_form_view_sharing_public` boolean: Allows users with this role to share their form views with all users of the space. - `access_entity_lead` 0 | 1 | 2 | 3 | 4: Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_lead_copy` boolean: Allows users with this role to create copies of existing leads. - `access_entity_lead_delete` boolean: Allows users with this role to delete leads they can edit. - `access_entity_lead_direction` 1 | 2 | 3 | 4 | 5 | 6: Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_lead_private` boolean: Allows users with this role to own private leads, which are visible only to their owner. - `access_entity_lead_tag_create` boolean: Allows users with this role to create new tags for leads. - `access_entity_lead_types` 1 | 2: Whether users with this role can work with all lead types (All) or only with those in allowed_lead_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_message_tag_create` boolean: Allows users with this role to create new tags for emails, memos and text messages. - `access_entity_oppty` 0 | 1 | 2 | 3 | 4: Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_oppty_copy` boolean: Allows users with this role to create copies of existing opportunities. - `access_entity_oppty_delete` boolean: Allows users with this role to delete opportunities they can edit. - `access_entity_oppty_direction` 1 | 2 | 3 | 4 | 5 | 6: Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_oppty_private` boolean: Allows users with this role to own private opportunities, which are visible only to their owner. - `access_entity_oppty_tag_create` boolean: Allows users with this role to create new tags for opportunities. - `access_entity_pipeline` 0 | 1 | 2 | 3: Which pipelines users with this role can work with: none (NoPipeline), those in allowed_pipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments - `access_entity_process` 1 | 2 | 3: Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_profile` 0 | 1 | 4: Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_profile_default_screen_profiles` object: Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.). - `access_entity_profile_delete_not_owned` boolean: Allows users with this role to delete screen profiles owned by other users. - `access_entity_profile_delete_owned` boolean: Allows users with this role to delete screen profiles they own. - `access_entity_profile_sharing_custom` boolean: Allows users with this role to share their screen profiles with selected users and sales units. - `access_entity_profile_sharing_public` boolean: Allows users with this role to share their screen profiles with all users of the space. - `access_entity_project` 0 | 1 | 2 | 3 | 4: Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_project_copy` boolean: Allows users with this role to create copies of existing projects. - `access_entity_project_delete` boolean: Allows users with this role to delete projects they can edit. - `access_entity_project_direction` 1 | 2 | 3 | 4 | 5 | 6: Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_project_private` boolean: Allows users with this role to own private projects, which are visible only to their owner. - `access_entity_project_tag_create` boolean: Allows users with this role to create new tags for projects. - `access_entity_quote` 0 | 1 | 2 | 3 | 4: Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_quote_copy` boolean: Allows users with this role to create copies of existing quotes. - `access_entity_quote_delete` boolean: Allows users with this role to delete quotes they can edit. - `access_entity_quote_direction` 1 | 2 | 3 | 4 | 5 | 6: Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_quote_tag_create` boolean: Allows users with this role to create new tags for quotes. - `access_entity_quote_types` 1 | 2: Whether users with this role can work with all quote types (All) or only with those in allowed_quote_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_report` 0 | 1 | 4: Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_report_create_delete_folder` boolean: Allows users with this role to create and delete report folders. - `access_entity_report_delete_not_owned` boolean: Allows users with this role to delete reports owned by other users. - `access_entity_report_delete_owned` boolean: Allows users with this role to delete reports they own. - `access_entity_report_private` boolean: Allows users with this role to save reports as private, visible only to themselves. - `access_entity_report_schedule_create` boolean: Allows users with this role to schedule reports for regular delivery. - `access_entity_report_schedule_management` boolean: Allows users with this role to view and manage report schedules of other users. - `access_entity_report_sharing_custom` boolean: Allows users with this role to share their reports with selected users and sales units. - `access_entity_report_sharing_public` boolean: Allows users with this role to share their reports with all users of the space. - `access_entity_solution` boolean: Allows users with this role to view and follow solutions, when the feature is enabled for the space. - `access_entity_solution_management` boolean: Allows users with this role to create, edit and delete solutions. - `access_entity_target` 0 | 1 | 4: Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_target_delete_not_owned` boolean: Allows users with this role to delete targets owned by other users. - `access_entity_target_delete_owned` boolean: Allows users with this role to delete targets they own. - `access_entity_task` 0 | 1 | 2 | 3 | 4: Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_task_delete` boolean: Allows users with this role to delete tasks they can edit. - `access_entity_task_direction` 1 | 2 | 3 | 4 | 5 | 6: Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_task_tag_create` boolean: Allows users with this role to create new tags for tasks. - `access_entity_task_types` 1 | 2: Whether users with this role can work with all task types (All) or only with those in allowed_task_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_task_unassigned` boolean: Allows users with this role to create tasks without an owner (unassigned tasks). - `access_export` boolean: Allows users with this role to export records and reports to files. - `access_feeds` boolean: Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. - `access_foreign_currencies` boolean: Allows users with this role to manage currencies and exchange rate lists in Administration. - `access_form_and_fields` boolean: Allows users with this role to manage fields, forms, record types, tags and translations in Administration. - `access_global_settings` boolean: Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. - `access_home_screen` boolean: Allows users with this role to open the Navigator screen. - `access_import` boolean: Allows users with this role to import records from files. - `access_insights` boolean: Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. - `access_leads` boolean: Shows the Leads screen to users with this role. Which leads they can see and edit is set by access_entity_lead. - `access_online_forms` boolean: Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. - `access_online_forms_management` boolean: Allows users with this role to edit and delete online forms owned by other users. - `access_opportunity` boolean: Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by access_entity_oppty. - `access_pipeline_configuration` boolean: Allows users with this role to manage pipelines, lead processes and quote processes in Administration. - `access_print` boolean: Allows users with this role to print records and reports. - `access_products_services` boolean: Allows users with this role to manage products, product categories and price lists in Administration. - `access_projects` boolean: Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by access_entity_project. - `access_quotes` boolean: Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by access_entity_quote. - `access_sales_roles` boolean: Allows users with this role to manage sales roles in Administration. - `access_security` boolean: Allows users with this role to manage the security settings of the space in Administration. - `access_units` boolean: Allows users with this role to manage sales units in Administration. - `access_user_and_roles` boolean: Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. - `access_whats_app_company_phone` 0 | 1 | 2: Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowed_company_phones (Selected) or all (All). Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `bottom_menu_layout` object: The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both. - `name` string: Name of the entity and its default text representation. - `revision` integer: Revision when entity was lastly changed. - `allowed_pipelines` object[]: Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted. - `id` string, uuid: Id of the related AllowedPipeline record. - `allowed_lead_types` object[]: Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected. - `id` string, uuid: Id of the related AllowedLeadType record. - `allowed_quote_types` object[]: Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected. - `id` string, uuid: Id of the related AllowedQuoteType record. - `allowed_account_types` object[]: Account types this user role can use. Effective only when access_entity_account_types is set to Selected. - `id` string, uuid: Id of the related AllowedAccountType record. - `allowed_contact_types` object[]: Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected. - `id` string, uuid: Id of the related AllowedContactType record. - `allowed_task_types` object[]: Task types this user role can use. Effective only when access_entity_task_types is set to Selected. - `id` string, uuid: Id of the related AllowedTaskType record. - `allowed_appointment_types` object[]: Appointment types this user role can use. Effective only when access_entity_appointment_types is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. - `id` string, uuid: Id of the related AllowedAppointmentType record. - `allowed_company_emails` object[]: Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected. - `id` string, uuid: Id of the related AllowedCompanyEmail record. - `allowed_company_phones` object[]: Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected. - `id` string, uuid: Id of the related AllowedCompanyPhone record. - `custom_entities` string, binary: Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space. ## Response `200` The changed MasterRight record. - object - `success` boolean: True when the request succeeded; false on error. - `data` MasterRight: User role in the space that defines which features, records and pipelines its users can access. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `access_account_relation_types` boolean: Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. - `access_accounts` boolean: Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by access_entity_account. - `access_ai_automatizer` boolean: Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. - `access_ai_online_forms` boolean: Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. - `access_ai_record_detail` boolean: Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. - `access_ai_record_enrichment` boolean: Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. - `access_ai_relationship_charts` boolean: Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. - `access_ai_reports` boolean: Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. - `access_ai_smart_field` boolean: Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. - `access_appointment_scheduler` boolean: Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. - `access_appointment_scheduler_management` boolean: Allows users with this role to manage appointment schedules of other users. - `access_approval_processes` boolean: Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. - `access_approval_processes_management` boolean: Allows users with this role to manage approval processes owned by other users. - `access_approvals` boolean: Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. - `access_archive` boolean: Allows users with this role to open the Archive screens listing lost, closed and archived records. - `access_audit` boolean: Allows users with this role to open the Audit screen. - `access_audit_log` boolean: Allows users with this role to view the audit log of changes made in the space. - `access_bottom_menu_customization` boolean: Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottom_menu_layout; a layout of their own (UISettings.bottom_menu_layout) is still stored but read as null until this is switched on. - `access_bulk_update` boolean: Allows users with this role to update many records at once with bulk update. - `access_calling` boolean: Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. - `access_calling_company_phone` 0 | 1 | 2: Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowed_company_phones (Selected) or all (All). Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_calling_purchase_phone` boolean: Allows users with this role to purchase and manage company phone numbers for the calling integration. - `access_company_emails` 0 | 1 | 2: Which shared company email accounts users with this role can send from: none (NoAccess), those in allowed_company_emails (Selected) or all (All). Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_contacts` boolean: Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by access_entity_contact. - `access_document_management` boolean: Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. - `access_document_management_company` boolean: Allows users with this role to manage company documents and folders that are not tied to a record. - `access_document_management_record` boolean: Allows users with this role to create and edit the document folders used for records. - `access_duplicate_checker` boolean: Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. - `access_email_notification_enforcement` boolean: When true, users with this role get the email notification preferences from access_email_notification_settings and cannot change their own. - `access_email_notification_settings` object: Default email notification preferences applied to users with this role (which events trigger an email and through which channel). - `access_entity_account` 0 | 1 | 2 | 3 | 4: Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_account_copy` boolean: Allows users with this role to create copies of existing accounts. - `access_entity_account_delete` boolean: Allows users with this role to delete accounts they can edit. - `access_entity_account_direction` 1 | 2 | 3 | 4 | 5 | 6: Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_account_private` boolean: Allows users with this role to own private accounts, which are visible only to their owner. - `access_entity_account_tag_create` boolean: Allows users with this role to create new tags for accounts. - `access_entity_account_types` 1 | 2: Whether users with this role can work with all account types (All) or only with those in allowed_account_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_appointment` 0 | 1 | 2 | 3 | 4: Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_appointment_delete` boolean: Allows users with this role to delete appointments they can edit. - `access_entity_appointment_direction` 1 | 2 | 3 | 4 | 5 | 6: Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_appointment_tag_create` boolean: Allows users with this role to create new tags for appointments. - `access_entity_appointment_types` 1 | 2: Whether users with this role can work with all appointment types (All) or only with those in allowed_appointment_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_better_navigator` 0 | 1 | 4: Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_better_navigator_delete_not_owned` boolean: Allows users with this role to delete Navigator screen layouts owned by other users. - `access_entity_better_navigator_delete_owned` boolean: Allows users with this role to delete Navigator screen layouts they own. - `access_entity_better_navigator_sharing_custom` boolean: Allows users with this role to share their Navigator screen layouts with selected users and sales units. - `access_entity_better_navigator_sharing_public` boolean: Allows users with this role to share their Navigator screen layouts with all users of the space. - `access_entity_contact` 0 | 1 | 2 | 3 | 4: Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_contact_copy` boolean: Allows users with this role to create copies of existing contacts. - `access_entity_contact_delete` boolean: Allows users with this role to delete contacts they can edit. - `access_entity_contact_direction` 1 | 2 | 3 | 4 | 5 | 6: Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_contact_private` boolean: Allows users with this role to own private contacts, which are visible only to their owner. - `access_entity_contact_tag_create` boolean: Allows users with this role to create new tags for contacts. - `access_entity_contact_types` 1 | 2: Whether users with this role can work with all contact types (All) or only with those in allowed_contact_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_dashboard` 0 | 1 | 4: Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while access_entity_report is NoAccess. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_dashboard_delete_not_owned` boolean: Allows users with this role to delete dashboards owned by other users. - `access_entity_dashboard_delete_owned` boolean: Allows users with this role to delete dashboards they own. - `access_entity_dashboard_sharing_custom` boolean: Allows users with this role to share their dashboards with selected users and sales units. - `access_entity_dashboard_sharing_public` boolean: Allows users with this role to share their dashboards with all users of the space. - `access_entity_email_access_level` 0 | 1: Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in access_entity_email_allowed (own and shared-with-me emails always stay visible). The Inbox is not affected. Integer enum value: 0 - Default, 1 - UsersAndSalesUnits - `access_entity_email_allowed` object: Allow-list for access_entity_email_access_level = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default. - `access_entity_email_content_share_mode` 0 | 1 | 2: How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly - `access_entity_email_delete_not_owned` boolean: Allows users with this role to delete emails they neither own nor sent. - `access_entity_email_link_to_accounts` 0 | 1 | 2: Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. Integer enum value: 0 - Custom, 1 - On, 2 - Off - `access_entity_email_link_to_accounts_by_domain` 0 | 1 | 2: Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. Integer enum value: 0 - Custom, 1 - On, 2 - Off - `access_entity_email_link_to_contacts` 0 | 1 | 2: Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. Integer enum value: 0 - Custom, 1 - On, 2 - Off - `access_entity_email_sequence` 1 | 2 | 3: Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_email_template` 0 | 1 | 4: Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_email_template_create_delete_folder` boolean: Allows users with this role to create and delete email template folders. - `access_entity_email_template_delete_not_owned` boolean: Allows users with this role to delete email templates owned by other users. - `access_entity_email_template_delete_owned` boolean: Allows users with this role to delete email templates they own. - `access_entity_email_template_sharing_custom` boolean: Allows users with this role to share their email templates with selected users and sales units. - `access_entity_email_template_sharing_public` boolean: Allows users with this role to share their email templates with all users of the space. - `access_entity_forecast` 0 | 1 | 4: Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_forecast_delete_not_owned` boolean: Allows users with this role to delete forecasts owned by other users. - `access_entity_forecast_delete_owned` boolean: Allows users with this role to delete forecasts they own. - `access_entity_forecast_edit_not_owned` boolean: Allows users with this role to edit forecasts owned by other users. - `access_entity_forecast_sharing_custom` boolean: Allows users with this role to share their forecasts with selected users and sales units. - `access_entity_forecast_sharing_public` boolean: Allows users with this role to share their forecasts with all users of the space. - `access_entity_form_view` 0 | 1 | 4: Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_form_view_delete_not_owned` boolean: Allows users with this role to delete form views owned by other users. - `access_entity_form_view_delete_owned` boolean: Allows users with this role to delete form views they own. - `access_entity_form_view_sharing_custom` boolean: Allows users with this role to share their form views with selected users and sales units. - `access_entity_form_view_sharing_public` boolean: Allows users with this role to share their form views with all users of the space. - `access_entity_lead` 0 | 1 | 2 | 3 | 4: Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_lead_copy` boolean: Allows users with this role to create copies of existing leads. - `access_entity_lead_delete` boolean: Allows users with this role to delete leads they can edit. - `access_entity_lead_direction` 1 | 2 | 3 | 4 | 5 | 6: Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_lead_private` boolean: Allows users with this role to own private leads, which are visible only to their owner. - `access_entity_lead_tag_create` boolean: Allows users with this role to create new tags for leads. - `access_entity_lead_types` 1 | 2: Whether users with this role can work with all lead types (All) or only with those in allowed_lead_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_message_tag_create` boolean: Allows users with this role to create new tags for emails, memos and text messages. - `access_entity_oppty` 0 | 1 | 2 | 3 | 4: Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_oppty_copy` boolean: Allows users with this role to create copies of existing opportunities. - `access_entity_oppty_delete` boolean: Allows users with this role to delete opportunities they can edit. - `access_entity_oppty_direction` 1 | 2 | 3 | 4 | 5 | 6: Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_oppty_private` boolean: Allows users with this role to own private opportunities, which are visible only to their owner. - `access_entity_oppty_tag_create` boolean: Allows users with this role to create new tags for opportunities. - `access_entity_pipeline` 0 | 1 | 2 | 3: Which pipelines users with this role can work with: none (NoPipeline), those in allowed_pipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments - `access_entity_process` 1 | 2 | 3: Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_profile` 0 | 1 | 4: Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_profile_default_screen_profiles` object: Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.). - `access_entity_profile_delete_not_owned` boolean: Allows users with this role to delete screen profiles owned by other users. - `access_entity_profile_delete_owned` boolean: Allows users with this role to delete screen profiles they own. - `access_entity_profile_sharing_custom` boolean: Allows users with this role to share their screen profiles with selected users and sales units. - `access_entity_profile_sharing_public` boolean: Allows users with this role to share their screen profiles with all users of the space. - `access_entity_project` 0 | 1 | 2 | 3 | 4: Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_project_copy` boolean: Allows users with this role to create copies of existing projects. - `access_entity_project_delete` boolean: Allows users with this role to delete projects they can edit. - `access_entity_project_direction` 1 | 2 | 3 | 4 | 5 | 6: Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_project_private` boolean: Allows users with this role to own private projects, which are visible only to their owner. - `access_entity_project_tag_create` boolean: Allows users with this role to create new tags for projects. - `access_entity_quote` 0 | 1 | 2 | 3 | 4: Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_quote_copy` boolean: Allows users with this role to create copies of existing quotes. - `access_entity_quote_delete` boolean: Allows users with this role to delete quotes they can edit. - `access_entity_quote_direction` 1 | 2 | 3 | 4 | 5 | 6: Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_quote_tag_create` boolean: Allows users with this role to create new tags for quotes. - `access_entity_quote_types` 1 | 2: Whether users with this role can work with all quote types (All) or only with those in allowed_quote_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_report` 0 | 1 | 4: Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_report_create_delete_folder` boolean: Allows users with this role to create and delete report folders. - `access_entity_report_delete_not_owned` boolean: Allows users with this role to delete reports owned by other users. - `access_entity_report_delete_owned` boolean: Allows users with this role to delete reports they own. - `access_entity_report_private` boolean: Allows users with this role to save reports as private, visible only to themselves. - `access_entity_report_schedule_create` boolean: Allows users with this role to schedule reports for regular delivery. - `access_entity_report_schedule_management` boolean: Allows users with this role to view and manage report schedules of other users. - `access_entity_report_sharing_custom` boolean: Allows users with this role to share their reports with selected users and sales units. - `access_entity_report_sharing_public` boolean: Allows users with this role to share their reports with all users of the space. - `access_entity_solution` boolean: Allows users with this role to view and follow solutions, when the feature is enabled for the space. - `access_entity_solution_management` boolean: Allows users with this role to create, edit and delete solutions. - `access_entity_target` 0 | 1 | 4: Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_target_delete_not_owned` boolean: Allows users with this role to delete targets owned by other users. - `access_entity_target_delete_owned` boolean: Allows users with this role to delete targets they own. - `access_entity_task` 0 | 1 | 2 | 3 | 4: Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_task_delete` boolean: Allows users with this role to delete tasks they can edit. - `access_entity_task_direction` 1 | 2 | 3 | 4 | 5 | 6: Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_task_tag_create` boolean: Allows users with this role to create new tags for tasks. - `access_entity_task_types` 1 | 2: Whether users with this role can work with all task types (All) or only with those in allowed_task_types (Selected). Integer enum value: 1 - All, 2 - Selected - `access_entity_task_unassigned` boolean: Allows users with this role to create tasks without an owner (unassigned tasks). - `access_export` boolean: Allows users with this role to export records and reports to files. - `access_feeds` boolean: Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. - `access_foreign_currencies` boolean: Allows users with this role to manage currencies and exchange rate lists in Administration. - `access_form_and_fields` boolean: Allows users with this role to manage fields, forms, record types, tags and translations in Administration. - `access_global_settings` boolean: Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. - `access_home_screen` boolean: Allows users with this role to open the Navigator screen. - `access_import` boolean: Allows users with this role to import records from files. - `access_insights` boolean: Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. - `access_leads` boolean: Shows the Leads screen to users with this role. Which leads they can see and edit is set by access_entity_lead. - `access_online_forms` boolean: Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. - `access_online_forms_management` boolean: Allows users with this role to edit and delete online forms owned by other users. - `access_opportunity` boolean: Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by access_entity_oppty. - `access_pipeline_configuration` boolean: Allows users with this role to manage pipelines, lead processes and quote processes in Administration. - `access_print` boolean: Allows users with this role to print records and reports. - `access_products_services` boolean: Allows users with this role to manage products, product categories and price lists in Administration. - `access_projects` boolean: Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by access_entity_project. - `access_quotes` boolean: Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by access_entity_quote. - `access_sales_roles` boolean: Allows users with this role to manage sales roles in Administration. - `access_security` boolean: Allows users with this role to manage the security settings of the space in Administration. - `access_units` boolean: Allows users with this role to manage sales units in Administration. - `access_user_and_roles` boolean: Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. - `access_whats_app_company_phone` 0 | 1 | 2: Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowed_company_phones (Selected) or all (All). Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `bottom_menu_layout` object: The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both. - `name` string, required: Name of the entity and its default text representation. - `revision` integer: Revision when entity was lastly changed. - `allowed_pipelines` string[]: Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted. - `allowed_lead_types` string[]: Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected. - `allowed_quote_types` string[]: Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected. - `allowed_account_types` string[]: Account types this user role can use. Effective only when access_entity_account_types is set to Selected. - `allowed_contact_types` string[]: Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected. - `allowed_task_types` string[]: Task types this user role can use. Effective only when access_entity_task_types is set to Selected. - `allowed_appointment_types` string[]: Appointment types this user role can use. Effective only when access_entity_appointment_types is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. - `allowed_company_emails` string[]: Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected. - `allowed_company_phones` string[]: Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected. - `custom_entities` string, binary: Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). - `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)