Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriesmasterRight

entities.masterRight

Read master right records with the masterRight repository, and change them with the master right mutations. Same records as the REST MasterRights entity.

Queries

Fields of entities { masterRight { … } }.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
MasterRightEntity
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[MasterRightEntity!]!
QUERYgetAll(limit: Int, offset: Int, filter: MasterRightFilterInput, orderBy: [MasterRightOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[MasterRightEntity!]!
QUERYgetByCriteria(filter: MasterRightFilterInput, orderBy: [MasterRightOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
MasterRightEntityConnection
QUERYgetChangedFieldsSinceRevision(id: UUID!, revision: Int!)
Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
[UUID!]!

Mutations

KindMutationDoesReturns
MUTATIONcreateMasterRight(input: CreateMasterRightInput!, validationLevel: [ValidationLevel!])Create one recordCreateMasterRightPayload
MUTATIONupdateMasterRight(input: UpdateMasterRightInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateMasterRightPayload
MUTATIONbulkUpdateMasterRight(input: [CreateOrUpdateMasterRightInput!]!, deleteInput: [DeleteMasterRightInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateMasterRightPayload
MUTATIONdeleteMasterRight(input: DeleteMasterRightInput!)Soft-deleteDeleteMasterRightPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

MasterRightEntity object 179 fields: isDeleteProtected, id, isDeleted, …

User role in the space that defines which features, records and pipelines its users can access.

FieldTypeDescription
isDeleteProtectedBoolean!True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accessAccountRelationTypesBooleanAllows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
accessAccountsBooleanShows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount.
accessAiAutomatizerBooleanAllows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
accessAiOnlineFormsBooleanAllows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
accessAiRecordDetailBooleanAllows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
accessAiRecordEnrichmentBooleanAllows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
accessAiRelationshipChartsBooleanAllows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
accessAiReportsBooleanAllows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
accessAiSmartFieldBooleanAllows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
accessAppointmentSchedulerBooleanAllows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
accessAppointmentSchedulerManagementBooleanAllows users with this role to manage appointment schedules of other users.
accessApprovalProcessesBooleanAllows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
accessApprovalProcessesManagementBooleanAllows users with this role to manage approval processes owned by other users.
accessApprovalsBooleanAllows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
accessArchiveBooleanAllows users with this role to open the Archive screens listing lost, closed and archived records.
accessAuditBooleanAllows users with this role to open the Audit screen.
accessAuditLogBooleanAllows users with this role to view the audit log of changes made in the space.
accessBottomMenuCustomizationBooleanWhether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on.
accessBulkUpdateBooleanAllows users with this role to update many records at once with bulk update.
accessCallingBooleanAllows users with this role to make calls through the calling integration, when the feature is enabled for the space.
accessCallingCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
accessCallingPurchasePhoneBooleanAllows users with this role to purchase and manage company phone numbers for the calling integration.
accessCompanyEmailsAccessLevelCompanyEmailsEnumWhich shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All).
accessContactsBooleanShows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact.
accessDocumentManagementBooleanAllows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
accessDocumentManagementCompanyBooleanAllows users with this role to manage company documents and folders that are not tied to a record.
accessDocumentManagementRecordBooleanAllows users with this role to create and edit the document folders used for records.
accessDuplicateCheckerBooleanAllows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
accessEmailNotificationEnforcementBooleanWhen true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own.
accessEmailNotificationSettingsNotificationSettingsDefault email notification preferences applied to users with this role (which events trigger an email and through which channel).
accessEntityAccountAccessLevelEntityEnumLevel of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
accessEntityAccountCopyBooleanAllows users with this role to create copies of existing accounts.
accessEntityAccountDeleteBooleanAllows users with this role to delete accounts they can edit.
accessEntityAccountDirectionAccessDirectionEnumWhich accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAccountPrivateBooleanAllows users with this role to own private accounts, which are visible only to their owner.
accessEntityAccountTagCreateBooleanAllows users with this role to create new tags for accounts.
accessEntityAccountTypesAccessEntityTypesEnumWhether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected).
accessEntityAppointmentAccessLevelEntityEnumLevel of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
accessEntityAppointmentDeleteBooleanAllows users with this role to delete appointments they can edit.
accessEntityAppointmentDirectionAccessDirectionEnumWhich appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAppointmentTagCreateBooleanAllows users with this role to create new tags for appointments.
accessEntityAppointmentTypesAccessEntityTypesEnumWhether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected).
accessEntityBetterNavigatorAccessLevelCommonRecordsEnumEnumLevel of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityBetterNavigatorDeleteNotOwnedBooleanAllows users with this role to delete Navigator screen layouts owned by other users.
accessEntityBetterNavigatorDeleteOwnedBooleanAllows users with this role to delete Navigator screen layouts they own.
accessEntityBetterNavigatorSharingCustomBooleanAllows users with this role to share their Navigator screen layouts with selected users and sales units.
accessEntityBetterNavigatorSharingPublicBooleanAllows users with this role to share their Navigator screen layouts with all users of the space.
accessEntityContactAccessLevelEntityEnumLevel of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
accessEntityContactCopyBooleanAllows users with this role to create copies of existing contacts.
accessEntityContactDeleteBooleanAllows users with this role to delete contacts they can edit.
accessEntityContactDirectionAccessDirectionEnumWhich contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityContactPrivateBooleanAllows users with this role to own private contacts, which are visible only to their owner.
accessEntityContactTagCreateBooleanAllows users with this role to create new tags for contacts.
accessEntityContactTypesAccessEntityTypesEnumWhether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected).
accessEntityDashboardAccessLevelCommonRecordsEnumEnumLevel of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess.
accessEntityDashboardDeleteNotOwnedBooleanAllows users with this role to delete dashboards owned by other users.
accessEntityDashboardDeleteOwnedBooleanAllows users with this role to delete dashboards they own.
accessEntityDashboardSharingCustomBooleanAllows users with this role to share their dashboards with selected users and sales units.
accessEntityDashboardSharingPublicBooleanAllows users with this role to share their dashboards with all users of the space.
accessEntityEmailAccessLevelEmailAccessLevelEnumWhich emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible).
accessEntityEmailAllowedEmailAccessAllowListAllow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default.
accessEntityEmailContentShareModeContentShareModeConfigEnumHow users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
accessEntityEmailDeleteNotOwnedBooleanAllows users with this role to delete emails they neither own nor sent.
accessEntityEmailLinkToAccountsTernaryConfigEnumWhether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToAccountsByDomainTernaryConfigEnumWhether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToContactsTernaryConfigEnumWhether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailSequenceAccessLevelEmailSequenceEnumLevel of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityEmailTemplateAccessLevelCommonRecordsEnumEnumLevel of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityEmailTemplateCreateDeleteFolderBooleanAllows users with this role to create and delete email template folders.
accessEntityEmailTemplateDeleteNotOwnedBooleanAllows users with this role to delete email templates owned by other users.
accessEntityEmailTemplateDeleteOwnedBooleanAllows users with this role to delete email templates they own.
accessEntityEmailTemplateSharingCustomBooleanAllows users with this role to share their email templates with selected users and sales units.
accessEntityEmailTemplateSharingPublicBooleanAllows users with this role to share their email templates with all users of the space.
accessEntityForecastAccessLevelCommonRecordsEnumEnumLevel of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityForecastDeleteNotOwnedBooleanAllows users with this role to delete forecasts owned by other users.
accessEntityForecastDeleteOwnedBooleanAllows users with this role to delete forecasts they own.
accessEntityForecastEditNotOwnedBooleanAllows users with this role to edit forecasts owned by other users.
accessEntityForecastSharingCustomBooleanAllows users with this role to share their forecasts with selected users and sales units.
accessEntityForecastSharingPublicBooleanAllows users with this role to share their forecasts with all users of the space.
accessEntityFormViewAccessLevelCommonRecordsEnumEnumLevel of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityFormViewDeleteNotOwnedBooleanAllows users with this role to delete form views owned by other users.
accessEntityFormViewDeleteOwnedBooleanAllows users with this role to delete form views they own.
accessEntityFormViewSharingCustomBooleanAllows users with this role to share their form views with selected users and sales units.
accessEntityFormViewSharingPublicBooleanAllows users with this role to share their form views with all users of the space.
accessEntityLeadAccessLevelEntityEnumLevel of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
accessEntityLeadCopyBooleanAllows users with this role to create copies of existing leads.
accessEntityLeadDeleteBooleanAllows users with this role to delete leads they can edit.
accessEntityLeadDirectionAccessDirectionEnumWhich leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityLeadPrivateBooleanAllows users with this role to own private leads, which are visible only to their owner.
accessEntityLeadTagCreateBooleanAllows users with this role to create new tags for leads.
accessEntityLeadTypesAccessEntityTypesEnumWhether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected).
accessEntityMessageTagCreateBooleanAllows users with this role to create new tags for emails, memos and text messages.
accessEntityOpptyAccessLevelEntityEnumLevel of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
accessEntityOpptyCopyBooleanAllows users with this role to create copies of existing opportunities.
accessEntityOpptyDeleteBooleanAllows users with this role to delete opportunities they can edit.
accessEntityOpptyDirectionAccessDirectionEnumWhich opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityOpptyPrivateBooleanAllows users with this role to own private opportunities, which are visible only to their owner.
accessEntityOpptyTagCreateBooleanAllows users with this role to create new tags for opportunities.
accessEntityPipelineAccessLevelPipelineEnumWhich pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
accessEntityProcessAccessLevelProcessBuilderEnumLevel of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityProfileAccessLevelCommonRecordsEnumEnumLevel of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
accessEntityProfileDefaultScreenProfilesScreensDefaultProfilesParamsDefault screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
accessEntityProfileDeleteNotOwnedBooleanAllows users with this role to delete screen profiles owned by other users.
accessEntityProfileDeleteOwnedBooleanAllows users with this role to delete screen profiles they own.
accessEntityProfileSharingCustomBooleanAllows users with this role to share their screen profiles with selected users and sales units.
accessEntityProfileSharingPublicBooleanAllows users with this role to share their screen profiles with all users of the space.
accessEntityProjectAccessLevelEntityEnumLevel of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
accessEntityProjectCopyBooleanAllows users with this role to create copies of existing projects.
accessEntityProjectDeleteBooleanAllows users with this role to delete projects they can edit.
accessEntityProjectDirectionAccessDirectionEnumWhich projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityProjectPrivateBooleanAllows users with this role to own private projects, which are visible only to their owner.
accessEntityProjectTagCreateBooleanAllows users with this role to create new tags for projects.
accessEntityQuoteAccessLevelEntityEnumLevel of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
accessEntityQuoteCopyBooleanAllows users with this role to create copies of existing quotes.
accessEntityQuoteDeleteBooleanAllows users with this role to delete quotes they can edit.
accessEntityQuoteDirectionAccessDirectionEnumWhich quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityQuoteTagCreateBooleanAllows users with this role to create new tags for quotes.
accessEntityQuoteTypesAccessEntityTypesEnumWhether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected).
accessEntityReportAccessLevelCommonRecordsEnumEnumLevel of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityReportCreateDeleteFolderBooleanAllows users with this role to create and delete report folders.
accessEntityReportDeleteNotOwnedBooleanAllows users with this role to delete reports owned by other users.
accessEntityReportDeleteOwnedBooleanAllows users with this role to delete reports they own.
accessEntityReportPrivateBooleanAllows users with this role to save reports as private, visible only to themselves.
accessEntityReportScheduleCreateBooleanAllows users with this role to schedule reports for regular delivery.
accessEntityReportScheduleManagementBooleanAllows users with this role to view and manage report schedules of other users.
accessEntityReportSharingCustomBooleanAllows users with this role to share their reports with selected users and sales units.
accessEntityReportSharingPublicBooleanAllows users with this role to share their reports with all users of the space.
accessEntitySolutionBooleanAllows users with this role to view and follow solutions, when the feature is enabled for the space.
accessEntitySolutionManagementBooleanAllows users with this role to create, edit and delete solutions.
accessEntityTargetAccessLevelCommonRecordsEnumEnumLevel of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityTargetDeleteNotOwnedBooleanAllows users with this role to delete targets owned by other users.
accessEntityTargetDeleteOwnedBooleanAllows users with this role to delete targets they own.
accessEntityTaskAccessLevelEntityEnumLevel of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
accessEntityTaskDeleteBooleanAllows users with this role to delete tasks they can edit.
accessEntityTaskDirectionAccessDirectionEnumWhich tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityTaskTagCreateBooleanAllows users with this role to create new tags for tasks.
accessEntityTaskTypesAccessEntityTypesEnumWhether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected).
accessEntityTaskUnassignedBooleanAllows users with this role to create tasks without an owner (unassigned tasks).
accessExportBooleanAllows users with this role to export records and reports to files.
accessFeedsBooleanAllows users with this role to open the Feed screen with the stream of activities, emails and other updates.
accessForeignCurrenciesBooleanAllows users with this role to manage currencies and exchange rate lists in Administration.
accessFormAndFieldsBooleanAllows users with this role to manage fields, forms, record types, tags and translations in Administration.
accessGlobalSettingsBooleanAllows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
accessHomeScreenBooleanAllows users with this role to open the Navigator screen.
accessImportBooleanAllows users with this role to import records from files.
accessInsightsBooleanAllows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
accessLeadsBooleanShows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead.
accessOnlineFormsBooleanAllows users with this role to create online forms and manage their own, when online forms are enabled for the space.
accessOnlineFormsManagementBooleanAllows users with this role to edit and delete online forms owned by other users.
accessOpportunityBooleanShows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty.
accessPipelineConfigurationBooleanAllows users with this role to manage pipelines, lead processes and quote processes in Administration.
accessPrintBooleanAllows users with this role to print records and reports.
accessProductsServicesBooleanAllows users with this role to manage products, product categories and price lists in Administration.
accessProjectsBooleanAllows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject.
accessQuotesBooleanAllows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote.
accessSalesRolesBooleanAllows users with this role to manage sales roles in Administration.
accessSecurityBooleanAllows users with this role to manage the security settings of the space in Administration.
accessUnitsBooleanAllows users with this role to manage sales units in Administration.
accessUserAndRolesBooleanAllows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
accessWhatsAppCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
bottomMenuLayout[InterfaceBottomMenuRow!]The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items.
nameString!Name of the entity and its default text representation.
revisionIntRevision when entity was lastly changed.
allowedPipelinesAllowedPipelineEntityConnection (8 args)Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted.
allowedLeadTypesAllowedLeadTypeEntityConnection (8 args)Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected.
allowedQuoteTypesAllowedQuoteTypeEntityConnection (8 args)Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected.
allowedAccountTypesAllowedAccountTypeEntityConnection (8 args)Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected.
allowedContactTypesAllowedContactTypeEntityConnection (8 args)Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected.
allowedTaskTypesAllowedTaskTypeEntityConnection (8 args)Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected.
allowedAppointmentTypesAllowedAppointmentTypeEntityConnection (8 args)Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here.
allowedCompanyEmailsAllowedCompanyEmailEntityConnection (8 args)Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected.
allowedCompanyPhonesAllowedCompanyPhoneEntityConnection (8 args)Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected.
customEntities[CustomEntityMasterRight!]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.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
MasterRightEntityConnection object pageInfo: PageInfo!, edges: [MasterRightEntityEdge]!, totalCount: Int

