OBJECT
EmailSequenceEntity

Automated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop.
GraphQL Schema definition

type EmailSequenceEntity {
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
isDeleteProtected: Boolean! 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# User who owns this email sequence.
owner: ClientEntity 
# Reason the sequence is currently disabled (e.g. Manual stop, system suspension). 
# Read-only.
deactivationReason: EmailSequenceDeactivationReasonEnum 
# Free-form description of the sequence.
description: String 
# Master switch for the sequence. Read-only on this surface — change it via the 
# enable / disable mutations.
isEnabled: Boolean 
# Timestamp of the most recent change to settings. Read-only.
lastSchemaChange: DateTime 
# Timestamp of the most recent change to isEnabled. Read-only.
lastStatusChange: DateTime 
# Display name of the email sequence.
name: String! 
# Id of the email sequence owner.
ownerId: ID! 
# JSON schema describing the sequence trigger, nodes (steps) and global actions 
# (e.g. on-reply, on-bounce, on-unsubscribe). This payload conforms to the 
# `EmailSequenceSchema` JSON Schema: 
# https://api-doc.coevera.com/schemas/EmailSequenceSchema.json
settings: EmailSequenceSchema 
# Process category of the sequence (e.g. EmailSequence vs other process types).
type: ProcessTypeEnum! 
# Run history of the sequence — one log per scheduled execution.
# 
# Arguments
# filter: Filter EmailSequenceActivityLog relations by target 
# EmailSequenceActivityLog attributes.
# orderBy: Order EmailSequenceActivityLog relations by target 
# EmailSequenceActivityLog attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
activityLogs(
filter: EmailSequenceActivityLogFilterInput,
orderBy: [EmailSequenceActivityLogOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): EmailSequenceActivityLogEntityConnection 
# Attachments and other documents linked to this sequence.
documents: [CloudObjectRelationEntity!] 
# Enrolment records (recipients currently or previously running through the 
# sequence).
# 
# Arguments
# filter: Filter EmailSequenceEnrolled relations by target 
# EmailSequenceEnrolled attributes.
# orderBy: Order EmailSequenceEnrolled relations by target 
# EmailSequenceEnrolled attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
enrolled(
filter: EmailSequenceEnrolledFilterInput,
orderBy: [EmailSequenceEnrolledOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): EmailSequenceEnrolledEntityConnection 
# Effective status of the sequence (e.g. Scheduled, Running, Expired, Error). 
# Read-only; derived from the active-from / active-to settings and the most recent 
# activity log status.
status: ProcessStatusEnum 
# Timestamp the sequence last produced a run (delivered or attempted a step).
lastEmailSequenceRun: DateTime 
# Fraction of delivered emails (0–1) where at least one tracked link was clicked.
clickRate: Float 
# Fraction of sent emails (0–1) that bounced (the recipient mailserver rejected 
# them).
bounceRate: Float 
# Fraction of delivered emails (0–1) that recorded at least one open event.
openRate: Float 
# Fraction of delivered emails (0–1) where the recipient replied.
replyRate: Float 
# Fraction of delivered emails (0–1) where the recipient unsubscribed.
unsubscribeRate: Float 
# Total number of emails produced (queued) by the sequence across all steps.
createdCount: Int! 
# Total number of emails actually delivered by the sequence across all steps.
sentCount: Int! 
# Number of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in 
# this sequence.
enrollCount: Int! 
# Solutions whose canvas contains this record. Deleted solutions are not included.
# 
# Arguments
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
solutions(before: String, after: String, first: Int, last: Int): SolutionEntityConnection 
# Entity name whose records trigger automatic enrollment into this sequence (e.g. 
# "Lead", "Contact"). Empty when the sequence is manually enrolled only.
triggerEntityName: EntityNameEnum 
# Id of the field on the trigger entity whose value change drives enrollment (e.g. 
# a step field on a Lead). Empty when no field-based trigger is configured.
triggerFieldId: UUID 
# Number of steps configured in the sequence.
stepCount: Int 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Statistics of the sequence for the selected period: enrollments, sent emails, 
# opens, clicks, replies and records created by its steps.
# 
# Arguments
# period: Time window of the enrollments the statistics cover.
stats(period: EmailSequenceStatsPeriodEnum!): EmailSequenceStats! 
}
EmailSequenceEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
