Types: E
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
EmailAccessAllowList EmailAccessAllowListParams EmailAccessLevelEnum EmailAccessLevelEnumFilterInput EmailAccountFeatureEnum EmailAccountLimit EmailContentSharingClientRelationEntity EmailContentSharingClientRelationEntityConnection EmailContentSharingClientRelationEntityEdge EmailContentSharingClientRelationFilterInput EmailContentSharingClientRelationOrderByInput EmailContentSharingClientRelationRepository EmailContentSharingSalesUnitRelationEntity EmailContentSharingSalesUnitRelationEntityConnection EmailContentSharingSalesUnitRelationEntityEdge EmailContentSharingSalesUnitRelationFilterInput EmailContentSharingSalesUnitRelationOrderByInput EmailContentSharingSalesUnitRelationRepository EmailConversationItem EmailConversationItemConnection EmailConversationItemEdge EmailConversationPicture EmailConversationSenderAccount EmailConversationSenderClient EmailConversationSenderContact EmailDataInterface EmailDirectionEnum EmailDirectionEnumFilterInput EmailDraftSettings EmailEntity EmailEntityConnection EmailEntityEdge EmailEntityLinkedRecord EmailEventEntity EmailEventFilterInput EmailEventOrderByInput EmailEventRepository EmailEventTypeEnum EmailEventTypeEnumFilterInput EmailEventTypeFlagEnum EmailEventTypeFlagEnumFilterInput EmailFilterInput EmailFilterTab EmailFollowUpTask EmailFollowUpTaskParams EmailLabelEntity EmailLabelEntityConnection EmailLabelEntityEdge EmailLabelFilterInput EmailLabelOrderByInput EmailLabelOrderByNestedInput EmailLabelRelationEntity EmailLabelRelationEntityConnection EmailLabelRelationEntityEdge EmailLabelRelationFilterInput EmailLabelRelationOrderByInput EmailLabelRelationRepository EmailLabelRepository EmailLinkedItem EmailMailboxRelationEntity EmailMailboxRelationFilterInput EmailMailboxRelationOrderByInput EmailMailboxRelationRepository EmailNotificationSettings EmailNotificationSettingsParams EmailOrderByInput EmailOrderByNestedInput EmailPivotReportProfile EmailProfileInterface EmailRepository EmailRoleTab EmailScheduleSettings EmailSentimentEnum EmailSentimentEnumFilterInput EmailSequenceActivityLogEntity EmailSequenceActivityLogEntityConnection EmailSequenceActivityLogEntityEdge EmailSequenceActivityLogFilterInput EmailSequenceActivityLogLineEntity EmailSequenceActivityLogLineEntityConnection EmailSequenceActivityLogLineEntityEdge EmailSequenceActivityLogLineFilterInput EmailSequenceActivityLogLineOrderByInput EmailSequenceActivityLogLineRepository EmailSequenceActivityLogOrderByInput EmailSequenceActivityLogOrderByNestedInput EmailSequenceActivityLogRepository EmailSequenceCountStats EmailSequenceCreateRecordNode EmailSequenceDeactivationReasonEnum EmailSequenceDeactivationReasonEnumFilterInput EmailSequenceEndReasonEnum EmailSequenceEndReasonEnumFilterInput EmailSequenceEnrolledEntity EmailSequenceEnrolledEntityConnection EmailSequenceEnrolledEntityEdge EmailSequenceEnrolledFilterInput EmailSequenceEnrolledOrderByInput EmailSequenceEnrolledRepository EmailSequenceEntity EmailSequenceEntityConnection EmailSequenceEntityEdge EmailSequenceFilter EmailSequenceFilterInput EmailSequenceGlobalActionsSettings EmailSequenceNode EmailSequenceNodeCondition EmailSequenceNodeConditionActionEnum EmailSequenceNodeEmail EmailSequenceNodeEmailSender EmailSequenceOrderByInput EmailSequenceOrderByNestedInput EmailSequencePeriodStats EmailSequenceRepository EmailSequenceSchema EmailSequenceSchemaJSONString EmailSequenceSendEmailNode EmailSequenceSettings EmailSequencesNotificationSettings EmailSequencesNotificationSettingsParams EmailSequenceStats EmailSequenceStatsPeriodEnum EmailSequenceStatsRecipientTypeEnum EmailSequenceStepStats EmailSequenceTabDataGridViewOptionsParams EmailSequenceTimelinePeriodEnum EmailSequenceTrigger EmailServiceTypeEnum EmailServiceTypeEnumFilterInput EmailTableReportProfile EmailTemplateEntity EmailTemplateEntityConnection EmailTemplateEntityEdge EmailTemplateFilterInput EmailTemplateFolderEntity EmailTemplateFolderEntityConnection EmailTemplateFolderEntityEdge EmailTemplateFolderFilterInput EmailTemplateFolderOrderByInput EmailTemplateFolderOrderByNestedInput EmailTemplateFolderRepository EmailTemplateOrderByInput EmailTemplateOrderByNestedInput EmailTemplatePersonificationResult EmailTemplateRepository EmailTemplateSharingClientRelationEntity EmailTemplateSharingClientRelationEntityConnection EmailTemplateSharingClientRelationEntityEdge EmailTemplateSharingClientRelationFilterInput EmailTemplateSharingClientRelationOrderByInput EmailTemplateSharingClientRelationRepository EmailTemplateSharingSalesUnitRelationEntity EmailTemplateSharingSalesUnitRelationEntityConnection EmailTemplateSharingSalesUnitRelationEntityEdge EmailTemplateSharingSalesUnitRelationFilterInput EmailTemplateSharingSalesUnitRelationOrderByInput EmailTemplateSharingSalesUnitRelationRepository EmailTemplateSharingUrlSettings EmailTemplateTypeEnum EmailTemplateTypeEnumFilterInput EmailThreadMailboxClientReadStateEntity EmailThreadMailboxClientReadStateFilterInput EmailThreadMailboxClientReadStateOrderByInput EmailThreadMailboxClientReadStateRepository EmailTrackingEvent EmailTrackingEventTypeEnum EmailTypeEnum EmailTypeEnumFilterInput EnableMessagingPhonePayload EntityEntity EntityEntityConnection EntityEntityEdge EntityFilterDateTimeField EntityFilterInput EntityFilterNumberField EntityFilterRelatedField EntityFilterStringField EntityFitnessEntity EntityFitnessEntityConnection EntityFitnessEntityEdge EntityFitnessFilterInput EntityFitnessIndicatorEntity EntityFitnessIndicatorEntityConnection EntityFitnessIndicatorEntityEdge EntityFitnessIndicatorFilterInput EntityFitnessIndicatorOrderByInput EntityFitnessIndicatorRepository EntityFitnessOrderByInput EntityFitnessOrderByNestedInput EntityFitnessRepository EntityHealthCalculationTypeEnum EntityHealthEntity EntityHealthEntityConnection EntityHealthEntityEdge EntityHealthFieldConfiguration EntityHealthFieldFilterRule EntityHealthFilterBox EntityHealthFilterInput EntityHealthIndicator EntityHealthIndicatorEnum EntityHealthMainFilterBox EntityHealthOrderByInput EntityHealthRepository EntityHealthResult EntityHealthSettings EntityHealthSettingsJSONString EntityHealthTrendEnum EntityIconEnum EntityLacotaType EntityListColumn EntityMapping EntityNameEnum EntityNameEnumFilterInput EntityOperationMapping EntityOperationMappingOption EntityOperationMappingOptionParams EntityOperationMappingParams EntityOrderByInput EntityPermsEnum EntityRepository EntityRepositoryRegistry EntityScoringActivityRule EntityScoringCategory EntityScoringEmailRule EntityScoringEntity EntityScoringEntityConnection EntityScoringEntityEdge EntityScoringFieldRule EntityScoringFilterInput EntityScoringOrderByInput EntityScoringRecalculationStatus EntityScoringRepository EntityScoringResult EntityScoringResultRule EntityScoringRule EntityScoringRuleEmailEventTypeEnum EntityScoringRuleExpirationUnitEnum EntityScoringRuleFilter EntityScoringSettings EntityScoringSettingsJSONString EntityScoringTrendEnum EntitySettingsDefaultListColumns EntitySettingsEntity EntitySettingsFilterInput EntitySettingsOrderByInput EntitySettingsRepository EntitySubtypeItem EntitySubtypeKind EntitySyncSettings EntityTypeFieldMapping EntityTypeFieldMappingJSONString EntityTypeFieldMappingParams EntityTypeSettings EntityValidationError EventEnum
Shared types: E
Types several repositories use, or none does, with their fields and their descriptions.
EmailContentSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailContentSharingClientRelation records.
| Field | Type | Description |
|---|---|---|
getById | EmailContentSharingClientRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailContentSharingClientRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailContentSharingClientRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailContentSharingClientRelationEntityConnection (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. |
EmailContentSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailContentSharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
getById | EmailContentSharingSalesUnitRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailContentSharingSalesUnitRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailContentSharingSalesUnitRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailContentSharingSalesUnitRelationEntityConnection (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. |
EmailDirectionEnum enum OutgoingEmail, IncomingEmail
Direction of an email or text message.
| Value | Description |
|---|---|
OutgoingEmail | Sent from Coevera or by a user's mailbox. |
IncomingEmail | Received from another party. |
EmailDirectionEnumFilterInput input eq: [EmailDirectionEnum!], NOT: EmailDirectionEnumFilterInput
Conditions on an enumeration field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [EmailDirectionEnum!] | Matches any of the listed values. |
NOT | EmailDirectionEnumFilterInput | Matches values that do not meet this condition. |
EmailEventRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailEvent records.
| Field | Type | Description |
|---|---|---|
getById | EmailEventEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailEventEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailEventEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [EmailEventEntity!]! (3 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. |
EmailLabelOrderByNestedInput input 9 fields: id, isDeleted, modified, …
Sorting by a field of the related EmailLabel 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. |
color | OrderByEnum | Color the label is displayed with, as a packed RGB integer. |
name | OrderByEnum | Name of the entity and its default text representation. |
ownerId | OrderByEnum | Id of the client who created this label. |
parentEmailLabelId | OrderByEnum | Id of the parent label this one is nested under, or empty for a top-level label. |
revision | OrderByEnum | Revision when entity was lastly changed. |
EmailLabelRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailLabelRelation records.
| Field | Type | Description |
|---|---|---|
getById | EmailLabelRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailLabelRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailLabelRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailLabelRelationEntityConnection (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. |
EmailLabelRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailLabel records.
| Field | Type | Description |
|---|---|---|
getById | EmailLabelEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailLabelEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailLabelEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailLabelEntityConnection (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. |
EmailMailboxRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailMailboxRelation records.
| Field | Type | Description |
|---|---|---|
getById | EmailMailboxRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailMailboxRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailMailboxRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [EmailMailboxRelationEntity!]! (3 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. |
EmailOrderByNestedInput input 30 fields: id, isDeleted, modified, …
Sorting by a field of the related Email 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. |
bcc | OrderByEnum | Comma-separated list of blind-carbon-copy recipients. |
bodySummary | OrderByEnum | Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. |
cc | OrderByEnum | Comma-separated list of carbon-copy recipients. |
companyEmailId | OrderByEnum | Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. |
contentShareMode | OrderByEnum | How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). |
contentType | OrderByEnum | MIME content type of the body (e.g. text/html, text/plain). |
dateSent | OrderByEnum | Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. |
direction | OrderByEnum | Direction of the email (Incoming, Outgoing). |
draftParentEmailId | OrderByEnum | Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. |
errorCode | OrderByEnum | Numeric error code recorded when the email failed to send. Zero when no error occurred. |
isDraft | OrderByEnum | True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. |
isTracked | OrderByEnum | True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. |
ownerId | OrderByEnum | Id of the email owner. |
parentEmailId | OrderByEnum | Id of the parent (master) email. |
sendAt | OrderByEnum | Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. |
sender | OrderByEnum | Sender address as it appeared on the email (free-text "From" header). |
senderAccountId | OrderByEnum | Id of the matched sender account. |
senderClientId | OrderByEnum | Id of the matched sender user. |
senderContactId | OrderByEnum | Id of the matched sender contact. |
sentiment | OrderByEnum | Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. |
shareMode | OrderByEnum | Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. |
subject | OrderByEnum | Name of the entity and its default text representation. |
templateId | OrderByEnum | Id of the email template. |
to | OrderByEnum | Comma-separated list of primary recipients. |
type | OrderByEnum | Whether the email is an individual email (Standard) or part of a mass email (Mass). |
revision | OrderByEnum | Revision when entity was lastly changed. |
EmailRepository object 8 fields: getById, getByIds, getAll, …
Read operations for Email records.
| Field | Type | Description |
|---|---|---|
getById | EmailEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailEntityConnection (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. |
checkForUnsubscribed | [SendEmailRecipient!]! (1 args) | Returns the recipients from the given list who have unsubscribed from emails, so they can be removed before sending. |
getDraftByParentAndMailbox | EmailEntity (2 args) | Returns the saved draft replying to the given email in the given mailbox, or null when there is none. |
getLinkedItems | [EmailLinkedItem!]! (2 args) | Returns the records (accounts, contacts, opportunities, projects, quotes, custom entities) linked to the email's conversation thread. |
EmailSequenceActivityLogLineRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailSequenceActivityLogLine records.
| Field | Type | Description |
|---|---|---|
getById | EmailSequenceActivityLogLineEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailSequenceActivityLogLineEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailSequenceActivityLogLineEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailSequenceActivityLogLineEntityConnection (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. |
EmailSequenceActivityLogOrderByNestedInput input 13 fields: id, isDeleted, modified, …
Sorting by a field of the related EmailSequenceActivityLog 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. |
actorId | OrderByEnum | Id of the user who initiated the run, or empty for runs triggered by automation. |
applicationId | OrderByEnum | Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. |
emailSequenceId | OrderByEnum | Id of the email sequence this activity log belongs to. |
endTime | OrderByEnum | Timestamp when the run finished. Empty for runs still in progress. |
isTestRun | OrderByEnum | True when the run was a dry-run / test execution and did not produce real-side effects. |
startTime | OrderByEnum | Timestamp when the run started. |
status | OrderByEnum | Outcome of the run (e.g. Ok, Error, Cancelled). |
recordName | OrderByEnum | Display name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera. |
recordEmail | OrderByEnum | Email address of the record this run enrolled. Read-only; computed by Coevera. |
EmailSequenceActivityLogRepository object 6 fields: getById, getByIds, getAll, …
Read operations for EmailSequenceActivityLog records.
| Field | Type | Description |
|---|---|---|
getById | EmailSequenceActivityLogEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailSequenceActivityLogEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailSequenceActivityLogEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailSequenceActivityLogEntityConnection (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. |
getDownloadUrl | String! (4 args) | Exports the activity log of an email sequence to a zipped text file and returns a URL to download it. |
EmailSequenceEnrolledRepository object 6 fields: getById, getByIds, getAll, …
Read operations for EmailSequenceEnrolled records.
| Field | Type | Description |
|---|---|---|
getById | EmailSequenceEnrolledEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailSequenceEnrolledEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailSequenceEnrolledEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailSequenceEnrolledEntityConnection (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. |
getEnrolledEmailSequences | [EmailSequenceEnrolledEntity!]! (2 args) | Returns the email sequence enrollments of a record, one per sequence, with the most recently updated first. When the record was enrolled in a sequence more than once, the active enrollment is preferred, otherwise the latest one. |
EmailSequenceNodeEmail object 14 fields: recipients, cc, bcc, …
Email sent by an email sequence: recipients, content, sender and the records it is linked to.
| Field | Type | Description |
|---|---|---|
recipients | [SendEmailRecipient!]! | Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record. |
cc | [SendEmailRecipient!]! | Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. |
bcc | [SendEmailRecipient!]! | Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. |
subject | String! | Subject line of the email. May contain personalization tags resolved from the triggered record. |
body | String! | HTML body of the email. May contain personalization tags resolved from the triggered record. |
emailTemplateId | UUID | Email template to use for the message. When set, the template supplies the subject and body. |
attachments | [UUID!]! | Stored files attached to the email. |
signature | String | Signature appended to the email body. |
isHtmlTemplate | Boolean | True when the chosen template is an HTML template rather than a plain-text one. |
linkTriggerEntity | Boolean | When true, the sent email is linked to the record that triggered the sequence. |
linkRecipients | Boolean | When true, the sent email is linked to the recipient records it is addressed to. |
sender | EmailSequenceNodeEmailSender! | Who the email is sent as. ActorEmail uses the user running the sequence, CompanyEmail uses a shared company mailbox, and RecordOwnerEmail uses the owner of the triggered record. |
senderCompanyEmailId | UUID | Company email account used as the sender when the sender is set to CompanyEmail. |
shareMode | ShareModeEnum | Sharing visibility applied to the sent email. Standard follows default sharing, Private restricts it to the owner, AllView grants everyone read access, and AllEdit grants everyone edit access. |
EmailSequenceNodeEmailSender enum ActorEmail, CompanyEmail, RecordOwnerEmail
Mailbox an email sequence step sends from.
| Value | Description |
|---|---|
ActorEmail | The user who enrolled the record. |
CompanyEmail | A shared company email account. |
RecordOwnerEmail | The owner of the enrolled record. |
EmailSequenceOrderByNestedInput input 26 fields: id, isDeleted, modified, …
Sorting by a field of the related EmailSequence 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. |
deactivationReason | OrderByEnum | Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only. |
description | OrderByEnum | Free-form description of the sequence. |
isEnabled | OrderByEnum | Master switch for the sequence. Read-only on this surface — change it via the enable / disable mutations. |
lastSchemaChange | OrderByEnum | Timestamp of the most recent change to settings. Read-only. |
lastStatusChange | OrderByEnum | Timestamp of the most recent change to isEnabled. Read-only. |
name | OrderByEnum | Display name of the email sequence. |
ownerId | OrderByEnum | Id of the email sequence owner. |
type | OrderByEnum | Process category of the sequence (e.g. EmailSequence vs other process types). |
status | OrderByEnum | Effective status of the sequence (e.g. Scheduled, Running, Expired, Error). Read-only; derived from the active-from / active-to settings and the most recent activity log status. |
lastEmailSequenceRun | OrderByEnum | Timestamp the sequence last produced a run (delivered or attempted a step). |
clickRate | OrderByEnum | Fraction of delivered emails (0–1) where at least one tracked link was clicked. |
bounceRate | OrderByEnum | Fraction of sent emails (0–1) that bounced (the recipient mailserver rejected them). |
openRate | OrderByEnum | Fraction of delivered emails (0–1) that recorded at least one open event. |
replyRate | OrderByEnum | Fraction of delivered emails (0–1) where the recipient replied. |
unsubscribeRate | OrderByEnum | Fraction of delivered emails (0–1) where the recipient unsubscribed. |
createdCount | OrderByEnum | Total number of emails produced (queued) by the sequence across all steps. |
sentCount | OrderByEnum | Total number of emails actually delivered by the sequence across all steps. |
enrollCount | OrderByEnum | Number of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in this sequence. |
solutions | OrderByEnum | Names of the solutions whose canvas contains this sequence, in name order. Empty when the sequence is on no solution canvas. |
triggerEntityName | OrderByEnum | Entity name whose records trigger automatic enrollment into this sequence (e.g. "Lead", "Contact"). Empty when the sequence is manually enrolled only. |
triggerFieldId | OrderByEnum | Id of the field on the trigger entity whose value change drives enrollment (e.g. a step field on a Lead). Empty when no field-based trigger is configured. |
stepCount | OrderByEnum | Number of steps configured in the sequence. |
EmailSequenceRepository object 7 fields: getById, getByIds, getAll, …
Read operations for EmailSequence records.
| Field | Type | Description |
|---|---|---|
getById | EmailSequenceEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailSequenceEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailSequenceEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailSequenceEntityConnection (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. |
getByEmailSequenceCriteria | EmailSequenceEntityConnection (7 args) | Returns a page of email sequences filtered by owner, enabled state and status, in addition to the regular filter. |
getEmailSequencesForUnenroll | [EmailSequenceEntity!]! (1 args) | Returns the email sequences in which any of the selected records is currently enrolled, so they can be offered for unenrollment. |
EmailSequenceSchemaJSONString scalar scalar
JSON object, sent as a string, conforming to the EmailSequenceSchema type.
EmailTemplateFolderOrderByNestedInput input 7 fields: id, isDeleted, modified, …
Sorting by a field of the related EmailTemplateFolder 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. |
name | OrderByEnum | Name of the entity and its default text representation. |
parentEmailTemplateFolderId | OrderByEnum | Id of the parent folder in the template hierarchy. Empty for top-level folders. |
revision | OrderByEnum | Revision when entity was lastly changed. |
EmailTemplateFolderRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailTemplateFolder records.
| Field | Type | Description |
|---|---|---|
getById | EmailTemplateFolderEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailTemplateFolderEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailTemplateFolderEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailTemplateFolderEntityConnection (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. |
EmailTemplateOrderByNestedInput input 13 fields: id, isDeleted, modified, …
Sorting by a field of the related EmailTemplate 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. |
emailTemplateFolderId | OrderByEnum | Id of the folder the template belongs to. Empty for templates at the root level. |
name | OrderByEnum | Name of the entity and its default text representation. |
ownerId | OrderByEnum | Id of the template owner. |
shareMode | OrderByEnum | Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). |
sharingUrlIsEnabled | OrderByEnum | When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. |
subject | OrderByEnum | Subject line of emails composed from this template. Supports merge-field placeholders. |
type | OrderByEnum | Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). |
revision | OrderByEnum | Revision when entity was lastly changed. |
solutions | OrderByEnum | Names of the solutions whose canvas contains this template, in name order. Empty when the template is on no solution canvas. |
EmailTemplateRepository object 12 fields: getById, getByIds, getAll, …
Read operations for EmailTemplate records.
| Field | Type | Description |
|---|---|---|
getById | EmailTemplateEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailTemplateEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailTemplateEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailTemplateEntityConnection (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. |
previewPersonifiedRecordsById | EmailTemplatePersonificationResult! (2 args) | Assigns properties of a living entity to a non-living template from its id. |
previewPersonifiedRecords | EmailTemplatePersonificationResult! (2 args) | Assigns properties of a living entity to a non-living template from input object. |
getAffectedProcesses | [AffectedProcessesProcessOutput!]! (3 args) | Returns the processes that send the given email template, so the caller can see which processes a change to the template affects. |
getAffectedEmailSequences | [AffectedProcessesProcessOutput!]! (3 args) | Returns the email sequences that send the given email template, so the caller can see which sequences a change to the template affects. |
getStatusInProcess | StatusInProcessOutput! (2 args) | Returns an email template's content and attachments, with a status telling whether a process can still use it. The status is Deleted for a deleted template, and Unavailable when the caller cannot open the template but the given process uses it. |
getStatusInEmailSequence | StatusInProcessOutput! (2 args) | Returns an email template's content and attachments, with a status telling whether an email sequence can still use it. The status is Deleted for a deleted template, and Unavailable when the caller cannot open the template but the given sequence uses it. |
convertWysiwygTemplateToHtml | String! (1 args) | Converts an email template body built in the visual (WYSIWYG) editor from MJML markup into HTML ready to be sent. |
EmailTemplateSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailTemplateSharingClientRelation records.
| Field | Type | Description |
|---|---|---|
getById | EmailTemplateSharingClientRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailTemplateSharingClientRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailTemplateSharingClientRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailTemplateSharingClientRelationEntityConnection (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. |
EmailTemplateSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailTemplateSharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
getById | EmailTemplateSharingSalesUnitRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailTemplateSharingSalesUnitRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailTemplateSharingSalesUnitRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EmailTemplateSharingSalesUnitRelationEntityConnection (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. |
EmailThreadMailboxClientReadStateRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EmailThreadMailboxClientReadState records.
| Field | Type | Description |
|---|---|---|
getById | EmailThreadMailboxClientReadStateEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EmailThreadMailboxClientReadStateEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EmailThreadMailboxClientReadStateEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [EmailThreadMailboxClientReadStateEntity!]! (3 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. |
EmailTypeEnum enum Standard, Mass
Whether an email is an individual email or part of a mass email.
| Value | Description |
|---|---|
Standard | Individual email. |
Mass | Mass email sent to many recipients. |
EmailTypeEnumFilterInput input eq: [EmailTypeEnum!], NOT: EmailTypeEnumFilterInput
Conditions on an enumeration field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [EmailTypeEnum!] | Matches any of the listed values. |
NOT | EmailTypeEnumFilterInput | Matches values that do not meet this condition. |
EntityFilterDateTimeField input 7 fields: eq, null, lt, …
Conditions on a date and time field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [String] | Exact match (case sensitive). Multiple values in list are evaluated as OR. |
null | Boolean | True matches records where the field has no value; false matches records where it has one. |
lt | DateTime | Matches values before this moment. |
lte | DateTime | Matches values before or equal to this moment. |
gt | DateTime | Matches values after this moment. |
gte | DateTime | Matches values after or equal to this moment. |
between | [DateTime] | Exactly two values, start and end. Matches values in this range, including both ends. |
EntityFilterNumberField input 7 fields: eq, null, lt, …
Conditions on a numeric field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [String] | Exact match (case sensitive). Multiple values in list are evaluated as OR. |
null | Boolean | True matches records where the field has no value; false matches records where it has one. |
lt | Float | Matches values lower than this number. |
lte | Float | Matches values lower than or equal to this number. |
gt | Float | Matches values greater than this number. |
gte | Float | Matches values greater than or equal to this number. |
between | [Float] | Exactly two values, lower and upper bound. Matches values in this range, including both bounds. |
EntityFilterRelatedField input entity: EntityLacotaType, entityIds: [UUID]
A set of records of one entity type that the result must be related to.
| Input field | Type | Description |
|---|---|---|
entity | EntityLacotaType | Entity type of the related records. |
entityIds | [UUID] | Ids of the related records. |
EntityFilterStringField input 10 fields: eq, null, ieq, …
Conditions on a text or identifier field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [String] | Exact match (case sensitive). Multiple values in list are evaluated as OR. |
null | Boolean | True matches records where the field has no value; false matches records where it has one. |
ieq | [String] | Exact match (case insensitive). Multiple values in list are evaluated as OR. |
empty | Boolean | True matches records where the text is missing or an empty string; false matches records with a non-empty text. |
starts | [String] | Compare against left side of string (case sensitive). Multiple values in list are evaluated as OR. |
ends | [String] | Compare against right side of string (case sensitive). Multiple values in list are evaluated as OR. |
contains | [String] | Substring match (case sensitive). Multiple values in list are evaluated as OR. |
istarts | [String] | Compare against left side of string (case insensitive). Multiple values in list are evaluated as OR. |
iends | [String] | Compare against right side of string (case insensitive). Multiple values in list are evaluated as OR. |
icontains | [String] | Substring match (case insensitive). Multiple values in list are evaluated as OR. |
EntityFitnessIndicatorRepository object 5 fields: getById, getByIds, getAll, …
Read operations for EntityFitnessIndicator records.
| Field | Type | Description |
|---|---|---|
getById | EntityFitnessIndicatorEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EntityFitnessIndicatorEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EntityFitnessIndicatorEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EntityFitnessIndicatorEntityConnection (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. |
EntityFitnessRepository object 6 fields: getById, getByIds, getAll, …
Read operations for EntityFitness records.
| Field | Type | Description |
|---|---|---|
getById | EntityFitnessEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EntityFitnessEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EntityFitnessEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EntityFitnessEntityConnection (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. |
getByEntityType | EntityFitnessEntity! (2 args) | Returns the fitness configuration of a lead type or opportunity type. |
EntityHealthRepository object 6 fields: getById, getByIds, getAll, …
Read operations for EntityHealth records.
| Field | Type | Description |
|---|---|---|
getById | EntityHealthEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EntityHealthEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EntityHealthEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EntityHealthEntityConnection (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. |
getByTypeId | EntityHealthEntity! (2 args) | Returns the account health configuration for the given account type. |
EntityHealthSettingsJSONString scalar scalar
JSON object, sent as a string, conforming to the EntityHealthSettings type.
EntityLacotaType enum Account, Contact, Task, Appointment, Lead, Opportunity, … (9 values)
Record entity that an email recipient or a related-record filter refers to, such as an account, contact, lead or quote.
| Value | Description |
|---|---|
Account | An account record. |
Contact | A contact record. |
Task | A task record. |
Appointment | An appointment record. |
Lead | A lead record. |
Opportunity | An opportunity record. |
Project | A project record. |
Quote | A quote record. |
CustomEntity | A record of a custom entity. |
EntityNameEnum enum AiAgent, AiBalance, AiEvent, AiEventJournal, AuditLog, Account, … (279 values)
Name of an entity (record type) of the space, used wherever an operation, filter or setting has to identify which entity it works with.
| Value | Description |
|---|---|
AiAgent | AI agent offered in the Automation Hub, such as an AI assistant integration, whose use is recorded as AI events. |
AiBalance | AI credit balance of a subscription for a period, with the free credits remaining and spent and the overage credits used. |
AiEvent | Use of an AI agent by a user in a space, with its outcome, response time and the AI credits it consumed. |
AiEventJournal | Single AI model call made while handling an AI event, with the model used, its response time and cost. |
AuditLog | Entry of the space audit log recording an administrative action, such as a data export, a user invitation or a sales unit change, and who performed it. |
Account | Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. |
AccountKPI | Recorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports. |
AccountRole | Role a contact can hold at an account, configurable per space and assigned on the link between the contact and the account. |
AccountSharingClientRelation | Sharing of an account with a user, as a watcher or an editor. |
AccountSharingSalesUnitRelation | Sharing of an account with a sales unit, as a watcher or an editor. |
AccountSocialRelation | Social network profiles of an account, such as its LinkedIn, Twitter or Facebook pages. |
AccountProductPricing | Special price of a product for one account, used instead of the regular price when the product is sold to that account. |
AccountType | Configurable category of accounts that defines the form layout and settings used for accounts of that type. |
Activity | Task or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern. |
ActivityComment | Comment written by a user on a task or an appointment. |
ActivityKPI | Recorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports. |
ActivityRelation | Link of a task or an appointment to a record it concerns, such as an account, contact, lead, opportunity, project or quote. |
ActivityType | Task type or appointment type, with the settings both kinds of activity types share. |
AllowedLeadType | Lead type that a user role is allowed to use. |
AllowedPipeline | Pipeline that a user role is allowed to use, optionally with access to the documents of its steps. |
ApiAccess | API credentials that an integration uses to access the space, with the parts of the API they may read or write. |
Application | Application 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. |
Appointment | Meeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns. |
AppointmentClientInviteesRelation | Invitation of a user of the space to an appointment, with their response. |
AppointmentContactInviteesRelation | Invitation of an external person to an appointment, identified by email and matched to a contact when one exists, with their response. |
AppointmentInviteeNotifyQueue | Invitation email for an appointment that is waiting to be sent to an invitee's email address. |
AppointmentReminder | Reminder a user has set for an appointment, notifying them a given time before it starts. |
AppointmentSchedule | Online booking link through which people book appointments with a user in the time slots the user has available. |
AppointmentType | Configurable category of appointments, such as a meeting or a call, that defines their form layout and icon. |
AllowedAccountType | Account type that a user role is allowed to use. |
AllowedAppointmentType | Appointment type that a user role is allowed to use. |
AllowedContactType | Contact type that a user role is allowed to use. |
AllowedCompanyPhone | Company phone number that a user role is allowed to use for calls and text messages. |
AllowedTaskType | Task type that a user role is allowed to use. |
Approval | Approval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers. |
ApprovalApprover | User asked to decide an approval request, with their response and comment. |
ApprovalProcess | Approval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them. |
ApprovalProcessActivityLogLine | Entry in the activity log of an approval, recording one step of the approval and its result. |
ChatConversation | Conversation of a user with the AI assistant, either general or about a specific record. |
Client | User of the space; owns records, belongs to sales units and has a user role that determines what they can do. |
ClientExcludedOppty | Choice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again. |
ClientFavorite | Record or screen profile that a user has marked as a favorite. |
ClientSetting | Personal setting of a user, stored as a named value. |
ClientStoryRead | Mark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it. |
CloudObject | File stored in the space, such as a document, image or recording, that can be attached to records. |
CloudObjectFolder | Folder that organizes files, either in the company documents or within a record. |
CloudObjectRelation | Attachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record. |
CloudObjectStepRelation | File attached to a pipeline step, such as a document the sales team uses in that step. |
CloudObjectTemplate | Document template, such as a Word or Excel file with placeholders, used to generate documents filled with record data. |
CompanyEmail | Shared company mailbox connected to the space that users can send emails from, such as a sales or support address. |
Contact | Person the sales team works with, usually linked to one or more accounts, leads and opportunities. |
ContactAccountRelation | Link between a contact and an account they work for, with their position and their place in the account org chart. |
ContactAccountAccountRoleRelation | Role assigned to a contact at an account, on the link between the contact and the account. |
ContactRelation | Link between two related contacts, such as colleagues or family members; its labels give the kind of relationship. |
ContactRelationType | Kind of relationship that can be assigned to a link between two contacts, such as Spouse or Colleague, with its display color. |
ContactKPI | Recorded KPI event of a contact, such as its creation, archiving or the first and last email sent, used in KPI reports. |
ContactSharingClientRelation | Sharing of a contact with a user, as a watcher or an editor. |
ContactSharingSalesUnitRelation | Sharing of a contact with a sales unit, as a watcher or an editor. |
ContactSocialRelation | Social network profiles of a contact, such as their LinkedIn, Twitter or Facebook profiles. |
ContactType | Configurable category of contacts that defines the form layout and settings used for contacts of that type. |
CountryCrm | Country offered in address fields; a new country value on a record must match one of these countries. |
Currency | Currency used for monetary values in the space, converted from the base currency by exchange rates. |
CurrencyExchangeRate | Exchange rate of a currency against the base currency within an exchange rate list. |
CurrencyExchangeRatesList | Set of exchange rates, one per currency, that applies from a given date until the next list takes effect. |
CustomEntityRelation | Custom relation that links records of two entities through a pair of relation fields, one on each side. |
CustomEntityRelationData | Link between two records made through a custom relation, such as an account linked to a custom entity record. |
CustomEntity | Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. |
CustomEntityDataExRelation | Option selected in a multi-select checkbox field of a custom entity record; there is one link per selected option. |
CustomEntityKPI | Recorded KPI event of a custom entity record, such as its creation or last modification, used in KPI reports. |
CustomEntitySharingClientRelation | Sharing of a custom entity record with a user, as a watcher or an editor. |
CustomEntitySharingSalesUnitRelation | Sharing of a custom entity record with a sales unit, as a watcher or an editor. |
CustomEntityType | Configurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity. |
Data | Option of a dropdown or multi-select field, one of the values users can choose from. |
Ebook | E-book offered to users in the in-app learning content, with view statistics. |
Email | Email message sent or received by users of the space, linked to the contacts, accounts and other records it concerns. |
EmailLabel | Personal label a user applies to email conversations to organize their mailbox; labels can be nested. |
EmailLabelRelation | Email label applied to a conversation in a mailbox. |
EmailMailboxRelation | Link between an email and a mailbox the email belongs to. |
EmailSequence | Automated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop. |
EmailSequenceActivityLog | Log of one run of an email sequence, with when it started and finished and who triggered it. |
EmailSequenceActivityLogLine | Entry in the log of an email sequence run, recording one step and its outcome. |
EmailSequenceEnrolled | Record enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it. |
EmailSequenceEnrolledStatus | Progress of an enrolled record through one step of an email sequence, with the email, text message or task the step produced. |
EmailSequenceSettings | Copy of an email sequence's steps and rules taken when records are enrolled, so later edits to the sequence do not affect runs already in progress. |
EmailTemplate | Reusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared. |
EmailTemplateFolder | Folder that organizes email templates; folders can be nested. |
EmailTemplateSharingClientRelation | Sharing of an email template with a user, as a watcher or an editor. |
EmailTemplateSharingSalesUnitRelation | Sharing of an email template with a sales unit, as a watcher or an editor. |
EmailContentSharingClientRelation | Sharing of the body of an email with a user, letting them read its content. |
EmailContentSharingSalesUnitRelation | Sharing of the body of an email with a sales unit, letting its members read its content. |
EmailThreadMailboxClientReadState | Time a user last read an email conversation in a mailbox, telling which conversations have unread emails. |
Entity | Kind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior. |
EntityHealth | Health configuration of an account type, defining when accounts of that type are healthy or in critical health. |
EntityScoring | Lead scoring configuration: rules that give leads a score, so that the most promising ones stand out. |
EntityHealthSettingsHistory | Version of the health configuration of an account type, recorded each time the configuration changes. |
EntityFitness | Fitness configuration of a lead or opportunity type: the indicators that flag records of that type needing attention. |
EntityFitnessIndicator | Indicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them. |
EntityType | Record type of an entity, such as an account, lead or task type, that classifies records and defines their form. |
EntitySettings | Space-wide settings of an entity, such as the default columns of its lists. |
Field | Field of an entity, built-in or custom, with its name, type and configuration. |
FieldMapping | Rules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity. |
FieldSequence | Numbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence. |
FieldPermission | Access a user role has to a custom field: full access, read-only or hidden. |
Forecast | Sales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users. |
ForecastSharingClientRelation | Share of a forecast with an individual user. |
ForecastSharingSalesUnitRelation | Share of a forecast with a sales unit. |
GhostContact | Placeholder person on an org chart for someone who is not a contact in the space yet, such as an unknown decision maker. |
GhostLeadOpptyContactRelation | Placement of a ghost contact on the org chart of a lead or an opportunity. |
GhostContactAccountRelation | Placement of a ghost contact on the org chart of an account, with its position and comment. |
GhostLeadOpptyContactSalesRoleRelation | Sales role assigned to a placeholder (ghost) contact on the org chart of a lead or opportunity. |
GhostContactAccountAccountRoleRelation | Role assigned to a ghost contact on the org chart of an account. |
ImportMappingMask | Saved mapping of import file columns to fields, reused when importing records of the same entity. |
Lead | Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. |
LeadOppty | Lead or opportunity, with the fields both kinds of sales records share. |
LeadOpptyAccountRelation | Link between a lead or opportunity and an account, marking the primary account. |
LeadOpptyContactGroupRelation | Group of contacts on the org chart of a lead or opportunity. |
LeadOpptyContactRelation | Link between a lead or opportunity and a contact, with the contact's sales roles and org-chart position. |
LeadOpptyContactSalesRoleRelation | Sales role assigned to a contact on a lead or opportunity. |
LeadOpptyKPI | KPI event of a lead or opportunity (e.g. created, qualified, won, lost or moved to another step), used in activity reporting. |
LeadOpptyProjectRelation | Link between a lead or opportunity and a project it is part of. |
LeadOpptySharingClientRelation | Share of a lead or opportunity with an individual user, with the access level granted. |
LeadOpptySharingSalesUnitRelation | Share of a lead or opportunity with a sales unit, with the access level granted. |
LeadOpptyStepCheckListRelation | Completion of a step checklist item on a lead, opportunity or quote, with the activity, email, note or document that fulfils it. |
LeadOpptyType | Lead type or opportunity type, with the settings both kinds of sales record types share. |
LeadProcess | Lead process: the ordered steps that leads of its lead types move through. |
LeadType | Lead type that classifies leads and defines their forms and the lead process they follow. |
MasterRight | User role in the space that defines which features, records and pipelines its users can access. |
Media | Recording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment. |
Memo | Internal message written by a user and linked to records, which other users can comment on. |
MemoComment | Comment a user wrote on a memo. |
Message | Email or memo, with the fields both kinds of messages share. |
MessageRelation | Link between a message (email or memo) and a record such as an account, contact, lead or opportunity. |
MessageSharingClientRelation | Share of a message (email or memo) with an individual user. |
MessageSharingSalesUnitRelation | Share of a message (email or memo) with a sales unit. |
Note | Note a user wrote on a record such as an account, contact, lead, opportunity, project or quote. |
OnlineForm | Submission (response) of an online form, with the answers and the records it created or updated. |
OnlineFormActivityLogLine | One step logged while processing an online form submission. |
OnlineFormDataExRelation | Option selected in a multi-select checkbox field of an online form submission. |
OnlineFormTypeEmailRelation | Email that sent an online form link to a recipient, with the record it was sent on. |
OnlineFormRelation | Link between an online form submission and a record it created or updated. |
OnlineFormType | Online form definition: the fields and settings of a web form whose submissions create or update records. |
OnlineFormStyle | Visual style (colors, fonts, layout) that can be applied to online forms. |
Opportunity | Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. |
OpportunityType | Opportunity type that classifies opportunities and defines their forms (edit, qualify, won and lost). |
OpptyProductRelation | Product line item on an opportunity or quote, with its quantity, price and discount. |
OpptyProductRelationDataExRelation | Option selected in a multi-select checkbox field of a product line item. |
OpptyProductRelationType | Line-item type that defines the form of product line items on opportunities and quotes; paired with a product type. |
OpptyRecurrence | Recurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost. |
OpptyRevenueSchedule | Revenue schedule that splits the value of an opportunity into periods. |
OpptyRevenueSchedulePeriod | One period of an opportunity revenue schedule, with its date and amount. |
OpptyProductRelationRevenueSchedule | Revenue schedule that splits the amount of a product line item into periods. |
OpptyProductRelationRevenueSchedulePeriod | One period of a product line item revenue schedule, with its date and amount. |
Order | Order of a subscription (e.g. a purchase, renewal or license change) with its items, amounts, tax and payment status. |
OrderItem | Line item of an order: a product with its quantity, price and subtotal, and the monthly recurring revenue it adds. |
OrderTempDataItem | Line item of an order that waits for online payment in checkout, with its product, quantity and price. |
OrderHistory | Status change recorded in the history of an order. |
OrderRelatedDocument | Payment confirmation or credit note issued for an order. |
OrderTempData | Order started in checkout that waits for online payment; it becomes a regular order once the payment succeeds. |
Payment | Payment received for an order, with the payment method, the amount paid and the transaction reference. |
PaymentTerm | Payment term of orders, such as immediate payment or payment within a number of days, in a given language. |
PaymentAdditionalData | Instructions given at checkout that are carried out once the order is paid, such as the invoice recipients, new subscription admins and the users to invite after a space reset. |
ParentAccountRelationType | Kind of parent-child relationship between accounts (e.g. parent company and subsidiary), with a label for each side. |
Phone | Phone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company. |
AllowedQuoteType | Quote type that a user role is allowed to use. |
Quote | Price offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process. |
QuoteAccountRelation | Link between a quote and an account, marking the primary account. |
QuoteContactRelation | Link between a quote and a contact, marking the primary contact. |
QuoteDataExRelation | Option selected in a multi-select checkbox field of a quote. |
QuoteKPI | KPI event of a quote (e.g. created, accepted, archived or moved to another step), used in activity reporting. |
QuoteProcess | Quote process: the ordered steps that quotes of its quote types move through. |
QuoteSharingClientRelation | Share of a quote with an individual user, with the access level granted. |
QuoteSharingSalesUnitRelation | Share of a quote with a sales unit, with the access level granted. |
QuoteType | Quote type that classifies quotes and defines their forms and the quote process they follow. |
LeadOpptyDataExRelation | Option selected in a multi-select checkbox field of a lead or opportunity. |
AccountDataExRelation | Option selected in a multi-select checkbox field of an account; there is one link per selected option. |
ContactDataExRelation | Option selected in a multi-select checkbox field of a contact; there is one link per selected option. |
ActivityDataExRelation | Option selected in a multi-select checkbox field of a task or an appointment; there is one link per selected option. |
ProductDataExRelation | Option selected in a multi-select checkbox field of a product. |
ProjectDataExRelation | Option selected in a multi-select checkbox field of a project. |
Pipeline | Sales pipeline: the ordered steps that opportunities of its opportunity types move through. |
Process | Automatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook). |
ProcessActivityLog | One run of an Automatizer process, with its status, timing and the steps it took. |
ProcessActivityLogLine | One step logged in a run of an Automatizer process. |
ProcessScheduledAction | Action of an Automatizer process that is waiting to run for a record at a scheduled time. |
ProcessTemplate | Ready-made Automatizer process offered in the template gallery as a starting point for new processes. |
Solution | Canvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity. |
SolutionTemplate | Ready-made solution offered in the template gallery as a starting point for new solutions. |
ProcessChangeOwnerLog | Round-robin progress of an Automatizer change-owner action, recording which users have already been assigned a record so the next record goes to the next user. |
Product | Product or service in the catalog that can be added as a line item to opportunities and quotes. |
ProductType | Product type that classifies products and defines their form. |
ProductCategory | Category in the hierarchy of the product catalog. |
ProductPipelineRelation | Pipeline in which a product can be added as a line item. |
ProductPriceList | Price list with product prices per currency, applied to opportunities and quotes while it is active. |
ProductPriceListPrice | Price of a product in one currency within a price list. |
Profile | Saved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others. |
ProfileRelation | Record added explicitly to a static saved view (profile). |
ProfileDraft | Unsaved changes a user made to the view of an app screen, kept until they are saved or discarded. |
ProfileSharingClientRelation | Share of a saved view (profile) with an individual user. |
ProfileSharingSalesUnitRelation | Share of a saved view (profile) with a sales unit. |
Project | Project delivered for an account or run internally, with its objectives, activities and progress. |
ProjectKPI | KPI event of a project (its completion), used in activity reporting. |
ProjectContactRelation | Link between a project and a contact, marking the primary contact. |
ProjectObjective | Objective (goal) of a project. |
ProjectType | Project type that classifies projects and defines their form and icon. |
ProjectSharingClientRelation | Share of a project with an individual user, with the access level granted. |
ProjectSharingSalesUnitRelation | Share of a project with a sales unit, with the access level granted. |
Report | Saved report or dashboard with its settings, sharing and delivery schedule. |
ReportFolder | Folder that organizes reports; folders can be nested. |
ReportSharingClientRelation | Share of a report with an individual user, with the access level granted. |
ReportSharingSalesUnitRelation | Share of a report with a sales unit, with the access level granted. |
ReportSchedule | Schedule that emails a report to its recipients at regular intervals. |
RevenueRecognition | Revenue of an opportunity product for one period of its revenue schedule, used in revenue reporting. |
SalesRole | Role a contact plays in a deal (e.g. decision maker), assigned to contacts on leads and opportunities. |
SalesUnit | Sales unit (team) in the organization hierarchy that users belong to. |
SalesUnitClientRelation | Membership of a user in a sales unit, as a member or manager. |
Step | Step of an opportunity pipeline, lead process or quote process that records move through. |
StepChecklist | Checklist item of a pipeline step, such as logging an activity, filling a field or attaching a document. |
StepChecklistSalesRoleRelation | Sales role that a step checklist item is shown to. |
Tag | Label that users attach to records such as accounts, contacts or opportunities to categorize them. |
TagRelation | Assignment of a tag to a record. |
Target | Sales target set for a user or a group of users for a period, measured by a chosen metric. |
TargetRelation | Link between a group target and a user target that rolls up into it. |
Task | Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records. |
TaskRecurrence | Recurrence rule that defines when the next occurrences of a recurring task are created. |
TaskReminder | Reminder a user set to be notified about a task at a given time. |
TaskSharingClientRelation | Share of a task with an individual user, with the access level granted. |
TaskSharingSalesUnitRelation | Share of a task with a sales unit, with the access level granted. |
TaskType | Task type that classifies tasks and defines their form and icon. |
TextMessage | Message sent or received in a text message conversation or in an AI assistant chat. |
TextMessageConversation | Text message conversation between a Coevera phone number and an external phone number. |
TextMessageConversationRelations | Link between a text message conversation and a record such as an account, contact, lead or opportunity. |
Translation | Translation of a field name, dropdown option or form text into the supported languages. |
Type | Data type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped. |
Timeframe | Time a lead or opportunity has spent in a pipeline step. |
UnsubscribedPhone | Phone number that opted out of receiving text messages. |
UseCase | Use case showing how a feature can be used, offered to users in the in-app learning content. |
Webresource | Web page embedded in the app for records of an entity, with its URL filled from the record's field values. |
Webhook | Registered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. |
WebhookEvent | Event a webhook subscribes to; the webhook is called whenever the event occurs. |
Country | Country that can be selected in billing addresses, with its states, sales region and the Coevera supplier that bills customers there. |
TeamSpaceClient | Membership of a user profile in a space. |
CpTeamSpaceClient | Membership of a user in a space, as listed for subscription administrators, who can disable it. |
CpCallLog | Call, text message or transcription made through built-in calling, with its phone numbers, status and cost. |
UserProfile | User account that signs in to Coevera and can be a member of several spaces and subscriptions. |
UserRole | Customer portal role that grants a user rights such as order, subscription, partner and user management. |
TeamSpace | Space of a subscription: a separate Coevera CRM instance with its own users, data and settings. |
TeamSpaceRegion | Hosting region where spaces run, with its address, email domain and whether new trial spaces can be created in it. |
TeamSpaceProperty | Named property of a space, such as its time zone, first day of the week or attachment size limit. |
TeamSpaceClientSetting | Integration settings of a user in a space, such as the connected mailbox and the contact, calendar and task sync with Google, Microsoft 365 or Exchange. |
SapiUser | API user that signs in with a user name and password, as a standard or administrator API user, optionally limited to one space and to allowed source IP addresses. |
CpCalling | Calling credit of a subscription, spent on calls, recordings and AI services such as transcription. |
Subscription | Customer subscription to Coevera: the contract that covers its spaces, licenses, billing and orders. |
SubscriptionRepresentative | Coevera staff member who can be assigned to subscriptions as their sales representative. |
SubscriptionSDR | Coevera staff member who can be assigned to subscriptions as their sales development representative. |
Partner | Partner company (e.g. affiliate, agent or consultant) that refers customer subscriptions and earns commission on their orders. |
Supplier | Company that sells subscriptions and issues orders and invoices, with its legal imprint. |
State | State or province of a country that can be selected in billing addresses. |
AutomationHubApp | App (vendor) in the Automation Hub that provides integrations, with its website and support links. |
AutomationHubCategory | Category that groups items in the Automation Hub. |
AutomationHubItem | Integration or add-on offered in the Automation Hub that can be enabled in a space. |
SubscriptionHubItem | Automation Hub item included in a subscription. |
TeamPipelineHubItem | Automation Hub item installed in a space, with its status and configuration. |
TeamPipelineHubItemBase | Automation Hub item installed in a space, of any integration kind, with its status and configuration. |
HowTo | Help resource (video, article or support link) shown in the app for a feature area, with view statistics. |
Storylane | Interactive product demo offered to users in the in-app learning content. |
ReleaseNote | Release note announcing a product change to users, who can react to it. |
CpClient | User account identified by its sign-in email, with the spaces it is a member of. |
CpProfile | Saved view of a customer portal screen that belongs to a Coevera staff member, with its view settings. |
CpProduct | Product of the Coevera catalog that subscriptions can purchase, such as licenses or add-ons, with its prices in EUR, USD and GBP and its renewal terms. |
PurchasedProduct | Product a subscription has purchased, such as licenses or an add-on, with its quantity, price, status and the period it is active. |
SubscriptionNotification | Notification email sent to the recipients of a subscription under a notification setting, such as a renewal reminder or an overdue payment notice for an order. |
CpActivity | Entry of the customer portal audit trail: an action a user performed, the module it was performed in and the space it concerned. |
ActivityDetail | Detail of a customer portal audit trail entry: the record that was changed, the operation performed and the data before and after the change. |
NotificationSetting | Automatic email notification to customers, sent before a subscription renewal or when an order payment is overdue. |
FormView | Variant 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. |
FormViewSharingClientRelation | Sharing of a form view with a user, as a watcher or an editor. |
FormViewSharingSalesUnitRelation | Sharing of a form view with a sales unit, as a watcher or an editor. |
InterfacePreview | Layout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts. |
SpaceSetting | Space-wide setting stored as a named value, such as the working days, custom entity names or the revenue schedule configuration. |
EntityPermsEnum enum Create, Read, Write, Delete, Ownership, Qualify, … (38 values)
Action a user can perform on a record; instancePermissions returns the ones the current user holds on a given record.
| Value | Description |
|---|---|
Create | Allows creating records of this type. |
Read | Allows viewing the record. |
Write | Allows editing the record. |
Delete | Allows deleting the record. |
Ownership | Allows changing the owner of the record. |
Qualify | Allows qualifying the lead into an opportunity. |
BackToLead | Allows turning the opportunity back into a lead. |
Archive | Allows archiving the account, contact, lead, opportunity or quote. |
Reactivate | Allows reactivating an archived account, contact, lead, opportunity or quote, or a completed or inactive target. |
Release | Allows giving up ownership of the lead or task so that it becomes unassigned. |
Restore | Allows restoring the deleted record. |
Invitee | Allows the current user, as an invitee, to respond to the appointment invitation. |
Move | Allows moving the lead, opportunity or quote to a different step. |
Copy | Allows creating a copy of the record. |
ChangePipeline | Allows moving the opportunity to a different pipeline. |
ChangeLeadProcess | Allows moving the lead to a different lead process. |
ChangeQuoteProcess | Allows moving the quote to a different quote process. |
Call | Allows placing a call from the record through the calling integration. |
UnitMembership | Legacy value; no longer used. |
UserAndRoles | Legacy value; no longer used. |
ApiAdmin | Allows administrative operations reserved for administrative API accounts. |
StepDocuments | Allows managing the documents attached to the pipeline step. |
Merge | Allows merging duplicate records into this record. |
Take | Allows taking ownership of the unassigned lead or task. |
AdminSetAutomationHub | Legacy value; no longer used. |
AdminAutomationHub | Legacy value; no longer used. |
Complete | Allows marking the project or target as completed. |
Reopen | Allows reopening the completed project. |
ManageUserData | Allows transferring or deleting the reports, profiles, form views, email templates and import templates of the deactivated user. |
ReadCopy | Allows reading the parts of the email template needed to use it, for example in a process or email sequence, without full read access. |
ContentRead | Allows reading the body of the email. |
ContentOwnership | Allows changing who can read the body of the email. |
RespondToApproval | Allows the current user, as a pending approver, to approve or reject the approval request. |
DelegateApproval | Allows the current user, as a pending approver, to delegate the approval request to another user. |
ResubmitApproval | Allows resubmitting a rejected approval request. |
CancelApproval | Allows cancelling the approval request. |
ReassignClient | Allows reassigning the user seat to a different person by email address. |
ResetPasswordClient | Allows resetting the password of the user. |
EntityRepository object 5 fields: getById, getByIds, getAll, …
Read operations for Entity records.
| Field | Type | Description |
|---|---|---|
getById | EntityEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EntityEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EntityEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EntityEntityConnection (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. |
EntityRepositoryRegistry object 219 fields: account, accountDataExRelation, accountKpi, …
Entry point for reading records; each field holds the read operations of one entity.
| Field | Type | Description |
|---|---|---|
account | AccountRepository | Read operations for Account records. |
accountDataExRelation | AccountDataExRelationRepository | Read operations for AccountDataExRelation records. |
accountKpi | AccountKPIRepository | Read operations for AccountKPI records. |
accountProductPricing | AccountProductPricingRepository | Read operations for AccountProductPricing records. |
accountRelation | AccountRelationRepository | Read operations for AccountRelation records. |
accountRelationLabel | AccountRelationLabelRepository | Read operations for AccountRelationLabel records. |
accountRelationType | AccountRelationTypeRepository | Read operations for AccountRelationType records. |
accountRole | AccountRoleRepository | Read operations for AccountRole records. |
accountSharingClientRelation | AccountSharingClientRelationRepository | Read operations for AccountSharingClientRelation records. |
accountSharingSalesUnitRelation | AccountSharingSalesUnitRelationRepository | Read operations for AccountSharingSalesUnitRelation records. |
accountSocialRelation | AccountSocialRelationRepository | Read operations for AccountSocialRelation records. |
accountType | AccountTypeRepository | Read operations for AccountType records. |
activity | ActivityRepository | Read operations for Activity records. |
activityComment | ActivityCommentRepository | Read operations for ActivityComment records. |
activityDataExRelation | ActivityDataExRelationRepository | Read operations for ActivityDataExRelation records. |
activityKpi | ActivityKPIRepository | Read operations for ActivityKPI records. |
activityRelation | ActivityRelationRepository | Read operations for ActivityRelation records. |
allowedAccountType | AllowedAccountTypeRepository | Read operations for AllowedAccountType records. |
allowedAppointmentType | AllowedAppointmentTypeRepository | Read operations for AllowedAppointmentType records. |
allowedCompanyEmail | AllowedCompanyEmailRepository | Read operations for AllowedCompanyEmail records. |
allowedCompanyPhone | AllowedCompanyPhoneRepository | Read operations for AllowedCompanyPhone records. |
allowedContactType | AllowedContactTypeRepository | Read operations for AllowedContactType records. |
allowedLeadType | AllowedLeadTypeRepository | Read operations for AllowedLeadType records. |
allowedPipeline | AllowedPipelineRepository | Read operations for AllowedPipeline records. |
allowedQuoteType | AllowedQuoteTypeRepository | Read operations for AllowedQuoteType records. |
allowedTaskType | AllowedTaskTypeRepository | Read operations for AllowedTaskType records. |
apiAccess | ApiAccessRepository | Read operations for ApiAccess records. |
application | ApplicationRepository | Read operations for Application records. |
appointment | AppointmentRepository | Read operations for Appointment records. |
appointmentClientInviteesRelation | AppointmentClientInviteesRelationRepository | Read operations for AppointmentClientInviteesRelation records. |
appointmentContactInviteesRelation | AppointmentContactInviteesRelationRepository | Read operations for AppointmentContactInviteesRelation records. |
appointmentReminder | AppointmentReminderRepository | Read operations for AppointmentReminder records. |
appointmentSchedule | AppointmentScheduleRepository | Read operations for AppointmentSchedule records. |
appointmentType | AppointmentTypeRepository | Read operations for AppointmentType records. |
approval | ApprovalRepository | Read operations for Approval records. |
approvalApprover | ApprovalApproverRepository | Read operations for ApprovalApprover records. |
approvalProcess | ApprovalProcessRepository | Read operations for ApprovalProcess records. |
approvalProcessActivityLogLine | ApprovalProcessActivityLogLineRepository | Read operations for ApprovalProcessActivityLogLine records. |
call | CallRepository | Read operations for Call records. |
chatConversation | ChatConversationRepository | Read operations for ChatConversation records. |
client | ClientRepository | Read operations for Client records. |
clientExcludedOppty | ClientExcludedOpptyRepository | Read operations for ClientExcludedOppty records. |
clientFavorite | ClientFavoriteRepository | Read operations for ClientFavorite records. |
clientSetting | ClientSettingRepository | Read operations for ClientSetting records. |
clientStoryRead | ClientStoryReadRepository | Read operations for ClientStoryRead records. |
cloudObject | CloudObjectRepository | Read operations for CloudObject records. |
cloudObjectFolder | CloudObjectFolderRepository | Read operations for CloudObjectFolder records. |
cloudObjectRelation | CloudObjectRelationRepository | Read operations for CloudObjectRelation records. |
cloudObjectStepRelation | CloudObjectStepRelationRepository | Read operations for CloudObjectStepRelation records. |
cloudObjectTemplate | CloudObjectTemplateRepository | Read operations for CloudObjectTemplate records. |
companyEmail | CompanyEmailRepository | Read operations for CompanyEmail records. |
contact | ContactRepository | Read operations for Contact records. |
contactAccountAccountRoleRelation | ContactAccountAccountRoleRelationRepository | Read operations for ContactAccountAccountRoleRelation records. |
contactAccountRelation | ContactAccountRelationRepository | Read operations for ContactAccountRelation records. |
contactDataExRelation | ContactDataExRelationRepository | Read operations for ContactDataExRelation records. |
contactKpi | ContactKPIRepository | Read operations for ContactKPI records. |
contactRelation | ContactRelationRepository | Read operations for ContactRelation records. |
contactRelationLabel | ContactRelationLabelRepository | Read operations for ContactRelationLabel records. |
contactRelationType | ContactRelationTypeRepository | Read operations for ContactRelationType records. |
contactSharingClientRelation | ContactSharingClientRelationRepository | Read operations for ContactSharingClientRelation records. |
contactSharingSalesUnitRelation | ContactSharingSalesUnitRelationRepository | Read operations for ContactSharingSalesUnitRelation records. |
contactSocialRelation | ContactSocialRelationRepository | Read operations for ContactSocialRelation records. |
contactType | ContactTypeRepository | Read operations for ContactType records. |
countryCrm | CountryCrmRepository | Read operations for CountryCrm records. |
currency | CurrencyRepository | Read operations for Currency records. |
currencyExchangeRate | CurrencyExchangeRateRepository | Read operations for CurrencyExchangeRate records. |
currencyExchangeRatesList | CurrencyExchangeRatesListRepository | Read operations for CurrencyExchangeRatesList records. |
customEntity | CustomEntityRepository (1 args) | Read operations for CustomEntity records. |
customEntityDataExRelation | CustomEntityDataExRelationRepository | Read operations for CustomEntityDataExRelation records. |
customEntityRelation | CustomEntityRelationRepository | Read operations for CustomEntityRelation records. |
customEntityRelationData | CustomEntityRelationDataRepository | Read operations for CustomEntityRelationData records. |
customEntitySharingClientRelation | CustomEntitySharingClientRelationRepository | Read operations for CustomEntitySharingClientRelation records. |
customEntitySharingSalesUnitRelation | CustomEntitySharingSalesUnitRelationRepository | Read operations for CustomEntitySharingSalesUnitRelation records. |
customEntityType | CustomEntityTypeRepository (1 args) | Read operations for CustomEntityType records. |
data | DataRepository | Read operations for Data records. |
email | EmailRepository | Read operations for Email records. |
emailContentSharingClientRelation | EmailContentSharingClientRelationRepository | Read operations for EmailContentSharingClientRelation records. |
emailContentSharingSalesUnitRelation | EmailContentSharingSalesUnitRelationRepository | Read operations for EmailContentSharingSalesUnitRelation records. |
emailEvent | EmailEventRepository | Read operations for EmailEvent records. |
emailLabel | EmailLabelRepository | Read operations for EmailLabel records. |
emailLabelRelation | EmailLabelRelationRepository | Read operations for EmailLabelRelation records. |
emailMailboxRelation | EmailMailboxRelationRepository | Read operations for EmailMailboxRelation records. |
emailSequence | EmailSequenceRepository | Read operations for EmailSequence records. |
emailSequenceActivityLog | EmailSequenceActivityLogRepository | Read operations for EmailSequenceActivityLog records. |
emailSequenceActivityLogLine | EmailSequenceActivityLogLineRepository | Read operations for EmailSequenceActivityLogLine records. |
emailSequenceEnrolled | EmailSequenceEnrolledRepository | Read operations for EmailSequenceEnrolled records. |
emailTemplate | EmailTemplateRepository | Read operations for EmailTemplate records. |
emailTemplateFolder | EmailTemplateFolderRepository | Read operations for EmailTemplateFolder records. |
emailTemplateSharingClientRelation | EmailTemplateSharingClientRelationRepository | Read operations for EmailTemplateSharingClientRelation records. |
emailTemplateSharingSalesUnitRelation | EmailTemplateSharingSalesUnitRelationRepository | Read operations for EmailTemplateSharingSalesUnitRelation records. |
emailThreadMailboxClientReadState | EmailThreadMailboxClientReadStateRepository | Read operations for EmailThreadMailboxClientReadState records. |
entity | EntityRepository | Read operations for Entity records. |
entityFitness | EntityFitnessRepository | Read operations for EntityFitness records. |
entityFitnessIndicator | EntityFitnessIndicatorRepository | Read operations for EntityFitnessIndicator records. |
entityHealth | EntityHealthRepository | Read operations for EntityHealth records. |
entityScoring | EntityScoringRepository | Read operations for EntityScoring records. |
entitySettings | EntitySettingsRepository | Read operations for EntitySettings records. |
field | FieldRepository | Read operations for Field records. |
fieldMapping | FieldMappingRepository | Read operations for FieldMapping records. |
fieldPermission | FieldPermissionRepository | Read operations for FieldPermission records. |
fieldSequence | FieldSequenceRepository | Read operations for FieldSequence records. |
forecast | ForecastRepository | Read operations for Forecast records. |
formView | FormViewRepository | Read operations for FormView records. |
formViewSharingClientRelation | FormViewSharingClientRelationRepository | Read operations for FormViewSharingClientRelation records. |
formViewSharingSalesUnitRelation | FormViewSharingSalesUnitRelationRepository | Read operations for FormViewSharingSalesUnitRelation records. |
ghostContact | GhostContactRepository | Read operations for GhostContact records. |
ghostContactAccountAccountRoleRelation | GhostContactAccountAccountRoleRelationRepository | Read operations for GhostContactAccountAccountRoleRelation records. |
ghostContactAccountRelation | GhostContactAccountRelationRepository | Read operations for GhostContactAccountRelation records. |
ghostLeadOpptyContactRelation | GhostLeadOpptyContactRelationRepository | Read operations for GhostLeadOpptyContactRelation records. |
ghostLeadOpptyContactSalesRoleRelation | GhostLeadOpptyContactSalesRoleRelationRepository | Read operations for GhostLeadOpptyContactSalesRoleRelation records. |
importMappingMask | ImportMappingMaskRepository | Read operations for ImportMappingMask records. |
interfacePreview | InterfacePreviewRepository | Read operations for InterfacePreview records. |
lead | LeadRepository | Read operations for Lead records. |
leadOppty | LeadOpptyRepository | Read operations for LeadOppty records. |
leadOpptyAccountRelation | LeadOpptyAccountRelationRepository | Read operations for LeadOpptyAccountRelation records. |
leadOpptyContactGroupRelation | LeadOpptyContactGroupRelationRepository | Read operations for LeadOpptyContactGroupRelation records. |
leadOpptyContactRelation | LeadOpptyContactRelationRepository | Read operations for LeadOpptyContactRelation records. |
leadOpptyContactSalesRoleRelation | LeadOpptyContactSalesRoleRelationRepository | Read operations for LeadOpptyContactSalesRoleRelation records. |
leadOpptyDataExRelation | LeadOpptyDataExRelationRepository | Read operations for LeadOpptyDataExRelation records. |
leadOpptyKpi | LeadOpptyKPIRepository | Read operations for LeadOpptyKPI records. |
leadOpptySharingClientRelation | LeadOpptySharingClientRelationRepository | Read operations for LeadOpptySharingClientRelation records. |
leadOpptySharingSalesUnitRelation | LeadOpptySharingSalesUnitRelationRepository | Read operations for LeadOpptySharingSalesUnitRelation records. |
leadOpptyStepCheckListRelation | LeadOpptyStepCheckListRelationRepository | Read operations for LeadOpptyStepCheckListRelation records. |
leadProcess | LeadProcessRepository | Read operations for LeadProcess records. |
leadType | LeadTypeRepository | Read operations for LeadType records. |
masterRight | MasterRightRepository | Read operations for MasterRight records. |
media | MediaRepository | Read operations for Media records. |
memo | MemoRepository | Read operations for Memo records. |
memoComment | MemoCommentRepository | Read operations for MemoComment records. |
messageRelation | MessageRelationRepository | Read operations for MessageRelation records. |
messageSharingClientRelation | MessageSharingClientRelationRepository | Read operations for MessageSharingClientRelation records. |
messageSharingSalesUnitRelation | MessageSharingSalesUnitRelationRepository | Read operations for MessageSharingSalesUnitRelation records. |
note | NoteRepository | Read operations for Note records. |
onlineForm | OnlineFormRepository | Read operations for OnlineForm records. |
onlineFormActivityLogLine | OnlineFormActivityLogLineRepository | Read operations for OnlineFormActivityLogLine records. |
onlineFormDataExRelation | OnlineFormDataExRelationRepository | Read operations for OnlineFormDataExRelation records. |
onlineFormRelation | OnlineFormRelationRepository | Read operations for OnlineFormRelation records. |
onlineFormStyle | OnlineFormStyleRepository | Read operations for OnlineFormStyle records. |
onlineFormType | OnlineFormTypeRepository | Read operations for OnlineFormType records. |
onlineFormTypeEmailRelation | OnlineFormTypeEmailRelationRepository | Read operations for OnlineFormTypeEmailRelation records. |
opportunity | OpportunityRepository | Read operations for Opportunity records. |
opportunityType | OpportunityTypeRepository | Read operations for OpportunityType records. |
opptyProductRelation | OpptyProductRelationRepository | Read operations for OpptyProductRelation records. |
opptyProductRelationDataExRelation | OpptyProductRelationDataExRelationRepository | Read operations for OpptyProductRelationDataExRelation records. |
opptyProductRelationRevenueSchedule | OpptyProductRelationRevenueScheduleRepository | Read operations for OpptyProductRelationRevenueSchedule records. |
opptyProductRelationRevenueSchedulePeriod | OpptyProductRelationRevenueSchedulePeriodRepository | Read operations for OpptyProductRelationRevenueSchedulePeriod records. |
opptyProductRelationType | OpptyProductRelationTypeRepository | Read operations for OpptyProductRelationType records. |
opptyRecurrence | OpptyRecurrenceRepository | Read operations for OpptyRecurrence records. |
opptyRevenueSchedule | OpptyRevenueScheduleRepository | Read operations for OpptyRevenueSchedule records. |
opptyRevenueSchedulePeriod | OpptyRevenueSchedulePeriodRepository | Read operations for OpptyRevenueSchedulePeriod records. |
parentAccountRelationType | ParentAccountRelationTypeRepository | Read operations for ParentAccountRelationType records. |
phone | PhoneRepository | Read operations for Phone records. |
pipeline | PipelineRepository | Read operations for Pipeline records. |
process | ProcessRepository | Read operations for Process records. |
processActivityLog | ProcessActivityLogRepository | Read operations for ProcessActivityLog records. |
processActivityLogLine | ProcessActivityLogLineRepository | Read operations for ProcessActivityLogLine records. |
processScheduledAction | ProcessScheduledActionRepository | Read operations for ProcessScheduledAction records. |
processTemplate | ProcessTemplateRepository | Read operations for ProcessTemplate records. |
product | ProductRepository | Read operations for Product records. |
productCategory | ProductCategoryRepository | Read operations for ProductCategory records. |
productDataExRelation | ProductDataExRelationRepository | Read operations for ProductDataExRelation records. |
productPipelineRelation | ProductPipelineRelationRepository | Read operations for ProductPipelineRelation records. |
productPriceList | ProductPriceListRepository | Read operations for ProductPriceList records. |
productPriceListPrice | ProductPriceListPriceRepository | Read operations for ProductPriceListPrice records. |
productType | ProductTypeRepository | Read operations for ProductType records. |
profile | ProfileRepository | Read operations for Profile records. |
profileRelation | ProfileRelationRepository | Read operations for ProfileRelation records. |
profileSharingClientRelation | ProfileSharingClientRelationRepository | Read operations for ProfileSharingClientRelation records. |
profileSharingSalesUnitRelation | ProfileSharingSalesUnitRelationRepository | Read operations for ProfileSharingSalesUnitRelation records. |
project | ProjectRepository | Read operations for Project records. |
projectContactRelation | ProjectContactRelationRepository | Read operations for ProjectContactRelation records. |
projectDataExRelation | ProjectDataExRelationRepository | Read operations for ProjectDataExRelation records. |
projectKpi | ProjectKPIRepository | Read operations for ProjectKPI records. |
projectObjective | ProjectObjectiveRepository | Read operations for ProjectObjective records. |
projectSharingClientRelation | ProjectSharingClientRelationRepository | Read operations for ProjectSharingClientRelation records. |
projectSharingSalesUnitRelation | ProjectSharingSalesUnitRelationRepository | Read operations for ProjectSharingSalesUnitRelation records. |
projectType | ProjectTypeRepository | Read operations for ProjectType records. |
quote | QuoteRepository | Read operations for Quote records. |
quoteAccountRelation | QuoteAccountRelationRepository | Read operations for QuoteAccountRelation records. |
quoteContactRelation | QuoteContactRelationRepository | Read operations for QuoteContactRelation records. |
quoteDataExRelation | QuoteDataExRelationRepository | Read operations for QuoteDataExRelation records. |
quoteKpi | QuoteKPIRepository | Read operations for QuoteKPI records. |
quoteProcess | QuoteProcessRepository | Read operations for QuoteProcess records. |
quoteSharingClientRelation | QuoteSharingClientRelationRepository | Read operations for QuoteSharingClientRelation records. |
quoteSharingSalesUnitRelation | QuoteSharingSalesUnitRelationRepository | Read operations for QuoteSharingSalesUnitRelation records. |
quoteType | QuoteTypeRepository | Read operations for QuoteType records. |
report | ReportRepository | Read operations for Report records. |
reportFolder | ReportFolderRepository | Read operations for ReportFolder records. |
reportSchedule | ReportScheduleRepository | Read operations for ReportSchedule records. |
reportSharingClientRelation | ReportSharingClientRelationRepository | Read operations for ReportSharingClientRelation records. |
reportSharingSalesUnitRelation | ReportSharingSalesUnitRelationRepository | Read operations for ReportSharingSalesUnitRelation records. |
salesRole | SalesRoleRepository | Read operations for SalesRole records. |
salesUnit | SalesUnitRepository | Read operations for SalesUnit records. |
salesUnitClientRelation | SalesUnitClientRelationRepository | Read operations for SalesUnitClientRelation records. |
solution | SolutionRepository | Read operations for Solution records. |
solutionTemplate | SolutionTemplateRepository | Read operations for SolutionTemplate records. |
step | StepRepository | Read operations for Step records. |
stepChecklist | StepChecklistRepository | Read operations for StepChecklist records. |
stepChecklistSalesRoleRelation | StepChecklistSalesRoleRelationRepository | Read operations for StepChecklistSalesRoleRelation records. |
tag | TagRepository | Read operations for Tag records. |
tagRelation | TagRelationRepository | Read operations for TagRelation records. |
target | TargetRepository | Read operations for Target records. |
targetRelation | TargetRelationRepository | Read operations for TargetRelation records. |
task | TaskRepository | Read operations for Task records. |
taskRecurrence | TaskRecurrenceRepository | Read operations for TaskRecurrence records. |
taskReminder | TaskReminderRepository | Read operations for TaskReminder records. |
taskSharingClientRelation | TaskSharingClientRelationRepository | Read operations for TaskSharingClientRelation records. |
taskSharingSalesUnitRelation | TaskSharingSalesUnitRelationRepository | Read operations for TaskSharingSalesUnitRelation records. |
taskType | TaskTypeRepository | Read operations for TaskType records. |
textMessage | TextMessageRepository | Read operations for TextMessage records. |
textMessageConversation | TextMessageConversationRepository | Read operations for TextMessageConversation records. |
textMessageConversationRelations | TextMessageConversationRelationsRepository | Read operations for TextMessageConversationRelations records. |
timeframe | TimeframeRepository | Read operations for Timeframe records. |
translation | TranslationRepository | Read operations for Translation records. |
type | TypeRepository | Read operations for Type records. |
unsubscribedPhone | UnsubscribedPhoneRepository | Read operations for UnsubscribedPhone records. |
webhook | WebhookRepository | Read operations for Webhook records. |
webhookEvent | WebhookEventRepository | Read operations for WebhookEvent records. |
webresource | WebresourceRepository | Read operations for Webresource records. |
EntityScoringCategory object 5 fields: id, label, useLang, …
Score category of a scoring, such as Hot, Warm or Cold, with its threshold and color.
| Field | Type | Description |
|---|---|---|
id | UUID! | Unique identifier of the scoring category. |
label | String! | Display name of the scoring category (for example Hot, Warm, Cold). |
useLang | Boolean! | When true, the label is treated as a translation key and localized in the UI; otherwise the literal label text is shown. |
value | Int! | Upper score threshold of this category. A record falls into the category whose threshold its accumulated score does not exceed. |
color | Int! | Color used to render this category in the UI, encoded as an integer. |
EntityScoringRepository object 7 fields: getById, getByIds, getAll, …
Read operations for EntityScoring records.
| Field | Type | Description |
|---|---|---|
getById | EntityScoringEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EntityScoringEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EntityScoringEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | EntityScoringEntityConnection (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. |
getRecalculationStatus | EntityScoringRecalculationStatus! (1 args) | Returns the progress of the score recalculation for the given record type and when scores were last recalculated. Both values are null when no scoring is enabled for the type. |
getByEntityType | [EntityScoringEntity!]! (1 args) | Returns the scoring definitions for the given record type, in their configured order. |
EntityScoringSettingsJSONString scalar scalar
JSON object, sent as a string, conforming to the EntityScoringSettings type.
EntitySettingsRepository object 8 fields: getById, getByIds, getAll, …
Read operations for EntitySettings records.
| Field | Type | Description |
|---|---|---|
getById | EntitySettingsEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [EntitySettingsEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [EntitySettingsEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [EntitySettingsEntity!]! (3 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [EntitySettingsEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [EntitySettingsEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | EntitySettingsEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
getForEntity | EntitySettingsEntity (2 args) | Returns the settings of the given record type (e.g. list and detail layout options). |
EntityTypeFieldMappingJSONString scalar scalar
JSON object, sent as a string, conforming to the EntityTypeFieldMapping type.
EntityTypeSettings object allowedTaskTypeIds: [ID!], allowedAppointmentTypeIds: [ID!]
Settings of a record type, such as the task and appointment types its records may use.
| Field | Type | Description |
|---|---|---|
allowedTaskTypeIds | [ID!] | Task type ids that may be linked to records of this entity type. Empty or null allows all task types. |
allowedAppointmentTypeIds | [ID!] | Appointment type ids that may be linked to records of this entity type. Empty or null allows all appointment types. |
EventEnum enum All, LeadAll, LeadCreate, LeadUpdate, LeadDelete, LeadBackToLead, … (138 values)
Webhook event a webhook subscribes to, named <Entity><Action>; deliveries report it in the Entity.Action form (for example Lead.Create), and the *All values subscribe to every event of their entity.
| Value | Description |
|---|---|
All | Subscribes to every event of every entity in this list. |
LeadAll | Subscribes to every lead event: LeadCreate, LeadUpdate, LeadDelete, LeadBackToLead, LeadOwnerChanged, LeadDocumentLinked and LeadLost. |
LeadCreate | Fires when a lead is created. |
LeadUpdate | Fires when a lead is updated. |
LeadDelete | Fires when a lead is deleted. |
LeadBackToLead | Fires when an opportunity is moved back to a lead; the event carries the resulting lead. |
LeadOwnerChanged | Fires when the owner of a lead changes, including when it is created with an owner other than the user who created it. |
LeadDocumentLinked | Fires when a document is linked to a lead; the event includes the document as the related entity. |
LeadLost | Fires when a lead is archived as lost. |
OpportunityAll | Subscribes to every opportunity event: OpportunityCreate, OpportunityUpdate, OpportunityDelete, OpportunityMove, OpportunityQualify, OpportunityOwnerChanged, OpportunityDocumentLinked, OpportunityWon and OpportunityLost. |
OpportunityCreate | Fires when an opportunity is created. |
OpportunityUpdate | Fires when an opportunity is updated. |
OpportunityDelete | Fires when an opportunity is deleted. |
OpportunityMove | Fires when an opportunity moves to a different sales step; winning an opportunity also raises this event. |
OpportunityQualify | Fires when a lead is qualified into an opportunity; the event carries the new opportunity. |
OpportunityOwnerChanged | Fires when the owner of an opportunity changes, including when it is created with an owner other than the user who created it. |
OpportunityDocumentLinked | Fires when a document is linked to an opportunity; the event includes the document as the related entity. |
OpportunityWon | Fires when an opportunity is created in or moved to the won step of its pipeline. |
OpportunityLost | Fires when an opportunity is archived as lost without reaching the won step. |
ContactAll | Subscribes to every contact event: ContactCreate, ContactUpdate, ContactDelete, ContactOwnerChanged and ContactDocumentLinked. |
ContactCreate | Fires when a contact is created. |
ContactUpdate | Fires when a contact is updated. |
ContactDelete | Fires when a contact is deleted. |
ContactOwnerChanged | Fires when the owner of a contact changes, including when it is created with an owner other than the user who created it. |
ContactDocumentLinked | Fires when a document is linked to a contact; the event includes the document as the related entity. |
AccountAll | Subscribes to every account event: AccountCreate, AccountUpdate, AccountDelete, AccountOwnerChanged and AccountDocumentLinked. |
AccountCreate | Fires when an account is created. |
AccountUpdate | Fires when an account is updated. |
AccountDelete | Fires when an account is deleted. |
AccountOwnerChanged | Fires when the owner of an account changes, including when it is created with an owner other than the user who created it. |
AccountDocumentLinked | Fires when a document is linked to an account; the event includes the document as the related entity. |
TaskAll | Subscribes to every task event: TaskCreate, TaskUpdate, TaskDelete, TaskOwnerChanged, TaskDocumentLinked and TaskComment. |
TaskCreate | Fires when a task is created. |
TaskUpdate | Fires when a task is updated. |
TaskDelete | Fires when a task is deleted. |
TaskOwnerChanged | Fires when the owner of a task changes, including when it is created with an owner other than the user who created it. |
TaskDocumentLinked | Fires when a document is linked to a task; the event includes the document as the related entity. |
TaskComment | Fires when a comment is added to a task. |
AppointmentAll | Subscribes to every appointment event: AppointmentCreate, AppointmentUpdate, AppointmentDelete, AppointmentOwnerChanged, AppointmentDocumentLinked and AppointmentComment. |
AppointmentCreate | Fires when an appointment is created. |
AppointmentUpdate | Fires when an appointment is updated. |
AppointmentDelete | Fires when an appointment is deleted. |
AppointmentOwnerChanged | Fires when the owner of an appointment changes, including when it is created with an owner other than the user who created it. |
AppointmentDocumentLinked | Fires when a document is linked to an appointment; the event includes the document as the related entity. |
AppointmentComment | Fires when a comment is added to an appointment. |
MessageAll | Legacy subscription to all message events; memo and email changes are delivered as Memo and Email events instead. |
MessageCreate | Legacy event that is no longer raised; use MemoCreate or EmailCreate instead. |
MessageUpdate | Legacy event that is no longer raised; use MemoUpdate or EmailUpdate instead. |
MessageDelete | Legacy event that is no longer raised; use MemoDelete or EmailDelete instead. |
MessageDocumentLinked | Legacy event that is no longer raised; use MemoDocumentLinked or EmailDocumentLinked instead. |
MemoAll | Subscribes to every memo event: MemoCreate, MemoUpdate, MemoDelete, MemoDocumentLinked and MemoComment. |
MemoCreate | Fires when a memo is created. |
MemoUpdate | Fires when a memo is updated. |
MemoDelete | Fires when a memo is deleted. |
MemoDocumentLinked | Fires when a document is linked to a memo; the event includes the document as the related entity. |
MemoComment | Fires when a comment is added to a memo. |
EmailAll | Subscribes to every email event: EmailCreate, EmailUpdate, EmailDelete and EmailDocumentLinked. |
EmailCreate | Fires when an email is created. |
EmailUpdate | Fires when an email is updated. |
EmailDelete | Fires when an email is deleted. |
EmailDocumentLinked | Fires when a document is linked to an email; the event includes the document as the related entity. |
OpptyProductRelationAll | Subscribes to every opportunity product line event: OpptyProductRelationCreate, OpptyProductRelationUpdate and OpptyProductRelationDelete. |
OpptyProductRelationCreate | Fires when a product line of an opportunity is created. |
OpptyProductRelationUpdate | Fires when a product line of an opportunity is updated. |
OpptyProductRelationDelete | Fires when a product line of an opportunity is deleted. |
ProjectAll | Subscribes to every project event: ProjectCreate, ProjectUpdate, ProjectDelete, ProjectOwnerChanged and ProjectDocumentLinked. |
ProjectCreate | Fires when a project is created. |
ProjectUpdate | Fires when a project is updated. |
ProjectDelete | Fires when a project is deleted. |
ProjectOwnerChanged | Fires when the owner of a project changes, including when it is created with an owner other than the user who created it. |
ProjectDocumentLinked | Fires when a document is linked to a project; the event includes the document as the related entity. |
QuoteAll | Subscribes to every quote event: QuoteCreate, QuoteUpdate, QuoteDelete, QuoteOwnerChanged, QuoteDocumentLinked, QuoteMove, QuoteWon and QuoteLost. |
QuoteCreate | Fires when a quote is created. |
QuoteUpdate | Fires when a quote is updated. |
QuoteDelete | Fires when a quote is deleted. |
QuoteOwnerChanged | Fires when the owner of a quote changes, including when it is created with an owner other than the user who created it. |
QuoteDocumentLinked | Fires when a document is linked to a quote; the event includes the document as the related entity. |
QuoteMove | Fires when a quote moves to a different step of its quote process; winning a quote also raises this event. |
QuoteWon | Fires when a quote is created in or moved to the won (accepted) step of its quote process. |
QuoteLost | Fires when a quote is archived as lost without reaching the won step. |
CustomEntityAll | Subscribes to every custom entity event: CustomEntityCreate, CustomEntityUpdate, CustomEntityDelete, CustomEntityOwnerChanged and CustomEntityDocumentLinked. |
CustomEntityCreate | Fires when a custom entity record is created. |
CustomEntityUpdate | Fires when a custom entity record is updated. |
CustomEntityDelete | Fires when a custom entity record is deleted. |
CustomEntityOwnerChanged | Fires when the owner of a custom entity record changes, including when it is created with an owner other than the user who created it. |
CustomEntityDocumentLinked | Fires when a document is linked to a custom entity record; the event includes the document as the related entity. |
ContactAccountRelationAll | Subscribes to every contact-account link event: ContactAccountRelationCreate, ContactAccountRelationUpdate and ContactAccountRelationDelete. |
ContactAccountRelationCreate | Fires when a contact is linked to an account. |
ContactAccountRelationUpdate | Fires when the link between a contact and an account is updated. |
ContactAccountRelationDelete | Fires when a contact is unlinked from an account. |
LeadOpptyAccountRelationAll | Subscribes to every lead/opportunity account link event: LeadOpptyAccountRelationCreate, LeadOpptyAccountRelationUpdate and LeadOpptyAccountRelationDelete. |
LeadOpptyAccountRelationCreate | Fires when an account is linked to a lead or opportunity. |
LeadOpptyAccountRelationUpdate | Fires when the link between an account and a lead or opportunity is updated. |
LeadOpptyAccountRelationDelete | Fires when an account is unlinked from a lead or opportunity. |
LeadOpptyContactRelationAll | Subscribes to every lead/opportunity contact link event: LeadOpptyContactRelationCreate, LeadOpptyContactRelationUpdate and LeadOpptyContactRelationDelete. |
LeadOpptyContactRelationCreate | Fires when a contact is linked to a lead or opportunity. |
LeadOpptyContactRelationUpdate | Fires when the link between a contact and a lead or opportunity is updated. |
LeadOpptyContactRelationDelete | Fires when a contact is unlinked from a lead or opportunity. |
ActivityRelationAll | Subscribes to every activity link event: ActivityRelationCreate, ActivityRelationUpdate and ActivityRelationDelete. |
ActivityRelationCreate | Fires when a task or appointment is linked to a record. |
ActivityRelationUpdate | Fires when the link between a task or appointment and a record is updated. |
ActivityRelationDelete | Fires when a task or appointment is unlinked from a record. |
QuoteAccountRelationAll | Subscribes to every quote-account link event: QuoteAccountRelationCreate, QuoteAccountRelationUpdate and QuoteAccountRelationDelete. |
QuoteAccountRelationCreate | Fires when an account is linked to a quote. |
QuoteAccountRelationUpdate | Fires when the link between an account and a quote is updated. |
QuoteAccountRelationDelete | Fires when an account is unlinked from a quote. |
QuoteContactRelationAll | Subscribes to every quote-contact link event: QuoteContactRelationCreate, QuoteContactRelationUpdate and QuoteContactRelationDelete. |
QuoteContactRelationCreate | Fires when a contact is linked to a quote. |
QuoteContactRelationUpdate | Fires when the link between a contact and a quote is updated. |
QuoteContactRelationDelete | Fires when a contact is unlinked from a quote. |
ProductAll | Subscribes to every product event: ProductCreate, ProductUpdate and ProductDelete. |
ProductCreate | Fires when a product is created. |
ProductUpdate | Fires when a product is updated. |
ProductDelete | Fires when a product is deleted. |
NoteAll | Subscribes to every note event: NoteCreate, NoteUpdate and NoteDelete. |
NoteCreate | Fires when a note is created. |
NoteUpdate | Fires when a note is updated. |
NoteDelete | Fires when a note is deleted. |
CurrencyAll | Subscribes to every currency event: CurrencyCreate, CurrencyUpdate and CurrencyDelete. |
CurrencyCreate | Fires when a currency is created. |
CurrencyUpdate | Fires when a currency is updated. |
CurrencyDelete | Fires when a currency is deleted. |
CurrencyExchangeRateAll | Subscribes to every exchange rate event: CurrencyExchangeRateCreate, CurrencyExchangeRateUpdate and CurrencyExchangeRateDelete. |
CurrencyExchangeRateCreate | Fires when an exchange rate is created. |
CurrencyExchangeRateUpdate | Fires when an exchange rate is updated. |
CurrencyExchangeRateDelete | Fires when an exchange rate is deleted. |
CurrencyExchangeRatesListAll | Subscribes to every exchange rate list event: CurrencyExchangeRatesListCreate, CurrencyExchangeRatesListUpdate and CurrencyExchangeRatesListDelete. |
CurrencyExchangeRatesListCreate | Fires when an exchange rate list is created. |
CurrencyExchangeRatesListUpdate | Fires when an exchange rate list is updated. |
CurrencyExchangeRatesListDelete | Fires when an exchange rate list is deleted. |
ProductPriceListAll | Subscribes to every price list event: ProductPriceListCreate, ProductPriceListUpdate and ProductPriceListDelete. |
ProductPriceListCreate | Fires when a price list is created. |
ProductPriceListUpdate | Fires when a price list is updated. |
ProductPriceListDelete | Fires when a price list is deleted. |
ProductPriceListPriceAll | Subscribes to every price list price event: ProductPriceListPriceCreate, ProductPriceListPriceUpdate and ProductPriceListPriceDelete. |
ProductPriceListPriceCreate | Fires when a product price in a price list is created. |
ProductPriceListPriceUpdate | Fires when a product price in a price list is updated. |
ProductPriceListPriceDelete | Fires when a product price in a price list is deleted. |