Paginated list of MasterRight records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[MasterRightEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
MasterRightEntityEdge object node: MasterRightEntity, cursor: String!

A Relay edge containing a MasterRightEntity and its cursor.

FieldTypeDescription
nodeMasterRightEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
AccessDirectionEnumFilterInput input eq: [AccessDirectionEnum!], NOT: AccessDirectionEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessDirectionEnum!]Matches any of the listed values.
NOTAccessDirectionEnumFilterInputMatches values that do not meet this condition.
AccessEntityTypesEnumFilterInput input eq: [AccessEntityTypesEnum!], NOT: AccessEntityTypesEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessEntityTypesEnum!]Matches any of the listed values.
NOTAccessEntityTypesEnumFilterInputMatches values that do not meet this condition.
AccessLevelCommonRecordsEnumEnumFilterInput input eq: [AccessLevelCommonRecordsEnumEnum!], NOT: AccessLevelCommonRecordsEnumEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessLevelCommonRecordsEnumEnum!]Matches any of the listed values.
NOTAccessLevelCommonRecordsEnumEnumFilterInputMatches values that do not meet this condition.
AccessLevelCompanyEmailsEnumFilterInput input eq: [AccessLevelCompanyEmailsEnum!], NOT: AccessLevelCompanyEmailsEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessLevelCompanyEmailsEnum!]Matches any of the listed values.
NOTAccessLevelCompanyEmailsEnumFilterInputMatches values that do not meet this condition.
AccessLevelEmailSequenceEnumFilterInput input eq: [AccessLevelEmailSequenceEnum!], NOT: AccessLevelEmailSequenceEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessLevelEmailSequenceEnum!]Matches any of the listed values.
NOTAccessLevelEmailSequenceEnumFilterInputMatches values that do not meet this condition.
AccessLevelEntityEnumFilterInput input eq: [AccessLevelEntityEnum!], NOT: AccessLevelEntityEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessLevelEntityEnum!]Matches any of the listed values.
NOTAccessLevelEntityEnumFilterInputMatches values that do not meet this condition.
AccessLevelPipelineEnumFilterInput input eq: [AccessLevelPipelineEnum!], NOT: AccessLevelPipelineEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessLevelPipelineEnum!]Matches any of the listed values.
NOTAccessLevelPipelineEnumFilterInputMatches values that do not meet this condition.
AccessLevelProcessBuilderEnumFilterInput input eq: [AccessLevelProcessBuilderEnum!], NOT: AccessLevelProcessBuilderEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccessLevelProcessBuilderEnum!]Matches any of the listed values.
NOTAccessLevelProcessBuilderEnumFilterInputMatches values that do not meet this condition.
ContentShareModeConfigEnumFilterInput input eq: [ContentShareModeConfigEnum!], NOT: ContentShareModeConfigEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[ContentShareModeConfigEnum!]Matches any of the listed values.
NOTContentShareModeConfigEnumFilterInputMatches values that do not meet this condition.
EmailAccessLevelEnumFilterInput input eq: [EmailAccessLevelEnum!], NOT: EmailAccessLevelEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[EmailAccessLevelEnum!]Matches any of the listed values.
NOTEmailAccessLevelEnumFilterInputMatches values that do not meet this condition.
MasterRightFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for MasterRight records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input fieldTypeDescription
OR[MasterRightFilterInput!]Matches records that meet at least one of the listed filters.
AND[MasterRightFilterInput!]Matches records that meet all of the listed filters.
NOTMasterRightFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
accessAccountRelationTypesBooleanAllows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
accessAccountsBooleanShows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount.
accessAiAutomatizerBooleanAllows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
accessAiOnlineFormsBooleanAllows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
accessAiRecordDetailBooleanAllows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
accessAiRecordEnrichmentBooleanAllows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
accessAiRelationshipChartsBooleanAllows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
accessAiReportsBooleanAllows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
accessAiSmartFieldBooleanAllows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
accessAppointmentSchedulerBooleanAllows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
accessAppointmentSchedulerManagementBooleanAllows users with this role to manage appointment schedules of other users.
accessApprovalProcessesBooleanAllows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
accessApprovalProcessesManagementBooleanAllows users with this role to manage approval processes owned by other users.
accessApprovalsBooleanAllows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
accessArchiveBooleanAllows users with this role to open the Archive screens listing lost, closed and archived records.
accessAuditBooleanAllows users with this role to open the Audit screen.
accessAuditLogBooleanAllows users with this role to view the audit log of changes made in the space.
accessBottomMenuCustomizationBooleanWhether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on.
accessBulkUpdateBooleanAllows users with this role to update many records at once with bulk update.
accessCallingBooleanAllows users with this role to make calls through the calling integration, when the feature is enabled for the space.
accessCallingCompanyPhoneAccessLevelCompanyEmailsEnumFilterInputWhich company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
accessCallingPurchasePhoneBooleanAllows users with this role to purchase and manage company phone numbers for the calling integration.
accessCompanyEmailsAccessLevelCompanyEmailsEnumFilterInputWhich shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All).
accessContactsBooleanShows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact.
accessDocumentManagementBooleanAllows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
accessDocumentManagementCompanyBooleanAllows users with this role to manage company documents and folders that are not tied to a record.
accessDocumentManagementRecordBooleanAllows users with this role to create and edit the document folders used for records.
accessDuplicateCheckerBooleanAllows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
accessEmailNotificationEnforcementBooleanWhen true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own.
accessEntityAccountAccessLevelEntityEnumFilterInputLevel of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
accessEntityAccountCopyBooleanAllows users with this role to create copies of existing accounts.
accessEntityAccountDeleteBooleanAllows users with this role to delete accounts they can edit.
accessEntityAccountDirectionAccessDirectionEnumFilterInputWhich accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAccountPrivateBooleanAllows users with this role to own private accounts, which are visible only to their owner.
accessEntityAccountTagCreateBooleanAllows users with this role to create new tags for accounts.
accessEntityAccountTypesAccessEntityTypesEnumFilterInputWhether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected).
accessEntityAppointmentAccessLevelEntityEnumFilterInputLevel of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
accessEntityAppointmentDeleteBooleanAllows users with this role to delete appointments they can edit.
accessEntityAppointmentDirectionAccessDirectionEnumFilterInputWhich appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAppointmentTagCreateBooleanAllows users with this role to create new tags for appointments.
accessEntityAppointmentTypesAccessEntityTypesEnumFilterInputWhether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected).
accessEntityBetterNavigatorAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityBetterNavigatorDeleteNotOwnedBooleanAllows users with this role to delete Navigator screen layouts owned by other users.
accessEntityBetterNavigatorDeleteOwnedBooleanAllows users with this role to delete Navigator screen layouts they own.
accessEntityBetterNavigatorSharingCustomBooleanAllows users with this role to share their Navigator screen layouts with selected users and sales units.
accessEntityBetterNavigatorSharingPublicBooleanAllows users with this role to share their Navigator screen layouts with all users of the space.
accessEntityContactAccessLevelEntityEnumFilterInputLevel of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
accessEntityContactCopyBooleanAllows users with this role to create copies of existing contacts.
accessEntityContactDeleteBooleanAllows users with this role to delete contacts they can edit.
accessEntityContactDirectionAccessDirectionEnumFilterInputWhich contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityContactPrivateBooleanAllows users with this role to own private contacts, which are visible only to their owner.
accessEntityContactTagCreateBooleanAllows users with this role to create new tags for contacts.
accessEntityContactTypesAccessEntityTypesEnumFilterInputWhether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected).
accessEntityDashboardAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess.
accessEntityDashboardDeleteNotOwnedBooleanAllows users with this role to delete dashboards owned by other users.
accessEntityDashboardDeleteOwnedBooleanAllows users with this role to delete dashboards they own.
accessEntityDashboardSharingCustomBooleanAllows users with this role to share their dashboards with selected users and sales units.
accessEntityDashboardSharingPublicBooleanAllows users with this role to share their dashboards with all users of the space.
accessEntityEmailAccessLevelEmailAccessLevelEnumFilterInputWhich emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible).
accessEntityEmailContentShareModeContentShareModeConfigEnumFilterInputHow users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
accessEntityEmailDeleteNotOwnedBooleanAllows users with this role to delete emails they neither own nor sent.
accessEntityEmailLinkToAccountsTernaryConfigEnumFilterInputWhether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToAccountsByDomainTernaryConfigEnumFilterInputWhether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToContactsTernaryConfigEnumFilterInputWhether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailSequenceAccessLevelEmailSequenceEnumFilterInputLevel of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityEmailTemplateAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityEmailTemplateCreateDeleteFolderBooleanAllows users with this role to create and delete email template folders.
accessEntityEmailTemplateDeleteNotOwnedBooleanAllows users with this role to delete email templates owned by other users.
accessEntityEmailTemplateDeleteOwnedBooleanAllows users with this role to delete email templates they own.
accessEntityEmailTemplateSharingCustomBooleanAllows users with this role to share their email templates with selected users and sales units.
accessEntityEmailTemplateSharingPublicBooleanAllows users with this role to share their email templates with all users of the space.
accessEntityForecastAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityForecastDeleteNotOwnedBooleanAllows users with this role to delete forecasts owned by other users.
accessEntityForecastDeleteOwnedBooleanAllows users with this role to delete forecasts they own.
accessEntityForecastEditNotOwnedBooleanAllows users with this role to edit forecasts owned by other users.
accessEntityForecastSharingCustomBooleanAllows users with this role to share their forecasts with selected users and sales units.
accessEntityForecastSharingPublicBooleanAllows users with this role to share their forecasts with all users of the space.
accessEntityFormViewAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityFormViewDeleteNotOwnedBooleanAllows users with this role to delete form views owned by other users.
accessEntityFormViewDeleteOwnedBooleanAllows users with this role to delete form views they own.
accessEntityFormViewSharingCustomBooleanAllows users with this role to share their form views with selected users and sales units.
accessEntityFormViewSharingPublicBooleanAllows users with this role to share their form views with all users of the space.
accessEntityLeadAccessLevelEntityEnumFilterInputLevel of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
accessEntityLeadCopyBooleanAllows users with this role to create copies of existing leads.
accessEntityLeadDeleteBooleanAllows users with this role to delete leads they can edit.
accessEntityLeadDirectionAccessDirectionEnumFilterInputWhich leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityLeadPrivateBooleanAllows users with this role to own private leads, which are visible only to their owner.
accessEntityLeadTagCreateBooleanAllows users with this role to create new tags for leads.
accessEntityLeadTypesAccessEntityTypesEnumFilterInputWhether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected).
accessEntityMessageTagCreateBooleanAllows users with this role to create new tags for emails, memos and text messages.
accessEntityOpptyAccessLevelEntityEnumFilterInputLevel of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
accessEntityOpptyCopyBooleanAllows users with this role to create copies of existing opportunities.
accessEntityOpptyDeleteBooleanAllows users with this role to delete opportunities they can edit.
accessEntityOpptyDirectionAccessDirectionEnumFilterInputWhich opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityOpptyPrivateBooleanAllows users with this role to own private opportunities, which are visible only to their owner.
accessEntityOpptyTagCreateBooleanAllows users with this role to create new tags for opportunities.
accessEntityPipelineAccessLevelPipelineEnumFilterInputWhich pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
accessEntityProcessAccessLevelProcessBuilderEnumFilterInputLevel of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityProfileAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
accessEntityProfileDeleteNotOwnedBooleanAllows users with this role to delete screen profiles owned by other users.
accessEntityProfileDeleteOwnedBooleanAllows users with this role to delete screen profiles they own.
accessEntityProfileSharingCustomBooleanAllows users with this role to share their screen profiles with selected users and sales units.
accessEntityProfileSharingPublicBooleanAllows users with this role to share their screen profiles with all users of the space.
accessEntityProjectAccessLevelEntityEnumFilterInputLevel of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
accessEntityProjectCopyBooleanAllows users with this role to create copies of existing projects.
accessEntityProjectDeleteBooleanAllows users with this role to delete projects they can edit.
accessEntityProjectDirectionAccessDirectionEnumFilterInputWhich projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityProjectPrivateBooleanAllows users with this role to own private projects, which are visible only to their owner.
accessEntityProjectTagCreateBooleanAllows users with this role to create new tags for projects.
accessEntityQuoteAccessLevelEntityEnumFilterInputLevel of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
accessEntityQuoteCopyBooleanAllows users with this role to create copies of existing quotes.
accessEntityQuoteDeleteBooleanAllows users with this role to delete quotes they can edit.
accessEntityQuoteDirectionAccessDirectionEnumFilterInputWhich quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityQuoteTagCreateBooleanAllows users with this role to create new tags for quotes.
accessEntityQuoteTypesAccessEntityTypesEnumFilterInputWhether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected).
accessEntityReportAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityReportCreateDeleteFolderBooleanAllows users with this role to create and delete report folders.
accessEntityReportDeleteNotOwnedBooleanAllows users with this role to delete reports owned by other users.
accessEntityReportDeleteOwnedBooleanAllows users with this role to delete reports they own.
accessEntityReportPrivateBooleanAllows users with this role to save reports as private, visible only to themselves.
accessEntityReportScheduleCreateBooleanAllows users with this role to schedule reports for regular delivery.
accessEntityReportScheduleManagementBooleanAllows users with this role to view and manage report schedules of other users.
accessEntityReportSharingCustomBooleanAllows users with this role to share their reports with selected users and sales units.
accessEntityReportSharingPublicBooleanAllows users with this role to share their reports with all users of the space.
accessEntitySolutionBooleanAllows users with this role to view and follow solutions, when the feature is enabled for the space.
accessEntitySolutionManagementBooleanAllows users with this role to create, edit and delete solutions.
accessEntityTargetAccessLevelCommonRecordsEnumEnumFilterInputLevel of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityTargetDeleteNotOwnedBooleanAllows users with this role to delete targets owned by other users.
accessEntityTargetDeleteOwnedBooleanAllows users with this role to delete targets they own.
accessEntityTaskAccessLevelEntityEnumFilterInputLevel of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
accessEntityTaskDeleteBooleanAllows users with this role to delete tasks they can edit.
accessEntityTaskDirectionAccessDirectionEnumFilterInputWhich tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityTaskTagCreateBooleanAllows users with this role to create new tags for tasks.
accessEntityTaskTypesAccessEntityTypesEnumFilterInputWhether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected).
accessEntityTaskUnassignedBooleanAllows users with this role to create tasks without an owner (unassigned tasks).
accessExportBooleanAllows users with this role to export records and reports to files.
accessFeedsBooleanAllows users with this role to open the Feed screen with the stream of activities, emails and other updates.
accessForeignCurrenciesBooleanAllows users with this role to manage currencies and exchange rate lists in Administration.
accessFormAndFieldsBooleanAllows users with this role to manage fields, forms, record types, tags and translations in Administration.
accessGlobalSettingsBooleanAllows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
accessHomeScreenBooleanAllows users with this role to open the Navigator screen.
accessImportBooleanAllows users with this role to import records from files.
accessInsightsBooleanAllows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
accessLeadsBooleanShows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead.
accessOnlineFormsBooleanAllows users with this role to create online forms and manage their own, when online forms are enabled for the space.
accessOnlineFormsManagementBooleanAllows users with this role to edit and delete online forms owned by other users.
accessOpportunityBooleanShows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty.
accessPipelineConfigurationBooleanAllows users with this role to manage pipelines, lead processes and quote processes in Administration.
accessPrintBooleanAllows users with this role to print records and reports.
accessProductsServicesBooleanAllows users with this role to manage products, product categories and price lists in Administration.
accessProjectsBooleanAllows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject.
accessQuotesBooleanAllows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote.
accessSalesRolesBooleanAllows users with this role to manage sales roles in Administration.
accessSecurityBooleanAllows users with this role to manage the security settings of the space in Administration.
accessUnitsBooleanAllows users with this role to manage sales units in Administration.
accessUserAndRolesBooleanAllows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
accessWhatsAppCompanyPhoneAccessLevelCompanyEmailsEnumFilterInputWhich company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
nameEntityFilterStringFieldName of the entity and its default text representation.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
allowedPipelinesAllowedPipelineFilterInputPipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted. Matches records where a related record meets these conditions.
allowedLeadTypesAllowedLeadTypeFilterInputLead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected. Matches records where a related record meets these conditions.
allowedQuoteTypesAllowedQuoteTypeFilterInputQuote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected. Matches records where a related record meets these conditions.
allowedAccountTypesAllowedAccountTypeFilterInputAccount types this user role can use. Effective only when accessEntityAccountTypes is set to Selected. Matches records where a related record meets these conditions.
allowedContactTypesAllowedContactTypeFilterInputContact types this user role can use. Effective only when accessEntityContactTypes is set to Selected. Matches records where a related record meets these conditions.
allowedTaskTypesAllowedTaskTypeFilterInputTask types this user role can use. Effective only when accessEntityTaskTypes is set to Selected. Matches records where a related record meets these conditions.
allowedAppointmentTypesAllowedAppointmentTypeFilterInputAppointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. Matches records where a related record meets these conditions.
allowedCompanyEmailsAllowedCompanyEmailFilterInputCompany email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected. Matches records where a related record meets these conditions.
allowedCompanyPhonesAllowedCompanyPhoneFilterInputCompany phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected. Matches records where a related record meets these conditions.
MasterRightOrderByInput input Asc or Desc per field

