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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Folder in the template hierarchy that the template belongs to. Empty for
- # templates at the root level.
- : EmailTemplateFolderEntity
- # User who owns the template.
- : ClientEntity
- # HTML body of the template. May use merge-field placeholders that are filled with
- # record values when the template is composed.
- : String
- # Id of the folder the template belongs to. Empty for templates at the root level.
- : ID
- # Name of the entity and its default text representation.
- : String!
- # Id of the template owner.
- : ID!
- # Colors recently used in the editor of the template body, as integer color
- # values.
- : [Int!]
- # Sharing model for the template (e.g. shared with selected sales units, selected
- # users, or open for editing by all).
- : ShareModeEnum
- # When true, the template's public sharing URL is active and accessible. Setting
- # to false invalidates outstanding sharing URLs.
- : Boolean
- # Public sharing link of the template and, when personalized, the record whose
- # data fills the template.
- : EmailTemplateSharingUrlSettings
- # Subject line of emails composed from this template. Supports merge-field
- # placeholders.
- : String!
- # Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in
- # the visual editor (WysiwygTemplate).
- : EmailTemplateTypeEnum!
- # Revision when entity was lastly changed.
- : 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.
- (: String, : String, : Int, : 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.
- (
- : SalesUnitFilterInput,
- : EmailTemplateSharingSalesUnitRelationFilterInput,
- : [SalesUnitOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : 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.
- (
- : ClientFilterInput,
- : EmailTemplateSharingClientRelationFilterInput,
- : [ClientOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : 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.
- (
- : CloudObjectFilterInput,
- : CloudObjectRelationFilterInput,
- : [CloudObjectOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : 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.
- (: [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.
- (: PeriodOptionParams): MassEmailTrackingInfo!
- }
link Require by
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CreateEmailTemplatePayloadResult of the createEmailTemplate mutation.
- DeleteEmailTemplatePayloadResult of the deleteEmailTemplate mutation.
- EmailEntityEmail message sent or received by users of the space, linked to the contacts, accounts and other records it concerns.
- EmailSequenceStepStatsStatistics of one step of an email sequence.
- EmailTemplateEntityEdgeA Relay edge containing a `EmailTemplateEntity` and its cursor.
- EmailTemplatePersonificationResultCopies of the EmailTemplate with its placeholders filled from the given records, and the records and fields that could not be used.
- EmailTemplateRepositoryRead operations for EmailTemplate records.
- EmailTemplateSharingClientRelationEntitySharing of an email template with a user, as a watcher or an editor.
- EmailTemplateSharingSalesUnitRelationEntitySharing of an email template with a sales unit, as a watcher or an editor.
- StepChecklistEntityChecklist item of a pipeline step, such as logging an activity, filling a field or attaching a document.
- UpdateEmailTemplatePayloadResult of the updateEmailTemplate mutation.