OBJECT

EmailTemplateEntity

Reusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared.

link GraphQL Schema definition

  • type EmailTemplateEntity {
  • # 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
  • # Folder in the template hierarchy that the template belongs to. Empty for
  • # templates at the root level.
  • emailTemplateFolder: EmailTemplateFolderEntity
  • # User who owns the template.
  • owner: ClientEntity
  • # HTML body of the template. May use merge-field placeholders that are filled with
  • # record values when the template is composed.
  • body: String
  • # Id of the folder the template belongs to. Empty for templates at the root level.
  • emailTemplateFolderId: ID
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the template owner.
  • ownerId: ID!
  • # Colors recently used in the editor of the template body, as integer color
  • # values.
  • recentColors: [Int!]
  • # Sharing model for the template (e.g. shared with selected sales units, selected
  • # users, or open for editing by all).
  • shareMode: ShareModeEnum
  • # When true, the template's public sharing URL is active and accessible. Setting
  • # to false invalidates outstanding sharing URLs.
  • sharingUrlIsEnabled: Boolean
  • # Public sharing link of the template and, when personalized, the record whose
  • # data fills the template.
  • sharingUrlSettings: EmailTemplateSharingUrlSettings
  • # Subject line of emails composed from this template. Supports merge-field
  • # placeholders.
  • subject: String!
  • # Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in
  • # the visual editor (WysiwygTemplate).
  • type: EmailTemplateTypeEnum!
  • # Revision when entity was lastly changed.
  • revision: 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
  • # Sales units granted shared access to this template (custom share mode).
  • #
  • # Arguments
  • # filter: Filter SalesUnit relations by target SalesUnit
  • # attributes.
  • # filterEdge: Filter EmailTemplateSharingSalesUnitRelation
  • # relations by edge (relation) EmailTemplateSharingSalesUnitRelation attributes.
  • # orderBy: Order SalesUnit relations by target SalesUnit
  • # 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.
  • sharingUnits(
  • filter: SalesUnitFilterInput,
  • filterEdge: EmailTemplateSharingSalesUnitRelationFilterInput,
  • orderBy: [SalesUnitOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EmailTemplateSharingSalesUnitRelationEntityConnection
  • # Users granted shared access to this template (custom share mode).
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter EmailTemplateSharingClientRelation relations
  • # by edge (relation) EmailTemplateSharingClientRelation attributes.
  • # orderBy: Order Client relations by target Client 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.
  • sharingClients(
  • filter: ClientFilterInput,
  • filterEdge: EmailTemplateSharingClientRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EmailTemplateSharingClientRelationEntityConnection
  • # Files attached to the template (used as default attachments).
  • #
  • # Arguments
  • # filter: Filter CloudObject relations by target CloudObject
  • # attributes.
  • # filterEdge: Filter CloudObjectRelation relations by edge
  • # (relation) CloudObjectRelation attributes.
  • # orderBy: Order CloudObject relations by target CloudObject
  • # 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.
  • documents(
  • filter: CloudObjectFilterInput,
  • filterEdge: CloudObjectRelationFilterInput,
  • orderBy: [CloudObjectOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): CloudObjectRelationEntityConnection
  • # 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!]!
  • # Tracking statistics (sent, opened, clicked, replied, bounced, unsubscribed) of
  • # the emails sent with this template.
  • #
  • # Arguments
  • # period: Period in which the tracking events occurred; all time
  • # when omitted.
  • trackingInfo(period: PeriodOptionParams): MassEmailTrackingInfo!
  • }