Sorting of MasterRight records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
accessAccountRelationTypesOrderByEnumAllows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
accessAccountsOrderByEnumShows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount.
accessAiAutomatizerOrderByEnumAllows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
accessAiOnlineFormsOrderByEnumAllows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
accessAiRecordDetailOrderByEnumAllows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
accessAiRecordEnrichmentOrderByEnumAllows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
accessAiRelationshipChartsOrderByEnumAllows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
accessAiReportsOrderByEnumAllows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
accessAiSmartFieldOrderByEnumAllows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
accessAppointmentSchedulerOrderByEnumAllows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
accessAppointmentSchedulerManagementOrderByEnumAllows users with this role to manage appointment schedules of other users.
accessApprovalProcessesOrderByEnumAllows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
accessApprovalProcessesManagementOrderByEnumAllows users with this role to manage approval processes owned by other users.
accessApprovalsOrderByEnumAllows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
accessArchiveOrderByEnumAllows users with this role to open the Archive screens listing lost, closed and archived records.
accessAuditOrderByEnumAllows users with this role to open the Audit screen.
accessAuditLogOrderByEnumAllows users with this role to view the audit log of changes made in the space.
accessBottomMenuCustomizationOrderByEnumWhether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on.
accessBulkUpdateOrderByEnumAllows users with this role to update many records at once with bulk update.
accessCallingOrderByEnumAllows users with this role to make calls through the calling integration, when the feature is enabled for the space.
accessCallingCompanyPhoneOrderByEnumWhich company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
accessCallingPurchasePhoneOrderByEnumAllows users with this role to purchase and manage company phone numbers for the calling integration.
accessCompanyEmailsOrderByEnumWhich shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All).
accessContactsOrderByEnumShows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact.
accessDocumentManagementOrderByEnumAllows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
accessDocumentManagementCompanyOrderByEnumAllows users with this role to manage company documents and folders that are not tied to a record.
accessDocumentManagementRecordOrderByEnumAllows users with this role to create and edit the document folders used for records.
accessDuplicateCheckerOrderByEnumAllows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
accessEmailNotificationEnforcementOrderByEnumWhen true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own.
accessEntityAccountOrderByEnumLevel of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
accessEntityAccountCopyOrderByEnumAllows users with this role to create copies of existing accounts.
accessEntityAccountDeleteOrderByEnumAllows users with this role to delete accounts they can edit.
accessEntityAccountDirectionOrderByEnumWhich accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAccountPrivateOrderByEnumAllows users with this role to own private accounts, which are visible only to their owner.
accessEntityAccountTagCreateOrderByEnumAllows users with this role to create new tags for accounts.
accessEntityAppointmentOrderByEnumLevel of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
accessEntityAppointmentDeleteOrderByEnumAllows users with this role to delete appointments they can edit.
accessEntityAppointmentDirectionOrderByEnumWhich appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAppointmentTagCreateOrderByEnumAllows users with this role to create new tags for appointments.
accessEntityBetterNavigatorOrderByEnumLevel of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityBetterNavigatorDeleteNotOwnedOrderByEnumAllows users with this role to delete Navigator screen layouts owned by other users.
accessEntityBetterNavigatorDeleteOwnedOrderByEnumAllows users with this role to delete Navigator screen layouts they own.
accessEntityBetterNavigatorSharingCustomOrderByEnumAllows users with this role to share their Navigator screen layouts with selected users and sales units.
accessEntityBetterNavigatorSharingPublicOrderByEnumAllows users with this role to share their Navigator screen layouts with all users of the space.
accessEntityContactOrderByEnumLevel of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
accessEntityContactCopyOrderByEnumAllows users with this role to create copies of existing contacts.
accessEntityContactDeleteOrderByEnumAllows users with this role to delete contacts they can edit.
accessEntityContactDirectionOrderByEnumWhich contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityContactPrivateOrderByEnumAllows users with this role to own private contacts, which are visible only to their owner.
accessEntityContactTagCreateOrderByEnumAllows users with this role to create new tags for contacts.
accessEntityDashboardOrderByEnumLevel of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess.
accessEntityDashboardDeleteNotOwnedOrderByEnumAllows users with this role to delete dashboards owned by other users.
accessEntityDashboardDeleteOwnedOrderByEnumAllows users with this role to delete dashboards they own.
accessEntityDashboardSharingCustomOrderByEnumAllows users with this role to share their dashboards with selected users and sales units.
accessEntityDashboardSharingPublicOrderByEnumAllows users with this role to share their dashboards with all users of the space.
accessEntityEmailAccessLevelOrderByEnumWhich emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible).
accessEntityEmailContentShareModeOrderByEnumHow users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
accessEntityEmailDeleteNotOwnedOrderByEnumAllows users with this role to delete emails they neither own nor sent.
accessEntityEmailLinkToAccountsOrderByEnumWhether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToAccountsByDomainOrderByEnumWhether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToContactsOrderByEnumWhether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailSequenceOrderByEnumLevel of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityEmailTemplateOrderByEnumLevel of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityEmailTemplateCreateDeleteFolderOrderByEnumAllows users with this role to create and delete email template folders.
accessEntityEmailTemplateDeleteNotOwnedOrderByEnumAllows users with this role to delete email templates owned by other users.
accessEntityEmailTemplateDeleteOwnedOrderByEnumAllows users with this role to delete email templates they own.
accessEntityEmailTemplateSharingCustomOrderByEnumAllows users with this role to share their email templates with selected users and sales units.
accessEntityEmailTemplateSharingPublicOrderByEnumAllows users with this role to share their email templates with all users of the space.
accessEntityForecastOrderByEnumLevel of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityForecastDeleteNotOwnedOrderByEnumAllows users with this role to delete forecasts owned by other users.
accessEntityForecastDeleteOwnedOrderByEnumAllows users with this role to delete forecasts they own.
accessEntityForecastEditNotOwnedOrderByEnumAllows users with this role to edit forecasts owned by other users.
accessEntityForecastSharingCustomOrderByEnumAllows users with this role to share their forecasts with selected users and sales units.
accessEntityForecastSharingPublicOrderByEnumAllows users with this role to share their forecasts with all users of the space.
accessEntityFormViewOrderByEnumLevel of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityFormViewDeleteNotOwnedOrderByEnumAllows users with this role to delete form views owned by other users.
accessEntityFormViewDeleteOwnedOrderByEnumAllows users with this role to delete form views they own.
accessEntityFormViewSharingCustomOrderByEnumAllows users with this role to share their form views with selected users and sales units.
accessEntityFormViewSharingPublicOrderByEnumAllows users with this role to share their form views with all users of the space.
accessEntityLeadOrderByEnumLevel of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
accessEntityLeadCopyOrderByEnumAllows users with this role to create copies of existing leads.
accessEntityLeadDeleteOrderByEnumAllows users with this role to delete leads they can edit.
accessEntityLeadDirectionOrderByEnumWhich leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityLeadPrivateOrderByEnumAllows users with this role to own private leads, which are visible only to their owner.
accessEntityLeadTagCreateOrderByEnumAllows users with this role to create new tags for leads.
accessEntityMessageTagCreateOrderByEnumAllows users with this role to create new tags for emails, memos and text messages.
accessEntityOpptyOrderByEnumLevel of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
accessEntityOpptyCopyOrderByEnumAllows users with this role to create copies of existing opportunities.
accessEntityOpptyDeleteOrderByEnumAllows users with this role to delete opportunities they can edit.
accessEntityOpptyDirectionOrderByEnumWhich opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityOpptyPrivateOrderByEnumAllows users with this role to own private opportunities, which are visible only to their owner.
accessEntityOpptyTagCreateOrderByEnumAllows users with this role to create new tags for opportunities.
accessEntityPipelineOrderByEnumWhich pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
accessEntityProcessOrderByEnumLevel of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityProfileOrderByEnumLevel of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
accessEntityProfileDeleteNotOwnedOrderByEnumAllows users with this role to delete screen profiles owned by other users.
accessEntityProfileDeleteOwnedOrderByEnumAllows users with this role to delete screen profiles they own.
accessEntityProfileSharingCustomOrderByEnumAllows users with this role to share their screen profiles with selected users and sales units.
accessEntityProfileSharingPublicOrderByEnumAllows users with this role to share their screen profiles with all users of the space.
accessEntityProjectOrderByEnumLevel of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
accessEntityProjectCopyOrderByEnumAllows users with this role to create copies of existing projects.
accessEntityProjectDeleteOrderByEnumAllows users with this role to delete projects they can edit.
accessEntityProjectDirectionOrderByEnumWhich projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityProjectPrivateOrderByEnumAllows users with this role to own private projects, which are visible only to their owner.
accessEntityProjectTagCreateOrderByEnumAllows users with this role to create new tags for projects.
accessEntityQuoteOrderByEnumLevel of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
accessEntityQuoteCopyOrderByEnumAllows users with this role to create copies of existing quotes.
accessEntityQuoteDeleteOrderByEnumAllows users with this role to delete quotes they can edit.
accessEntityQuoteDirectionOrderByEnumWhich quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityQuoteTagCreateOrderByEnumAllows users with this role to create new tags for quotes.
accessEntityReportOrderByEnumLevel of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityReportCreateDeleteFolderOrderByEnumAllows users with this role to create and delete report folders.
accessEntityReportDeleteNotOwnedOrderByEnumAllows users with this role to delete reports owned by other users.
accessEntityReportDeleteOwnedOrderByEnumAllows users with this role to delete reports they own.
accessEntityReportPrivateOrderByEnumAllows users with this role to save reports as private, visible only to themselves.
accessEntityReportScheduleCreateOrderByEnumAllows users with this role to schedule reports for regular delivery.
accessEntityReportScheduleManagementOrderByEnumAllows users with this role to view and manage report schedules of other users.
accessEntityReportSharingCustomOrderByEnumAllows users with this role to share their reports with selected users and sales units.
accessEntityReportSharingPublicOrderByEnumAllows users with this role to share their reports with all users of the space.
accessEntitySolutionOrderByEnumAllows users with this role to view and follow solutions, when the feature is enabled for the space.
accessEntitySolutionManagementOrderByEnumAllows users with this role to create, edit and delete solutions.
accessEntityTargetOrderByEnumLevel of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityTargetDeleteNotOwnedOrderByEnumAllows users with this role to delete targets owned by other users.
accessEntityTargetDeleteOwnedOrderByEnumAllows users with this role to delete targets they own.
accessEntityTaskOrderByEnumLevel of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
accessEntityTaskDeleteOrderByEnumAllows users with this role to delete tasks they can edit.
accessEntityTaskDirectionOrderByEnumWhich tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityTaskTagCreateOrderByEnumAllows users with this role to create new tags for tasks.
accessEntityTaskUnassignedOrderByEnumAllows users with this role to create tasks without an owner (unassigned tasks).
accessExportOrderByEnumAllows users with this role to export records and reports to files.
accessFeedsOrderByEnumAllows users with this role to open the Feed screen with the stream of activities, emails and other updates.
accessForeignCurrenciesOrderByEnumAllows users with this role to manage currencies and exchange rate lists in Administration.
accessFormAndFieldsOrderByEnumAllows users with this role to manage fields, forms, record types, tags and translations in Administration.
accessGlobalSettingsOrderByEnumAllows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
accessHomeScreenOrderByEnumAllows users with this role to open the Navigator screen.
accessImportOrderByEnumAllows users with this role to import records from files.
accessInsightsOrderByEnumAllows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
accessLeadsOrderByEnumShows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead.
accessOnlineFormsOrderByEnumAllows users with this role to create online forms and manage their own, when online forms are enabled for the space.
accessOnlineFormsManagementOrderByEnumAllows users with this role to edit and delete online forms owned by other users.
accessOpportunityOrderByEnumShows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty.
accessPipelineConfigurationOrderByEnumAllows users with this role to manage pipelines, lead processes and quote processes in Administration.
accessPrintOrderByEnumAllows users with this role to print records and reports.
accessProductsServicesOrderByEnumAllows users with this role to manage products, product categories and price lists in Administration.
accessProjectsOrderByEnumAllows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject.
accessQuotesOrderByEnumAllows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote.
accessSalesRolesOrderByEnumAllows users with this role to manage sales roles in Administration.
accessSecurityOrderByEnumAllows users with this role to manage the security settings of the space in Administration.
accessUnitsOrderByEnumAllows users with this role to manage sales units in Administration.
accessUserAndRolesOrderByEnumAllows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
accessWhatsAppCompanyPhoneOrderByEnumWhich company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
nameOrderByEnumName of the entity and its default text representation.
revisionOrderByEnumRevision when entity was lastly changed.
TernaryConfigEnumFilterInput input eq: [TernaryConfigEnum!], NOT: TernaryConfigEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[TernaryConfigEnum!]Matches any of the listed values.
NOTTernaryConfigEnumFilterInputMatches values that do not meet this condition.
AccountsAndContactsNotificationSettingsParams input IsActive: Boolean!, OwnershipAndSalesTeamChange: Boolean!, LinkedItem: Boolean!

