Skip to main content

queueEmailCommunication

Queues an email communication that uses a merge document for content and targets one or more contacts.

Throws an error with code:

  • BAD_USER_INPUT if the input's contactIds field is an empty list.
  • BAD_USER_INPUT if the input's delayedDeliveryDate field is specified and its value represents a date in the past.
  • BAD_USER_INPUT if the input's emailSenderName field is empty.
  • BAD_USER_INPUT if the input's emailSubject field is empty.
  • NOT_FOUND if an event matching the input's eventId field cannot be found.
  • NOT_FOUND if contacts matching the input's contactIds field cannot be found within the event specified by the eventId input field.
  • NOT_FOUND if a communication tag code matching the input's communicationTagCode field cannot be found within the event specified by the eventId input field.
queueEmailCommunication(
  input: QueueEmailCommunicationInput!
): QueueEmailCommunicationPayload!

Arguments​

queueEmailCommunication.input ● QueueEmailCommunicationInput! non-null input​

Type​

QueueEmailCommunicationPayload object​

The payload object returned when queuing an email communication that uses a merge document for content.