Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
MasterRight

MasterRights.update

Modifies MasterRight or MasterRights with given id(s)

patch/entities/MasterRights/{id}

Path parameters

idstring uuid required

ID of MasterRight to update

Query parameters

validation-levelinteger

Specify validation level of MasterRight on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

access_account_relation_typesboolean

Controls access to resource.

access_accountsboolean

Controls access to resource.

access_ai_automatizerboolean

Controls access to resource.

access_ai_online_formsboolean

Controls access to resource.

access_ai_record_detailboolean

Controls access to resource.

access_ai_record_enrichmentboolean

Controls access to resource.

access_ai_relationship_chartsboolean

Controls access to resource.

access_ai_reportsboolean

Controls access to resource.

access_ai_smart_fieldboolean

Controls access to resource.

access_appointment_schedulerboolean

Controls access to resource.

access_appointment_scheduler_managementboolean

Controls access to resource.

access_approval_processesboolean

Controls access to resource.

access_approval_processes_managementboolean

Controls access to resource.

access_approvalsboolean

Controls access to resource.

access_archiveboolean

Controls access to resource.

access_auditboolean

Controls access to resource.

access_audit_logboolean

Controls access to resource.

access_bulk_updateboolean

Controls access to resource.

access_callingboolean

Controls access to resource.

access_calling_company_phone0 | 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_phoneboolean

Controls access to resource.

access_company_emails0 | 1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All

access_contactsboolean

Controls access to resource.

access_document_managementboolean

Controls access to resource.

access_document_management_companyboolean

Controls access to resource.

access_document_management_recordboolean

Controls access to resource.

access_duplicate_checkerboolean

Controls access to resource.

access_email_notification_enforcementboolean

Controls access to resource.

access_email_notification_settingsobject

Default email notification preferences applied to users with this role (which events trigger an email and through which channel).

access_entity_account0 | 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_copyboolean

Controls access to resource.

access_entity_account_deleteboolean

Controls access to resource.

access_entity_account_direction1 | 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_privateboolean

Controls access to resource.

access_entity_account_tag_createboolean

Controls access to resource.

access_entity_account_types1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - All, 2 - Selected

access_entity_appointment0 | 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_deleteboolean

Controls access to resource.

access_entity_appointment_direction1 | 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_createboolean

Controls access to resource.

access_entity_better_navigator0 | 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_ownedboolean

Controls access to resource.

access_entity_better_navigator_delete_ownedboolean

Controls access to resource.

access_entity_better_navigator_sharing_customboolean

Controls access to resource.

access_entity_better_navigator_sharing_publicboolean

Controls access to resource.

access_entity_contact0 | 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_copyboolean

Controls access to resource.

access_entity_contact_deleteboolean

Controls access to resource.

access_entity_contact_direction1 | 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_privateboolean

Controls access to resource.

access_entity_contact_tag_createboolean

Controls access to resource.

access_entity_contact_types1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - All, 2 - Selected

access_entity_dashboard0 | 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_ownedboolean

Controls access to resource.

access_entity_dashboard_delete_ownedboolean

Controls access to resource.

access_entity_dashboard_sharing_customboolean

Controls access to resource.

access_entity_dashboard_sharing_publicboolean

Controls access to resource.

access_entity_email_content_share_mode0 | 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_ownedboolean

Controls access to resource.

access_entity_email_sequence1 | 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_template0 | 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_folderboolean

Controls access to resource.

access_entity_email_template_delete_not_ownedboolean

Controls access to resource.

access_entity_email_template_delete_ownedboolean

Controls access to resource.

access_entity_email_template_sharing_customboolean

Controls access to resource.

access_entity_email_template_sharing_publicboolean

Controls access to resource.

access_entity_forecast0 | 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_ownedboolean

Controls access to resource.

access_entity_forecast_delete_ownedboolean

Controls access to resource.

access_entity_forecast_edit_not_ownedboolean

Controls access to resource.

access_entity_forecast_sharing_customboolean

Controls access to resource.

access_entity_forecast_sharing_publicboolean

Controls access to resource.

access_entity_form_view0 | 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_ownedboolean

Controls access to resource.

access_entity_form_view_delete_ownedboolean

Controls access to resource.

access_entity_form_view_sharing_customboolean

Controls access to resource.

access_entity_form_view_sharing_publicboolean

Controls access to resource.

access_entity_lead0 | 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_copyboolean

Controls access to resource.

access_entity_lead_deleteboolean

Controls access to resource.

access_entity_lead_direction1 | 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_privateboolean

Controls access to resource.

access_entity_lead_tag_createboolean

Controls access to resource.

access_entity_lead_types1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - All, 2 - Selected