Which notifications a user receives about accounts and contacts.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of accounts and contacts and about assignments to their sales team as editor or watcher.
LinkedItemBoolean!Notifies when an item is linked to an account or contact.
ActivitiesNotificationSettingsParams input 5 fields: IsActive, OwnershipAndSalesTeamChange, StatusChange, …

Which notifications a user receives about tasks and appointments.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of tasks and appointments and about assignments to their sales team as editor or watcher.
StatusChangeBoolean!Notifies when the status of a task or appointment changes or it is canceled.
InvitationBoolean!Notifies about appointment invitations received, accepted or rejected.
CommentBoolean!Notifies about comments on tasks and appointments.
ApprovalProcessesNotificationSettingsParams input 5 fields: IsActive, ApprovalRequest, ApprovalResponse, …

Which notifications a user receives about approval requests, their responses, and approval process warnings and errors.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
ApprovalRequestBoolean!Notifies about approval requests, including delegated requests and requests that found no approver.
ApprovalResponseBoolean!Notifies when an approval request is approved or rejected.
ApprovalProcessWarningBooleanNotifies about warnings raised while an approval process runs.
ApprovalProcessErrorBooleanNotifies about errors raised while an approval process runs.
CreateAllowedAccountTypeNoMasterRightBackrefInput input modified: DateTime, created: DateTime, accountTypeId: ID!, revision: Int

Field values of a new AllowedAccountType record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountTypeIdID!Id of the account type the user role can use.
revisionIntRevision when entity was lastly changed.
CreateAllowedAppointmentTypeNoMasterRightBackrefInput input modified: DateTime, created: DateTime, appointmentTypeId: ID!, revision: Int

Field values of a new AllowedAppointmentType record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentTypeIdID!Id of the appointment type the user role can use.
revisionIntRevision when entity was lastly changed.
CreateAllowedCompanyEmailNoMasterRightBackrefInput input modified: DateTime, created: DateTime, companyEmailId: ID!, revision: Int

Field values of a new AllowedCompanyEmail record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
companyEmailIdID!Id of the company email address.
revisionIntRevision when entity was lastly changed.
CreateAllowedCompanyPhoneNoMasterRightBackrefInput input modified: DateTime, created: DateTime, phoneId: ID!, revision: Int

Field values of a new AllowedCompanyPhone record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
phoneIdID!Id of the company phone.
revisionIntRevision when entity was lastly changed.
CreateAllowedContactTypeNoMasterRightBackrefInput input modified: DateTime, created: DateTime, contactTypeId: ID!, revision: Int

Field values of a new AllowedContactType record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
contactTypeIdID!Id of the contact type the user role can use.
revisionIntRevision when entity was lastly changed.
CreateAllowedLeadTypeNoMasterRightBackrefInput input modified: DateTime, created: DateTime, leadTypeId: ID!, revision: Int

Field values of a new AllowedLeadType record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
leadTypeIdID!Id of the lead type the user role can use.
revisionIntRevision when entity was lastly changed.
CreateAllowedPipelineNoMasterRightBackrefInput input 5 fields: modified, created, accessStepDocuments, …

Field values of a new AllowedPipeline record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accessStepDocumentsBooleanWhen true, the user role can access documents attached to steps of this pipeline.
pipelineIdID!Id of the pipeline the user role can use.
revisionIntRevision when entity was lastly changed.
CreateAllowedQuoteTypeNoMasterRightBackrefInput input modified: DateTime, created: DateTime, quoteTypeId: ID!, revision: Int

Field values of a new AllowedQuoteType record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
quoteTypeIdID!Id of the quote type the user role can use.
revisionIntRevision when entity was lastly changed.
CreateAllowedTaskTypeNoMasterRightBackrefInput input modified: DateTime, created: DateTime, taskTypeId: ID!, revision: Int

Field values of a new AllowedTaskType record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
taskTypeIdID!Id of the task type the user role can use.
revisionIntRevision when entity was lastly changed.
CreateMasterRightInput input 176 fields: clientMutationId, modified, created, …

Field values of a new MasterRight record.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accessAccountRelationTypesBooleanAllows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
accessAccountsBooleanShows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount.
accessAiAutomatizerBooleanAllows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
accessAiOnlineFormsBooleanAllows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
accessAiRecordDetailBooleanAllows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
accessAiRecordEnrichmentBooleanAllows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
accessAiRelationshipChartsBooleanAllows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
accessAiReportsBooleanAllows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
accessAiSmartFieldBooleanAllows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
accessAppointmentSchedulerBooleanAllows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
accessAppointmentSchedulerManagementBooleanAllows users with this role to manage appointment schedules of other users.
accessApprovalProcessesBooleanAllows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
accessApprovalProcessesManagementBooleanAllows users with this role to manage approval processes owned by other users.
accessApprovalsBooleanAllows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
accessArchiveBooleanAllows users with this role to open the Archive screens listing lost, closed and archived records.
accessAuditBooleanAllows users with this role to open the Audit screen.
accessAuditLogBooleanAllows users with this role to view the audit log of changes made in the space.
accessBottomMenuCustomizationBooleanWhether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on.
accessBulkUpdateBooleanAllows users with this role to update many records at once with bulk update.
accessCallingBooleanAllows users with this role to make calls through the calling integration, when the feature is enabled for the space.
accessCallingCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
accessCallingPurchasePhoneBooleanAllows users with this role to purchase and manage company phone numbers for the calling integration.
accessCompanyEmailsAccessLevelCompanyEmailsEnumWhich shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All).
accessContactsBooleanShows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact.
accessDocumentManagementBooleanAllows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
accessDocumentManagementCompanyBooleanAllows users with this role to manage company documents and folders that are not tied to a record.
accessDocumentManagementRecordBooleanAllows users with this role to create and edit the document folders used for records.
accessDuplicateCheckerBooleanAllows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
accessEmailNotificationEnforcementBooleanWhen true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own.
accessEmailNotificationSettingsNotificationSettingsParamsDefault email notification preferences applied to users with this role (which events trigger an email and through which channel).
accessEntityAccountAccessLevelEntityEnumLevel of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
accessEntityAccountCopyBooleanAllows users with this role to create copies of existing accounts.
accessEntityAccountDeleteBooleanAllows users with this role to delete accounts they can edit.
accessEntityAccountDirectionAccessDirectionEnumWhich accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAccountPrivateBooleanAllows users with this role to own private accounts, which are visible only to their owner.
accessEntityAccountTagCreateBooleanAllows users with this role to create new tags for accounts.
accessEntityAccountTypesAccessEntityTypesEnumWhether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected).
accessEntityAppointmentAccessLevelEntityEnumLevel of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
accessEntityAppointmentDeleteBooleanAllows users with this role to delete appointments they can edit.
accessEntityAppointmentDirectionAccessDirectionEnumWhich appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAppointmentTagCreateBooleanAllows users with this role to create new tags for appointments.
accessEntityAppointmentTypesAccessEntityTypesEnumWhether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected).
accessEntityBetterNavigatorAccessLevelCommonRecordsEnumEnumLevel of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityBetterNavigatorDeleteNotOwnedBooleanAllows users with this role to delete Navigator screen layouts owned by other users.
accessEntityBetterNavigatorDeleteOwnedBooleanAllows users with this role to delete Navigator screen layouts they own.
accessEntityBetterNavigatorSharingCustomBooleanAllows users with this role to share their Navigator screen layouts with selected users and sales units.
accessEntityBetterNavigatorSharingPublicBooleanAllows users with this role to share their Navigator screen layouts with all users of the space.
accessEntityContactAccessLevelEntityEnumLevel of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
accessEntityContactCopyBooleanAllows users with this role to create copies of existing contacts.
accessEntityContactDeleteBooleanAllows users with this role to delete contacts they can edit.
accessEntityContactDirectionAccessDirectionEnumWhich contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityContactPrivateBooleanAllows users with this role to own private contacts, which are visible only to their owner.
accessEntityContactTagCreateBooleanAllows users with this role to create new tags for contacts.
accessEntityContactTypesAccessEntityTypesEnumWhether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected).
accessEntityDashboardAccessLevelCommonRecordsEnumEnumLevel of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess.
accessEntityDashboardDeleteNotOwnedBooleanAllows users with this role to delete dashboards owned by other users.
accessEntityDashboardDeleteOwnedBooleanAllows users with this role to delete dashboards they own.
accessEntityDashboardSharingCustomBooleanAllows users with this role to share their dashboards with selected users and sales units.
accessEntityDashboardSharingPublicBooleanAllows users with this role to share their dashboards with all users of the space.
accessEntityEmailAccessLevelEmailAccessLevelEnumWhich emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible).
accessEntityEmailAllowedEmailAccessAllowListParamsAllow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default.
accessEntityEmailContentShareModeContentShareModeConfigEnumHow users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
accessEntityEmailDeleteNotOwnedBooleanAllows users with this role to delete emails they neither own nor sent.
accessEntityEmailLinkToAccountsTernaryConfigEnumWhether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToAccountsByDomainTernaryConfigEnumWhether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToContactsTernaryConfigEnumWhether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailSequenceAccessLevelEmailSequenceEnumLevel of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityEmailTemplateAccessLevelCommonRecordsEnumEnumLevel of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityEmailTemplateCreateDeleteFolderBooleanAllows users with this role to create and delete email template folders.
accessEntityEmailTemplateDeleteNotOwnedBooleanAllows users with this role to delete email templates owned by other users.
accessEntityEmailTemplateDeleteOwnedBooleanAllows users with this role to delete email templates they own.
accessEntityEmailTemplateSharingCustomBooleanAllows users with this role to share their email templates with selected users and sales units.
accessEntityEmailTemplateSharingPublicBooleanAllows users with this role to share their email templates with all users of the space.
accessEntityForecastAccessLevelCommonRecordsEnumEnumLevel of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityForecastDeleteNotOwnedBooleanAllows users with this role to delete forecasts owned by other users.
accessEntityForecastDeleteOwnedBooleanAllows users with this role to delete forecasts they own.
accessEntityForecastEditNotOwnedBooleanAllows users with this role to edit forecasts owned by other users.
accessEntityForecastSharingCustomBooleanAllows users with this role to share their forecasts with selected users and sales units.
accessEntityForecastSharingPublicBooleanAllows users with this role to share their forecasts with all users of the space.
accessEntityFormViewAccessLevelCommonRecordsEnumEnumLevel of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityFormViewDeleteNotOwnedBooleanAllows users with this role to delete form views owned by other users.
accessEntityFormViewDeleteOwnedBooleanAllows users with this role to delete form views they own.
accessEntityFormViewSharingCustomBooleanAllows users with this role to share their form views with selected users and sales units.
accessEntityFormViewSharingPublicBooleanAllows users with this role to share their form views with all users of the space.
accessEntityLeadAccessLevelEntityEnumLevel of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
accessEntityLeadCopyBooleanAllows users with this role to create copies of existing leads.
accessEntityLeadDeleteBooleanAllows users with this role to delete leads they can edit.
accessEntityLeadDirectionAccessDirectionEnumWhich leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityLeadPrivateBooleanAllows users with this role to own private leads, which are visible only to their owner.
accessEntityLeadTagCreateBooleanAllows users with this role to create new tags for leads.
accessEntityLeadTypesAccessEntityTypesEnumWhether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected).
accessEntityMessageTagCreateBooleanAllows users with this role to create new tags for emails, memos and text messages.
accessEntityOpptyAccessLevelEntityEnumLevel of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
accessEntityOpptyCopyBooleanAllows users with this role to create copies of existing opportunities.
accessEntityOpptyDeleteBooleanAllows users with this role to delete opportunities they can edit.
accessEntityOpptyDirectionAccessDirectionEnumWhich opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityOpptyPrivateBooleanAllows users with this role to own private opportunities, which are visible only to their owner.
accessEntityOpptyTagCreateBooleanAllows users with this role to create new tags for opportunities.
accessEntityPipelineAccessLevelPipelineEnumWhich pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
accessEntityProcessAccessLevelProcessBuilderEnumLevel of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityProfileAccessLevelCommonRecordsEnumEnumLevel of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
accessEntityProfileDefaultScreenProfilesScreensDefaultProfilesParamsParamsDefault screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
accessEntityProfileDeleteNotOwnedBooleanAllows users with this role to delete screen profiles owned by other users.
accessEntityProfileDeleteOwnedBooleanAllows users with this role to delete screen profiles they own.
accessEntityProfileSharingCustomBooleanAllows users with this role to share their screen profiles with selected users and sales units.
accessEntityProfileSharingPublicBooleanAllows users with this role to share their screen profiles with all users of the space.
accessEntityProjectAccessLevelEntityEnumLevel of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
accessEntityProjectCopyBooleanAllows users with this role to create copies of existing projects.
accessEntityProjectDeleteBooleanAllows users with this role to delete projects they can edit.
accessEntityProjectDirectionAccessDirectionEnumWhich projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityProjectPrivateBooleanAllows users with this role to own private projects, which are visible only to their owner.
accessEntityProjectTagCreateBooleanAllows users with this role to create new tags for projects.
accessEntityQuoteAccessLevelEntityEnumLevel of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
accessEntityQuoteCopyBooleanAllows users with this role to create copies of existing quotes.
accessEntityQuoteDeleteBooleanAllows users with this role to delete quotes they can edit.
accessEntityQuoteDirectionAccessDirectionEnumWhich quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityQuoteTagCreateBooleanAllows users with this role to create new tags for quotes.
accessEntityQuoteTypesAccessEntityTypesEnumWhether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected).
accessEntityReportAccessLevelCommonRecordsEnumEnumLevel of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityReportCreateDeleteFolderBooleanAllows users with this role to create and delete report folders.
accessEntityReportDeleteNotOwnedBooleanAllows users with this role to delete reports owned by other users.
accessEntityReportDeleteOwnedBooleanAllows users with this role to delete reports they own.
accessEntityReportPrivateBooleanAllows users with this role to save reports as private, visible only to themselves.
accessEntityReportScheduleCreateBooleanAllows users with this role to schedule reports for regular delivery.
accessEntityReportScheduleManagementBooleanAllows users with this role to view and manage report schedules of other users.
accessEntityReportSharingCustomBooleanAllows users with this role to share their reports with selected users and sales units.
accessEntityReportSharingPublicBooleanAllows users with this role to share their reports with all users of the space.
accessEntitySolutionBooleanAllows users with this role to view and follow solutions, when the feature is enabled for the space.
accessEntitySolutionManagementBooleanAllows users with this role to create, edit and delete solutions.
accessEntityTargetAccessLevelCommonRecordsEnumEnumLevel of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityTargetDeleteNotOwnedBooleanAllows users with this role to delete targets owned by other users.
accessEntityTargetDeleteOwnedBooleanAllows users with this role to delete targets they own.
accessEntityTaskAccessLevelEntityEnumLevel of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
accessEntityTaskDeleteBooleanAllows users with this role to delete tasks they can edit.
accessEntityTaskDirectionAccessDirectionEnumWhich tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityTaskTagCreateBooleanAllows users with this role to create new tags for tasks.
accessEntityTaskTypesAccessEntityTypesEnumWhether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected).
accessEntityTaskUnassignedBooleanAllows users with this role to create tasks without an owner (unassigned tasks).
accessExportBooleanAllows users with this role to export records and reports to files.
accessFeedsBooleanAllows users with this role to open the Feed screen with the stream of activities, emails and other updates.
accessForeignCurrenciesBooleanAllows users with this role to manage currencies and exchange rate lists in Administration.
accessFormAndFieldsBooleanAllows users with this role to manage fields, forms, record types, tags and translations in Administration.
accessGlobalSettingsBooleanAllows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
accessHomeScreenBooleanAllows users with this role to open the Navigator screen.
accessImportBooleanAllows users with this role to import records from files.
accessInsightsBooleanAllows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
accessLeadsBooleanShows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead.
accessOnlineFormsBooleanAllows users with this role to create online forms and manage their own, when online forms are enabled for the space.
accessOnlineFormsManagementBooleanAllows users with this role to edit and delete online forms owned by other users.
accessOpportunityBooleanShows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty.
accessPipelineConfigurationBooleanAllows users with this role to manage pipelines, lead processes and quote processes in Administration.
accessPrintBooleanAllows users with this role to print records and reports.
accessProductsServicesBooleanAllows users with this role to manage products, product categories and price lists in Administration.
accessProjectsBooleanAllows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject.
accessQuotesBooleanAllows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote.
accessSalesRolesBooleanAllows users with this role to manage sales roles in Administration.
accessSecurityBooleanAllows users with this role to manage the security settings of the space in Administration.
accessUnitsBooleanAllows users with this role to manage sales units in Administration.
accessUserAndRolesBooleanAllows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
accessWhatsAppCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
bottomMenuLayout[InterfaceBottomMenuRowParams!]The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items.
nameString!Name of the entity and its default text representation.
revisionIntRevision when entity was lastly changed.
allowedPipelines[CreateAllowedPipelineNoMasterRightBackrefInput!]Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted.
allowedLeadTypes[CreateAllowedLeadTypeNoMasterRightBackrefInput!]Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected.
allowedQuoteTypes[CreateAllowedQuoteTypeNoMasterRightBackrefInput!]Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected.
allowedAccountTypes[CreateAllowedAccountTypeNoMasterRightBackrefInput!]Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected.
allowedContactTypes[CreateAllowedContactTypeNoMasterRightBackrefInput!]Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected.
allowedTaskTypes[CreateAllowedTaskTypeNoMasterRightBackrefInput!]Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected.
allowedAppointmentTypes[CreateAllowedAppointmentTypeNoMasterRightBackrefInput!]Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here.
allowedCompanyEmails[CreateAllowedCompanyEmailNoMasterRightBackrefInput!]Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected.
allowedCompanyPhones[CreateAllowedCompanyPhoneNoMasterRightBackrefInput!]Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected.
customEntities[CustomEntityMasterRightParams!]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.
CreateOrUpdateMasterRightInput input 177 fields: clientMutationId, id, modified, …

