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

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

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

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

More in the quickstart

GraphQLTypes indexE

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.

FieldTypeDescription
getByIdEmailContentSharingClientRelationEntity (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.
getByCriteriaEmailContentSharingClientRelationEntityConnection (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.

FieldTypeDescription
getByIdEmailContentSharingSalesUnitRelationEntity (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.
getByCriteriaEmailContentSharingSalesUnitRelationEntityConnection (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.

ValueDescription
OutgoingEmailSent from Coevera or by a user's mailbox.
IncomingEmailReceived from another party.
EmailDirectionEnumFilterInput input eq: [EmailDirectionEnum!], NOT: EmailDirectionEnumFilterInput

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

Input fieldTypeDescription
eq[EmailDirectionEnum!]Matches any of the listed values.
NOTEmailDirectionEnumFilterInputMatches values that do not meet this condition.
EmailEventRepository object 5 fields: getById, getByIds, getAll, …

Read operations for EmailEvent records.

FieldTypeDescription
getByIdEmailEventEntity (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 fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
colorOrderByEnumColor the label is displayed with, as a packed RGB integer.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the client who created this label.
parentEmailLabelIdOrderByEnumId of the parent label this one is nested under, or empty for a top-level label.
revisionOrderByEnumRevision when entity was lastly changed.
EmailLabelRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for EmailLabelRelation records.

FieldTypeDescription
getByIdEmailLabelRelationEntity (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.
getByCriteriaEmailLabelRelationEntityConnection (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.

FieldTypeDescription
getByIdEmailLabelEntity (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.
getByCriteriaEmailLabelEntityConnection (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.

FieldTypeDescription
getByIdEmailMailboxRelationEntity (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 fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
bccOrderByEnumComma-separated list of blind-carbon-copy recipients.
bodySummaryOrderByEnumPlain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty.
ccOrderByEnumComma-separated list of carbon-copy recipients.
companyEmailIdOrderByEnumId of the company email used as the From / Reply-To. Empty when sent from the user mailbox.
contentShareModeOrderByEnumHow 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).
contentTypeOrderByEnumMIME content type of the body (e.g. text/html, text/plain).
dateSentOrderByEnumTimestamp the email was sent. Empty for drafts and scheduled emails not yet sent.
directionOrderByEnumDirection of the email (Incoming, Outgoing).
draftParentEmailIdOrderByEnumId of the original email a draft was started from (reply/forward source), or empty for a standalone draft.
errorCodeOrderByEnumNumeric error code recorded when the email failed to send. Zero when no error occurred.
isDraftOrderByEnumTrue when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams.
isTrackedOrderByEnumTrue when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click.
ownerIdOrderByEnumId of the email owner.
parentEmailIdOrderByEnumId of the parent (master) email.
sendAtOrderByEnumTimestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails.
senderOrderByEnumSender address as it appeared on the email (free-text "From" header).
senderAccountIdOrderByEnumId of the matched sender account.
senderClientIdOrderByEnumId of the matched sender user.
senderContactIdOrderByEnumId of the matched sender contact.
sentimentOrderByEnumTone 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.
shareModeOrderByEnumSharing 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.
subjectOrderByEnumName of the entity and its default text representation.
templateIdOrderByEnumId of the email template.
toOrderByEnumComma-separated list of primary recipients.
typeOrderByEnumWhether the email is an individual email (Standard) or part of a mass email (Mass).
revisionOrderByEnumRevision when entity was lastly changed.
EmailRepository object 8 fields: getById, getByIds, getAll, …

Read operations for Email records.

FieldTypeDescription
getByIdEmailEntity (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.
getByCriteriaEmailEntityConnection (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.
getDraftByParentAndMailboxEmailEntity (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.

FieldTypeDescription
getByIdEmailSequenceActivityLogLineEntity (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.
getByCriteriaEmailSequenceActivityLogLineEntityConnection (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 fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
actorIdOrderByEnumId of the user who initiated the run, or empty for runs triggered by automation.
applicationIdOrderByEnumId of the application (e.g. browser, automation, third-party integration) the run was triggered in.
emailSequenceIdOrderByEnumId of the email sequence this activity log belongs to.
endTimeOrderByEnumTimestamp when the run finished. Empty for runs still in progress.
isTestRunOrderByEnumTrue when the run was a dry-run / test execution and did not produce real-side effects.
startTimeOrderByEnumTimestamp when the run started.
statusOrderByEnumOutcome of the run (e.g. Ok, Error, Cancelled).
recordNameOrderByEnumDisplay name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera.
recordEmailOrderByEnumEmail address of the record this run enrolled. Read-only; computed by Coevera.
EmailSequenceActivityLogRepository object 6 fields: getById, getByIds, getAll, …

Read operations for EmailSequenceActivityLog records.

FieldTypeDescription
getByIdEmailSequenceActivityLogEntity (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.
getByCriteriaEmailSequenceActivityLogEntityConnection (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.
getDownloadUrlString! (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.

FieldTypeDescription
getByIdEmailSequenceEnrolledEntity (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.
getByCriteriaEmailSequenceEnrolledEntityConnection (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.

FieldTypeDescription
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.
subjectString!Subject line of the email. May contain personalization tags resolved from the triggered record.
bodyString!HTML body of the email. May contain personalization tags resolved from the triggered record.
emailTemplateIdUUIDEmail template to use for the message. When set, the template supplies the subject and body.
attachments[UUID!]!Stored files attached to the email.
signatureStringSignature appended to the email body.
isHtmlTemplateBooleanTrue when the chosen template is an HTML template rather than a plain-text one.
linkTriggerEntityBooleanWhen true, the sent email is linked to the record that triggered the sequence.
linkRecipientsBooleanWhen true, the sent email is linked to the recipient records it is addressed to.
senderEmailSequenceNodeEmailSender!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.
senderCompanyEmailIdUUIDCompany email account used as the sender when the sender is set to CompanyEmail.
shareModeShareModeEnumSharing 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.

ValueDescription
ActorEmailThe user who enrolled the record.
CompanyEmailA shared company email account.
RecordOwnerEmailThe 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 fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
deactivationReasonOrderByEnumReason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only.
descriptionOrderByEnumFree-form description of the sequence.
isEnabledOrderByEnumMaster switch for the sequence. Read-only on this surface — change it via the enable / disable mutations.
lastSchemaChangeOrderByEnumTimestamp of the most recent change to settings. Read-only.
lastStatusChangeOrderByEnumTimestamp of the most recent change to isEnabled. Read-only.
nameOrderByEnumDisplay name of the email sequence.
ownerIdOrderByEnumId of the email sequence owner.
typeOrderByEnumProcess category of the sequence (e.g. EmailSequence vs other process types).
statusOrderByEnumEffective 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.
lastEmailSequenceRunOrderByEnumTimestamp the sequence last produced a run (delivered or attempted a step).
clickRateOrderByEnumFraction of delivered emails (0–1) where at least one tracked link was clicked.
bounceRateOrderByEnumFraction of sent emails (0–1) that bounced (the recipient mailserver rejected them).
openRateOrderByEnumFraction of delivered emails (0–1) that recorded at least one open event.
replyRateOrderByEnumFraction of delivered emails (0–1) where the recipient replied.
unsubscribeRateOrderByEnumFraction of delivered emails (0–1) where the recipient unsubscribed.
createdCountOrderByEnumTotal number of emails produced (queued) by the sequence across all steps.
sentCountOrderByEnumTotal number of emails actually delivered by the sequence across all steps.
enrollCountOrderByEnumNumber of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in this sequence.
solutionsOrderByEnumNames of the solutions whose canvas contains this sequence, in name order. Empty when the sequence is on no solution canvas.
triggerEntityNameOrderByEnumEntity name whose records trigger automatic enrollment into this sequence (e.g. "Lead", "Contact"). Empty when the sequence is manually enrolled only.
triggerFieldIdOrderByEnumId 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.
stepCountOrderByEnumNumber of steps configured in the sequence.
EmailSequenceRepository object 7 fields: getById, getByIds, getAll, …

Read operations for EmailSequence records.

FieldTypeDescription
getByIdEmailSequenceEntity (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.
getByCriteriaEmailSequenceEntityConnection (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.
getByEmailSequenceCriteriaEmailSequenceEntityConnection (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 fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
nameOrderByEnumName of the entity and its default text representation.
parentEmailTemplateFolderIdOrderByEnumId of the parent folder in the template hierarchy. Empty for top-level folders.
revisionOrderByEnumRevision when entity was lastly changed.
EmailTemplateFolderRepository object 5 fields: getById, getByIds, getAll, …

Read operations for EmailTemplateFolder records.

FieldTypeDescription
getByIdEmailTemplateFolderEntity (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.
getByCriteriaEmailTemplateFolderEntityConnection (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 fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
emailTemplateFolderIdOrderByEnumId of the folder the template belongs to. Empty for templates at the root level.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the template owner.
shareModeOrderByEnumSharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all).
sharingUrlIsEnabledOrderByEnumWhen true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs.
subjectOrderByEnumSubject line of emails composed from this template. Supports merge-field placeholders.
typeOrderByEnumTemplate format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate).
revisionOrderByEnumRevision when entity was lastly changed.
solutionsOrderByEnumNames 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.

FieldTypeDescription
getByIdEmailTemplateEntity (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.
getByCriteriaEmailTemplateEntityConnection (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.
previewPersonifiedRecordsByIdEmailTemplatePersonificationResult! (2 args)Assigns properties of a living entity to a non-living template from its id.
previewPersonifiedRecordsEmailTemplatePersonificationResult! (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.
getStatusInProcessStatusInProcessOutput! (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.
getStatusInEmailSequenceStatusInProcessOutput! (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.
convertWysiwygTemplateToHtmlString! (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.

FieldTypeDescription
getByIdEmailTemplateSharingClientRelationEntity (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.
getByCriteriaEmailTemplateSharingClientRelationEntityConnection (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.

FieldTypeDescription
getByIdEmailTemplateSharingSalesUnitRelationEntity (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.
getByCriteriaEmailTemplateSharingSalesUnitRelationEntityConnection (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.

FieldTypeDescription
getByIdEmailThreadMailboxClientReadStateEntity (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.

ValueDescription
StandardIndividual email.
MassMass email sent to many recipients.
EmailTypeEnumFilterInput input eq: [EmailTypeEnum!], NOT: EmailTypeEnumFilterInput

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

Input fieldTypeDescription
eq[EmailTypeEnum!]Matches any of the listed values.
NOTEmailTypeEnumFilterInputMatches 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 fieldTypeDescription
eq[String]Exact match (case sensitive). Multiple values in list are evaluated as OR.
nullBooleanTrue matches records where the field has no value; false matches records where it has one.
ltDateTimeMatches values before this moment.
lteDateTimeMatches values before or equal to this moment.
gtDateTimeMatches values after this moment.
gteDateTimeMatches 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 fieldTypeDescription
eq[String]Exact match (case sensitive). Multiple values in list are evaluated as OR.
nullBooleanTrue matches records where the field has no value; false matches records where it has one.
ltFloatMatches values lower than this number.
lteFloatMatches values lower than or equal to this number.
gtFloatMatches values greater than this number.
gteFloatMatches 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 fieldTypeDescription
entityEntityLacotaTypeEntity 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 fieldTypeDescription
eq[String]Exact match (case sensitive). Multiple values in list are evaluated as OR.
nullBooleanTrue 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.
emptyBooleanTrue 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.

FieldTypeDescription
getByIdEntityFitnessIndicatorEntity (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.
getByCriteriaEntityFitnessIndicatorEntityConnection (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.

FieldTypeDescription
getByIdEntityFitnessEntity (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.
getByCriteriaEntityFitnessEntityConnection (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.
getByEntityTypeEntityFitnessEntity! (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.

FieldTypeDescription
getByIdEntityHealthEntity (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.
getByCriteriaEntityHealthEntityConnection (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.
getByTypeIdEntityHealthEntity! (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.

ValueDescription
AccountAn account record.
ContactA contact record.
TaskA task record.
AppointmentAn appointment record.
LeadA lead record.
OpportunityAn opportunity record.
ProjectA project record.
QuoteA quote record.
CustomEntityA 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.

ValueDescription
AiAgentAI agent offered in the Automation Hub, such as an AI assistant integration, whose use is recorded as AI events.
AiBalanceAI credit balance of a subscription for a period, with the free credits remaining and spent and the overage credits used.
AiEventUse of an AI agent by a user in a space, with its outcome, response time and the AI credits it consumed.
AiEventJournalSingle AI model call made while handling an AI event, with the model used, its response time and cost.
AuditLogEntry 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.
AccountCompany or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.
AccountKPIRecorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports.
AccountRoleRole a contact can hold at an account, configurable per space and assigned on the link between the contact and the account.
AccountSharingClientRelationSharing of an account with a user, as a watcher or an editor.
AccountSharingSalesUnitRelationSharing of an account with a sales unit, as a watcher or an editor.
AccountSocialRelationSocial network profiles of an account, such as its LinkedIn, Twitter or Facebook pages.
AccountProductPricingSpecial price of a product for one account, used instead of the regular price when the product is sold to that account.
AccountTypeConfigurable category of accounts that defines the form layout and settings used for accounts of that type.
ActivityTask or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern.
ActivityCommentComment written by a user on a task or an appointment.
ActivityKPIRecorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports.
ActivityRelationLink of a task or an appointment to a record it concerns, such as an account, contact, lead, opportunity, project or quote.
ActivityTypeTask type or appointment type, with the settings both kinds of activity types share.
AllowedLeadTypeLead type that a user role is allowed to use.
AllowedPipelinePipeline that a user role is allowed to use, optionally with access to the documents of its steps.
ApiAccessAPI credentials that an integration uses to access the space, with the parts of the API they may read or write.
ApplicationApplication 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.
AppointmentMeeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns.
AppointmentClientInviteesRelationInvitation of a user of the space to an appointment, with their response.
AppointmentContactInviteesRelationInvitation of an external person to an appointment, identified by email and matched to a contact when one exists, with their response.
AppointmentInviteeNotifyQueueInvitation email for an appointment that is waiting to be sent to an invitee's email address.
AppointmentReminderReminder a user has set for an appointment, notifying them a given time before it starts.
AppointmentScheduleOnline booking link through which people book appointments with a user in the time slots the user has available.
AppointmentTypeConfigurable category of appointments, such as a meeting or a call, that defines their form layout and icon.
AllowedAccountTypeAccount type that a user role is allowed to use.
AllowedAppointmentTypeAppointment type that a user role is allowed to use.
AllowedContactTypeContact type that a user role is allowed to use.
AllowedCompanyPhoneCompany phone number that a user role is allowed to use for calls and text messages.
AllowedTaskTypeTask type that a user role is allowed to use.
ApprovalApproval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers.
ApprovalApproverUser asked to decide an approval request, with their response and comment.
ApprovalProcessApproval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them.
ApprovalProcessActivityLogLineEntry in the activity log of an approval, recording one step of the approval and its result.
ChatConversationConversation of a user with the AI assistant, either general or about a specific record.
ClientUser of the space; owns records, belongs to sales units and has a user role that determines what they can do.
ClientExcludedOpptyChoice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again.
ClientFavoriteRecord or screen profile that a user has marked as a favorite.
ClientSettingPersonal setting of a user, stored as a named value.
ClientStoryReadMark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it.
CloudObjectFile stored in the space, such as a document, image or recording, that can be attached to records.
CloudObjectFolderFolder that organizes files, either in the company documents or within a record.
CloudObjectRelationAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
CloudObjectStepRelationFile attached to a pipeline step, such as a document the sales team uses in that step.
CloudObjectTemplateDocument template, such as a Word or Excel file with placeholders, used to generate documents filled with record data.
CompanyEmailShared company mailbox connected to the space that users can send emails from, such as a sales or support address.
ContactPerson the sales team works with, usually linked to one or more accounts, leads and opportunities.
ContactAccountRelationLink between a contact and an account they work for, with their position and their place in the account org chart.
ContactAccountAccountRoleRelationRole assigned to a contact at an account, on the link between the contact and the account.
ContactRelationLink between two related contacts, such as colleagues or family members; its labels give the kind of relationship.
ContactRelationTypeKind of relationship that can be assigned to a link between two contacts, such as Spouse or Colleague, with its display color.
ContactKPIRecorded KPI event of a contact, such as its creation, archiving or the first and last email sent, used in KPI reports.
ContactSharingClientRelationSharing of a contact with a user, as a watcher or an editor.
ContactSharingSalesUnitRelationSharing of a contact with a sales unit, as a watcher or an editor.
ContactSocialRelationSocial network profiles of a contact, such as their LinkedIn, Twitter or Facebook profiles.
ContactTypeConfigurable category of contacts that defines the form layout and settings used for contacts of that type.
CountryCrmCountry offered in address fields; a new country value on a record must match one of these countries.
CurrencyCurrency used for monetary values in the space, converted from the base currency by exchange rates.
CurrencyExchangeRateExchange rate of a currency against the base currency within an exchange rate list.
CurrencyExchangeRatesListSet of exchange rates, one per currency, that applies from a given date until the next list takes effect.
CustomEntityRelationCustom relation that links records of two entities through a pair of relation fields, one on each side.
CustomEntityRelationDataLink between two records made through a custom relation, such as an account linked to a custom entity record.
CustomEntityRecord of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities.
CustomEntityDataExRelationOption selected in a multi-select checkbox field of a custom entity record; there is one link per selected option.
CustomEntityKPIRecorded KPI event of a custom entity record, such as its creation or last modification, used in KPI reports.
CustomEntitySharingClientRelationSharing of a custom entity record with a user, as a watcher or an editor.
CustomEntitySharingSalesUnitRelationSharing of a custom entity record with a sales unit, as a watcher or an editor.
CustomEntityTypeConfigurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity.
DataOption of a dropdown or multi-select field, one of the values users can choose from.
EbookE-book offered to users in the in-app learning content, with view statistics.
EmailEmail message sent or received by users of the space, linked to the contacts, accounts and other records it concerns.
EmailLabelPersonal label a user applies to email conversations to organize their mailbox; labels can be nested.
EmailLabelRelationEmail label applied to a conversation in a mailbox.
EmailMailboxRelationLink between an email and a mailbox the email belongs to.
EmailSequenceAutomated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop.
EmailSequenceActivityLogLog of one run of an email sequence, with when it started and finished and who triggered it.
EmailSequenceActivityLogLineEntry in the log of an email sequence run, recording one step and its outcome.
EmailSequenceEnrolledRecord enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it.
EmailSequenceEnrolledStatusProgress of an enrolled record through one step of an email sequence, with the email, text message or task the step produced.
EmailSequenceSettingsCopy 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.
EmailTemplateReusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared.
EmailTemplateFolderFolder that organizes email templates; folders can be nested.
EmailTemplateSharingClientRelationSharing of an email template with a user, as a watcher or an editor.
EmailTemplateSharingSalesUnitRelationSharing of an email template with a sales unit, as a watcher or an editor.
EmailContentSharingClientRelationSharing of the body of an email with a user, letting them read its content.
EmailContentSharingSalesUnitRelationSharing of the body of an email with a sales unit, letting its members read its content.
EmailThreadMailboxClientReadStateTime a user last read an email conversation in a mailbox, telling which conversations have unread emails.
EntityKind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior.
EntityHealthHealth configuration of an account type, defining when accounts of that type are healthy or in critical health.
EntityScoringLead scoring configuration: rules that give leads a score, so that the most promising ones stand out.
EntityHealthSettingsHistoryVersion of the health configuration of an account type, recorded each time the configuration changes.
EntityFitnessFitness configuration of a lead or opportunity type: the indicators that flag records of that type needing attention.
EntityFitnessIndicatorIndicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them.
EntityTypeRecord type of an entity, such as an account, lead or task type, that classifies records and defines their form.
EntitySettingsSpace-wide settings of an entity, such as the default columns of its lists.
FieldField of an entity, built-in or custom, with its name, type and configuration.
FieldMappingRules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity.
FieldSequenceNumbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence.
FieldPermissionAccess a user role has to a custom field: full access, read-only or hidden.
ForecastSales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users.
ForecastSharingClientRelationShare of a forecast with an individual user.
ForecastSharingSalesUnitRelationShare of a forecast with a sales unit.
GhostContactPlaceholder person on an org chart for someone who is not a contact in the space yet, such as an unknown decision maker.
GhostLeadOpptyContactRelationPlacement of a ghost contact on the org chart of a lead or an opportunity.
GhostContactAccountRelationPlacement of a ghost contact on the org chart of an account, with its position and comment.
GhostLeadOpptyContactSalesRoleRelationSales role assigned to a placeholder (ghost) contact on the org chart of a lead or opportunity.
GhostContactAccountAccountRoleRelationRole assigned to a ghost contact on the org chart of an account.
ImportMappingMaskSaved mapping of import file columns to fields, reused when importing records of the same entity.
LeadPotential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.
LeadOpptyLead or opportunity, with the fields both kinds of sales records share.
LeadOpptyAccountRelationLink between a lead or opportunity and an account, marking the primary account.
LeadOpptyContactGroupRelationGroup of contacts on the org chart of a lead or opportunity.
LeadOpptyContactRelationLink between a lead or opportunity and a contact, with the contact's sales roles and org-chart position.
LeadOpptyContactSalesRoleRelationSales role assigned to a contact on a lead or opportunity.
LeadOpptyKPIKPI event of a lead or opportunity (e.g. created, qualified, won, lost or moved to another step), used in activity reporting.
LeadOpptyProjectRelationLink between a lead or opportunity and a project it is part of.
LeadOpptySharingClientRelationShare of a lead or opportunity with an individual user, with the access level granted.
LeadOpptySharingSalesUnitRelationShare of a lead or opportunity with a sales unit, with the access level granted.
LeadOpptyStepCheckListRelationCompletion of a step checklist item on a lead, opportunity or quote, with the activity, email, note or document that fulfils it.
LeadOpptyTypeLead type or opportunity type, with the settings both kinds of sales record types share.
LeadProcessLead process: the ordered steps that leads of its lead types move through.
LeadTypeLead type that classifies leads and defines their forms and the lead process they follow.
MasterRightUser role in the space that defines which features, records and pipelines its users can access.
MediaRecording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment.
MemoInternal message written by a user and linked to records, which other users can comment on.
MemoCommentComment a user wrote on a memo.
MessageEmail or memo, with the fields both kinds of messages share.
MessageRelationLink between a message (email or memo) and a record such as an account, contact, lead or opportunity.
MessageSharingClientRelationShare of a message (email or memo) with an individual user.
MessageSharingSalesUnitRelationShare of a message (email or memo) with a sales unit.
NoteNote a user wrote on a record such as an account, contact, lead, opportunity, project or quote.
OnlineFormSubmission (response) of an online form, with the answers and the records it created or updated.
OnlineFormActivityLogLineOne step logged while processing an online form submission.
OnlineFormDataExRelationOption selected in a multi-select checkbox field of an online form submission.
OnlineFormTypeEmailRelationEmail that sent an online form link to a recipient, with the record it was sent on.
OnlineFormRelationLink between an online form submission and a record it created or updated.
OnlineFormTypeOnline form definition: the fields and settings of a web form whose submissions create or update records.
OnlineFormStyleVisual style (colors, fonts, layout) that can be applied to online forms.
OpportunityPotential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
OpportunityTypeOpportunity type that classifies opportunities and defines their forms (edit, qualify, won and lost).
OpptyProductRelationProduct line item on an opportunity or quote, with its quantity, price and discount.
OpptyProductRelationDataExRelationOption selected in a multi-select checkbox field of a product line item.
OpptyProductRelationTypeLine-item type that defines the form of product line items on opportunities and quotes; paired with a product type.
OpptyRecurrenceRecurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost.
OpptyRevenueScheduleRevenue schedule that splits the value of an opportunity into periods.
OpptyRevenueSchedulePeriodOne period of an opportunity revenue schedule, with its date and amount.
OpptyProductRelationRevenueScheduleRevenue schedule that splits the amount of a product line item into periods.
OpptyProductRelationRevenueSchedulePeriodOne period of a product line item revenue schedule, with its date and amount.
OrderOrder of a subscription (e.g. a purchase, renewal or license change) with its items, amounts, tax and payment status.
OrderItemLine item of an order: a product with its quantity, price and subtotal, and the monthly recurring revenue it adds.
OrderTempDataItemLine item of an order that waits for online payment in checkout, with its product, quantity and price.
OrderHistoryStatus change recorded in the history of an order.
OrderRelatedDocumentPayment confirmation or credit note issued for an order.
OrderTempDataOrder started in checkout that waits for online payment; it becomes a regular order once the payment succeeds.
PaymentPayment received for an order, with the payment method, the amount paid and the transaction reference.
PaymentTermPayment term of orders, such as immediate payment or payment within a number of days, in a given language.
PaymentAdditionalDataInstructions 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.
ParentAccountRelationTypeKind of parent-child relationship between accounts (e.g. parent company and subsidiary), with a label for each side.
PhonePhone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company.
AllowedQuoteTypeQuote type that a user role is allowed to use.
QuotePrice offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process.
QuoteAccountRelationLink between a quote and an account, marking the primary account.
QuoteContactRelationLink between a quote and a contact, marking the primary contact.
QuoteDataExRelationOption selected in a multi-select checkbox field of a quote.
QuoteKPIKPI event of a quote (e.g. created, accepted, archived or moved to another step), used in activity reporting.
QuoteProcessQuote process: the ordered steps that quotes of its quote types move through.
QuoteSharingClientRelationShare of a quote with an individual user, with the access level granted.
QuoteSharingSalesUnitRelationShare of a quote with a sales unit, with the access level granted.
QuoteTypeQuote type that classifies quotes and defines their forms and the quote process they follow.
LeadOpptyDataExRelationOption selected in a multi-select checkbox field of a lead or opportunity.
AccountDataExRelationOption selected in a multi-select checkbox field of an account; there is one link per selected option.
ContactDataExRelationOption selected in a multi-select checkbox field of a contact; there is one link per selected option.
ActivityDataExRelationOption selected in a multi-select checkbox field of a task or an appointment; there is one link per selected option.
ProductDataExRelationOption selected in a multi-select checkbox field of a product.
ProjectDataExRelationOption selected in a multi-select checkbox field of a project.
PipelineSales pipeline: the ordered steps that opportunities of its opportunity types move through.
ProcessAutomatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook).
ProcessActivityLogOne run of an Automatizer process, with its status, timing and the steps it took.
ProcessActivityLogLineOne step logged in a run of an Automatizer process.
ProcessScheduledActionAction of an Automatizer process that is waiting to run for a record at a scheduled time.
ProcessTemplateReady-made Automatizer process offered in the template gallery as a starting point for new processes.
SolutionCanvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity.
SolutionTemplateReady-made solution offered in the template gallery as a starting point for new solutions.
ProcessChangeOwnerLogRound-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.
ProductProduct or service in the catalog that can be added as a line item to opportunities and quotes.
ProductTypeProduct type that classifies products and defines their form.
ProductCategoryCategory in the hierarchy of the product catalog.
ProductPipelineRelationPipeline in which a product can be added as a line item.
ProductPriceListPrice list with product prices per currency, applied to opportunities and quotes while it is active.
ProductPriceListPricePrice of a product in one currency within a price list.
ProfileSaved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.
ProfileRelationRecord added explicitly to a static saved view (profile).
ProfileDraftUnsaved changes a user made to the view of an app screen, kept until they are saved or discarded.
ProfileSharingClientRelationShare of a saved view (profile) with an individual user.
ProfileSharingSalesUnitRelationShare of a saved view (profile) with a sales unit.
ProjectProject delivered for an account or run internally, with its objectives, activities and progress.
ProjectKPIKPI event of a project (its completion), used in activity reporting.
ProjectContactRelationLink between a project and a contact, marking the primary contact.
ProjectObjectiveObjective (goal) of a project.
ProjectTypeProject type that classifies projects and defines their form and icon.
ProjectSharingClientRelationShare of a project with an individual user, with the access level granted.
ProjectSharingSalesUnitRelationShare of a project with a sales unit, with the access level granted.
ReportSaved report or dashboard with its settings, sharing and delivery schedule.
ReportFolderFolder that organizes reports; folders can be nested.
ReportSharingClientRelationShare of a report with an individual user, with the access level granted.
ReportSharingSalesUnitRelationShare of a report with a sales unit, with the access level granted.
ReportScheduleSchedule that emails a report to its recipients at regular intervals.
RevenueRecognitionRevenue of an opportunity product for one period of its revenue schedule, used in revenue reporting.
SalesRoleRole a contact plays in a deal (e.g. decision maker), assigned to contacts on leads and opportunities.
SalesUnitSales unit (team) in the organization hierarchy that users belong to.
SalesUnitClientRelationMembership of a user in a sales unit, as a member or manager.
StepStep of an opportunity pipeline, lead process or quote process that records move through.
StepChecklistChecklist item of a pipeline step, such as logging an activity, filling a field or attaching a document.
StepChecklistSalesRoleRelationSales role that a step checklist item is shown to.
TagLabel that users attach to records such as accounts, contacts or opportunities to categorize them.
TagRelationAssignment of a tag to a record.
TargetSales target set for a user or a group of users for a period, measured by a chosen metric.
TargetRelationLink between a group target and a user target that rolls up into it.
TaskTask (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records.
TaskRecurrenceRecurrence rule that defines when the next occurrences of a recurring task are created.
TaskReminderReminder a user set to be notified about a task at a given time.
TaskSharingClientRelationShare of a task with an individual user, with the access level granted.
TaskSharingSalesUnitRelationShare of a task with a sales unit, with the access level granted.
TaskTypeTask type that classifies tasks and defines their form and icon.
TextMessageMessage sent or received in a text message conversation or in an AI assistant chat.
TextMessageConversationText message conversation between a Coevera phone number and an external phone number.
TextMessageConversationRelationsLink between a text message conversation and a record such as an account, contact, lead or opportunity.
TranslationTranslation of a field name, dropdown option or form text into the supported languages.
TypeData type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped.
TimeframeTime a lead or opportunity has spent in a pipeline step.
UnsubscribedPhonePhone number that opted out of receiving text messages.
UseCaseUse case showing how a feature can be used, offered to users in the in-app learning content.
WebresourceWeb page embedded in the app for records of an entity, with its URL filled from the record's field values.
WebhookRegistered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner.
WebhookEventEvent a webhook subscribes to; the webhook is called whenever the event occurs.
CountryCountry that can be selected in billing addresses, with its states, sales region and the Coevera supplier that bills customers there.
TeamSpaceClientMembership of a user profile in a space.
CpTeamSpaceClientMembership of a user in a space, as listed for subscription administrators, who can disable it.
CpCallLogCall, text message or transcription made through built-in calling, with its phone numbers, status and cost.
UserProfileUser account that signs in to Coevera and can be a member of several spaces and subscriptions.
UserRoleCustomer portal role that grants a user rights such as order, subscription, partner and user management.
TeamSpaceSpace of a subscription: a separate Coevera CRM instance with its own users, data and settings.
TeamSpaceRegionHosting region where spaces run, with its address, email domain and whether new trial spaces can be created in it.
TeamSpacePropertyNamed property of a space, such as its time zone, first day of the week or attachment size limit.
TeamSpaceClientSettingIntegration 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.
SapiUserAPI 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.
CpCallingCalling credit of a subscription, spent on calls, recordings and AI services such as transcription.
SubscriptionCustomer subscription to Coevera: the contract that covers its spaces, licenses, billing and orders.
SubscriptionRepresentativeCoevera staff member who can be assigned to subscriptions as their sales representative.
SubscriptionSDRCoevera staff member who can be assigned to subscriptions as their sales development representative.
PartnerPartner company (e.g. affiliate, agent or consultant) that refers customer subscriptions and earns commission on their orders.
SupplierCompany that sells subscriptions and issues orders and invoices, with its legal imprint.
StateState or province of a country that can be selected in billing addresses.
AutomationHubAppApp (vendor) in the Automation Hub that provides integrations, with its website and support links.
AutomationHubCategoryCategory that groups items in the Automation Hub.
AutomationHubItemIntegration or add-on offered in the Automation Hub that can be enabled in a space.
SubscriptionHubItemAutomation Hub item included in a subscription.
TeamPipelineHubItemAutomation Hub item installed in a space, with its status and configuration.
TeamPipelineHubItemBaseAutomation Hub item installed in a space, of any integration kind, with its status and configuration.
HowToHelp resource (video, article or support link) shown in the app for a feature area, with view statistics.
StorylaneInteractive product demo offered to users in the in-app learning content.
ReleaseNoteRelease note announcing a product change to users, who can react to it.
CpClientUser account identified by its sign-in email, with the spaces it is a member of.
CpProfileSaved view of a customer portal screen that belongs to a Coevera staff member, with its view settings.
CpProductProduct 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.
PurchasedProductProduct a subscription has purchased, such as licenses or an add-on, with its quantity, price, status and the period it is active.
SubscriptionNotificationNotification 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.
CpActivityEntry of the customer portal audit trail: an action a user performed, the module it was performed in and the space it concerned.
ActivityDetailDetail of a customer portal audit trail entry: the record that was changed, the operation performed and the data before and after the change.
NotificationSettingAutomatic email notification to customers, sent before a subscription renewal or when an order payment is overdue.
FormViewVariant 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.
FormViewSharingClientRelationSharing of a form view with a user, as a watcher or an editor.
FormViewSharingSalesUnitRelationSharing of a form view with a sales unit, as a watcher or an editor.
InterfacePreviewLayout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts.
SpaceSettingSpace-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.

ValueDescription
CreateAllows creating records of this type.
ReadAllows viewing the record.
WriteAllows editing the record.
DeleteAllows deleting the record.
OwnershipAllows changing the owner of the record.
QualifyAllows qualifying the lead into an opportunity.
BackToLeadAllows turning the opportunity back into a lead.
ArchiveAllows archiving the account, contact, lead, opportunity or quote.
ReactivateAllows reactivating an archived account, contact, lead, opportunity or quote, or a completed or inactive target.
ReleaseAllows giving up ownership of the lead or task so that it becomes unassigned.
RestoreAllows restoring the deleted record.
InviteeAllows the current user, as an invitee, to respond to the appointment invitation.
MoveAllows moving the lead, opportunity or quote to a different step.
CopyAllows creating a copy of the record.
ChangePipelineAllows moving the opportunity to a different pipeline.
ChangeLeadProcessAllows moving the lead to a different lead process.
ChangeQuoteProcessAllows moving the quote to a different quote process.
CallAllows placing a call from the record through the calling integration.
UnitMembershipLegacy value; no longer used.
UserAndRolesLegacy value; no longer used.
ApiAdminAllows administrative operations reserved for administrative API accounts.
StepDocumentsAllows managing the documents attached to the pipeline step.
MergeAllows merging duplicate records into this record.
TakeAllows taking ownership of the unassigned lead or task.
AdminSetAutomationHubLegacy value; no longer used.
AdminAutomationHubLegacy value; no longer used.
CompleteAllows marking the project or target as completed.
ReopenAllows reopening the completed project.
ManageUserDataAllows transferring or deleting the reports, profiles, form views, email templates and import templates of the deactivated user.
ReadCopyAllows reading the parts of the email template needed to use it, for example in a process or email sequence, without full read access.
ContentReadAllows reading the body of the email.
ContentOwnershipAllows changing who can read the body of the email.
RespondToApprovalAllows the current user, as a pending approver, to approve or reject the approval request.
DelegateApprovalAllows the current user, as a pending approver, to delegate the approval request to another user.
ResubmitApprovalAllows resubmitting a rejected approval request.
CancelApprovalAllows cancelling the approval request.
ReassignClientAllows reassigning the user seat to a different person by email address.
ResetPasswordClientAllows resetting the password of the user.
EntityRepository object 5 fields: getById, getByIds, getAll, …

Read operations for Entity records.

FieldTypeDescription
getByIdEntityEntity (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.
getByCriteriaEntityEntityConnection (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.

FieldTypeDescription
accountAccountRepositoryRead operations for Account records.
accountDataExRelationAccountDataExRelationRepositoryRead operations for AccountDataExRelation records.
accountKpiAccountKPIRepositoryRead operations for AccountKPI records.
accountProductPricingAccountProductPricingRepositoryRead operations for AccountProductPricing records.
accountRelationAccountRelationRepositoryRead operations for AccountRelation records.
accountRelationLabelAccountRelationLabelRepositoryRead operations for AccountRelationLabel records.
accountRelationTypeAccountRelationTypeRepositoryRead operations for AccountRelationType records.
accountRoleAccountRoleRepositoryRead operations for AccountRole records.
accountSharingClientRelationAccountSharingClientRelationRepositoryRead operations for AccountSharingClientRelation records.
accountSharingSalesUnitRelationAccountSharingSalesUnitRelationRepositoryRead operations for AccountSharingSalesUnitRelation records.
accountSocialRelationAccountSocialRelationRepositoryRead operations for AccountSocialRelation records.
accountTypeAccountTypeRepositoryRead operations for AccountType records.
activityActivityRepositoryRead operations for Activity records.
activityCommentActivityCommentRepositoryRead operations for ActivityComment records.
activityDataExRelationActivityDataExRelationRepositoryRead operations for ActivityDataExRelation records.
activityKpiActivityKPIRepositoryRead operations for ActivityKPI records.
activityRelationActivityRelationRepositoryRead operations for ActivityRelation records.
allowedAccountTypeAllowedAccountTypeRepositoryRead operations for AllowedAccountType records.
allowedAppointmentTypeAllowedAppointmentTypeRepositoryRead operations for AllowedAppointmentType records.
allowedCompanyEmailAllowedCompanyEmailRepositoryRead operations for AllowedCompanyEmail records.
allowedCompanyPhoneAllowedCompanyPhoneRepositoryRead operations for AllowedCompanyPhone records.
allowedContactTypeAllowedContactTypeRepositoryRead operations for AllowedContactType records.
allowedLeadTypeAllowedLeadTypeRepositoryRead operations for AllowedLeadType records.
allowedPipelineAllowedPipelineRepositoryRead operations for AllowedPipeline records.
allowedQuoteTypeAllowedQuoteTypeRepositoryRead operations for AllowedQuoteType records.
allowedTaskTypeAllowedTaskTypeRepositoryRead operations for AllowedTaskType records.
apiAccessApiAccessRepositoryRead operations for ApiAccess records.
applicationApplicationRepositoryRead operations for Application records.
appointmentAppointmentRepositoryRead operations for Appointment records.
appointmentClientInviteesRelationAppointmentClientInviteesRelationRepositoryRead operations for AppointmentClientInviteesRelation records.
appointmentContactInviteesRelationAppointmentContactInviteesRelationRepositoryRead operations for AppointmentContactInviteesRelation records.
appointmentReminderAppointmentReminderRepositoryRead operations for AppointmentReminder records.
appointmentScheduleAppointmentScheduleRepositoryRead operations for AppointmentSchedule records.
appointmentTypeAppointmentTypeRepositoryRead operations for AppointmentType records.
approvalApprovalRepositoryRead operations for Approval records.
approvalApproverApprovalApproverRepositoryRead operations for ApprovalApprover records.
approvalProcessApprovalProcessRepositoryRead operations for ApprovalProcess records.
approvalProcessActivityLogLineApprovalProcessActivityLogLineRepositoryRead operations for ApprovalProcessActivityLogLine records.
callCallRepositoryRead operations for Call records.
chatConversationChatConversationRepositoryRead operations for ChatConversation records.
clientClientRepositoryRead operations for Client records.
clientExcludedOpptyClientExcludedOpptyRepositoryRead operations for ClientExcludedOppty records.
clientFavoriteClientFavoriteRepositoryRead operations for ClientFavorite records.
clientSettingClientSettingRepositoryRead operations for ClientSetting records.
clientStoryReadClientStoryReadRepositoryRead operations for ClientStoryRead records.
cloudObjectCloudObjectRepositoryRead operations for CloudObject records.
cloudObjectFolderCloudObjectFolderRepositoryRead operations for CloudObjectFolder records.
cloudObjectRelationCloudObjectRelationRepositoryRead operations for CloudObjectRelation records.
cloudObjectStepRelationCloudObjectStepRelationRepositoryRead operations for CloudObjectStepRelation records.
cloudObjectTemplateCloudObjectTemplateRepositoryRead operations for CloudObjectTemplate records.
companyEmailCompanyEmailRepositoryRead operations for CompanyEmail records.
contactContactRepositoryRead operations for Contact records.
contactAccountAccountRoleRelationContactAccountAccountRoleRelationRepositoryRead operations for ContactAccountAccountRoleRelation records.
contactAccountRelationContactAccountRelationRepositoryRead operations for ContactAccountRelation records.
contactDataExRelationContactDataExRelationRepositoryRead operations for ContactDataExRelation records.
contactKpiContactKPIRepositoryRead operations for ContactKPI records.
contactRelationContactRelationRepositoryRead operations for ContactRelation records.
contactRelationLabelContactRelationLabelRepositoryRead operations for ContactRelationLabel records.
contactRelationTypeContactRelationTypeRepositoryRead operations for ContactRelationType records.
contactSharingClientRelationContactSharingClientRelationRepositoryRead operations for ContactSharingClientRelation records.
contactSharingSalesUnitRelationContactSharingSalesUnitRelationRepositoryRead operations for ContactSharingSalesUnitRelation records.
contactSocialRelationContactSocialRelationRepositoryRead operations for ContactSocialRelation records.
contactTypeContactTypeRepositoryRead operations for ContactType records.
countryCrmCountryCrmRepositoryRead operations for CountryCrm records.
currencyCurrencyRepositoryRead operations for Currency records.
currencyExchangeRateCurrencyExchangeRateRepositoryRead operations for CurrencyExchangeRate records.
currencyExchangeRatesListCurrencyExchangeRatesListRepositoryRead operations for CurrencyExchangeRatesList records.
customEntityCustomEntityRepository (1 args)Read operations for CustomEntity records.
customEntityDataExRelationCustomEntityDataExRelationRepositoryRead operations for CustomEntityDataExRelation records.
customEntityRelationCustomEntityRelationRepositoryRead operations for CustomEntityRelation records.
customEntityRelationDataCustomEntityRelationDataRepositoryRead operations for CustomEntityRelationData records.
customEntitySharingClientRelationCustomEntitySharingClientRelationRepositoryRead operations for CustomEntitySharingClientRelation records.
customEntitySharingSalesUnitRelationCustomEntitySharingSalesUnitRelationRepositoryRead operations for CustomEntitySharingSalesUnitRelation records.
customEntityTypeCustomEntityTypeRepository (1 args)Read operations for CustomEntityType records.
dataDataRepositoryRead operations for Data records.
emailEmailRepositoryRead operations for Email records.
emailContentSharingClientRelationEmailContentSharingClientRelationRepositoryRead operations for EmailContentSharingClientRelation records.
emailContentSharingSalesUnitRelationEmailContentSharingSalesUnitRelationRepositoryRead operations for EmailContentSharingSalesUnitRelation records.
emailEventEmailEventRepositoryRead operations for EmailEvent records.
emailLabelEmailLabelRepositoryRead operations for EmailLabel records.
emailLabelRelationEmailLabelRelationRepositoryRead operations for EmailLabelRelation records.
emailMailboxRelationEmailMailboxRelationRepositoryRead operations for EmailMailboxRelation records.
emailSequenceEmailSequenceRepositoryRead operations for EmailSequence records.
emailSequenceActivityLogEmailSequenceActivityLogRepositoryRead operations for EmailSequenceActivityLog records.
emailSequenceActivityLogLineEmailSequenceActivityLogLineRepositoryRead operations for EmailSequenceActivityLogLine records.
emailSequenceEnrolledEmailSequenceEnrolledRepositoryRead operations for EmailSequenceEnrolled records.
emailTemplateEmailTemplateRepositoryRead operations for EmailTemplate records.
emailTemplateFolderEmailTemplateFolderRepositoryRead operations for EmailTemplateFolder records.
emailTemplateSharingClientRelationEmailTemplateSharingClientRelationRepositoryRead operations for EmailTemplateSharingClientRelation records.
emailTemplateSharingSalesUnitRelationEmailTemplateSharingSalesUnitRelationRepositoryRead operations for EmailTemplateSharingSalesUnitRelation records.
emailThreadMailboxClientReadStateEmailThreadMailboxClientReadStateRepositoryRead operations for EmailThreadMailboxClientReadState records.
entityEntityRepositoryRead operations for Entity records.
entityFitnessEntityFitnessRepositoryRead operations for EntityFitness records.
entityFitnessIndicatorEntityFitnessIndicatorRepositoryRead operations for EntityFitnessIndicator records.
entityHealthEntityHealthRepositoryRead operations for EntityHealth records.
entityScoringEntityScoringRepositoryRead operations for EntityScoring records.
entitySettingsEntitySettingsRepositoryRead operations for EntitySettings records.
fieldFieldRepositoryRead operations for Field records.
fieldMappingFieldMappingRepositoryRead operations for FieldMapping records.
fieldPermissionFieldPermissionRepositoryRead operations for FieldPermission records.
fieldSequenceFieldSequenceRepositoryRead operations for FieldSequence records.
forecastForecastRepositoryRead operations for Forecast records.
formViewFormViewRepositoryRead operations for FormView records.
formViewSharingClientRelationFormViewSharingClientRelationRepositoryRead operations for FormViewSharingClientRelation records.
formViewSharingSalesUnitRelationFormViewSharingSalesUnitRelationRepositoryRead operations for FormViewSharingSalesUnitRelation records.
ghostContactGhostContactRepositoryRead operations for GhostContact records.
ghostContactAccountAccountRoleRelationGhostContactAccountAccountRoleRelationRepositoryRead operations for GhostContactAccountAccountRoleRelation records.
ghostContactAccountRelationGhostContactAccountRelationRepositoryRead operations for GhostContactAccountRelation records.
ghostLeadOpptyContactRelationGhostLeadOpptyContactRelationRepositoryRead operations for GhostLeadOpptyContactRelation records.
ghostLeadOpptyContactSalesRoleRelationGhostLeadOpptyContactSalesRoleRelationRepositoryRead operations for GhostLeadOpptyContactSalesRoleRelation records.
importMappingMaskImportMappingMaskRepositoryRead operations for ImportMappingMask records.
interfacePreviewInterfacePreviewRepositoryRead operations for InterfacePreview records.
leadLeadRepositoryRead operations for Lead records.
leadOpptyLeadOpptyRepositoryRead operations for LeadOppty records.
leadOpptyAccountRelationLeadOpptyAccountRelationRepositoryRead operations for LeadOpptyAccountRelation records.
leadOpptyContactGroupRelationLeadOpptyContactGroupRelationRepositoryRead operations for LeadOpptyContactGroupRelation records.
leadOpptyContactRelationLeadOpptyContactRelationRepositoryRead operations for LeadOpptyContactRelation records.
leadOpptyContactSalesRoleRelationLeadOpptyContactSalesRoleRelationRepositoryRead operations for LeadOpptyContactSalesRoleRelation records.
leadOpptyDataExRelationLeadOpptyDataExRelationRepositoryRead operations for LeadOpptyDataExRelation records.
leadOpptyKpiLeadOpptyKPIRepositoryRead operations for LeadOpptyKPI records.
leadOpptySharingClientRelationLeadOpptySharingClientRelationRepositoryRead operations for LeadOpptySharingClientRelation records.
leadOpptySharingSalesUnitRelationLeadOpptySharingSalesUnitRelationRepositoryRead operations for LeadOpptySharingSalesUnitRelation records.
leadOpptyStepCheckListRelationLeadOpptyStepCheckListRelationRepositoryRead operations for LeadOpptyStepCheckListRelation records.
leadProcessLeadProcessRepositoryRead operations for LeadProcess records.
leadTypeLeadTypeRepositoryRead operations for LeadType records.
masterRightMasterRightRepositoryRead operations for MasterRight records.
mediaMediaRepositoryRead operations for Media records.
memoMemoRepositoryRead operations for Memo records.
memoCommentMemoCommentRepositoryRead operations for MemoComment records.
messageRelationMessageRelationRepositoryRead operations for MessageRelation records.
messageSharingClientRelationMessageSharingClientRelationRepositoryRead operations for MessageSharingClientRelation records.
messageSharingSalesUnitRelationMessageSharingSalesUnitRelationRepositoryRead operations for MessageSharingSalesUnitRelation records.
noteNoteRepositoryRead operations for Note records.
onlineFormOnlineFormRepositoryRead operations for OnlineForm records.
onlineFormActivityLogLineOnlineFormActivityLogLineRepositoryRead operations for OnlineFormActivityLogLine records.
onlineFormDataExRelationOnlineFormDataExRelationRepositoryRead operations for OnlineFormDataExRelation records.
onlineFormRelationOnlineFormRelationRepositoryRead operations for OnlineFormRelation records.
onlineFormStyleOnlineFormStyleRepositoryRead operations for OnlineFormStyle records.
onlineFormTypeOnlineFormTypeRepositoryRead operations for OnlineFormType records.
onlineFormTypeEmailRelationOnlineFormTypeEmailRelationRepositoryRead operations for OnlineFormTypeEmailRelation records.
opportunityOpportunityRepositoryRead operations for Opportunity records.
opportunityTypeOpportunityTypeRepositoryRead operations for OpportunityType records.
opptyProductRelationOpptyProductRelationRepositoryRead operations for OpptyProductRelation records.
opptyProductRelationDataExRelationOpptyProductRelationDataExRelationRepositoryRead operations for OpptyProductRelationDataExRelation records.
opptyProductRelationRevenueScheduleOpptyProductRelationRevenueScheduleRepositoryRead operations for OpptyProductRelationRevenueSchedule records.
opptyProductRelationRevenueSchedulePeriodOpptyProductRelationRevenueSchedulePeriodRepositoryRead operations for OpptyProductRelationRevenueSchedulePeriod records.
opptyProductRelationTypeOpptyProductRelationTypeRepositoryRead operations for OpptyProductRelationType records.
opptyRecurrenceOpptyRecurrenceRepositoryRead operations for OpptyRecurrence records.
opptyRevenueScheduleOpptyRevenueScheduleRepositoryRead operations for OpptyRevenueSchedule records.
opptyRevenueSchedulePeriodOpptyRevenueSchedulePeriodRepositoryRead operations for OpptyRevenueSchedulePeriod records.
parentAccountRelationTypeParentAccountRelationTypeRepositoryRead operations for ParentAccountRelationType records.
phonePhoneRepositoryRead operations for Phone records.
pipelinePipelineRepositoryRead operations for Pipeline records.
processProcessRepositoryRead operations for Process records.
processActivityLogProcessActivityLogRepositoryRead operations for ProcessActivityLog records.
processActivityLogLineProcessActivityLogLineRepositoryRead operations for ProcessActivityLogLine records.
processScheduledActionProcessScheduledActionRepositoryRead operations for ProcessScheduledAction records.
processTemplateProcessTemplateRepositoryRead operations for ProcessTemplate records.
productProductRepositoryRead operations for Product records.
productCategoryProductCategoryRepositoryRead operations for ProductCategory records.
productDataExRelationProductDataExRelationRepositoryRead operations for ProductDataExRelation records.
productPipelineRelationProductPipelineRelationRepositoryRead operations for ProductPipelineRelation records.
productPriceListProductPriceListRepositoryRead operations for ProductPriceList records.
productPriceListPriceProductPriceListPriceRepositoryRead operations for ProductPriceListPrice records.
productTypeProductTypeRepositoryRead operations for ProductType records.
profileProfileRepositoryRead operations for Profile records.
profileRelationProfileRelationRepositoryRead operations for ProfileRelation records.
profileSharingClientRelationProfileSharingClientRelationRepositoryRead operations for ProfileSharingClientRelation records.
profileSharingSalesUnitRelationProfileSharingSalesUnitRelationRepositoryRead operations for ProfileSharingSalesUnitRelation records.
projectProjectRepositoryRead operations for Project records.
projectContactRelationProjectContactRelationRepositoryRead operations for ProjectContactRelation records.
projectDataExRelationProjectDataExRelationRepositoryRead operations for ProjectDataExRelation records.
projectKpiProjectKPIRepositoryRead operations for ProjectKPI records.
projectObjectiveProjectObjectiveRepositoryRead operations for ProjectObjective records.
projectSharingClientRelationProjectSharingClientRelationRepositoryRead operations for ProjectSharingClientRelation records.
projectSharingSalesUnitRelationProjectSharingSalesUnitRelationRepositoryRead operations for ProjectSharingSalesUnitRelation records.
projectTypeProjectTypeRepositoryRead operations for ProjectType records.
quoteQuoteRepositoryRead operations for Quote records.
quoteAccountRelationQuoteAccountRelationRepositoryRead operations for QuoteAccountRelation records.
quoteContactRelationQuoteContactRelationRepositoryRead operations for QuoteContactRelation records.
quoteDataExRelationQuoteDataExRelationRepositoryRead operations for QuoteDataExRelation records.
quoteKpiQuoteKPIRepositoryRead operations for QuoteKPI records.
quoteProcessQuoteProcessRepositoryRead operations for QuoteProcess records.
quoteSharingClientRelationQuoteSharingClientRelationRepositoryRead operations for QuoteSharingClientRelation records.
quoteSharingSalesUnitRelationQuoteSharingSalesUnitRelationRepositoryRead operations for QuoteSharingSalesUnitRelation records.
quoteTypeQuoteTypeRepositoryRead operations for QuoteType records.
reportReportRepositoryRead operations for Report records.
reportFolderReportFolderRepositoryRead operations for ReportFolder records.
reportScheduleReportScheduleRepositoryRead operations for ReportSchedule records.
reportSharingClientRelationReportSharingClientRelationRepositoryRead operations for ReportSharingClientRelation records.
reportSharingSalesUnitRelationReportSharingSalesUnitRelationRepositoryRead operations for ReportSharingSalesUnitRelation records.
salesRoleSalesRoleRepositoryRead operations for SalesRole records.
salesUnitSalesUnitRepositoryRead operations for SalesUnit records.
salesUnitClientRelationSalesUnitClientRelationRepositoryRead operations for SalesUnitClientRelation records.
solutionSolutionRepositoryRead operations for Solution records.
solutionTemplateSolutionTemplateRepositoryRead operations for SolutionTemplate records.
stepStepRepositoryRead operations for Step records.
stepChecklistStepChecklistRepositoryRead operations for StepChecklist records.
stepChecklistSalesRoleRelationStepChecklistSalesRoleRelationRepositoryRead operations for StepChecklistSalesRoleRelation records.
tagTagRepositoryRead operations for Tag records.
tagRelationTagRelationRepositoryRead operations for TagRelation records.
targetTargetRepositoryRead operations for Target records.
targetRelationTargetRelationRepositoryRead operations for TargetRelation records.
taskTaskRepositoryRead operations for Task records.
taskRecurrenceTaskRecurrenceRepositoryRead operations for TaskRecurrence records.
taskReminderTaskReminderRepositoryRead operations for TaskReminder records.
taskSharingClientRelationTaskSharingClientRelationRepositoryRead operations for TaskSharingClientRelation records.
taskSharingSalesUnitRelationTaskSharingSalesUnitRelationRepositoryRead operations for TaskSharingSalesUnitRelation records.
taskTypeTaskTypeRepositoryRead operations for TaskType records.
textMessageTextMessageRepositoryRead operations for TextMessage records.
textMessageConversationTextMessageConversationRepositoryRead operations for TextMessageConversation records.
textMessageConversationRelationsTextMessageConversationRelationsRepositoryRead operations for TextMessageConversationRelations records.
timeframeTimeframeRepositoryRead operations for Timeframe records.
translationTranslationRepositoryRead operations for Translation records.
typeTypeRepositoryRead operations for Type records.
unsubscribedPhoneUnsubscribedPhoneRepositoryRead operations for UnsubscribedPhone records.
webhookWebhookRepositoryRead operations for Webhook records.
webhookEventWebhookEventRepositoryRead operations for WebhookEvent records.
webresourceWebresourceRepositoryRead 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.

FieldTypeDescription
idUUID!Unique identifier of the scoring category.
labelString!Display name of the scoring category (for example Hot, Warm, Cold).
useLangBoolean!When true, the label is treated as a translation key and localized in the UI; otherwise the literal label text is shown.
valueInt!Upper score threshold of this category. A record falls into the category whose threshold its accumulated score does not exceed.
colorInt!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.

FieldTypeDescription
getByIdEntityScoringEntity (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.
getByCriteriaEntityScoringEntityConnection (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.
getRecalculationStatusEntityScoringRecalculationStatus! (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.

FieldTypeDescription
getByIdEntitySettingsEntity (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.
getDraftByIdEntitySettingsEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
getForEntityEntitySettingsEntity (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.

FieldTypeDescription
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.

ValueDescription
AllSubscribes to every event of every entity in this list.
LeadAllSubscribes to every lead event: LeadCreate, LeadUpdate, LeadDelete, LeadBackToLead, LeadOwnerChanged, LeadDocumentLinked and LeadLost.
LeadCreateFires when a lead is created.
LeadUpdateFires when a lead is updated.
LeadDeleteFires when a lead is deleted.
LeadBackToLeadFires when an opportunity is moved back to a lead; the event carries the resulting lead.
LeadOwnerChangedFires when the owner of a lead changes, including when it is created with an owner other than the user who created it.
LeadDocumentLinkedFires when a document is linked to a lead; the event includes the document as the related entity.
LeadLostFires when a lead is archived as lost.
OpportunityAllSubscribes to every opportunity event: OpportunityCreate, OpportunityUpdate, OpportunityDelete, OpportunityMove, OpportunityQualify, OpportunityOwnerChanged, OpportunityDocumentLinked, OpportunityWon and OpportunityLost.
OpportunityCreateFires when an opportunity is created.
OpportunityUpdateFires when an opportunity is updated.
OpportunityDeleteFires when an opportunity is deleted.
OpportunityMoveFires when an opportunity moves to a different sales step; winning an opportunity also raises this event.
OpportunityQualifyFires when a lead is qualified into an opportunity; the event carries the new opportunity.
OpportunityOwnerChangedFires when the owner of an opportunity changes, including when it is created with an owner other than the user who created it.
OpportunityDocumentLinkedFires when a document is linked to an opportunity; the event includes the document as the related entity.
OpportunityWonFires when an opportunity is created in or moved to the won step of its pipeline.
OpportunityLostFires when an opportunity is archived as lost without reaching the won step.
ContactAllSubscribes to every contact event: ContactCreate, ContactUpdate, ContactDelete, ContactOwnerChanged and ContactDocumentLinked.
ContactCreateFires when a contact is created.
ContactUpdateFires when a contact is updated.
ContactDeleteFires when a contact is deleted.
ContactOwnerChangedFires when the owner of a contact changes, including when it is created with an owner other than the user who created it.
ContactDocumentLinkedFires when a document is linked to a contact; the event includes the document as the related entity.
AccountAllSubscribes to every account event: AccountCreate, AccountUpdate, AccountDelete, AccountOwnerChanged and AccountDocumentLinked.
AccountCreateFires when an account is created.
AccountUpdateFires when an account is updated.
AccountDeleteFires when an account is deleted.
AccountOwnerChangedFires when the owner of an account changes, including when it is created with an owner other than the user who created it.
AccountDocumentLinkedFires when a document is linked to an account; the event includes the document as the related entity.
TaskAllSubscribes to every task event: TaskCreate, TaskUpdate, TaskDelete, TaskOwnerChanged, TaskDocumentLinked and TaskComment.
TaskCreateFires when a task is created.
TaskUpdateFires when a task is updated.
TaskDeleteFires when a task is deleted.
TaskOwnerChangedFires when the owner of a task changes, including when it is created with an owner other than the user who created it.
TaskDocumentLinkedFires when a document is linked to a task; the event includes the document as the related entity.
TaskCommentFires when a comment is added to a task.
AppointmentAllSubscribes to every appointment event: AppointmentCreate, AppointmentUpdate, AppointmentDelete, AppointmentOwnerChanged, AppointmentDocumentLinked and AppointmentComment.
AppointmentCreateFires when an appointment is created.
AppointmentUpdateFires when an appointment is updated.
AppointmentDeleteFires when an appointment is deleted.
AppointmentOwnerChangedFires when the owner of an appointment changes, including when it is created with an owner other than the user who created it.
AppointmentDocumentLinkedFires when a document is linked to an appointment; the event includes the document as the related entity.
AppointmentCommentFires when a comment is added to an appointment.
MessageAllLegacy subscription to all message events; memo and email changes are delivered as Memo and Email events instead.
MessageCreateLegacy event that is no longer raised; use MemoCreate or EmailCreate instead.
MessageUpdateLegacy event that is no longer raised; use MemoUpdate or EmailUpdate instead.
MessageDeleteLegacy event that is no longer raised; use MemoDelete or EmailDelete instead.
MessageDocumentLinkedLegacy event that is no longer raised; use MemoDocumentLinked or EmailDocumentLinked instead.
MemoAllSubscribes to every memo event: MemoCreate, MemoUpdate, MemoDelete, MemoDocumentLinked and MemoComment.
MemoCreateFires when a memo is created.
MemoUpdateFires when a memo is updated.
MemoDeleteFires when a memo is deleted.
MemoDocumentLinkedFires when a document is linked to a memo; the event includes the document as the related entity.
MemoCommentFires when a comment is added to a memo.
EmailAllSubscribes to every email event: EmailCreate, EmailUpdate, EmailDelete and EmailDocumentLinked.
EmailCreateFires when an email is created.
EmailUpdateFires when an email is updated.
EmailDeleteFires when an email is deleted.
EmailDocumentLinkedFires when a document is linked to an email; the event includes the document as the related entity.
OpptyProductRelationAllSubscribes to every opportunity product line event: OpptyProductRelationCreate, OpptyProductRelationUpdate and OpptyProductRelationDelete.
OpptyProductRelationCreateFires when a product line of an opportunity is created.
OpptyProductRelationUpdateFires when a product line of an opportunity is updated.
OpptyProductRelationDeleteFires when a product line of an opportunity is deleted.
ProjectAllSubscribes to every project event: ProjectCreate, ProjectUpdate, ProjectDelete, ProjectOwnerChanged and ProjectDocumentLinked.
ProjectCreateFires when a project is created.
ProjectUpdateFires when a project is updated.
ProjectDeleteFires when a project is deleted.
ProjectOwnerChangedFires when the owner of a project changes, including when it is created with an owner other than the user who created it.
ProjectDocumentLinkedFires when a document is linked to a project; the event includes the document as the related entity.
QuoteAllSubscribes to every quote event: QuoteCreate, QuoteUpdate, QuoteDelete, QuoteOwnerChanged, QuoteDocumentLinked, QuoteMove, QuoteWon and QuoteLost.
QuoteCreateFires when a quote is created.
QuoteUpdateFires when a quote is updated.
QuoteDeleteFires when a quote is deleted.
QuoteOwnerChangedFires when the owner of a quote changes, including when it is created with an owner other than the user who created it.
QuoteDocumentLinkedFires when a document is linked to a quote; the event includes the document as the related entity.
QuoteMoveFires when a quote moves to a different step of its quote process; winning a quote also raises this event.
QuoteWonFires when a quote is created in or moved to the won (accepted) step of its quote process.
QuoteLostFires when a quote is archived as lost without reaching the won step.
CustomEntityAllSubscribes to every custom entity event: CustomEntityCreate, CustomEntityUpdate, CustomEntityDelete, CustomEntityOwnerChanged and CustomEntityDocumentLinked.
CustomEntityCreateFires when a custom entity record is created.
CustomEntityUpdateFires when a custom entity record is updated.
CustomEntityDeleteFires when a custom entity record is deleted.
CustomEntityOwnerChangedFires when the owner of a custom entity record changes, including when it is created with an owner other than the user who created it.
CustomEntityDocumentLinkedFires when a document is linked to a custom entity record; the event includes the document as the related entity.
ContactAccountRelationAllSubscribes to every contact-account link event: ContactAccountRelationCreate, ContactAccountRelationUpdate and ContactAccountRelationDelete.
ContactAccountRelationCreateFires when a contact is linked to an account.
ContactAccountRelationUpdateFires when the link between a contact and an account is updated.
ContactAccountRelationDeleteFires when a contact is unlinked from an account.
LeadOpptyAccountRelationAllSubscribes to every lead/opportunity account link event: LeadOpptyAccountRelationCreate, LeadOpptyAccountRelationUpdate and LeadOpptyAccountRelationDelete.
LeadOpptyAccountRelationCreateFires when an account is linked to a lead or opportunity.
LeadOpptyAccountRelationUpdateFires when the link between an account and a lead or opportunity is updated.
LeadOpptyAccountRelationDeleteFires when an account is unlinked from a lead or opportunity.
LeadOpptyContactRelationAllSubscribes to every lead/opportunity contact link event: LeadOpptyContactRelationCreate, LeadOpptyContactRelationUpdate and LeadOpptyContactRelationDelete.
LeadOpptyContactRelationCreateFires when a contact is linked to a lead or opportunity.
LeadOpptyContactRelationUpdateFires when the link between a contact and a lead or opportunity is updated.
LeadOpptyContactRelationDeleteFires when a contact is unlinked from a lead or opportunity.
ActivityRelationAllSubscribes to every activity link event: ActivityRelationCreate, ActivityRelationUpdate and ActivityRelationDelete.
ActivityRelationCreateFires when a task or appointment is linked to a record.
ActivityRelationUpdateFires when the link between a task or appointment and a record is updated.
ActivityRelationDeleteFires when a task or appointment is unlinked from a record.
QuoteAccountRelationAllSubscribes to every quote-account link event: QuoteAccountRelationCreate, QuoteAccountRelationUpdate and QuoteAccountRelationDelete.
QuoteAccountRelationCreateFires when an account is linked to a quote.
QuoteAccountRelationUpdateFires when the link between an account and a quote is updated.
QuoteAccountRelationDeleteFires when an account is unlinked from a quote.
QuoteContactRelationAllSubscribes to every quote-contact link event: QuoteContactRelationCreate, QuoteContactRelationUpdate and QuoteContactRelationDelete.
QuoteContactRelationCreateFires when a contact is linked to a quote.
QuoteContactRelationUpdateFires when the link between a contact and a quote is updated.
QuoteContactRelationDeleteFires when a contact is unlinked from a quote.
ProductAllSubscribes to every product event: ProductCreate, ProductUpdate and ProductDelete.
ProductCreateFires when a product is created.
ProductUpdateFires when a product is updated.
ProductDeleteFires when a product is deleted.
NoteAllSubscribes to every note event: NoteCreate, NoteUpdate and NoteDelete.
NoteCreateFires when a note is created.
NoteUpdateFires when a note is updated.
NoteDeleteFires when a note is deleted.
CurrencyAllSubscribes to every currency event: CurrencyCreate, CurrencyUpdate and CurrencyDelete.
CurrencyCreateFires when a currency is created.
CurrencyUpdateFires when a currency is updated.
CurrencyDeleteFires when a currency is deleted.
CurrencyExchangeRateAllSubscribes to every exchange rate event: CurrencyExchangeRateCreate, CurrencyExchangeRateUpdate and CurrencyExchangeRateDelete.
CurrencyExchangeRateCreateFires when an exchange rate is created.
CurrencyExchangeRateUpdateFires when an exchange rate is updated.
CurrencyExchangeRateDeleteFires when an exchange rate is deleted.
CurrencyExchangeRatesListAllSubscribes to every exchange rate list event: CurrencyExchangeRatesListCreate, CurrencyExchangeRatesListUpdate and CurrencyExchangeRatesListDelete.
CurrencyExchangeRatesListCreateFires when an exchange rate list is created.
CurrencyExchangeRatesListUpdateFires when an exchange rate list is updated.
CurrencyExchangeRatesListDeleteFires when an exchange rate list is deleted.
ProductPriceListAllSubscribes to every price list event: ProductPriceListCreate, ProductPriceListUpdate and ProductPriceListDelete.
ProductPriceListCreateFires when a price list is created.
ProductPriceListUpdateFires when a price list is updated.
ProductPriceListDeleteFires when a price list is deleted.
ProductPriceListPriceAllSubscribes to every price list price event: ProductPriceListPriceCreate, ProductPriceListPriceUpdate and ProductPriceListPriceDelete.
ProductPriceListPriceCreateFires when a product price in a price list is created.
ProductPriceListPriceUpdateFires when a product price in a price list is updated.
ProductPriceListPriceDeleteFires when a product price in a price list is deleted.