OBJECT
EmailSequenceEnrolledEntity
Record enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it.
link GraphQL Schema definition
- type EmailSequenceEnrolledEntity {
- # 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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Account that was enrolled, when the trigger entity is an Account; otherwise
- # empty.
- : AccountEntity
- # User who triggered the enrolment, or empty for runs triggered by automation.
- : ClientEntity
- # Application context the enrolment was triggered in.
- : ApplicationEntity
- # Contact that was enrolled, when the trigger entity is a Contact; otherwise
- # empty.
- : ContactEntity
- # Activity log run that produced this enrolment.
- : EmailSequenceActivityLogEntity
- # Email sequence this enrolment belongs to.
- : EmailSequenceEntity
- # Lead that was enrolled, when the trigger entity is a Lead; otherwise empty.
- : LeadEntity
- # Opportunity that was enrolled, when the trigger entity is an Opportunity;
- # otherwise empty.
- : OpportunityEntity
- # Project that was enrolled, when the trigger entity is a Project; otherwise
- # empty.
- : ProjectEntity
- # Id of the enrolled account.
- : ID
- # Id of the user who triggered the enrolment, or empty for runs triggered by
- # automation.
- : ID
- # Id of the application (e.g. browser, automation, third-party integration) the
- # enrolment was triggered in.
- : ID!
- # Id of the enrolled contact.
- : ID
- # Id of the activity log run that produced this enrolment.
- : ID!
- # Id of the email sequence this enrolment belongs to.
- : ID!
- # Why the enrolment ended: Finished after all steps, Unenrolled when the record
- # was removed before finishing, or NoReason while the enrolment is still active.
- : EmailSequenceEndReasonEnum
- # Timestamp when the enrolment ended (completed or unenrolled). Empty while the
- # enrolment is active.
- : DateTime
- # Id of the enrolled record: the account, contact, lead, opportunity or project
- # that is set. Read-only.
- : ID!
- # Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.
- : BaseEntityTypeEnum!
- # True when this enrolment is excluded from sequence statistics (e.g. after a
- # stats reset).
- : Boolean
- # Id of the enrolled lead.
- : ID
- # Id of the enrolled opportunity.
- : ID
- # Id of the enrolled project.
- : ID
- # Timestamp when the enrolment started.
- : DateTime!
- # Number of steps the enrolment has reached. Read-only.
- : Int!
- # Display name of the enrolled record, formatted according to the calling user's
- # preferred name format. Empty when the underlying record has been deleted.
- : String
- # Email address used for delivery of this enrolment.
- : String
- # Zero-based index of the next step the enrolment will execute (i.e. one past the
- # highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the
- # first step runs.
- : Int
- # Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error).
- # Empty before the first run.
- : ProcessStatusEnum
- # Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project),
- # derived from entityType.
- : EntityNameEnum!
- # 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.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- CreateEmailSequenceEnrolledPayloadResult of the createEmailSequenceEnrolled mutation.
- DeleteEmailSequenceEnrolledPayloadResult of the deleteEmailSequenceEnrolled mutation.
- EmailSequenceEnrolledEntityEdgeA Relay edge containing a `EmailSequenceEnrolledEntity` and its cursor.
- EmailSequenceEnrolledRepositoryRead operations for EmailSequenceEnrolled records.
- UpdateEmailSequenceEnrolledPayloadResult of the updateEmailSequenceEnrolled mutation.