Field values of a MasterRight record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accessAccountRelationTypesBooleanAllows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
accessAccountsBooleanShows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount.
accessAiAutomatizerBooleanAllows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
accessAiOnlineFormsBooleanAllows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
accessAiRecordDetailBooleanAllows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
accessAiRecordEnrichmentBooleanAllows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
accessAiRelationshipChartsBooleanAllows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
accessAiReportsBooleanAllows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
accessAiSmartFieldBooleanAllows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
accessAppointmentSchedulerBooleanAllows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
accessAppointmentSchedulerManagementBooleanAllows users with this role to manage appointment schedules of other users.
accessApprovalProcessesBooleanAllows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
accessApprovalProcessesManagementBooleanAllows users with this role to manage approval processes owned by other users.
accessApprovalsBooleanAllows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
accessArchiveBooleanAllows users with this role to open the Archive screens listing lost, closed and archived records.
accessAuditBooleanAllows users with this role to open the Audit screen.
accessAuditLogBooleanAllows users with this role to view the audit log of changes made in the space.
accessBottomMenuCustomizationBooleanWhether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on.
accessBulkUpdateBooleanAllows users with this role to update many records at once with bulk update.
accessCallingBooleanAllows users with this role to make calls through the calling integration, when the feature is enabled for the space.
accessCallingCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
accessCallingPurchasePhoneBooleanAllows users with this role to purchase and manage company phone numbers for the calling integration.
accessCompanyEmailsAccessLevelCompanyEmailsEnumWhich shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All).
accessContactsBooleanShows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact.
accessDocumentManagementBooleanAllows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
accessDocumentManagementCompanyBooleanAllows users with this role to manage company documents and folders that are not tied to a record.
accessDocumentManagementRecordBooleanAllows users with this role to create and edit the document folders used for records.
accessDuplicateCheckerBooleanAllows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
accessEmailNotificationEnforcementBooleanWhen true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own.
accessEmailNotificationSettingsNotificationSettingsParamsDefault email notification preferences applied to users with this role (which events trigger an email and through which channel).
accessEntityAccountAccessLevelEntityEnumLevel of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
accessEntityAccountCopyBooleanAllows users with this role to create copies of existing accounts.
accessEntityAccountDeleteBooleanAllows users with this role to delete accounts they can edit.
accessEntityAccountDirectionAccessDirectionEnumWhich accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAccountPrivateBooleanAllows users with this role to own private accounts, which are visible only to their owner.
accessEntityAccountTagCreateBooleanAllows users with this role to create new tags for accounts.
accessEntityAccountTypesAccessEntityTypesEnumWhether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected).
accessEntityAppointmentAccessLevelEntityEnumLevel of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
accessEntityAppointmentDeleteBooleanAllows users with this role to delete appointments they can edit.
accessEntityAppointmentDirectionAccessDirectionEnumWhich appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAppointmentTagCreateBooleanAllows users with this role to create new tags for appointments.
accessEntityAppointmentTypesAccessEntityTypesEnumWhether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected).
accessEntityBetterNavigatorAccessLevelCommonRecordsEnumEnumLevel of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityBetterNavigatorDeleteNotOwnedBooleanAllows users with this role to delete Navigator screen layouts owned by other users.
accessEntityBetterNavigatorDeleteOwnedBooleanAllows users with this role to delete Navigator screen layouts they own.
accessEntityBetterNavigatorSharingCustomBooleanAllows users with this role to share their Navigator screen layouts with selected users and sales units.
accessEntityBetterNavigatorSharingPublicBooleanAllows users with this role to share their Navigator screen layouts with all users of the space.
accessEntityContactAccessLevelEntityEnumLevel of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
accessEntityContactCopyBooleanAllows users with this role to create copies of existing contacts.
accessEntityContactDeleteBooleanAllows users with this role to delete contacts they can edit.
accessEntityContactDirectionAccessDirectionEnumWhich contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityContactPrivateBooleanAllows users with this role to own private contacts, which are visible only to their owner.
accessEntityContactTagCreateBooleanAllows users with this role to create new tags for contacts.
accessEntityContactTypesAccessEntityTypesEnumWhether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected).
accessEntityDashboardAccessLevelCommonRecordsEnumEnumLevel of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess.
accessEntityDashboardDeleteNotOwnedBooleanAllows users with this role to delete dashboards owned by other users.
accessEntityDashboardDeleteOwnedBooleanAllows users with this role to delete dashboards they own.
accessEntityDashboardSharingCustomBooleanAllows users with this role to share their dashboards with selected users and sales units.
accessEntityDashboardSharingPublicBooleanAllows users with this role to share their dashboards with all users of the space.
accessEntityEmailAccessLevelEmailAccessLevelEnumWhich emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible).
accessEntityEmailAllowedEmailAccessAllowListParamsAllow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default.
accessEntityEmailContentShareModeContentShareModeConfigEnumHow users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
accessEntityEmailDeleteNotOwnedBooleanAllows users with this role to delete emails they neither own nor sent.
accessEntityEmailLinkToAccountsTernaryConfigEnumWhether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToAccountsByDomainTernaryConfigEnumWhether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToContactsTernaryConfigEnumWhether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailSequenceAccessLevelEmailSequenceEnumLevel of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityEmailTemplateAccessLevelCommonRecordsEnumEnumLevel of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityEmailTemplateCreateDeleteFolderBooleanAllows users with this role to create and delete email template folders.
accessEntityEmailTemplateDeleteNotOwnedBooleanAllows users with this role to delete email templates owned by other users.
accessEntityEmailTemplateDeleteOwnedBooleanAllows users with this role to delete email templates they own.
accessEntityEmailTemplateSharingCustomBooleanAllows users with this role to share their email templates with selected users and sales units.
accessEntityEmailTemplateSharingPublicBooleanAllows users with this role to share their email templates with all users of the space.
accessEntityForecastAccessLevelCommonRecordsEnumEnumLevel of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityForecastDeleteNotOwnedBooleanAllows users with this role to delete forecasts owned by other users.
accessEntityForecastDeleteOwnedBooleanAllows users with this role to delete forecasts they own.
accessEntityForecastEditNotOwnedBooleanAllows users with this role to edit forecasts owned by other users.
accessEntityForecastSharingCustomBooleanAllows users with this role to share their forecasts with selected users and sales units.
accessEntityForecastSharingPublicBooleanAllows users with this role to share their forecasts with all users of the space.
accessEntityFormViewAccessLevelCommonRecordsEnumEnumLevel of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityFormViewDeleteNotOwnedBooleanAllows users with this role to delete form views owned by other users.
accessEntityFormViewDeleteOwnedBooleanAllows users with this role to delete form views they own.
accessEntityFormViewSharingCustomBooleanAllows users with this role to share their form views with selected users and sales units.
accessEntityFormViewSharingPublicBooleanAllows users with this role to share their form views with all users of the space.
accessEntityLeadAccessLevelEntityEnumLevel of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
accessEntityLeadCopyBooleanAllows users with this role to create copies of existing leads.
accessEntityLeadDeleteBooleanAllows users with this role to delete leads they can edit.
accessEntityLeadDirectionAccessDirectionEnumWhich leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityLeadPrivateBooleanAllows users with this role to own private leads, which are visible only to their owner.
accessEntityLeadTagCreateBooleanAllows users with this role to create new tags for leads.
accessEntityLeadTypesAccessEntityTypesEnumWhether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected).
accessEntityMessageTagCreateBooleanAllows users with this role to create new tags for emails, memos and text messages.
accessEntityOpptyAccessLevelEntityEnumLevel of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
accessEntityOpptyCopyBooleanAllows users with this role to create copies of existing opportunities.
accessEntityOpptyDeleteBooleanAllows users with this role to delete opportunities they can edit.
accessEntityOpptyDirectionAccessDirectionEnumWhich opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityOpptyPrivateBooleanAllows users with this role to own private opportunities, which are visible only to their owner.
accessEntityOpptyTagCreateBooleanAllows users with this role to create new tags for opportunities.
accessEntityPipelineAccessLevelPipelineEnumWhich pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
accessEntityProcessAccessLevelProcessBuilderEnumLevel of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityProfileAccessLevelCommonRecordsEnumEnumLevel of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
accessEntityProfileDefaultScreenProfilesScreensDefaultProfilesParamsParamsDefault screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
accessEntityProfileDeleteNotOwnedBooleanAllows users with this role to delete screen profiles owned by other users.
accessEntityProfileDeleteOwnedBooleanAllows users with this role to delete screen profiles they own.
accessEntityProfileSharingCustomBooleanAllows users with this role to share their screen profiles with selected users and sales units.
accessEntityProfileSharingPublicBooleanAllows users with this role to share their screen profiles with all users of the space.
accessEntityProjectAccessLevelEntityEnumLevel of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
accessEntityProjectCopyBooleanAllows users with this role to create copies of existing projects.
accessEntityProjectDeleteBooleanAllows users with this role to delete projects they can edit.
accessEntityProjectDirectionAccessDirectionEnumWhich projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityProjectPrivateBooleanAllows users with this role to own private projects, which are visible only to their owner.
accessEntityProjectTagCreateBooleanAllows users with this role to create new tags for projects.
accessEntityQuoteAccessLevelEntityEnumLevel of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
accessEntityQuoteCopyBooleanAllows users with this role to create copies of existing quotes.
accessEntityQuoteDeleteBooleanAllows users with this role to delete quotes they can edit.
accessEntityQuoteDirectionAccessDirectionEnumWhich quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityQuoteTagCreateBooleanAllows users with this role to create new tags for quotes.
accessEntityQuoteTypesAccessEntityTypesEnumWhether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected).
accessEntityReportAccessLevelCommonRecordsEnumEnumLevel of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityReportCreateDeleteFolderBooleanAllows users with this role to create and delete report folders.
accessEntityReportDeleteNotOwnedBooleanAllows users with this role to delete reports owned by other users.
accessEntityReportDeleteOwnedBooleanAllows users with this role to delete reports they own.
accessEntityReportPrivateBooleanAllows users with this role to save reports as private, visible only to themselves.
accessEntityReportScheduleCreateBooleanAllows users with this role to schedule reports for regular delivery.
accessEntityReportScheduleManagementBooleanAllows users with this role to view and manage report schedules of other users.
accessEntityReportSharingCustomBooleanAllows users with this role to share their reports with selected users and sales units.
accessEntityReportSharingPublicBooleanAllows users with this role to share their reports with all users of the space.
accessEntitySolutionBooleanAllows users with this role to view and follow solutions, when the feature is enabled for the space.
accessEntitySolutionManagementBooleanAllows users with this role to create, edit and delete solutions.
accessEntityTargetAccessLevelCommonRecordsEnumEnumLevel of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityTargetDeleteNotOwnedBooleanAllows users with this role to delete targets owned by other users.
accessEntityTargetDeleteOwnedBooleanAllows users with this role to delete targets they own.
accessEntityTaskAccessLevelEntityEnumLevel of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
accessEntityTaskDeleteBooleanAllows users with this role to delete tasks they can edit.
accessEntityTaskDirectionAccessDirectionEnumWhich tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityTaskTagCreateBooleanAllows users with this role to create new tags for tasks.
accessEntityTaskTypesAccessEntityTypesEnumWhether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected).
accessEntityTaskUnassignedBooleanAllows users with this role to create tasks without an owner (unassigned tasks).
accessExportBooleanAllows users with this role to export records and reports to files.
accessFeedsBooleanAllows users with this role to open the Feed screen with the stream of activities, emails and other updates.
accessForeignCurrenciesBooleanAllows users with this role to manage currencies and exchange rate lists in Administration.
accessFormAndFieldsBooleanAllows users with this role to manage fields, forms, record types, tags and translations in Administration.
accessGlobalSettingsBooleanAllows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
accessHomeScreenBooleanAllows users with this role to open the Navigator screen.
accessImportBooleanAllows users with this role to import records from files.
accessInsightsBooleanAllows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
accessLeadsBooleanShows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead.
accessOnlineFormsBooleanAllows users with this role to create online forms and manage their own, when online forms are enabled for the space.
accessOnlineFormsManagementBooleanAllows users with this role to edit and delete online forms owned by other users.
accessOpportunityBooleanShows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty.
accessPipelineConfigurationBooleanAllows users with this role to manage pipelines, lead processes and quote processes in Administration.
accessPrintBooleanAllows users with this role to print records and reports.
accessProductsServicesBooleanAllows users with this role to manage products, product categories and price lists in Administration.
accessProjectsBooleanAllows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject.
accessQuotesBooleanAllows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote.
accessSalesRolesBooleanAllows users with this role to manage sales roles in Administration.
accessSecurityBooleanAllows users with this role to manage the security settings of the space in Administration.
accessUnitsBooleanAllows users with this role to manage sales units in Administration.
accessUserAndRolesBooleanAllows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
accessWhatsAppCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
bottomMenuLayout[InterfaceBottomMenuRowParams!]The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items.
nameStringName of the entity and its default text representation.
revisionIntRevision when entity was lastly changed.
allowedPipelines[CreateAllowedPipelineNoMasterRightBackrefInput!]Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted.
allowedLeadTypes[CreateAllowedLeadTypeNoMasterRightBackrefInput!]Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected.
allowedQuoteTypes[CreateAllowedQuoteTypeNoMasterRightBackrefInput!]Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected.
allowedAccountTypes[CreateAllowedAccountTypeNoMasterRightBackrefInput!]Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected.
allowedContactTypes[CreateAllowedContactTypeNoMasterRightBackrefInput!]Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected.
allowedTaskTypes[CreateAllowedTaskTypeNoMasterRightBackrefInput!]Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected.
allowedAppointmentTypes[CreateAllowedAppointmentTypeNoMasterRightBackrefInput!]Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here.
allowedCompanyEmails[CreateAllowedCompanyEmailNoMasterRightBackrefInput!]Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected.
allowedCompanyPhones[CreateAllowedCompanyPhoneNoMasterRightBackrefInput!]Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected.
customEntities[CustomEntityMasterRightParams!]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.
CustomEntitiesNotificationSettingParams input entityApiName: String!, IsActive: Boolean!, OwnershipAndSalesTeamChange: Boolean!, LinkedItem: Boolean!

