Skip to main content

MergeDocument

A Merge Document is a template for personalized communications. A Merge Document can be prepared and sent via email to one or more contacts.

type MergeDocument {
brand: Brand
communicationTag: CommunicationTag
createdAt: DateTime!
createdBy: String
dateFormat: MergeDocumentDateFormat
emailSenderAddress: String
emailSenderName: String
emailSubject: String
id: ID!
lastModifiedAt: DateTime!
lastModifiedBy: String
title: String!
type: MergeDocumentType!
}

Fields

MergeDocument.brand ● Brand object

The brand associated with the Merge Document. Optional.

Rules:

  • Merge Documents of type CONFIRMATION will always have a brand.
  • Merge Documents of type MARKETING will never have an associated brand.

MergeDocument.communicationTag ● CommunicationTag object

The communication tag associated with the Merge Document. Optional.

MergeDocument.createdAt ● DateTime! non-null scalar

The date and time the record was created.

MergeDocument.createdBy ● String scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

MergeDocument.dateFormat ● MergeDocumentDateFormat enum

The date format used by the Merge Document. Optional.

Only Merge Documents of type CONFIRMATION will have a date format specified.

MergeDocument.emailSenderAddress ● String scalar

The email address of the sender for email messages generated from this Merge Document. Optional.

MergeDocument.emailSenderName ● String scalar

The name of the sender for email messages generated from this Merge Document. Optional.

MergeDocument.emailSubject ● String scalar

The subject line for email messages generated from this Merge Document. Optional.

MergeDocument.id ● ID! non-null scalar

The unique identifier of the Merge Document.

MergeDocument.lastModifiedAt ● DateTime! non-null scalar

The date and time the record was last modified.

MergeDocument.lastModifiedBy ● String scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

MergeDocument.title ● String! non-null scalar

The title of the Merge Document.

MergeDocument.type ● MergeDocumentType! non-null enum

The type of the Merge Document.

Member Of

CeContactStore object ● ContactStore object ● Event object ● MembershipContactStore object