INPUT_OBJECT

EmailSequenceFilterInput

Filter conditions for EmailSequence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input EmailSequenceFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [EmailSequenceFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [EmailSequenceFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: EmailSequenceFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Reason the sequence is currently disabled (e.g. Manual stop, system suspension).
  • # Read-only.
  • deactivationReason: EmailSequenceDeactivationReasonEnumFilterInput
  • # Free-form description of the sequence.
  • description: EntityFilterStringField
  • # 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: EntityFilterDateTimeField
  • # Timestamp of the most recent change to isEnabled. Read-only.
  • lastStatusChange: EntityFilterDateTimeField
  • # Display name of the email sequence.
  • name: EntityFilterStringField
  • # Id of the email sequence owner.
  • ownerId: EntityFilterStringField
  • # Process category of the sequence (e.g. EmailSequence vs other process types).
  • type: ProcessTypeEnumFilterInput
  • # 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
  • # 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
  • # User who owns this email sequence. Matches records where a related record meets
  • # these conditions.
  • owner: ClientFilterInput
  • # Run history of the sequence — one log per scheduled execution. Matches records
  • # where a related record meets these conditions.
  • activityLogs: EmailSequenceActivityLogFilterInput
  • # Attachments and other documents linked to this sequence. Matches records where a
  • # related record meets these conditions.
  • documents: CloudObjectRelationFilterInput
  • # Enrolment records (recipients currently or previously running through the
  • # sequence). Matches records where a related record meets these conditions.
  • enrolled: EmailSequenceEnrolledFilterInput
  • }

link Require by