Which notifications a user receives about the records of one custom entity type.

Input fieldTypeDescription
entityApiNameString!API name of the custom entity type these options apply to.
IsActiveBoolean!Turns all notifications of this custom entity type on or off; when false, the other options are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of records of this type and about assignments to their sales team as editor or watcher.
LinkedItemBoolean!Notifies when an item is linked to a record of this type.
CustomEntityMasterRightParams input 11 fields: entityApiName, navigationAccess, accessLevel, …

Rights of a user role to one custom entity: screen access, record access level and the actions its users may take.

Input fieldTypeDescription
entityApiNameString!API name of the custom entity these settings apply to.
navigationAccessBoolean!Shows the screen of the custom entity to users with this role. Which records they can see and edit is set by accessLevel.
accessLevelAccessLevelEntityEnum!Level of access to records of the custom entity for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the records the role can see.
accessDirectionAccessDirectionEnum!Which records of the custom entity users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessPrivateBoolean!Allows users with this role to own private records of the custom entity, which are visible only to their owner.
accessDeleteBoolean!Allows users with this role to delete records of the custom entity they can edit.
accessEntityTypesAccessEntityTypesEnum!Whether users with this role can work with all types of the custom entity (All) or only with those in allowedEntityTypeIds (Selected).
allowedEntityTypeIds[ID!]!Types of the custom entity this user role can use. Effective only when accessEntityTypes is set to Selected.
defaultProfileIdID!Default screen profile (saved screen view) of the custom entity screen for users with this role.
accessCopyBoolean!Allows users with this role to create copies of existing records of the custom entity.
accessTagCreateBoolean!Allows users with this role to create new tags for records of the custom entity.
DeleteMasterRightInput input clientMutationId: String, id: ID!

Id of the MasterRight record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
EmailAccessAllowListParams input clientIds: [UUID!]!, unitIds: [UUID!]!

Users and sales units whose emails stay visible to users with the role.

Input fieldTypeDescription
clientIds[UUID!]!Ids of users whose emails stay visible.
unitIds[UUID!]!Ids of sales units whose Member users' emails stay visible.
EmailNotificationSettingsParams input IsActive: Boolean!, LinkedItem: Boolean, Tracking: Boolean, Bounced: Boolean

Which notifications a user receives about emails: sent and received emails, opens and bounces.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBooleanNotifies about emails sent and received.
TrackingBooleanNotifies when a sent email is opened.
BouncedBooleanNotifies when a sent email bounces.
EmailSequencesNotificationSettingsParams input IsActive: Boolean!, Warnings: Boolean!, Errors: Boolean!

Which notifications a user receives about warnings and errors of email sequences.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
WarningsBoolean!Notifies about warnings raised while the automation or sequence runs.
ErrorsBoolean!Notifies about errors raised while the automation or sequence runs.
FeedsNotificationSettingsParams input IsActive: Boolean!, Create: Boolean!, Comment: Boolean!

Which notifications a user receives about feed posts and their comments.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
CreateBoolean!Notifies about new feed posts.
CommentBoolean!Notifies about comments on feed posts.
InterfaceBottomMenuRowParams input 8 fields: kind, entityApiName, isEnabled, …

Written by hand, not via InterfaceBottomMenuRow.InputObjectType(): the generic converter builds field types eagerly, and the self-referencing items list makes it recurse without end.

Input fieldTypeDescription
kindInterfaceBottomMenuItemKind!The screen of an item row; Section on a group row.
entityApiNameStringSet on CustomEntity rows.
isEnabledBooleanDefault Access of the item in the role; stored as the client sent it.
isPinnedBooleanPinned to the bar. On the role's items it equals isEnabled after every role save; on a user's own layout it is what the user chose.
nameStringA group's name as the admin typed it, or a translation key (see useLang).
useLangBooleanTrue when name is a translation key the client localizes, as on the default groups Communication, Analytics, Archive and Tools; false when shown as typed.
iconEntityIconEnumA group's icon.
items[InterfaceBottomMenuRowParams!]Members of a group row, in submenu order; null on items.
LeadsAndOpportunitiesNotificationSettingsParams input 6 fields: IsActive, LinkedItem, Move, …

Which notifications a user receives about leads and opportunities.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBoolean!Notifies when an item is linked to a lead or opportunity.
MoveBoolean!Notifies when a lead or opportunity moves to another step or an opportunity is turned back into a lead.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of leads and opportunities and about assignments to their sales team as editor or watcher.
QualificationBoolean!Notifies when a lead is qualified to an opportunity.
StatusChangeBoolean!Notifies when a lead or opportunity is won, lost or reactivated.
NotificationSettingsParams input 15 fields: Emails, AccountsAndContacts, LeadsAndOpportunities, …

Which events a user is notified about, grouped by area such as emails, activities or automations.

Input fieldTypeDescription
EmailsEmailNotificationSettingsParams!Notification options for emails.
AccountsAndContactsAccountsAndContactsNotificationSettingsParams!Notification options for accounts and contacts.
LeadsAndOpportunitiesLeadsAndOpportunitiesNotificationSettingsParams!Notification options for leads and opportunities.
FeedsFeedsNotificationSettingsParams!Notification options for feed posts.
ActivitiesActivitiesNotificationSettingsParams!Notification options for tasks and appointments.
WhatsAppTextMessageNotificationSettingsParamsNotification options for WhatsApp messages.
CallingAndMessagingTextMessageNotificationSettingsParamsNotification options for calling and text messaging.
ProcessBuilderProcessBuilderNotificationSettingsParamsNotification options for automations.
ProjectsProjectsNotificationSettingsParamsNotification options for projects.
QuotesQuotesNotificationSettingsParamsNotification options for quotes.
EmailSequencesEmailSequencesNotificationSettingsParamsNotification options for email sequences.
ApprovalProcessesApprovalProcessesNotificationSettingsParamsNotification options for approval processes.
OnlineFormsOnlineFormsNotificationSettingsParamsNotification options for online forms.
CustomEntities[CustomEntitiesNotificationSettingParams!]!Notification options per custom entity type. Custom entity types not listed notify about all their events.
isSettingsEnforcedBoolean!True when an administrator enforces these options for the user, so the user's own choices do not apply. Computed by the server; ignored on input.
OnlineFormsNotificationSettingsParams input IsActive: Boolean!, Responses: Boolean!, Warnings: Boolean!, Errors: Boolean!

Which notifications a user receives about online form responses and the warnings and errors raised while they are processed.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
ResponsesBoolean!Notifies about responses submitted through online forms.
WarningsBoolean!Notifies about warnings raised while an online form response is processed.
ErrorsBoolean!Notifies about errors raised while an online form response is processed.
ProcessBuilderNotificationSettingsParams input IsActive: Boolean!, Warnings: Boolean!, Errors: Boolean!

Which notifications a user receives about warnings and errors of automations.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
WarningsBoolean!Notifies about warnings raised while the automation or sequence runs.
ErrorsBoolean!Notifies about errors raised while the automation or sequence runs.
ProjectsNotificationSettingsParams input IsActive: Boolean!, OwnershipAndSalesTeamChange: Boolean!, StatusChange: Boolean!, LinkedItem: Boolean!

Which notifications a user receives about projects.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of projects and about assignments to their sales team as editor or watcher.
StatusChangeBoolean!Notifies when the status of a project changes.
LinkedItemBoolean!Notifies when an item is linked to a project.
QuotesNotificationSettingsParams input 5 fields: IsActive, LinkedItem, Move, …

Which notifications a user receives about quotes.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBoolean!Notifies when an item is linked to a quote.
MoveBoolean!Notifies when a quote moves to another step.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of quotes and about assignments to their sales team as editor or watcher.
StatusChangeBoolean!Notifies when a quote is won, lost or reactivated.
ScreensDefaultProfilesParamsParams input 17 fields: Navigator, Pipelinescreen, Leadscreen, …

Default profiles (saved views) of the main screens for users with a given role.

Input fieldTypeDescription
NavigatorUUID!Id of the default profile (saved view) of the original Navigator screen for users with this role.
PipelinescreenUUID!Id of the default profile (saved view) of the Opportunities screen for users with this role.
LeadscreenUUID!Id of the default profile (saved view) of the Leads screen for users with this role.
AccountscreenUUID!Id of the default profile (saved view) of the Accounts screen for users with this role.
ContactscreenUUID!Id of the default profile (saved view) of the Contacts screen for users with this role.
ActivityscreenUUID!Id of the default profile (saved view) of the Activities screen for users with this role.
Feedscreen2UUID!Id of the default profile (saved view) of the Feed screen for users with this role.
ArchivescreenUUID!Id of the default profile (saved view) of the opportunity archive for users with this role.
LeadArchivescreenUUID!Id of the default profile (saved view) of the lead archive for users with this role.
InsightsscreenUUID!Id of the default profile (saved view) of the Insights overview screen for users with this role.
IndicatorsscreenUUID!Id of the default profile (saved view) of the Insights indicators screen for users with this role.
ConversionsscreenUUID!Id of the default profile (saved view) of the Insights conversions screen for users with this role.
LifecyclescreenUUID!Id of the default profile (saved view) of the Insights lifecycle screen for users with this role.
ProjectscreenUUID!Id of the default profile (saved view) of the Projects screen for users with this role.
QuotescreenUUID!Id of the default profile (saved view) of the Quotes screen for users with this role.
QuoteArchivescreenUUID!Id of the default profile (saved view) of the quote archive for users with this role.
BetterNavigatorscreenUUID!Id of the default profile (saved view) of the Navigator screen for users with this role.
TextMessageNotificationSettingsParams input IsActive: Boolean!, LinkedItem: Boolean

Which notifications a user receives about new text or WhatsApp messages.

Input fieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBooleanNotifies about new messages.
UpdateMasterRightInput input 177 fields: clientMutationId, id, modified, …

