ENUM
EntityPermsEnum
Action a user can perform on a record; instancePermissions returns the ones the current user holds on a given record.
link GraphQL Schema definition
- enum EntityPermsEnum {
- # Allows creating records of this type.
- # Allows viewing the record.
- # Allows editing the record.
- # Allows deleting the record.
- # Allows changing the owner of the record.
- # Allows qualifying the lead into an opportunity.
- # Allows turning the opportunity back into a lead.
- # Allows archiving the account, contact, lead, opportunity or quote.
- # Allows reactivating an archived account, contact, lead, opportunity or quote, or
- # a completed or inactive target.
- # Allows giving up ownership of the lead or task so that it becomes unassigned.
- # Allows restoring the deleted record.
- # Allows the current user, as an invitee, to respond to the appointment
- # invitation.
- # Allows moving the lead, opportunity or quote to a different step.
- # Allows creating a copy of the record.
- # Allows moving the opportunity to a different pipeline.
- # Allows moving the lead to a different lead process.
- # Allows moving the quote to a different quote process.
- # Allows placing a call from the record through the calling integration.
- # Legacy value; no longer used.
- # Legacy value; no longer used.
- # Allows administrative operations reserved for administrative API accounts.
- # Allows managing the documents attached to the pipeline step.
- # Allows merging duplicate records into this record.
- # Allows taking ownership of the unassigned lead or task.
- # Legacy value; no longer used.
- # Legacy value; no longer used.
- # Allows marking the project or target as completed.
- # Allows reopening the completed project.
- # Allows transferring or deleting the reports, profiles, form views, email
- # templates and import templates of the deactivated user.
- # Allows reading the parts of the email template needed to use it, for example in
- # a process or email sequence, without full read access.
- # Allows reading the body of the email.
- # Allows changing who can read the body of the email.
- # Allows the current user, as a pending approver, to approve or reject the
- # approval request.
- # Allows the current user, as a pending approver, to delegate the approval request
- # to another user.
- # Allows resubmitting a rejected approval request.
- # Allows cancelling the approval request.
- # Allows reassigning the user seat to a different person by email address.
- # Allows resetting the password of the user.
- }
link Require by
- AccountDataExRelationEntityOption selected in a multi-select checkbox field of an account; there is one link per selected option.
- AccountEntityCompany or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.
- AccountKPIEntityRecorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports.
- AccountProductPricingEntitySpecial price of a product for one account, used instead of the regular price when the product is sold to that account.
- AccountRelationEntityLink between two related accounts, such as partners or a supplier and its customer; its labels give the kind of relationship.
- AccountRelationLabelEntityRelationship type assigned to a link between two accounts, such as Partner or Supplier.
- AccountRelationTypeEntityKind of relationship that can be assigned to a link between two accounts, such as Partner or Supplier, with its display color.
- AccountRoleEntityRole a contact can hold at an account, configurable per space and assigned on the link between the contact and the account.
- AccountSharingClientRelationEntitySharing of an account with a user, as a watcher or an editor.
- AccountSharingSalesUnitRelationEntitySharing of an account with a sales unit, as a watcher or an editor.
- AccountSocialRelationEntitySocial network profiles of an account, such as its LinkedIn, Twitter or Facebook pages.
- AccountTypeEntityConfigurable category of accounts that defines the form layout and settings used for accounts of that type.
- ActivityCommentEntityComment written by a user on a task or an appointment.
- ActivityDataExRelationEntityOption selected in a multi-select checkbox field of a task or an appointment; there is one link per selected option.
- ActivityEntityTask or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern.
- ActivityKPIEntityRecorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports.
- ActivityRelationEntityLink of a task or an appointment to a record it concerns, such as an account, contact, lead, opportunity, project or quote.
- AllowedAccountTypeEntityAccount type that a user role is allowed to use.
- AllowedAppointmentTypeEntityAppointment type that a user role is allowed to use.
- AllowedCompanyEmailEntityCompany email address that a user role is allowed to send emails from.
- AllowedCompanyPhoneEntityCompany phone number that a user role is allowed to use for calls and text messages.
- AllowedContactTypeEntityContact type that a user role is allowed to use.
- AllowedLeadTypeEntityLead type that a user role is allowed to use.
- AllowedPipelineEntityPipeline that a user role is allowed to use, optionally with access to the documents of its steps.
- AllowedQuoteTypeEntityQuote type that a user role is allowed to use.
- AllowedTaskTypeEntityTask type that a user role is allowed to use.
- ApiAccessEntityAPI credentials that an integration uses to access the space, with the parts of the API they may read or write.
- ApplicationEntityApplication that works with the space, such as the web or mobile app, an Automation Hub integration or an API access; changes and events are attributed to it.
- AppointmentClientInviteesRelationEntityInvitation of a user of the space to an appointment, with their response.
- AppointmentContactInviteesRelationEntityInvitation of an external person to an appointment, identified by email and matched to a contact when one exists, with their response.
- AppointmentEntityMeeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns.
- AppointmentReminderEntityReminder a user has set for an appointment, notifying them a given time before it starts.
- AppointmentScheduleEntityOnline booking link through which people book appointments with a user in the time slots the user has available.
- AppointmentTypeEntityConfigurable category of appointments, such as a meeting or a call, that defines their form layout and icon.
- ApprovalApproverEntityUser asked to decide an approval request, with their response and comment.
- ApprovalEntityApproval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers.
- ApprovalProcessActivityLogLineEntityEntry in the activity log of an approval, recording one step of the approval and its result.
- ApprovalProcessEntityApproval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them.
- CallEntityPhone call logged in the space, linked to the user who made it and to the contact, account, lead or opportunity it concerns.
- ChatConversationEntityConversation of a user with the AI assistant, either general or about a specific record.
- ClientEntityUser of the space; owns records, belongs to sales units and has a user role that determines what they can do.
- ClientExcludedOpptyEntityChoice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again.
- ClientFavoriteEntityRecord or screen profile that a user has marked as a favorite.
- ClientSettingEntityPersonal setting of a user, stored as a named value.
- ClientStoryReadEntityMark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it.
- CloudObjectEntityFile stored in the space, such as a document, image or recording, that can be attached to records.
- CloudObjectFolderEntityFolder that organizes files, either in the company documents or within a record.
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CloudObjectStepRelationEntityFile attached to a pipeline step, such as a document the sales team uses in that step.
- CloudObjectTemplateEntityDocument template, such as a Word or Excel file with placeholders, used to generate documents filled with record data.
- CompanyEmailEntityShared company mailbox connected to the space that users can send emails from, such as a sales or support address.
- ContactAccountAccountRoleRelationEntityRole assigned to a contact at an account, on the link between the contact and the account.
- ContactAccountRelationEntityLink between a contact and an account they work for, with their position and their place in the account org chart.
- ContactDataExRelationEntityOption selected in a multi-select checkbox field of a contact; there is one link per selected option.
- ContactEntityPerson the sales team works with, usually linked to one or more accounts, leads and opportunities.
- ContactKPIEntityRecorded KPI event of a contact, such as its creation, archiving or the first and last email sent, used in KPI reports.
- ContactRelationEntityLink between two related contacts, such as colleagues or family members; its labels give the kind of relationship.
- ContactRelationLabelEntityRelationship type assigned to a link between two contacts, such as Spouse or Colleague.
- ContactRelationTypeEntityKind of relationship that can be assigned to a link between two contacts, such as Spouse or Colleague, with its display color.
- ContactSharingClientRelationEntitySharing of a contact with a user, as a watcher or an editor.
- ContactSharingSalesUnitRelationEntitySharing of a contact with a sales unit, as a watcher or an editor.
- ContactSocialRelationEntitySocial network profiles of a contact, such as their LinkedIn, Twitter or Facebook profiles.
- ContactTypeEntityConfigurable category of contacts that defines the form layout and settings used for contacts of that type.
- CountryCrmEntityCountry offered in address fields; a new country value on a record must match one of these countries.
- CurrencyEntityCurrency used for monetary values in the space, converted from the base currency by exchange rates.
- CurrencyExchangeRateEntityExchange rate of a currency against the base currency within an exchange rate list.
- CurrencyExchangeRatesListEntitySet of exchange rates, one per currency, that applies from a given date until the next list takes effect.
- CustomEntityDataExRelationEntityOption selected in a multi-select checkbox field of a custom entity record; there is one link per selected option.
- CustomEntityEntityRecord of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities.
- CustomEntityRelationDataEntityLink between two records made through a custom relation, such as an account linked to a custom entity record.
- CustomEntityRelationEntityCustom relation that links records of two entities through a pair of relation fields, one on each side.
- CustomEntitySharingClientRelationEntitySharing of a custom entity record with a user, as a watcher or an editor.
- CustomEntitySharingSalesUnitRelationEntitySharing of a custom entity record with a sales unit, as a watcher or an editor.
- CustomEntityTypeEntityConfigurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity.
- DataEntityOption of a dropdown or multi-select field, one of the values users can choose from.
- EmailContentSharingClientRelationEntitySharing of the body of an email with a user, letting them read its content.
- EmailContentSharingSalesUnitRelationEntitySharing of the body of an email with a sales unit, letting its members read its content.
- EmailEntityEmail message sent or received by users of the space, linked to the contacts, accounts and other records it concerns.
- EmailEventEntityTracking event reported for a sent email, such as an open, a link click, a reply or an unsubscribe.
- EmailLabelEntityPersonal label a user applies to email conversations to organize their mailbox; labels can be nested.
- EmailLabelRelationEntityEmail label applied to a conversation in a mailbox.
- EmailMailboxRelationEntityLink between an email and a mailbox the email belongs to.
- EmailSequenceActivityLogEntityLog of one run of an email sequence, with when it started and finished and who triggered it.
- EmailSequenceActivityLogLineEntityEntry in the log of an email sequence run, recording one step and its outcome.
- EmailSequenceEnrolledEntityRecord enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it.
- EmailSequenceEntityAutomated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop.
- EmailTemplateEntityReusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared.
- EmailTemplateFolderEntityFolder that organizes email templates; folders can be nested.
- EmailTemplateSharingClientRelationEntitySharing of an email template with a user, as a watcher or an editor.
- EmailTemplateSharingSalesUnitRelationEntitySharing of an email template with a sales unit, as a watcher or an editor.
- EmailThreadMailboxClientReadStateEntityTime a user last read an email conversation in a mailbox, telling which conversations have unread emails.
- EntityEntityKind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior.
- EntityFitnessEntityFitness configuration of a lead or opportunity type: the indicators that flag records of that type needing attention.
- EntityFitnessIndicatorEntityIndicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them.
- EntityHealthEntityHealth configuration of an account type, defining when accounts of that type are healthy or in critical health.
- EntityScoringEntityLead scoring configuration: rules that give leads a score, so that the most promising ones stand out.
- EntitySettingsEntitySpace-wide settings of an entity, such as the default columns of its lists.
- FieldEntityField of an entity, built-in or custom, with its name, type and configuration.
- FieldMappingEntityRules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity.
- FieldPermissionEntityAccess a user role has to a custom field: full access, read-only or hidden.
- FieldSequenceEntityNumbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence.
- ForecastEntitySales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users.
- FormViewEntityVariant of the form of an account, contact, lead or opportunity type that hides or colors selected fields; owned by a user and can be shared.
- FormViewSharingClientRelationEntitySharing of a form view with a user, as a watcher or an editor.
- FormViewSharingSalesUnitRelationEntitySharing of a form view with a sales unit, as a watcher or an editor.
- GhostContactAccountAccountRoleRelationEntityRole assigned to a ghost contact on the org chart of an account.
- GhostContactAccountRelationEntityPlacement of a ghost contact on the org chart of an account, with its position and comment.
- GhostContactEntityPlaceholder person on an org chart for someone who is not a contact in the space yet, such as an unknown decision maker.
- GhostLeadOpptyContactRelationEntityPlacement of a ghost contact on the org chart of a lead or an opportunity.
- GhostLeadOpptyContactSalesRoleRelationEntitySales role assigned to a placeholder (ghost) contact on the org chart of a lead or opportunity.
- ImportMappingMaskEntitySaved mapping of import file columns to fields, reused when importing records of the same entity.
- InterfacePreviewEntityLayout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts.
- LeadEntityPotential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.
- LeadOpptyAccountRelationEntityLink between a lead or opportunity and an account, marking the primary account.
- LeadOpptyContactGroupRelationEntityGroup of contacts on the org chart of a lead or opportunity.
- LeadOpptyContactRelationEntityLink between a lead or opportunity and a contact, with the contact's sales roles and org-chart position.
- LeadOpptyContactSalesRoleRelationEntitySales role assigned to a contact on a lead or opportunity.
- LeadOpptyDataExRelationEntityOption selected in a multi-select checkbox field of a lead or opportunity.
- LeadOpptyEntityLead or opportunity, with the fields both kinds of sales records share.
- LeadOpptyKPIEntityKPI event of a lead or opportunity (e.g. created, qualified, won, lost or moved to another step), used in activity reporting.
- LeadOpptySharingClientRelationEntityShare of a lead or opportunity with an individual user, with the access level granted.
- LeadOpptySharingSalesUnitRelationEntityShare of a lead or opportunity with a sales unit, with the access level granted.
- LeadOpptyStepCheckListRelationEntityCompletion of a step checklist item on a lead, opportunity or quote, with the activity, email, note or document that fulfils it.
- LeadProcessEntityLead process: the ordered steps that leads of its lead types move through.
- LeadTypeEntityLead type that classifies leads and defines their forms and the lead process they follow.
- MasterRightEntityUser role in the space that defines which features, records and pipelines its users can access.
- MediaEntityRecording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment.
- MemoCommentEntityComment a user wrote on a memo.
- MemoEntityInternal message written by a user and linked to records, which other users can comment on.
- MessageRelationEntityLink between a message (email or memo) and a record such as an account, contact, lead or opportunity.
- MessageSharingClientRelationEntityShare of a message (email or memo) with an individual user.
- MessageSharingSalesUnitRelationEntityShare of a message (email or memo) with a sales unit.
- NoteEntityNote a user wrote on a record such as an account, contact, lead, opportunity, project or quote.
- OnlineFormActivityLogLineEntityOne step logged while processing an online form submission.
- OnlineFormDataExRelationEntityOption selected in a multi-select checkbox field of an online form submission.
- OnlineFormEntitySubmission (response) of an online form, with the answers and the records it created or updated.
- OnlineFormRelationEntityLink between an online form submission and a record it created or updated.
- OnlineFormStyleEntityVisual style (colors, fonts, layout) that can be applied to online forms.
- OnlineFormTypeEmailRelationEntityEmail that sent an online form link to a recipient, with the record it was sent on.
- OnlineFormTypeEntityOnline form definition: the fields and settings of a web form whose submissions create or update records.
- OpportunityEntityPotential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
- OpportunityTypeEntityOpportunity type that classifies opportunities and defines their forms (edit, qualify, won and lost).
- OpptyProductRelationDataExRelationEntityOption selected in a multi-select checkbox field of a product line item.
- OpptyProductRelationEntityProduct line item on an opportunity or quote, with its quantity, price and discount.
- OpptyProductRelationRevenueScheduleEntityRevenue schedule that splits the amount of a product line item into periods.
- OpptyProductRelationRevenueSchedulePeriodEntityOne period of a product line item revenue schedule, with its date and amount.
- OpptyProductRelationTypeEntityLine-item type that defines the form of product line items on opportunities and quotes; paired with a product type.
- OpptyRecurrenceEntityRecurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost.
- OpptyRevenueScheduleEntityRevenue schedule that splits the value of an opportunity into periods.
- OpptyRevenueSchedulePeriodEntityOne period of an opportunity revenue schedule, with its date and amount.
- ParentAccountRelationTypeEntityKind of parent-child relationship between accounts (e.g. parent company and subsidiary), with a label for each side.
- PhoneEntityPhone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company.
- PipelineEntitySales pipeline: the ordered steps that opportunities of its opportunity types move through.
- ProcessActivityLogEntityOne run of an Automatizer process, with its status, timing and the steps it took.
- ProcessActivityLogLineEntityOne step logged in a run of an Automatizer process.
- ProcessEntityAutomatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook).
- ProcessScheduledActionEntityAction of an Automatizer process that is waiting to run for a record at a scheduled time.
- ProcessTemplateEntityReady-made Automatizer process offered in the template gallery as a starting point for new processes.
- ProductCategoryEntityCategory in the hierarchy of the product catalog.
- ProductDataExRelationEntityOption selected in a multi-select checkbox field of a product.
- ProductEntityProduct or service in the catalog that can be added as a line item to opportunities and quotes.
- ProductPipelineRelationEntityPipeline in which a product can be added as a line item.
- ProductPriceListEntityPrice list with product prices per currency, applied to opportunities and quotes while it is active.
- ProductPriceListPriceEntityPrice of a product in one currency within a price list.
- ProductTypeEntityProduct type that classifies products and defines their form.
- ProfileEntitySaved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.
- ProfileRelationEntityRecord added explicitly to a static saved view (profile).
- ProfileSharingClientRelationEntityShare of a saved view (profile) with an individual user.
- ProfileSharingSalesUnitRelationEntityShare of a saved view (profile) with a sales unit.
- ProjectContactRelationEntityLink between a project and a contact, marking the primary contact.
- ProjectDataExRelationEntityOption selected in a multi-select checkbox field of a project.
- ProjectEntityProject delivered for an account or run internally, with its objectives, activities and progress.
- ProjectKPIEntityKPI event of a project (its completion), used in activity reporting.
- ProjectObjectiveEntityObjective (goal) of a project.
- ProjectSharingClientRelationEntityShare of a project with an individual user, with the access level granted.
- ProjectSharingSalesUnitRelationEntityShare of a project with a sales unit, with the access level granted.
- ProjectTypeEntityProject type that classifies projects and defines their form and icon.
- QuoteAccountRelationEntityLink between a quote and an account, marking the primary account.
- QuoteContactRelationEntityLink between a quote and a contact, marking the primary contact.
- QuoteDataExRelationEntityOption selected in a multi-select checkbox field of a quote.
- QuoteEntityPrice offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process.
- QuoteKPIEntityKPI event of a quote (e.g. created, accepted, archived or moved to another step), used in activity reporting.
- QuoteProcessEntityQuote process: the ordered steps that quotes of its quote types move through.
- QuoteSharingClientRelationEntityShare of a quote with an individual user, with the access level granted.
- QuoteSharingSalesUnitRelationEntityShare of a quote with a sales unit, with the access level granted.
- QuoteTypeEntityQuote type that classifies quotes and defines their forms and the quote process they follow.
- ReportEntitySaved report or dashboard with its settings, sharing and delivery schedule.
- ReportFolderEntityFolder that organizes reports; folders can be nested.
- ReportScheduleEntitySchedule that emails a report to its recipients at regular intervals.
- ReportSharingClientRelationEntityShare of a report with an individual user, with the access level granted.
- ReportSharingSalesUnitRelationEntityShare of a report with a sales unit, with the access level granted.
- SalesRoleEntityRole a contact plays in a deal (e.g. decision maker), assigned to contacts on leads and opportunities.
- SalesUnitClientRelationEntityMembership of a user in a sales unit, as a member or manager.
- SalesUnitEntitySales unit (team) in the organization hierarchy that users belong to.
- SolutionEntityCanvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity.
- SolutionTemplateEntityReady-made solution offered in the template gallery as a starting point for new solutions.
- StepChecklistEntityChecklist item of a pipeline step, such as logging an activity, filling a field or attaching a document.
- StepChecklistSalesRoleRelationEntitySales role that a step checklist item is shown to.
- StepEntityStep of an opportunity pipeline, lead process or quote process that records move through.
- TagEntityLabel that users attach to records such as accounts, contacts or opportunities to categorize them.
- TagRelationEntityAssignment of a tag to a record.
- TargetEntitySales target set for a user or a group of users for a period, measured by a chosen metric.
- TargetRelationEntityLink between a group target and a user target that rolls up into it.
- TaskEntityTask (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records.
- TaskRecurrenceEntityRecurrence rule that defines when the next occurrences of a recurring task are created.
- TaskReminderEntityReminder a user set to be notified about a task at a given time.
- TaskSharingClientRelationEntityShare of a task with an individual user, with the access level granted.
- TaskSharingSalesUnitRelationEntityShare of a task with a sales unit, with the access level granted.
- TaskTypeEntityTask type that classifies tasks and defines their form and icon.
- TextMessageConversationEntityText message conversation between a Coevera phone number and an external phone number.
- TextMessageConversationRelationsEntityLink between a text message conversation and a record such as an account, contact, lead or opportunity.
- TextMessageEntityMessage sent or received in a text message conversation or in an AI assistant chat.
- TimeframeEntityTime a lead or opportunity has spent in a pipeline step.
- TranslationEntityTranslation of a field name, dropdown option or form text into the supported languages.
- TypeEntityData type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped.
- UnsubscribedPhoneEntityPhone number that opted out of receiving text messages.
- WebhookEntityRegistered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. Recipient has to receive the webhook in 10 seconds and respond with HTTP 200 (2XX) status. On failed delivery it will be retried up to 10 times within 24 hours. If the receiving side will respond with HTTP 410 status, the webhook will be disabled. Webhook is also disabled when we receive HTTP timeout on 10th retry and there was no successful delivery in last 5 days.
- WebhookEventEntityEvent a webhook subscribes to; the webhook is called whenever the event occurs.
- WebresourceEntityWeb page embedded in the app for records of an entity, with its URL filled from the record's field values.