--- title: "MasterRights.update" method: PATCH path: "/entities/MasterRights/{id}" tags: ["MasterRight"] --- # MasterRights.update `PATCH /entities/MasterRights/{id}` Modifies MasterRight or MasterRights with given id(s) ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateMasterRightInput - `access_account_relation_types` boolean — Controls access to resource. - `access_accounts` boolean — Controls access to resource. - `access_ai_automatizer` boolean — Controls access to resource. - `access_ai_online_forms` boolean — Controls access to resource. - `access_ai_record_detail` boolean — Controls access to resource. - `access_ai_record_enrichment` boolean — Controls access to resource. - `access_ai_relationship_charts` boolean — Controls access to resource. - `access_ai_reports` boolean — Controls access to resource. - `access_ai_smart_field` boolean — Controls access to resource. - `access_appointment_scheduler` boolean — Controls access to resource. - `access_appointment_scheduler_management` boolean — Controls access to resource. - `access_approval_processes` boolean — Controls access to resource. - `access_approval_processes_management` boolean — Controls access to resource. - `access_approvals` boolean — Controls access to resource. - `access_archive` boolean — Controls access to resource. - `access_audit` boolean — Controls access to resource. - `access_audit_log` boolean — Controls access to resource. - `access_bulk_update` boolean — Controls access to resource. - `access_calling` boolean — Controls access to resource. - `access_calling_company_phone` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_calling_purchase_phone` boolean — Controls access to resource. - `access_company_emails` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_contacts` boolean — Controls access to resource. - `access_document_management` boolean — Controls access to resource. - `access_document_management_company` boolean — Controls access to resource. - `access_document_management_record` boolean — Controls access to resource. - `access_duplicate_checker` boolean — Controls access to resource. - `access_email_notification_enforcement` boolean — Controls access to resource. - `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 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_account_copy` boolean — Controls access to resource. - `access_entity_account_delete` boolean — Controls access to resource. - `access_entity_account_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_account_private` boolean — Controls access to resource. - `access_entity_account_tag_create` boolean — Controls access to resource. - `access_entity_account_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_appointment` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_appointment_delete` boolean — Controls access to resource. - `access_entity_appointment_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_appointment_tag_create` boolean — Controls access to resource. - `access_entity_better_navigator` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_better_navigator_delete_not_owned` boolean — Controls access to resource. - `access_entity_better_navigator_delete_owned` boolean — Controls access to resource. - `access_entity_better_navigator_sharing_custom` boolean — Controls access to resource. - `access_entity_better_navigator_sharing_public` boolean — Controls access to resource. - `access_entity_contact` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_contact_copy` boolean — Controls access to resource. - `access_entity_contact_delete` boolean — Controls access to resource. - `access_entity_contact_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_contact_private` boolean — Controls access to resource. - `access_entity_contact_tag_create` boolean — Controls access to resource. - `access_entity_contact_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_dashboard` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_dashboard_delete_not_owned` boolean — Controls access to resource. - `access_entity_dashboard_delete_owned` boolean — Controls access to resource. - `access_entity_dashboard_sharing_custom` boolean — Controls access to resource. - `access_entity_dashboard_sharing_public` boolean — Controls access to resource. - `access_entity_email_content_share_mode` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly - `access_entity_email_delete_not_owned` boolean — Controls access to resource. - `access_entity_email_sequence` 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_email_template` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_email_template_create_delete_folder` boolean — Controls access to resource. - `access_entity_email_template_delete_not_owned` boolean — Controls access to resource. - `access_entity_email_template_delete_owned` boolean — Controls access to resource. - `access_entity_email_template_sharing_custom` boolean — Controls access to resource. - `access_entity_email_template_sharing_public` boolean — Controls access to resource. - `access_entity_forecast` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_forecast_delete_not_owned` boolean — Controls access to resource. - `access_entity_forecast_delete_owned` boolean — Controls access to resource. - `access_entity_forecast_edit_not_owned` boolean — Controls access to resource. - `access_entity_forecast_sharing_custom` boolean — Controls access to resource. - `access_entity_forecast_sharing_public` boolean — Controls access to resource. - `access_entity_form_view` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_form_view_delete_not_owned` boolean — Controls access to resource. - `access_entity_form_view_delete_owned` boolean — Controls access to resource. - `access_entity_form_view_sharing_custom` boolean — Controls access to resource. - `access_entity_form_view_sharing_public` boolean — Controls access to resource. - `access_entity_lead` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_lead_copy` boolean — Controls access to resource. - `access_entity_lead_delete` boolean — Controls access to resource. - `access_entity_lead_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_lead_private` boolean — Controls access to resource. - `access_entity_lead_tag_create` boolean — Controls access to resource. - `access_entity_lead_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_message_tag_create` boolean — Controls access to resource. - `access_entity_oppty` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_oppty_copy` boolean — Controls access to resource. - `access_entity_oppty_delete` boolean — Controls access to resource. - `access_entity_oppty_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_oppty_private` boolean — Controls access to resource. - `access_entity_oppty_tag_create` boolean — Controls access to resource. - `access_entity_pipeline` 0 | 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments - `access_entity_process` 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_profile` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. 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 — Controls access to resource. - `access_entity_profile_delete_owned` boolean — Controls access to resource. - `access_entity_profile_sharing_custom` boolean — Controls access to resource. - `access_entity_profile_sharing_public` boolean — Controls access to resource. - `access_entity_project` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_project_copy` boolean — Controls access to resource. - `access_entity_project_delete` boolean — Controls access to resource. - `access_entity_project_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_project_private` boolean — Controls access to resource. - `access_entity_project_tag_create` boolean — Controls access to resource. - `access_entity_quote` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_quote_copy` boolean — Controls access to resource. - `access_entity_quote_delete` boolean — Controls access to resource. - `access_entity_quote_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_quote_tag_create` boolean — Controls access to resource. - `access_entity_quote_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_report` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_report_create_delete_folder` boolean — Controls access to resource. - `access_entity_report_delete_not_owned` boolean — Controls access to resource. - `access_entity_report_delete_owned` boolean — Controls access to resource. - `access_entity_report_private` boolean — Controls access to resource. - `access_entity_report_schedule_create` boolean — Controls access to resource. - `access_entity_report_schedule_management` boolean — Controls access to resource. - `access_entity_report_sharing_custom` boolean — Controls access to resource. - `access_entity_report_sharing_public` boolean — Controls access to resource. - `access_entity_target` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_target_delete_not_owned` boolean — Controls access to resource. - `access_entity_target_delete_owned` boolean — Controls access to resource. - `access_entity_task` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_task_delete` boolean — Controls access to resource. - `access_entity_task_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_task_tag_create` boolean — Controls access to resource. - `access_entity_task_unassigned` boolean — Controls access to resource. - `access_export` boolean — Controls access to resource. - `access_feeds` boolean — Controls access to resource. - `access_foreign_currencies` boolean — Controls access to resource. - `access_form_and_fields` boolean — Controls access to resource. - `access_global_settings` boolean — Controls access to resource. - `access_home_screen` boolean — Controls access to resource. - `access_import` boolean — Controls access to resource. - `access_insights` boolean — Controls access to resource. - `access_leads` boolean — Controls access to resource. - `access_online_forms` boolean — Controls access to resource. - `access_online_forms_management` boolean — Controls access to resource. - `access_opportunity` boolean — Controls access to resource. - `access_pipeline_configuration` boolean — Controls access to resource. - `access_print` boolean — Controls access to resource. - `access_products_services` boolean — Controls access to resource. - `access_projects` boolean — Controls access to resource. - `access_quotes` boolean — Controls access to resource. - `access_sales_roles` boolean — Controls access to resource. - `access_security` boolean — Controls access to resource. - `access_units` boolean — Controls access to resource. - `access_user_and_roles` boolean — Controls access to resource. - `access_whats_app_company_phone` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `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, uri - `allowed_lead_types` object[] — Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected. - `id` string, uri - `allowed_quote_types` object[] — Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected. - `id` string, uri - `allowed_account_types` object[] — Account types this user role can use. Effective only when access_entity_account_types is set to Selected. - `id` string, uri - `allowed_contact_types` object[] — Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected. - `id` string, uri - `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, uri - `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, uri - `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` Modification confirmation. Returns resulting MasterRight - object - `success` boolean — True when response succeeded, false on error. - `data` MasterRight - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. - `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 — Controls access to resource. - `access_accounts` boolean — Controls access to resource. - `access_ai_automatizer` boolean — Controls access to resource. - `access_ai_online_forms` boolean — Controls access to resource. - `access_ai_record_detail` boolean — Controls access to resource. - `access_ai_record_enrichment` boolean — Controls access to resource. - `access_ai_relationship_charts` boolean — Controls access to resource. - `access_ai_reports` boolean — Controls access to resource. - `access_ai_smart_field` boolean — Controls access to resource. - `access_appointment_scheduler` boolean — Controls access to resource. - `access_appointment_scheduler_management` boolean — Controls access to resource. - `access_approval_processes` boolean — Controls access to resource. - `access_approval_processes_management` boolean — Controls access to resource. - `access_approvals` boolean — Controls access to resource. - `access_archive` boolean — Controls access to resource. - `access_audit` boolean — Controls access to resource. - `access_audit_log` boolean — Controls access to resource. - `access_bulk_update` boolean — Controls access to resource. - `access_calling` boolean — Controls access to resource. - `access_calling_company_phone` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_calling_purchase_phone` boolean — Controls access to resource. - `access_company_emails` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `access_contacts` boolean — Controls access to resource. - `access_document_management` boolean — Controls access to resource. - `access_document_management_company` boolean — Controls access to resource. - `access_document_management_record` boolean — Controls access to resource. - `access_duplicate_checker` boolean — Controls access to resource. - `access_email_notification_enforcement` boolean — Controls access to resource. - `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 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_account_copy` boolean — Controls access to resource. - `access_entity_account_delete` boolean — Controls access to resource. - `access_entity_account_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_account_private` boolean — Controls access to resource. - `access_entity_account_tag_create` boolean — Controls access to resource. - `access_entity_account_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_appointment` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_appointment_delete` boolean — Controls access to resource. - `access_entity_appointment_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_appointment_tag_create` boolean — Controls access to resource. - `access_entity_better_navigator` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_better_navigator_delete_not_owned` boolean — Controls access to resource. - `access_entity_better_navigator_delete_owned` boolean — Controls access to resource. - `access_entity_better_navigator_sharing_custom` boolean — Controls access to resource. - `access_entity_better_navigator_sharing_public` boolean — Controls access to resource. - `access_entity_contact` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_contact_copy` boolean — Controls access to resource. - `access_entity_contact_delete` boolean — Controls access to resource. - `access_entity_contact_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_contact_private` boolean — Controls access to resource. - `access_entity_contact_tag_create` boolean — Controls access to resource. - `access_entity_contact_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_dashboard` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_dashboard_delete_not_owned` boolean — Controls access to resource. - `access_entity_dashboard_delete_owned` boolean — Controls access to resource. - `access_entity_dashboard_sharing_custom` boolean — Controls access to resource. - `access_entity_dashboard_sharing_public` boolean — Controls access to resource. - `access_entity_email_content_share_mode` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly - `access_entity_email_delete_not_owned` boolean — Controls access to resource. - `access_entity_email_sequence` 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_email_template` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_email_template_create_delete_folder` boolean — Controls access to resource. - `access_entity_email_template_delete_not_owned` boolean — Controls access to resource. - `access_entity_email_template_delete_owned` boolean — Controls access to resource. - `access_entity_email_template_sharing_custom` boolean — Controls access to resource. - `access_entity_email_template_sharing_public` boolean — Controls access to resource. - `access_entity_forecast` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_forecast_delete_not_owned` boolean — Controls access to resource. - `access_entity_forecast_delete_owned` boolean — Controls access to resource. - `access_entity_forecast_edit_not_owned` boolean — Controls access to resource. - `access_entity_forecast_sharing_custom` boolean — Controls access to resource. - `access_entity_forecast_sharing_public` boolean — Controls access to resource. - `access_entity_form_view` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_form_view_delete_not_owned` boolean — Controls access to resource. - `access_entity_form_view_delete_owned` boolean — Controls access to resource. - `access_entity_form_view_sharing_custom` boolean — Controls access to resource. - `access_entity_form_view_sharing_public` boolean — Controls access to resource. - `access_entity_lead` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_lead_copy` boolean — Controls access to resource. - `access_entity_lead_delete` boolean — Controls access to resource. - `access_entity_lead_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_lead_private` boolean — Controls access to resource. - `access_entity_lead_tag_create` boolean — Controls access to resource. - `access_entity_lead_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_message_tag_create` boolean — Controls access to resource. - `access_entity_oppty` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_oppty_copy` boolean — Controls access to resource. - `access_entity_oppty_delete` boolean — Controls access to resource. - `access_entity_oppty_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_oppty_private` boolean — Controls access to resource. - `access_entity_oppty_tag_create` boolean — Controls access to resource. - `access_entity_pipeline` 0 | 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments - `access_entity_process` 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess - `access_entity_profile` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. 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 — Controls access to resource. - `access_entity_profile_delete_owned` boolean — Controls access to resource. - `access_entity_profile_sharing_custom` boolean — Controls access to resource. - `access_entity_profile_sharing_public` boolean — Controls access to resource. - `access_entity_project` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_project_copy` boolean — Controls access to resource. - `access_entity_project_delete` boolean — Controls access to resource. - `access_entity_project_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_project_private` boolean — Controls access to resource. - `access_entity_project_tag_create` boolean — Controls access to resource. - `access_entity_quote` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_quote_copy` boolean — Controls access to resource. - `access_entity_quote_delete` boolean — Controls access to resource. - `access_entity_quote_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_quote_tag_create` boolean — Controls access to resource. - `access_entity_quote_types` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected - `access_entity_report` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_report_create_delete_folder` boolean — Controls access to resource. - `access_entity_report_delete_not_owned` boolean — Controls access to resource. - `access_entity_report_delete_owned` boolean — Controls access to resource. - `access_entity_report_private` boolean — Controls access to resource. - `access_entity_report_schedule_create` boolean — Controls access to resource. - `access_entity_report_schedule_management` boolean — Controls access to resource. - `access_entity_report_sharing_custom` boolean — Controls access to resource. - `access_entity_report_sharing_public` boolean — Controls access to resource. - `access_entity_target` 0 | 1 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All - `access_entity_target_delete_not_owned` boolean — Controls access to resource. - `access_entity_target_delete_owned` boolean — Controls access to resource. - `access_entity_task` 0 | 1 | 2 | 3 | 4 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All - `access_entity_task_delete` boolean — Controls access to resource. - `access_entity_task_direction` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All - `access_entity_task_tag_create` boolean — Controls access to resource. - `access_entity_task_unassigned` boolean — Controls access to resource. - `access_export` boolean — Controls access to resource. - `access_feeds` boolean — Controls access to resource. - `access_foreign_currencies` boolean — Controls access to resource. - `access_form_and_fields` boolean — Controls access to resource. - `access_global_settings` boolean — Controls access to resource. - `access_home_screen` boolean — Controls access to resource. - `access_import` boolean — Controls access to resource. - `access_insights` boolean — Controls access to resource. - `access_leads` boolean — Controls access to resource. - `access_online_forms` boolean — Controls access to resource. - `access_online_forms_management` boolean — Controls access to resource. - `access_opportunity` boolean — Controls access to resource. - `access_pipeline_configuration` boolean — Controls access to resource. - `access_print` boolean — Controls access to resource. - `access_products_services` boolean — Controls access to resource. - `access_projects` boolean — Controls access to resource. - `access_quotes` boolean — Controls access to resource. - `access_sales_roles` boolean — Controls access to resource. - `access_security` boolean — Controls access to resource. - `access_units` boolean — Controls access to resource. - `access_user_and_roles` boolean — Controls access to resource. - `access_whats_app_company_phone` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All - `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_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 - `404` — Sent when invalid ID is given - `500` — unexpected error --- [API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)