Id of a MasterRight record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accessAccountRelationTypesBooleanAllows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
accessAccountsBooleanShows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount.
accessAiAutomatizerBooleanAllows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
accessAiOnlineFormsBooleanAllows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
accessAiRecordDetailBooleanAllows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
accessAiRecordEnrichmentBooleanAllows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
accessAiRelationshipChartsBooleanAllows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
accessAiReportsBooleanAllows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
accessAiSmartFieldBooleanAllows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
accessAppointmentSchedulerBooleanAllows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
accessAppointmentSchedulerManagementBooleanAllows users with this role to manage appointment schedules of other users.
accessApprovalProcessesBooleanAllows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
accessApprovalProcessesManagementBooleanAllows users with this role to manage approval processes owned by other users.
accessApprovalsBooleanAllows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
accessArchiveBooleanAllows users with this role to open the Archive screens listing lost, closed and archived records.
accessAuditBooleanAllows users with this role to open the Audit screen.
accessAuditLogBooleanAllows users with this role to view the audit log of changes made in the space.
accessBottomMenuCustomizationBooleanWhether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on.
accessBulkUpdateBooleanAllows users with this role to update many records at once with bulk update.
accessCallingBooleanAllows users with this role to make calls through the calling integration, when the feature is enabled for the space.
accessCallingCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
accessCallingPurchasePhoneBooleanAllows users with this role to purchase and manage company phone numbers for the calling integration.
accessCompanyEmailsAccessLevelCompanyEmailsEnumWhich shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All).
accessContactsBooleanShows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact.
accessDocumentManagementBooleanAllows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
accessDocumentManagementCompanyBooleanAllows users with this role to manage company documents and folders that are not tied to a record.
accessDocumentManagementRecordBooleanAllows users with this role to create and edit the document folders used for records.
accessDuplicateCheckerBooleanAllows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
accessEmailNotificationEnforcementBooleanWhen true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own.
accessEmailNotificationSettingsNotificationSettingsParamsDefault email notification preferences applied to users with this role (which events trigger an email and through which channel).
accessEntityAccountAccessLevelEntityEnumLevel of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
accessEntityAccountCopyBooleanAllows users with this role to create copies of existing accounts.
accessEntityAccountDeleteBooleanAllows users with this role to delete accounts they can edit.
accessEntityAccountDirectionAccessDirectionEnumWhich accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAccountPrivateBooleanAllows users with this role to own private accounts, which are visible only to their owner.
accessEntityAccountTagCreateBooleanAllows users with this role to create new tags for accounts.
accessEntityAccountTypesAccessEntityTypesEnumWhether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected).
accessEntityAppointmentAccessLevelEntityEnumLevel of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
accessEntityAppointmentDeleteBooleanAllows users with this role to delete appointments they can edit.
accessEntityAppointmentDirectionAccessDirectionEnumWhich appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityAppointmentTagCreateBooleanAllows users with this role to create new tags for appointments.
accessEntityAppointmentTypesAccessEntityTypesEnumWhether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected).
accessEntityBetterNavigatorAccessLevelCommonRecordsEnumEnumLevel of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityBetterNavigatorDeleteNotOwnedBooleanAllows users with this role to delete Navigator screen layouts owned by other users.
accessEntityBetterNavigatorDeleteOwnedBooleanAllows users with this role to delete Navigator screen layouts they own.
accessEntityBetterNavigatorSharingCustomBooleanAllows users with this role to share their Navigator screen layouts with selected users and sales units.
accessEntityBetterNavigatorSharingPublicBooleanAllows users with this role to share their Navigator screen layouts with all users of the space.
accessEntityContactAccessLevelEntityEnumLevel of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
accessEntityContactCopyBooleanAllows users with this role to create copies of existing contacts.
accessEntityContactDeleteBooleanAllows users with this role to delete contacts they can edit.
accessEntityContactDirectionAccessDirectionEnumWhich contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityContactPrivateBooleanAllows users with this role to own private contacts, which are visible only to their owner.
accessEntityContactTagCreateBooleanAllows users with this role to create new tags for contacts.
accessEntityContactTypesAccessEntityTypesEnumWhether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected).
accessEntityDashboardAccessLevelCommonRecordsEnumEnumLevel of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess.
accessEntityDashboardDeleteNotOwnedBooleanAllows users with this role to delete dashboards owned by other users.
accessEntityDashboardDeleteOwnedBooleanAllows users with this role to delete dashboards they own.
accessEntityDashboardSharingCustomBooleanAllows users with this role to share their dashboards with selected users and sales units.
accessEntityDashboardSharingPublicBooleanAllows users with this role to share their dashboards with all users of the space.
accessEntityEmailAccessLevelEmailAccessLevelEnumWhich emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible).
accessEntityEmailAllowedEmailAccessAllowListParamsAllow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default.
accessEntityEmailContentShareModeContentShareModeConfigEnumHow users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
accessEntityEmailDeleteNotOwnedBooleanAllows users with this role to delete emails they neither own nor sent.
accessEntityEmailLinkToAccountsTernaryConfigEnumWhether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToAccountsByDomainTernaryConfigEnumWhether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
accessEntityEmailLinkToContactsTernaryConfigEnumWhether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
accessEntityEmailSequenceAccessLevelEmailSequenceEnumLevel of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityEmailTemplateAccessLevelCommonRecordsEnumEnumLevel of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityEmailTemplateCreateDeleteFolderBooleanAllows users with this role to create and delete email template folders.
accessEntityEmailTemplateDeleteNotOwnedBooleanAllows users with this role to delete email templates owned by other users.
accessEntityEmailTemplateDeleteOwnedBooleanAllows users with this role to delete email templates they own.
accessEntityEmailTemplateSharingCustomBooleanAllows users with this role to share their email templates with selected users and sales units.
accessEntityEmailTemplateSharingPublicBooleanAllows users with this role to share their email templates with all users of the space.
accessEntityForecastAccessLevelCommonRecordsEnumEnumLevel of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityForecastDeleteNotOwnedBooleanAllows users with this role to delete forecasts owned by other users.
accessEntityForecastDeleteOwnedBooleanAllows users with this role to delete forecasts they own.
accessEntityForecastEditNotOwnedBooleanAllows users with this role to edit forecasts owned by other users.
accessEntityForecastSharingCustomBooleanAllows users with this role to share their forecasts with selected users and sales units.
accessEntityForecastSharingPublicBooleanAllows users with this role to share their forecasts with all users of the space.
accessEntityFormViewAccessLevelCommonRecordsEnumEnumLevel of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityFormViewDeleteNotOwnedBooleanAllows users with this role to delete form views owned by other users.
accessEntityFormViewDeleteOwnedBooleanAllows users with this role to delete form views they own.
accessEntityFormViewSharingCustomBooleanAllows users with this role to share their form views with selected users and sales units.
accessEntityFormViewSharingPublicBooleanAllows users with this role to share their form views with all users of the space.
accessEntityLeadAccessLevelEntityEnumLevel of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
accessEntityLeadCopyBooleanAllows users with this role to create copies of existing leads.
accessEntityLeadDeleteBooleanAllows users with this role to delete leads they can edit.
accessEntityLeadDirectionAccessDirectionEnumWhich leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityLeadPrivateBooleanAllows users with this role to own private leads, which are visible only to their owner.
accessEntityLeadTagCreateBooleanAllows users with this role to create new tags for leads.
accessEntityLeadTypesAccessEntityTypesEnumWhether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected).
accessEntityMessageTagCreateBooleanAllows users with this role to create new tags for emails, memos and text messages.
accessEntityOpptyAccessLevelEntityEnumLevel of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
accessEntityOpptyCopyBooleanAllows users with this role to create copies of existing opportunities.
accessEntityOpptyDeleteBooleanAllows users with this role to delete opportunities they can edit.
accessEntityOpptyDirectionAccessDirectionEnumWhich opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityOpptyPrivateBooleanAllows users with this role to own private opportunities, which are visible only to their owner.
accessEntityOpptyTagCreateBooleanAllows users with this role to create new tags for opportunities.
accessEntityPipelineAccessLevelPipelineEnumWhich pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
accessEntityProcessAccessLevelProcessBuilderEnumLevel of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
accessEntityProfileAccessLevelCommonRecordsEnumEnumLevel of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
accessEntityProfileDefaultScreenProfilesScreensDefaultProfilesParamsParamsDefault screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
accessEntityProfileDeleteNotOwnedBooleanAllows users with this role to delete screen profiles owned by other users.
accessEntityProfileDeleteOwnedBooleanAllows users with this role to delete screen profiles they own.
accessEntityProfileSharingCustomBooleanAllows users with this role to share their screen profiles with selected users and sales units.
accessEntityProfileSharingPublicBooleanAllows users with this role to share their screen profiles with all users of the space.
accessEntityProjectAccessLevelEntityEnumLevel of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
accessEntityProjectCopyBooleanAllows users with this role to create copies of existing projects.
accessEntityProjectDeleteBooleanAllows users with this role to delete projects they can edit.
accessEntityProjectDirectionAccessDirectionEnumWhich projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityProjectPrivateBooleanAllows users with this role to own private projects, which are visible only to their owner.
accessEntityProjectTagCreateBooleanAllows users with this role to create new tags for projects.
accessEntityQuoteAccessLevelEntityEnumLevel of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
accessEntityQuoteCopyBooleanAllows users with this role to create copies of existing quotes.
accessEntityQuoteDeleteBooleanAllows users with this role to delete quotes they can edit.
accessEntityQuoteDirectionAccessDirectionEnumWhich quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityQuoteTagCreateBooleanAllows users with this role to create new tags for quotes.
accessEntityQuoteTypesAccessEntityTypesEnumWhether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected).
accessEntityReportAccessLevelCommonRecordsEnumEnumLevel of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityReportCreateDeleteFolderBooleanAllows users with this role to create and delete report folders.
accessEntityReportDeleteNotOwnedBooleanAllows users with this role to delete reports owned by other users.
accessEntityReportDeleteOwnedBooleanAllows users with this role to delete reports they own.
accessEntityReportPrivateBooleanAllows users with this role to save reports as private, visible only to themselves.
accessEntityReportScheduleCreateBooleanAllows users with this role to schedule reports for regular delivery.
accessEntityReportScheduleManagementBooleanAllows users with this role to view and manage report schedules of other users.
accessEntityReportSharingCustomBooleanAllows users with this role to share their reports with selected users and sales units.
accessEntityReportSharingPublicBooleanAllows users with this role to share their reports with all users of the space.
accessEntitySolutionBooleanAllows users with this role to view and follow solutions, when the feature is enabled for the space.
accessEntitySolutionManagementBooleanAllows users with this role to create, edit and delete solutions.
accessEntityTargetAccessLevelCommonRecordsEnumEnumLevel of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
accessEntityTargetDeleteNotOwnedBooleanAllows users with this role to delete targets owned by other users.
accessEntityTargetDeleteOwnedBooleanAllows users with this role to delete targets they own.
accessEntityTaskAccessLevelEntityEnumLevel of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
accessEntityTaskDeleteBooleanAllows users with this role to delete tasks they can edit.
accessEntityTaskDirectionAccessDirectionEnumWhich tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessEntityTaskTagCreateBooleanAllows users with this role to create new tags for tasks.
accessEntityTaskTypesAccessEntityTypesEnumWhether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected).
accessEntityTaskUnassignedBooleanAllows users with this role to create tasks without an owner (unassigned tasks).
accessExportBooleanAllows users with this role to export records and reports to files.
accessFeedsBooleanAllows users with this role to open the Feed screen with the stream of activities, emails and other updates.
accessForeignCurrenciesBooleanAllows users with this role to manage currencies and exchange rate lists in Administration.
accessFormAndFieldsBooleanAllows users with this role to manage fields, forms, record types, tags and translations in Administration.
accessGlobalSettingsBooleanAllows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
accessHomeScreenBooleanAllows users with this role to open the Navigator screen.
accessImportBooleanAllows users with this role to import records from files.
accessInsightsBooleanAllows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
accessLeadsBooleanShows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead.
accessOnlineFormsBooleanAllows users with this role to create online forms and manage their own, when online forms are enabled for the space.
accessOnlineFormsManagementBooleanAllows users with this role to edit and delete online forms owned by other users.
accessOpportunityBooleanShows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty.
accessPipelineConfigurationBooleanAllows users with this role to manage pipelines, lead processes and quote processes in Administration.
accessPrintBooleanAllows users with this role to print records and reports.
accessProductsServicesBooleanAllows users with this role to manage products, product categories and price lists in Administration.
accessProjectsBooleanAllows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject.
accessQuotesBooleanAllows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote.
accessSalesRolesBooleanAllows users with this role to manage sales roles in Administration.
accessSecurityBooleanAllows users with this role to manage the security settings of the space in Administration.
accessUnitsBooleanAllows users with this role to manage sales units in Administration.
accessUserAndRolesBooleanAllows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
accessWhatsAppCompanyPhoneAccessLevelCompanyEmailsEnumWhich company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All).
bottomMenuLayout[InterfaceBottomMenuRowParams!]The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items.
nameStringName of the entity and its default text representation.
revisionIntRevision when entity was lastly changed.
allowedPipelines[CreateAllowedPipelineNoMasterRightBackrefInput!]Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted.
allowedLeadTypes[CreateAllowedLeadTypeNoMasterRightBackrefInput!]Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected.
allowedQuoteTypes[CreateAllowedQuoteTypeNoMasterRightBackrefInput!]Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected.
allowedAccountTypes[CreateAllowedAccountTypeNoMasterRightBackrefInput!]Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected.
allowedContactTypes[CreateAllowedContactTypeNoMasterRightBackrefInput!]Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected.
allowedTaskTypes[CreateAllowedTaskTypeNoMasterRightBackrefInput!]Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected.
allowedAppointmentTypes[CreateAllowedAppointmentTypeNoMasterRightBackrefInput!]Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here.
allowedCompanyEmails[CreateAllowedCompanyEmailNoMasterRightBackrefInput!]Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected.
allowedCompanyPhones[CreateAllowedCompanyPhoneNoMasterRightBackrefInput!]Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected.
customEntities[CustomEntityMasterRightParams!]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.
BulkUpdateMasterRightPayload object result: BulkUpdateResults!

Result of the bulkUpdateMasterRight mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
CreateMasterRightPayload object masterRight: MasterRightEntity, clientMutationId: String

Result of the createMasterRight mutation.

FieldTypeDescription
masterRightMasterRightEntityThe created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
DeleteMasterRightPayload object masterRight: MasterRightEntity, clientMutationId: String

Result of the deleteMasterRight mutation.

FieldTypeDescription
masterRightMasterRightEntityThe deleted record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateMasterRightPayload object masterRight: MasterRightEntity, clientMutationId: String

Result of the updateMasterRight mutation.

FieldTypeDescription
masterRightMasterRightEntityThe updated record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
AccessDirectionEnum enum Owned, Current, CurrentAndParent, CurrentAndSubunit, CurrentAndParentAndSubunit, All

Which sales units' records a user role can see, in addition to the records the user owns or that are shared with them.

ValueDescription
OwnedOnly records the user owns or that are shared with them.
CurrentAlso records of the sales units the user is a member of.
CurrentAndParentAlso records of the user's sales units and their parent units.
CurrentAndSubunitAlso records of the user's sales units and their subunits.
CurrentAndParentAndSubunitAlso records of the user's sales units, their parent units and their subunits.
AllRecords of all sales units.
AccessEntityTypesEnum enum All, Selected

Which record types of an entity a user role can work with.

ValueDescription
AllThe role can work with records of every type of the entity.
SelectedThe role can work only with records of the types explicitly allowed for it; with none allowed, no type is available.
AccessLevelCommonRecordsEnumEnum enum NoAccess, Readonly, All

Level of access a user role grants to shared items such as reports, dashboards, forecasts, targets, screen profiles, form views and email templates.

ValueDescription
NoAccessThe feature is not available to the user.
ReadonlyThe user can use items shared with them but cannot create their own.
AllThe user can create and manage their own items and use items shared with them.
AccessLevelCompanyEmailsEnum enum NoAccess, Selected, All

Which shared company email accounts or company phone numbers a user role can use.

ValueDescription
NoAccessNone can be used.
SelectedOnly those listed in the role's allowedCompanyEmails or allowedCompanyPhones.
AllAll company email accounts or phone numbers can be used.
AccessLevelEmailSequenceEnum enum FullAccess, Personal, NoAccess

Level of access a user role grants to email sequences.

ValueDescription
FullAccessThe user can view and manage all email sequences.
PersonalThe user can view and manage only their own personal email sequences.
NoAccessEmail sequences are not available to the user.
AccessLevelEntityEnum enum NoAccess, Readonly, Editor, EditorOrUnitManger, All

Level of access a user role grants to a record type, applied to the records the role can see.

ValueDescription
NoAccessThe record type is not available to the user.
ReadonlyThe user can view records but cannot create or edit them.
EditorThe user can create records and edit records they own or that are shared with them for editing.
EditorOrUnitMangerSame as Editor, and the user can also edit records of the sales units they manage.
AllThe user can edit all records they can see.
AccessLevelPipelineEnum enum NoPipeline, Selected, AllNoDocuments, AllWithDocuments

Which pipelines a user role can work with.

ValueDescription
NoPipelineNo pipelines are available to the user.
SelectedOnly the pipelines listed in the role's allowedPipelines, each with its own step document access.
AllNoDocumentsAll pipelines, without access to documents attached to pipeline steps.
AllWithDocumentsAll pipelines, including documents attached to pipeline steps.
AccessLevelProcessBuilderEnum enum FullAccess, Personal, NoAccess

