OBJECT

EmailSequenceEnrolledEntity

link GraphQL Schema definition

  • type EmailSequenceEnrolledEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • 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
  • # Account that was enrolled, when the trigger entity is an Account; otherwise
  • # empty.
  • account: AccountEntity
  • # User who triggered the enrolment, or empty for runs triggered by automation.
  • actor: ClientEntity
  • # Application context the enrolment was triggered in.
  • application: ApplicationEntity
  • # Contact that was enrolled, when the trigger entity is a Contact; otherwise
  • # empty.
  • contact: ContactEntity
  • # Activity log run that produced this enrolment.
  • emailSequenceActivityLog: EmailSequenceActivityLogEntity
  • # Email sequence this enrolment belongs to.
  • emailSequence: EmailSequenceEntity
  • # Lead that was enrolled, when the trigger entity is a Lead; otherwise empty.
  • lead: LeadEntity
  • # Opportunity that was enrolled, when the trigger entity is an Opportunity;
  • # otherwise empty.
  • oppty: OpportunityEntity
  • # Project that was enrolled, when the trigger entity is a Project; otherwise
  • # empty.
  • project: ProjectEntity
  • # Id of the enrolled account.
  • accountId: ID
  • # Id of the actor.
  • actorId: ID
  • # Id of the application.
  • applicationId: ID!
  • # Id of the enrolled contact.
  • contactId: ID
  • # Id of the activity log.
  • emailSequenceActivityLogId: ID!
  • # Id of the email sequence.
  • emailSequenceId: ID!
  • # Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed).
  • endReason: EmailSequenceEndReasonEnum
  • # Timestamp when the enrolment ended (completed or unenrolled). Empty while the
  • # enrolment is active.
  • endTime: DateTime
  • # Id of the enrolled entity (matches whichever of
  • # account/contact/lead/oppty/project is set). Read-only.
  • entityId: ID!
  • # Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.
  • entityType: BaseEntityTypeEnum!
  • # True when this enrolment is excluded from sequence statistics (e.g. after a
  • # stats reset).
  • excludedFromStats: Boolean
  • # Id of the enrolled lead.
  • leadId: ID
  • # Id of the enrolled opportunity.
  • opptyId: ID
  • # Id of the enrolled project.
  • projectId: ID
  • # Timestamp when the enrolment started.
  • startTime: DateTime!
  • # Number of steps the enrolment has reached. Read-only.
  • stepCount: 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.
  • name: String
  • # Email address used for delivery of this enrolment.
  • address: String
  • # Zero-based index of the next step the enrolment will execute (i.e. one past the
  • # highest step_index recorded in EmailSequenceEnrolledStatus). Empty before the
  • # first step runs.
  • stepIndex: Int
  • # Status of the enrolment's most recent sequence run: NoActivity, Running,
  • # Success, Warning, or Error.
  • status: ProcessStatusEnum
  • # Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project),
  • # derived from entity_type.
  • entityName: EntityNameEnum!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by