Types: M
Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.
A B C D E F G H I J L M N O P Q R S T U V W X Y
MainFilterBox MainFilterBoxParams ManageContentSharingEmailInput ManageContentSharingEmailPayload ManageSharingAccountInput ManageSharingAccountPayload ManageSharingContactInput ManageSharingContactPayload ManageSharingCustomEntityInput ManageSharingCustomEntityPayload ManageSharingEmailInput ManageSharingEmailPayload ManageSharingLeadInput ManageSharingLeadPayload ManageSharingOpportunityInput ManageSharingOpportunityPayload ManageSharingProjectInput ManageSharingProjectPayload ManageSharingQuoteInput ManageSharingQuotePayload ManageSharingTaskInput ManageSharingTaskPayload MassEmailDetailGridSortyBy MassEmailRelation MassEmailRelationCategory MassEmailRelationItemConnection MassEmailRelationItemEdge MassEmailTrackingInfo MasterRightEntity MasterRightEntityConnection MasterRightEntityEdge MasterRightFilterInput MasterRightOrderByInput MasterRightOrderByNestedInput MasterRightRepository MatchingInput MediaEntity MediaEntityConnection MediaEntityEdge MediaFilterInput MediaOrderByInput MediaOrderByNestedInput MediaRepository MediaStatusEnum MediaStatusEnumFilterInput MediaTypeEnum MediaTypeEnumFilterInput MemoCommentEntity MemoCommentEntityConnection MemoCommentEntityEdge MemoCommentFilterInput MemoCommentOrderByInput MemoCommentRepository MemoEntity MemoEntityConnection MemoEntityEdge MemoFilterInput MemoOrderByInput MemoOrderByNestedInput MemoRepository MergeAccountInput MergeAccountPayload MergeContactInput MergeContactPayload MessageRelationEntity MessageRelationEntityConnection MessageRelationEntityEdge MessageRelationFilterInput MessageRelationOrderByInput MessageRelationRepository MessageSharingClientRelationEntity MessageSharingClientRelationEntityConnection MessageSharingClientRelationEntityEdge MessageSharingClientRelationFilterInput MessageSharingClientRelationOrderByInput MessageSharingClientRelationRepository MessageSharingSalesUnitRelationEntity MessageSharingSalesUnitRelationEntityConnection MessageSharingSalesUnitRelationEntityEdge MessageSharingSalesUnitRelationFilterInput MessageSharingSalesUnitRelationOrderByInput MessageSharingSalesUnitRelationRepository MoveCloudObjectsInput MoveCloudObjectsPayload MoveLeadInput MoveLeadPayload MoveOpportunityInput MoveOpportunityPayload MoveQuoteInput MoveQuotePayload MultiMatchEnum MultiSelectProperty Mutation
Shared types: M
Types several repositories use, or none does, with their fields and their descriptions.
MainFilterBox object id: String!, entity: String!, lookupFieldId: UUID, filterFields: [FieldFilterRule!]!
Group of filter conditions evaluated on the main record type of a filter.
| Field | Type | Description |
|---|---|---|
id | String! | Identifier of this filter box within the filter tab. |
entity | String! | Name of the record type whose fields the conditions in this box are evaluated against. |
lookupFieldId | UUID | Identifier of the lookup field that connects this box to the main record type when the box filters a related record reached through a lookup. |
filterFields | [FieldFilterRule!]! | Conditions evaluated on the main record type, each comparing one field against a set of values. |
MainFilterBoxParams input id: String!, entity: String!, lookupFieldId: UUID, filterFields: [FieldFilterRuleParams!]!
Group of filter conditions evaluated on the main record type of a filter.
| Input field | Type | Description |
|---|---|---|
id | String! | Identifier of this filter box within the filter tab. |
entity | String! | Name of the record type whose fields the conditions in this box are evaluated against. |
lookupFieldId | UUID | Identifier of the lookup field that connects this box to the main record type when the box filters a related record reached through a lookup. |
filterFields | [FieldFilterRuleParams!]! | Conditions evaluated on the main record type, each comparing one field against a set of values. |
MassEmailTrackingInfo object 7 fields: openEmailEventCount, clickEmailEventCount, totalEmailEventCount, …
Tracking statistics of a mass email or of the emails sent from a template: how many were sent, opened, clicked, replied to, bounced or unsubscribed.
| Field | Type | Description |
|---|---|---|
openEmailEventCount | Int! | Number of emails that were opened; a click or an unsubscribe also counts as an open. Bounced emails are not counted. |
clickEmailEventCount | Int! | Number of emails in which a link was clicked. Bounced emails are not counted. |
totalEmailEventCount | Int! | Total number of emails the statistics are based on. |
sentEmailEventCount | Int! | Number of emails that were sent. |
bouncedEmailCount | Int! | Number of emails that bounced. |
repliedEmailCount | Int! | Number of emails that received a reply. |
unsubscribedEmailCount | Int! | Number of emails through which the recipient unsubscribed. |
MasterRightOrderByNestedInput input 157 fields: id, isDeleted, modified, …
Sorting by a field of the related MasterRight record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
accessAccountRelationTypes | OrderByEnum | Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. |
accessAccounts | OrderByEnum | Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. |
accessAiAutomatizer | OrderByEnum | Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. |
accessAiOnlineForms | OrderByEnum | Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. |
accessAiRecordDetail | OrderByEnum | Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. |
accessAiRecordEnrichment | OrderByEnum | Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. |
accessAiRelationshipCharts | OrderByEnum | Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. |
accessAiReports | OrderByEnum | Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. |
accessAiSmartField | OrderByEnum | Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. |
accessAppointmentScheduler | OrderByEnum | Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. |
accessAppointmentSchedulerManagement | OrderByEnum | Allows users with this role to manage appointment schedules of other users. |
accessApprovalProcesses | OrderByEnum | Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. |
accessApprovalProcessesManagement | OrderByEnum | Allows users with this role to manage approval processes owned by other users. |
accessApprovals | OrderByEnum | Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. |
accessArchive | OrderByEnum | Allows users with this role to open the Archive screens listing lost, closed and archived records. |
accessAudit | OrderByEnum | Allows users with this role to open the Audit screen. |
accessAuditLog | OrderByEnum | Allows users with this role to view the audit log of changes made in the space. |
accessBottomMenuCustomization | OrderByEnum | Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. |
accessBulkUpdate | OrderByEnum | Allows users with this role to update many records at once with bulk update. |
accessCalling | OrderByEnum | Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. |
accessCallingCompanyPhone | OrderByEnum | Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). |
accessCallingPurchasePhone | OrderByEnum | Allows users with this role to purchase and manage company phone numbers for the calling integration. |
accessCompanyEmails | OrderByEnum | Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). |
accessContacts | OrderByEnum | Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. |
accessDocumentManagement | OrderByEnum | Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. |
accessDocumentManagementCompany | OrderByEnum | Allows users with this role to manage company documents and folders that are not tied to a record. |
accessDocumentManagementRecord | OrderByEnum | Allows users with this role to create and edit the document folders used for records. |
accessDuplicateChecker | OrderByEnum | Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. |
accessEmailNotificationEnforcement | OrderByEnum | When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. |
accessEntityAccount | OrderByEnum | Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. |
accessEntityAccountCopy | OrderByEnum | Allows users with this role to create copies of existing accounts. |
accessEntityAccountDelete | OrderByEnum | Allows users with this role to delete accounts they can edit. |
accessEntityAccountDirection | OrderByEnum | Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityAccountPrivate | OrderByEnum | Allows users with this role to own private accounts, which are visible only to their owner. |
accessEntityAccountTagCreate | OrderByEnum | Allows users with this role to create new tags for accounts. |
accessEntityAppointment | OrderByEnum | Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. |
accessEntityAppointmentDelete | OrderByEnum | Allows users with this role to delete appointments they can edit. |
accessEntityAppointmentDirection | OrderByEnum | Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityAppointmentTagCreate | OrderByEnum | Allows users with this role to create new tags for appointments. |
accessEntityBetterNavigator | OrderByEnum | Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). |
accessEntityBetterNavigatorDeleteNotOwned | OrderByEnum | Allows users with this role to delete Navigator screen layouts owned by other users. |
accessEntityBetterNavigatorDeleteOwned | OrderByEnum | Allows users with this role to delete Navigator screen layouts they own. |
accessEntityBetterNavigatorSharingCustom | OrderByEnum | Allows users with this role to share their Navigator screen layouts with selected users and sales units. |
accessEntityBetterNavigatorSharingPublic | OrderByEnum | Allows users with this role to share their Navigator screen layouts with all users of the space. |
accessEntityContact | OrderByEnum | Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. |
accessEntityContactCopy | OrderByEnum | Allows users with this role to create copies of existing contacts. |
accessEntityContactDelete | OrderByEnum | Allows users with this role to delete contacts they can edit. |
accessEntityContactDirection | OrderByEnum | Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityContactPrivate | OrderByEnum | Allows users with this role to own private contacts, which are visible only to their owner. |
accessEntityContactTagCreate | OrderByEnum | Allows users with this role to create new tags for contacts. |
accessEntityDashboard | OrderByEnum | Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. |
accessEntityDashboardDeleteNotOwned | OrderByEnum | Allows users with this role to delete dashboards owned by other users. |
accessEntityDashboardDeleteOwned | OrderByEnum | Allows users with this role to delete dashboards they own. |
accessEntityDashboardSharingCustom | OrderByEnum | Allows users with this role to share their dashboards with selected users and sales units. |
accessEntityDashboardSharingPublic | OrderByEnum | Allows users with this role to share their dashboards with all users of the space. |
accessEntityEmailAccessLevel | OrderByEnum | Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). |
accessEntityEmailContentShareMode | OrderByEnum | How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). |
accessEntityEmailDeleteNotOwned | OrderByEnum | Allows users with this role to delete emails they neither own nor sent. |
accessEntityEmailLinkToAccounts | OrderByEnum | Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. |
accessEntityEmailLinkToAccountsByDomain | OrderByEnum | Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. |
accessEntityEmailLinkToContacts | OrderByEnum | Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. |
accessEntityEmailSequence | OrderByEnum | Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). |
accessEntityEmailTemplate | OrderByEnum | Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). |
accessEntityEmailTemplateCreateDeleteFolder | OrderByEnum | Allows users with this role to create and delete email template folders. |
accessEntityEmailTemplateDeleteNotOwned | OrderByEnum | Allows users with this role to delete email templates owned by other users. |
accessEntityEmailTemplateDeleteOwned | OrderByEnum | Allows users with this role to delete email templates they own. |
accessEntityEmailTemplateSharingCustom | OrderByEnum | Allows users with this role to share their email templates with selected users and sales units. |
accessEntityEmailTemplateSharingPublic | OrderByEnum | Allows users with this role to share their email templates with all users of the space. |
accessEntityForecast | OrderByEnum | Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). |
accessEntityForecastDeleteNotOwned | OrderByEnum | Allows users with this role to delete forecasts owned by other users. |
accessEntityForecastDeleteOwned | OrderByEnum | Allows users with this role to delete forecasts they own. |
accessEntityForecastEditNotOwned | OrderByEnum | Allows users with this role to edit forecasts owned by other users. |
accessEntityForecastSharingCustom | OrderByEnum | Allows users with this role to share their forecasts with selected users and sales units. |
accessEntityForecastSharingPublic | OrderByEnum | Allows users with this role to share their forecasts with all users of the space. |
accessEntityFormView | OrderByEnum | Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). |
accessEntityFormViewDeleteNotOwned | OrderByEnum | Allows users with this role to delete form views owned by other users. |
accessEntityFormViewDeleteOwned | OrderByEnum | Allows users with this role to delete form views they own. |
accessEntityFormViewSharingCustom | OrderByEnum | Allows users with this role to share their form views with selected users and sales units. |
accessEntityFormViewSharingPublic | OrderByEnum | Allows users with this role to share their form views with all users of the space. |
accessEntityLead | OrderByEnum | Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. |
accessEntityLeadCopy | OrderByEnum | Allows users with this role to create copies of existing leads. |
accessEntityLeadDelete | OrderByEnum | Allows users with this role to delete leads they can edit. |
accessEntityLeadDirection | OrderByEnum | Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityLeadPrivate | OrderByEnum | Allows users with this role to own private leads, which are visible only to their owner. |
accessEntityLeadTagCreate | OrderByEnum | Allows users with this role to create new tags for leads. |
accessEntityMessageTagCreate | OrderByEnum | Allows users with this role to create new tags for emails, memos and text messages. |
accessEntityOppty | OrderByEnum | Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. |
accessEntityOpptyCopy | OrderByEnum | Allows users with this role to create copies of existing opportunities. |
accessEntityOpptyDelete | OrderByEnum | Allows users with this role to delete opportunities they can edit. |
accessEntityOpptyDirection | OrderByEnum | Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityOpptyPrivate | OrderByEnum | Allows users with this role to own private opportunities, which are visible only to their owner. |
accessEntityOpptyTagCreate | OrderByEnum | Allows users with this role to create new tags for opportunities. |
accessEntityPipeline | OrderByEnum | Which 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). |
accessEntityProcess | OrderByEnum | Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). |
accessEntityProfile | OrderByEnum | Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. |
accessEntityProfileDeleteNotOwned | OrderByEnum | Allows users with this role to delete screen profiles owned by other users. |
accessEntityProfileDeleteOwned | OrderByEnum | Allows users with this role to delete screen profiles they own. |
accessEntityProfileSharingCustom | OrderByEnum | Allows users with this role to share their screen profiles with selected users and sales units. |
accessEntityProfileSharingPublic | OrderByEnum | Allows users with this role to share their screen profiles with all users of the space. |
accessEntityProject | OrderByEnum | Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. |
accessEntityProjectCopy | OrderByEnum | Allows users with this role to create copies of existing projects. |
accessEntityProjectDelete | OrderByEnum | Allows users with this role to delete projects they can edit. |
accessEntityProjectDirection | OrderByEnum | Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityProjectPrivate | OrderByEnum | Allows users with this role to own private projects, which are visible only to their owner. |
accessEntityProjectTagCreate | OrderByEnum | Allows users with this role to create new tags for projects. |
accessEntityQuote | OrderByEnum | Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. |
accessEntityQuoteCopy | OrderByEnum | Allows users with this role to create copies of existing quotes. |
accessEntityQuoteDelete | OrderByEnum | Allows users with this role to delete quotes they can edit. |
accessEntityQuoteDirection | OrderByEnum | Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityQuoteTagCreate | OrderByEnum | Allows users with this role to create new tags for quotes. |
accessEntityReport | OrderByEnum | Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). |
accessEntityReportCreateDeleteFolder | OrderByEnum | Allows users with this role to create and delete report folders. |
accessEntityReportDeleteNotOwned | OrderByEnum | Allows users with this role to delete reports owned by other users. |
accessEntityReportDeleteOwned | OrderByEnum | Allows users with this role to delete reports they own. |
accessEntityReportPrivate | OrderByEnum | Allows users with this role to save reports as private, visible only to themselves. |
accessEntityReportScheduleCreate | OrderByEnum | Allows users with this role to schedule reports for regular delivery. |
accessEntityReportScheduleManagement | OrderByEnum | Allows users with this role to view and manage report schedules of other users. |
accessEntityReportSharingCustom | OrderByEnum | Allows users with this role to share their reports with selected users and sales units. |
accessEntityReportSharingPublic | OrderByEnum | Allows users with this role to share their reports with all users of the space. |
accessEntitySolution | OrderByEnum | Allows users with this role to view and follow solutions, when the feature is enabled for the space. |
accessEntitySolutionManagement | OrderByEnum | Allows users with this role to create, edit and delete solutions. |
accessEntityTarget | OrderByEnum | Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). |
accessEntityTargetDeleteNotOwned | OrderByEnum | Allows users with this role to delete targets owned by other users. |
accessEntityTargetDeleteOwned | OrderByEnum | Allows users with this role to delete targets they own. |
accessEntityTask | OrderByEnum | Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. |
accessEntityTaskDelete | OrderByEnum | Allows users with this role to delete tasks they can edit. |
accessEntityTaskDirection | OrderByEnum | Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). |
accessEntityTaskTagCreate | OrderByEnum | Allows users with this role to create new tags for tasks. |
accessEntityTaskUnassigned | OrderByEnum | Allows users with this role to create tasks without an owner (unassigned tasks). |
accessExport | OrderByEnum | Allows users with this role to export records and reports to files. |
accessFeeds | OrderByEnum | Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. |
accessForeignCurrencies | OrderByEnum | Allows users with this role to manage currencies and exchange rate lists in Administration. |
accessFormAndFields | OrderByEnum | Allows users with this role to manage fields, forms, record types, tags and translations in Administration. |
accessGlobalSettings | OrderByEnum | Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. |
accessHomeScreen | OrderByEnum | Allows users with this role to open the Navigator screen. |
accessImport | OrderByEnum | Allows users with this role to import records from files. |
accessInsights | OrderByEnum | Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. |
accessLeads | OrderByEnum | Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. |
accessOnlineForms | OrderByEnum | Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. |
accessOnlineFormsManagement | OrderByEnum | Allows users with this role to edit and delete online forms owned by other users. |
accessOpportunity | OrderByEnum | Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. |
accessPipelineConfiguration | OrderByEnum | Allows users with this role to manage pipelines, lead processes and quote processes in Administration. |
accessPrint | OrderByEnum | Allows users with this role to print records and reports. |
accessProductsServices | OrderByEnum | Allows users with this role to manage products, product categories and price lists in Administration. |
accessProjects | OrderByEnum | Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. |
accessQuotes | OrderByEnum | Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. |
accessSalesRoles | OrderByEnum | Allows users with this role to manage sales roles in Administration. |
accessSecurity | OrderByEnum | Allows users with this role to manage the security settings of the space in Administration. |
accessUnits | OrderByEnum | Allows users with this role to manage sales units in Administration. |
accessUserAndRoles | OrderByEnum | Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. |
accessWhatsAppCompanyPhone | OrderByEnum | Which 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). |
name | OrderByEnum | Name of the entity and its default text representation. |
revision | OrderByEnum | Revision when entity was lastly changed. |
MasterRightRepository object 5 fields: getById, getByIds, getAll, …
Read operations for MasterRight records.
| Field | Type | Description |
|---|---|---|
getById | MasterRightEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MasterRightEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MasterRightEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MasterRightEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MatchingInput input identityKey: [String!]!, thirdPartyKey: String, onMultiMatch: MultiMatchEnum!
How items without an id are matched to existing records.
| Input field | Type | Description |
|---|---|---|
identityKey | [String!]! | Api names of the fields whose values identify an existing record; each input item must contain all of them. |
thirdPartyKey | String | Api name of a field holding an external id; with identityKey, a record matching either one is used. |
onMultiMatch | MultiMatchEnum! | What to do when more than one existing record matches. |
MediaRepository object 5 fields: getById, getByIds, getAll, …
Read operations for Media records.
| Field | Type | Description |
|---|---|---|
getById | MediaEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MediaEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MediaEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MediaEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MemoCommentRepository object 5 fields: getById, getByIds, getAll, …
Read operations for MemoComment records.
| Field | Type | Description |
|---|---|---|
getById | MemoCommentEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MemoCommentEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MemoCommentEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MemoCommentEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MemoOrderByNestedInput input 7 fields: id, isDeleted, modified, …
Sorting by a field of the related Memo record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
ownerId | OrderByEnum | Id of the memo author. |
subject | OrderByEnum | Short summary line of the memo. |
revision | OrderByEnum | Revision when entity was lastly changed. |
MemoRepository object 5 fields: getById, getByIds, getAll, …
Read operations for Memo records.
| Field | Type | Description |
|---|---|---|
getById | MemoEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MemoEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MemoEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MemoEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MessageRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for MessageRelation records.
| Field | Type | Description |
|---|---|---|
getById | MessageRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MessageRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MessageRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MessageRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MessageSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for MessageSharingClientRelation records.
| Field | Type | Description |
|---|---|---|
getById | MessageSharingClientRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MessageSharingClientRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MessageSharingClientRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MessageSharingClientRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MessageSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for MessageSharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
getById | MessageSharingSalesUnitRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [MessageSharingSalesUnitRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [MessageSharingSalesUnitRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | MessageSharingSalesUnitRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
MultiMatchEnum enum UpdateOldest, UpdateNewest, UpdateAll, RaiseError, OnlyReturn, SkipUpdate, UpdateNewestIgnoreEmpty
What a bulkUpdate upsert does when more than one existing record matches the matching key.
| Value | Description |
|---|---|
UpdateOldest | Updates only the oldest matching record, by creation time. |
UpdateNewest | Updates only the newest matching record, by creation time. |
UpdateAll | Updates every matching record; the request fails when more than 100 records match. |
RaiseError | Fails the item when more than one record matches; a single match is updated. |
OnlyReturn | Returns the matching records without changing them; no record is created when nothing matches. |
SkipUpdate | Returns the matching records without changing them; a new record is created when nothing matches. |
UpdateNewestIgnoreEmpty | Updates only the newest matching record and ignores input fields with null, empty or zero values. |