Level of access a user role grants to automation processes.

ValueDescription
FullAccessThe user can view and manage all processes.
PersonalThe user can view and manage only their own personal processes; space processes cannot be changed.
NoAccessProcesses are not available to the user.
AccountsAndContactsNotificationSettings object IsActive: Boolean!, OwnershipAndSalesTeamChange: Boolean!, LinkedItem: Boolean!

Which notifications a user receives about accounts and contacts.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of accounts and contacts and about assignments to their sales team as editor or watcher.
LinkedItemBoolean!Notifies when an item is linked to an account or contact.
ActivitiesNotificationSettings object 5 fields: IsActive, OwnershipAndSalesTeamChange, StatusChange, …

Which notifications a user receives about tasks and appointments.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of tasks and appointments and about assignments to their sales team as editor or watcher.
StatusChangeBoolean!Notifies when the status of a task or appointment changes or it is canceled.
InvitationBoolean!Notifies about appointment invitations received, accepted or rejected.
CommentBoolean!Notifies about comments on tasks and appointments.
ApprovalProcessesNotificationSettings object 5 fields: IsActive, ApprovalRequest, ApprovalResponse, …

Which notifications a user receives about approval requests, their responses, and approval process warnings and errors.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
ApprovalRequestBoolean!Notifies about approval requests, including delegated requests and requests that found no approver.
ApprovalResponseBoolean!Notifies when an approval request is approved or rejected.
ApprovalProcessWarningBooleanNotifies about warnings raised while an approval process runs.
ApprovalProcessErrorBooleanNotifies about errors raised while an approval process runs.
ContentShareModeConfigEnum enum PrivateOnly, Custom, PublicOnly

How a user role lets users share the body of their emails.

ValueDescription
PrivateOnlyEmail bodies are always private.
CustomUsers choose per email, starting from their default in emailDefaultContentSharingMode.
PublicOnlyEmail bodies are always public.
CustomEntitiesNotificationSetting object entityApiName: String!, IsActive: Boolean!, OwnershipAndSalesTeamChange: Boolean!, LinkedItem: Boolean!

Which notifications a user receives about the records of one custom entity type.

FieldTypeDescription
entityApiNameString!API name of the custom entity type these options apply to.
IsActiveBoolean!Turns all notifications of this custom entity type on or off; when false, the other options are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of records of this type and about assignments to their sales team as editor or watcher.
LinkedItemBoolean!Notifies when an item is linked to a record of this type.
CustomEntityMasterRight object 11 fields: entityApiName, navigationAccess, accessLevel, …

Rights of a user role to one custom entity: screen access, record access level and the actions its users may take.

FieldTypeDescription
entityApiNameString!API name of the custom entity these settings apply to.
navigationAccessBoolean!Shows the screen of the custom entity to users with this role. Which records they can see and edit is set by accessLevel.
accessLevelAccessLevelEntityEnum!Level of access to records of the custom entity for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the records the role can see.
accessDirectionAccessDirectionEnum!Which records of the custom entity users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
accessPrivateBoolean!Allows users with this role to own private records of the custom entity, which are visible only to their owner.
accessDeleteBoolean!Allows users with this role to delete records of the custom entity they can edit.
accessEntityTypesAccessEntityTypesEnum!Whether users with this role can work with all types of the custom entity (All) or only with those in allowedEntityTypeIds (Selected).
allowedEntityTypeIds[ID!]!Types of the custom entity this user role can use. Effective only when accessEntityTypes is set to Selected.
defaultProfileIdID!Default screen profile (saved screen view) of the custom entity screen for users with this role.
accessCopyBoolean!Allows users with this role to create copies of existing records of the custom entity.
accessTagCreateBoolean!Allows users with this role to create new tags for records of the custom entity.
EmailAccessAllowList object clientIds: [UUID!]!, unitIds: [UUID!]!

Users and sales units whose emails stay visible to users with the role.

FieldTypeDescription
clientIds[UUID!]!Ids of users whose emails stay visible.
unitIds[UUID!]!Ids of sales units whose Member users' emails stay visible.
EmailAccessLevelEnum enum Default, UsersAndSalesUnits

Which emails a user role lets users see on records, reports, feeds and automation.

ValueDescription
DefaultEvery email linked to a record the user can see.
UsersAndSalesUnitsOnly emails owned or shared by the users and sales unit members in accessEntityEmailAllowed, plus the user's own emails and emails shared with them.
EmailNotificationSettings object IsActive: Boolean!, LinkedItem: Boolean, Tracking: Boolean, Bounced: Boolean

Which notifications a user receives about emails: sent and received emails, opens and bounces.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBooleanNotifies about emails sent and received.
TrackingBooleanNotifies when a sent email is opened.
BouncedBooleanNotifies when a sent email bounces.
EmailSequencesNotificationSettings object IsActive: Boolean!, Warnings: Boolean!, Errors: Boolean!

Which notifications a user receives about warnings and errors of email sequences.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
WarningsBoolean!Notifies about warnings raised while the automation or sequence runs.
ErrorsBoolean!Notifies about errors raised while the automation or sequence runs.
EntityIconEnum enum GeneralIcon, Task, Appointment, Call, Mail, Message, … (24 values)

Icon used to display a custom entity and its records.

ValueDescription
GeneralIconGeneric icon not tied to a specific kind of record.
TaskIcon depicting a task.
AppointmentIcon depicting an appointment.
CallIcon depicting a phone call.
MailIcon depicting an email.
MessageIcon depicting a message.
TicketingIntegrationIcon depicting a ticketing system integration.
DocumentManagementIcon depicting document management.
EventManagementIcon depicting event management.
AccountingSystemIcon depicting an accounting system.
MarketingCommunicationSystemsIcon depicting a marketing communication system.
OrderProcessingIcon depicting order processing.
WebServicesIcon depicting web services.
ReturnMerchandiseAuthorizationSystemsIcon depicting a return merchandise authorization (RMA) system.
SalesAutomatizationIcon depicting sales automation.
SmsMessagingIcon depicting SMS messaging.
ErpSystemsIcon depicting an ERP system.
DataAnalyticsIcon depicting data analytics.
WarehousesIcon depicting a warehouse.
ContactManagementIcon depicting contact management.
ContentManagementSystemsIcon depicting a content management system.
InventorySystemsIcon depicting an inventory system.
WorkflowIcon depicting a workflow.
AssetManagementSystemIcon depicting an asset management system.
FeedsNotificationSettings object IsActive: Boolean!, Create: Boolean!, Comment: Boolean!

Which notifications a user receives about feed posts and their comments.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
CreateBoolean!Notifies about new feed posts.
CommentBoolean!Notifies about comments on feed posts.
InterfaceBottomMenuItemKind enum Section, Accounts, Activities, AppointmentScheduler, ApprovalProcesses, Approvals, … (33 values)

What a row of the bottom menu is: a group row (Section) or the screen an item row opens.

ValueDescription
SectionGroup row whose items open as a submenu.
AccountsAccounts list.
ActivitiesActivities list.
AppointmentSchedulerAppointment scheduler screen.
ApprovalProcessesApproval process settings.
ApprovalsApproval requests waiting for the user.
ArchiveAccountsArchived accounts.
ArchiveContactsArchived contacts.
ArchiveLeadsArchived leads.
ArchiveOpportunitiesArchived opportunities.
ArchiveQuotesArchived quotes.
AutomatizerAutomatizer processes that automate actions on records.
CallingCalling screen.
ContactsContacts list.
CustomEntityList of the custom entity named by entityApiName.
DocumentManagementDocuments stored in the space.
DocumentTemplatesTemplates for generating documents from records.
DuplicateCheckerDuplicate checker that finds duplicate records.
EmailSequencesEmail sequences screen.
EmailTemplatesTemplates for composing emails.
FeedsFeeds screen.
ForecastsForecasts screen.
InboxThe user's email inbox.
InsightsInsights screen with sales KPIs.
LeadsLeads list.
NavigatorNavigator screen.
OnlineFormsOnline forms screen.
OpportunitiesOpportunities list.
ProjectsProjects list.
QuotesQuotes list.
ReportsReports screen.
SolutionsSolutions screen.
TargetsTargets screen.
InterfaceBottomMenuRow object 8 fields: kind, entityApiName, isEnabled, …

A row of the bottom menu (Navigation list): an item that opens a screen, or a group row whose items open as a submenu.

FieldTypeDescription
kindInterfaceBottomMenuItemKind!The screen of an item row; Section on a group row.
entityApiNameStringSet on CustomEntity rows.
isEnabledBooleanDefault Access of the item in the role; stored as the client sent it.
isPinnedBooleanPinned to the bar. On the role's items it equals isEnabled after every role save; on a user's own layout it is what the user chose.
nameStringA group's name as the admin typed it, or a translation key (see useLang).
useLangBooleanTrue when name is a translation key the client localizes, as on the default groups Communication, Analytics, Archive and Tools; false when shown as typed.
iconEntityIconEnumA group's icon.
items[InterfaceBottomMenuRow!]Members of a group row, in submenu order; null on items.
LeadsAndOpportunitiesNotificationSettings object 6 fields: IsActive, LinkedItem, Move, …

Which notifications a user receives about leads and opportunities.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBoolean!Notifies when an item is linked to a lead or opportunity.
MoveBoolean!Notifies when a lead or opportunity moves to another step or an opportunity is turned back into a lead.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of leads and opportunities and about assignments to their sales team as editor or watcher.
QualificationBoolean!Notifies when a lead is qualified to an opportunity.
StatusChangeBoolean!Notifies when a lead or opportunity is won, lost or reactivated.
NotificationSettings object 15 fields: Emails, AccountsAndContacts, LeadsAndOpportunities, …

Which events a user is notified about, grouped by area such as emails, activities or automations.

FieldTypeDescription
EmailsEmailNotificationSettings!Notification options for emails.
AccountsAndContactsAccountsAndContactsNotificationSettings!Notification options for accounts and contacts.
LeadsAndOpportunitiesLeadsAndOpportunitiesNotificationSettings!Notification options for leads and opportunities.
FeedsFeedsNotificationSettings!Notification options for feed posts.
ActivitiesActivitiesNotificationSettings!Notification options for tasks and appointments.
WhatsAppTextMessageNotificationSettingsNotification options for WhatsApp messages.
CallingAndMessagingTextMessageNotificationSettingsNotification options for calling and text messaging.
ProcessBuilderProcessBuilderNotificationSettingsNotification options for automations.
ProjectsProjectsNotificationSettingsNotification options for projects.
QuotesQuotesNotificationSettingsNotification options for quotes.
EmailSequencesEmailSequencesNotificationSettingsNotification options for email sequences.
ApprovalProcessesApprovalProcessesNotificationSettingsNotification options for approval processes.
OnlineFormsOnlineFormsNotificationSettingsNotification options for online forms.
CustomEntities[CustomEntitiesNotificationSetting!]!Notification options per custom entity type. Custom entity types not listed notify about all their events.
isSettingsEnforcedBoolean!True when an administrator enforces these options for the user, so the user's own choices do not apply. Computed by the server; ignored on input.
OnlineFormsNotificationSettings object IsActive: Boolean!, Responses: Boolean!, Warnings: Boolean!, Errors: Boolean!

Which notifications a user receives about online form responses and the warnings and errors raised while they are processed.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
ResponsesBoolean!Notifies about responses submitted through online forms.
WarningsBoolean!Notifies about warnings raised while an online form response is processed.
ErrorsBoolean!Notifies about errors raised while an online form response is processed.
ProcessBuilderNotificationSettings object IsActive: Boolean!, Warnings: Boolean!, Errors: Boolean!

Which notifications a user receives about warnings and errors of automations.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
WarningsBoolean!Notifies about warnings raised while the automation or sequence runs.
ErrorsBoolean!Notifies about errors raised while the automation or sequence runs.
ProjectsNotificationSettings object IsActive: Boolean!, OwnershipAndSalesTeamChange: Boolean!, StatusChange: Boolean!, LinkedItem: Boolean!

Which notifications a user receives about projects.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of projects and about assignments to their sales team as editor or watcher.
StatusChangeBoolean!Notifies when the status of a project changes.
LinkedItemBoolean!Notifies when an item is linked to a project.
QuotesNotificationSettings object 5 fields: IsActive, LinkedItem, Move, …

Which notifications a user receives about quotes.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBoolean!Notifies when an item is linked to a quote.
MoveBoolean!Notifies when a quote moves to another step.
OwnershipAndSalesTeamChangeBoolean!Notifies about owner changes of quotes and about assignments to their sales team as editor or watcher.
StatusChangeBoolean!Notifies when a quote is won, lost or reactivated.
ScreensDefaultProfilesParams object 17 fields: Navigator, Pipelinescreen, Leadscreen, …

Default profiles (saved views) of the main screens for users with a given role.

FieldTypeDescription
NavigatorUUID!Id of the default profile (saved view) of the original Navigator screen for users with this role.
PipelinescreenUUID!Id of the default profile (saved view) of the Opportunities screen for users with this role.
LeadscreenUUID!Id of the default profile (saved view) of the Leads screen for users with this role.
AccountscreenUUID!Id of the default profile (saved view) of the Accounts screen for users with this role.
ContactscreenUUID!Id of the default profile (saved view) of the Contacts screen for users with this role.
ActivityscreenUUID!Id of the default profile (saved view) of the Activities screen for users with this role.
Feedscreen2UUID!Id of the default profile (saved view) of the Feed screen for users with this role.
ArchivescreenUUID!Id of the default profile (saved view) of the opportunity archive for users with this role.
LeadArchivescreenUUID!Id of the default profile (saved view) of the lead archive for users with this role.
InsightsscreenUUID!Id of the default profile (saved view) of the Insights overview screen for users with this role.
IndicatorsscreenUUID!Id of the default profile (saved view) of the Insights indicators screen for users with this role.
ConversionsscreenUUID!Id of the default profile (saved view) of the Insights conversions screen for users with this role.
LifecyclescreenUUID!Id of the default profile (saved view) of the Insights lifecycle screen for users with this role.
ProjectscreenUUID!Id of the default profile (saved view) of the Projects screen for users with this role.
QuotescreenUUID!Id of the default profile (saved view) of the Quotes screen for users with this role.
QuoteArchivescreenUUID!Id of the default profile (saved view) of the quote archive for users with this role.
BetterNavigatorscreenUUID!Id of the default profile (saved view) of the Navigator screen for users with this role.
TernaryConfigEnum enum Custom, On, Off

Whether a user role enforces a setting or leaves it to each user.

ValueDescription
CustomEach user's own setting applies.
OnThe setting is on for every user with the role.
OffThe setting is off for every user with the role.
TextMessageNotificationSettings object IsActive: Boolean!, LinkedItem: Boolean

Which notifications a user receives about new text or WhatsApp messages.

FieldTypeDescription
IsActiveBoolean!Turns all notifications of this group on or off; when false, the other options of the group are ignored.
LinkedItemBooleanNotifies about new messages.