OBJECT

EmailSequenceSettings

link GraphQL Schema definition

  • type EmailSequenceSettings {
  • # Sequence-wide reactions to recipient replies, unsubscribes, bounces, and custom
  • # conditions.
  • globalActions: EmailSequenceGlobalActionsSettings!
  • # IANA time-zone name (for example Europe/Bratislava) in which the sending window
  • # and active dates are interpreted.
  • timezone: String!
  • # Weekdays on which emails may be sent, given as numbers 1 (Monday) through 7
  • # (Sunday).
  • dayOfWeek: [Int!]!
  • # Start of the daily sending window, expressed as minutes after midnight (0-1440).
  • fromTimeOfDay: Int!
  • # End of the daily sending window, expressed as minutes after midnight (0-1440);
  • # must be greater than fromTimeOfDay.
  • toTimeOfDay: Int!
  • # When true, each email starts its own conversation thread; when false, all emails
  • # of one enrollment share a single thread.
  • everyEmailStartsConversation: Boolean!
  • # When true, the sequence starts the process given by triggerProcessId for records
  • # it creates.
  • triggerProcess: Boolean
  • # Identifier of the process to start when triggerProcess is enabled.
  • triggerProcessId: UUID
  • # Date from which the sequence is allowed to send; earlier scheduling waits until
  • # this date.
  • activeFrom: Date
  • # Date after which the sequence stops sending.
  • activeTo: Date
  • # When true, records still enrolled after activeTo passes are automatically
  • # removed from the sequence.
  • autoUnenrollWhenExpired: Boolean
  • }