access_entity_message_tag_createboolean

Controls access to resource.

access_entity_oppty0 | 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_copyboolean

Controls access to resource.

access_entity_oppty_deleteboolean

Controls access to resource.

access_entity_oppty_direction1 | 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_privateboolean

Controls access to resource.

access_entity_oppty_tag_createboolean

Controls access to resource.

access_entity_pipeline0 | 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_process1 | 2 | 3

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess

access_entity_profile0 | 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_profilesobject

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_ownedboolean

Controls access to resource.

access_entity_profile_delete_ownedboolean

Controls access to resource.

access_entity_profile_sharing_customboolean

Controls access to resource.

access_entity_profile_sharing_publicboolean

Controls access to resource.

access_entity_project0 | 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_copyboolean

Controls access to resource.

access_entity_project_deleteboolean

Controls access to resource.

access_entity_project_direction1 | 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_privateboolean

Controls access to resource.

access_entity_project_tag_createboolean

Controls access to resource.

access_entity_quote0 | 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_copyboolean

Controls access to resource.

access_entity_quote_deleteboolean

Controls access to resource.

access_entity_quote_direction1 | 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_createboolean

Controls access to resource.

access_entity_quote_types1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - All, 2 - Selected

access_entity_report0 | 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_folderboolean

Controls access to resource.

access_entity_report_delete_not_ownedboolean

Controls access to resource.

access_entity_report_delete_ownedboolean

Controls access to resource.

access_entity_report_privateboolean

Controls access to resource.

access_entity_report_schedule_createboolean

Controls access to resource.

access_entity_report_schedule_managementboolean

Controls access to resource.

access_entity_report_sharing_customboolean

Controls access to resource.

access_entity_report_sharing_publicboolean

Controls access to resource.

access_entity_target0 | 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_ownedboolean

Controls access to resource.

access_entity_target_delete_ownedboolean

Controls access to resource.

access_entity_task0 | 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_deleteboolean

Controls access to resource.

access_entity_task_direction1 | 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_createboolean

Controls access to resource.

access_entity_task_unassignedboolean

Controls access to resource.

access_exportboolean

Controls access to resource.

access_feedsboolean

Controls access to resource.

access_foreign_currenciesboolean

Controls access to resource.

access_form_and_fieldsboolean

Controls access to resource.

access_global_settingsboolean

Controls access to resource.

access_home_screenboolean

Controls access to resource.

access_importboolean

Controls access to resource.

access_insightsboolean

Controls access to resource.

access_leadsboolean

Controls access to resource.

access_online_formsboolean

Controls access to resource.

access_online_forms_managementboolean

Controls access to resource.

access_opportunityboolean

Controls access to resource.

access_pipeline_configurationboolean

Controls access to resource.

access_printboolean

Controls access to resource.

access_products_servicesboolean

Controls access to resource.

access_projectsboolean

Controls access to resource.

access_quotesboolean

Controls access to resource.

access_sales_rolesboolean

Controls access to resource.

access_securityboolean

Controls access to resource.

access_unitsboolean

Controls access to resource.

access_user_and_rolesboolean

Controls access to resource.

access_whats_app_company_phone0 | 1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All

namestring

Name of the entity and its default text representation.

revisioninteger

Revision when entity was lastly changed.

custom_entitiesstring 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.

Example request

{
  "access_entity_account_direction": 1,
  "access_entity_account_types": 1,
  "access_entity_appointment_direction": 1,
  "access_entity_contact_direction": 1,
  "access_entity_contact_types": 1,
  "access_entity_email_sequence": 1,
  "access_entity_lead_direction": 1,
  "access_entity_lead_types": 1,
  "access_entity_oppty_direction": 1,
  "access_entity_process": 1,
  "access_entity_project_direction": 1,
  "access_entity_quote_direction": 1,
  "access_entity_quote_types": 1,
  "access_entity_task_direction": 1,
  "name": "string",
  "revision": 1,
  "custom_entities": "blob"
}

Response

Modification confirmation. Returns resulting MasterRight

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "access_entity_account_direction": 1,
    "access_entity_account_types": 1,
    "access_entity_appointment_direction": 1,
    "access_entity_contact_direction": 1,
    "access_entity_contact_types": 1,
    "access_entity_email_sequence": 1,
    "access_entity_lead_direction": 1,
    "access_entity_lead_types": 1,
    "access_entity_oppty_direction": 1,
    "access_entity_process": 1,
    "access_entity_project_direction": 1,
    "access_entity_quote_direction": 1,
    "access_entity_quote_types": 1,
    "access_entity_task_direction": 1,
    "name": "string",
    "revision": 1,
    "custom_entities": "blob"
  }
}