batchMasterRightInput

CRMSalesAutomationPipelinesCloud

Properties

Name	Type	Description
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	integer	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	integer	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	integer	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	integer	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	integer	Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected
access_entity_appointment	integer	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	integer	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	integer	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	integer	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	integer	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	integer	Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected
access_entity_dashboard	integer	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	integer	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	integer	Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess
access_entity_email_template	integer	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	integer	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	integer	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	integer	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	integer	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	integer	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	integer	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	integer	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	integer	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	integer	Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess
access_entity_profile	integer	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	integer	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	integer	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	integer	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	integer	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	integer	Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - All, 2 - Selected
access_entity_report	integer	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	integer	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	integer	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	integer	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	integer	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	array	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	array	Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected.
allowed_quote_types	array	Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected.
allowed_account_types	array	Account types this user role can use. Effective only when access_entity_account_types is set to Selected.
allowed_contact_types	array	Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected.
allowed_company_emails	array	Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected.
allowed_company_phones	array	Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected.
custom_entities	string	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.
id	string	ID of object to update.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pipeliner/main/json-schema/pipeliner-batch-master-right-input-schema.json",
  "title": "batchMasterRightInput",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pipeliner-openapi.json#/components/schemas/batchMasterRightInput",
  "properties": {
    "access_account_relation_types": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_accounts": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_automatizer": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_online_forms": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_record_detail": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_record_enrichment": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_relationship_charts": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_reports": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_ai_smart_field": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_appointment_scheduler": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_appointment_scheduler_management": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_approval_processes": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_approval_processes_management": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_approvals": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_archive": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_audit": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_audit_log": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_bulk_update": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_calling": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_calling_company_phone": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All",
      "enum": [
        0,
        1,
        2
      ]
    },
    "access_calling_purchase_phone": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_company_emails": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All",
      "enum": [
        0,
        1,
        2
      ]
    },
    "access_contacts": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_document_management": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_document_management_company": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_document_management_record": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_duplicate_checker": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_email_notification_enforcement": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_email_notification_settings": {
      "type": "object",
      "description": "Default email notification preferences applied to users with this role (which events trigger an email and through which channel)."
    },
    "access_entity_account": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_account_copy": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_account_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_account_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_account_private": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_account_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_account_types": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected",
      "enum": [
        1,
        2
      ]
    },
    "access_entity_appointment": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_appointment_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_appointment_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_appointment_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_better_navigator": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_better_navigator_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_better_navigator_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_better_navigator_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_better_navigator_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_contact": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_contact_copy": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_contact_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_contact_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_contact_private": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_contact_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_contact_types": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected",
      "enum": [
        1,
        2
      ]
    },
    "access_entity_dashboard": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_dashboard_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_dashboard_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_dashboard_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_dashboard_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_email_content_share_mode": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly",
      "enum": [
        0,
        1,
        2
      ]
    },
    "access_entity_email_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_email_sequence": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess",
      "enum": [
        1,
        2,
        3
      ]
    },
    "access_entity_email_template": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_email_template_create_delete_folder": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_email_template_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_email_template_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_email_template_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_email_template_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_forecast": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_forecast_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_forecast_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_forecast_edit_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_forecast_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_forecast_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_form_view": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_form_view_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_form_view_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_form_view_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_form_view_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_lead": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_lead_copy": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_lead_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_lead_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_lead_private": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_lead_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_lead_types": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected",
      "enum": [
        1,
        2
      ]
    },
    "access_entity_message_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_oppty": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_oppty_copy": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_oppty_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_oppty_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_oppty_private": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_oppty_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_pipeline": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments",
      "enum": [
        0,
        1,
        2,
        3
      ]
    },
    "access_entity_process": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess",
      "enum": [
        1,
        2,
        3
      ]
    },
    "access_entity_profile": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_profile_default_screen_profiles": {
      "type": "object",
      "description": "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": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_profile_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_profile_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_profile_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_project": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_project_copy": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_project_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_project_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_project_private": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_project_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_quote": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_quote_copy": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_quote_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_quote_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_quote_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_quote_types": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected",
      "enum": [
        1,
        2
      ]
    },
    "access_entity_report": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_report_create_delete_folder": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_private": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_schedule_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_schedule_management": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_sharing_custom": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_report_sharing_public": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_target": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All",
      "enum": [
        0,
        1,
        4
      ]
    },
    "access_entity_target_delete_not_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_target_delete_owned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_task": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "access_entity_task_delete": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_task_direction": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    "access_entity_task_tag_create": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_entity_task_unassigned": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_export": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_feeds": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_foreign_currencies": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_form_and_fields": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_global_settings": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_home_screen": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_import": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_insights": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_leads": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_online_forms": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_online_forms_management": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_opportunity": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_pipeline_configuration": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_print": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_products_services": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_projects": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_quotes": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_sales_roles": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_security": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_units": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_user_and_roles": {
      "type": "boolean",
      "description": "Controls access to resource."
    },
    "access_whats_app_company_phone": {
      "type": "integer",
      "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All",
      "enum": [
        0,
        1,
        2
      ]
    },
    "name": {
      "type": "string",
      "description": "Name of the entity and its default text representation."
    },
    "revision": {
      "type": "integer",
      "format": "int32",
      "description": "Revision when entity was lastly changed."
    },
    "allowed_pipelines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedPipeline, see: 'updateAllowedPipelineInput' object for properties."
      },
      "description": "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": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedLeadType, see: 'updateAllowedLeadTypeInput' object for properties."
      },
      "description": "Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected."
    },
    "allowed_quote_types": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedQuoteType, see: 'updateAllowedQuoteTypeInput' object for properties."
      },
      "description": "Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected."
    },
    "allowed_account_types": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedAccountType, see: 'updateAllowedAccountTypeInput' object for properties."
      },
      "description": "Account types this user role can use. Effective only when access_entity_account_types is set to Selected."
    },
    "allowed_contact_types": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedContactType, see: 'updateAllowedContactTypeInput' object for properties."
      },
      "description": "Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected."
    },
    "allowed_company_emails": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedCompanyEmail, see: 'updateAllowedCompanyEmailInput' object for properties."
      },
      "description": "Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected."
    },
    "allowed_company_phones": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Relation to AllowedCompanyPhone, see: 'updateAllowedCompanyPhoneInput' object for properties."
      },
      "description": "Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected."
    },
    "custom_entities": {
      "type": "string",
      "format": "binary",
      "description": "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."
    },
    "id": {
      "description": "ID of object to update.",
      "type": "string",
      "format": "uuid"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/pipeliner-batch-master-right-input"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.