Skip to main content

QueueMembershipContactStoreEmailCommunicationInput

Defines the input to queue an email communication that uses a merge document for content, for a membership contact store.

input QueueMembershipContactStoreEmailCommunicationInput {
  bccAddresses: [EmailAddress!]
  ccAddresses: [EmailAddress!]
  communicationTagCode: String
  contactIds: [ID!]!
  delayedDeliveryDate: DateTime
  emailSenderAddress: EmailAddress!
  emailSenderName: String!
  emailSubject: String!
  isMarketing: Boolean
  membershipContactStoreId: ID!
  mergeDocumentId: ID!
}

Fields​

QueueMembershipContactStoreEmailCommunicationInput.bccAddresses ● [EmailAddress!] list scalar​

The email addresses of the recipients who will receive the email as a blind carbon copy. Optional.

QueueMembershipContactStoreEmailCommunicationInput.ccAddresses ● [EmailAddress!] list scalar​

The email addresses of the recipients who will receive the email as a carbon copy. Optional.

QueueMembershipContactStoreEmailCommunicationInput.communicationTagCode ● String scalar​

The code of the communication tag to associate with the email communication. Optional.

QueueMembershipContactStoreEmailCommunicationInput.contactIds ● [ID!]! non-null scalar​

The list of identifiers of the contacts to send the email communication to.

Rules:

  • The list must not be empty, i.e. it must contain at least one element.
  • All identifiers must be linked to the membership contact store specified in membershipContactStoreId.

QueueMembershipContactStoreEmailCommunicationInput.delayedDeliveryDate ● DateTime scalar​

The date at which the email communication will be queued to be sent to recipients. Optional.

Rules:

  • When specified, the value must be in the future.
  • When not specified, the email communication will be queued to be sent immediately.

QueueMembershipContactStoreEmailCommunicationInput.emailSenderAddress ● EmailAddress! non-null scalar​

The email address of the sender for the email message.

If the membership contact store (specified by membershipContactStoreId) is using the default email domain, this value will be ignored and emails will be sent from mail@eventsairmail.com.

QueueMembershipContactStoreEmailCommunicationInput.emailSenderName ● String! non-null scalar​

The name of the sender for the email message.

QueueMembershipContactStoreEmailCommunicationInput.emailSubject ● String! non-null scalar​

The subject line for the email message.

QueueMembershipContactStoreEmailCommunicationInput.isMarketing ● Boolean scalar​

A flag indicating whether the email communication is marketing material. Optional.

When not specified, the default value is false.

QueueMembershipContactStoreEmailCommunicationInput.membershipContactStoreId ● ID! non-null scalar​

The identifier of the membership contact store for this communication. The contacts and Merge Document must be linked to this membership contact store.

QueueMembershipContactStoreEmailCommunicationInput.mergeDocumentId ● ID! non-null scalar​

The identifier of the Merge Document used for the email communication.

Member Of​

queueMembershipContactStoreEmailCommunication mutation