Skip to main content

QueueContactStoreTextMessageCommunicationInput

Defines the input to queue a text message (SMS) communication for a contact store.

input QueueContactStoreTextMessageCommunicationInput {
  communicationTagCode: String
  contactIds: [ID!]!
  contactStoreId: ID!
  delayedDeliveryDate: DateTime
  isMarketing: Boolean
  messageBody: String!
  senderNumber: String
}

Fields​

QueueContactStoreTextMessageCommunicationInput.communicationTagCode ● String scalar​

The code of the communication tag to associate with the text message communication. Optional.

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

The list of identifiers of the contacts to send the text message to.

Rules:

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

QueueContactStoreTextMessageCommunicationInput.contactStoreId ● ID! non-null scalar​

The identifier of the contact store for this communication. The contacts must be linked to this contact store.

QueueContactStoreTextMessageCommunicationInput.delayedDeliveryDate ● DateTime scalar​

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

Rules:

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

QueueContactStoreTextMessageCommunicationInput.isMarketing ● Boolean scalar​

A flag indicating whether the text message communication is marketing material. Optional. When not specified, the default value is false.

QueueContactStoreTextMessageCommunicationInput.messageBody ● String! non-null scalar​

The plain text content of the text message.

QueueContactStoreTextMessageCommunicationInput.senderNumber ● String scalar​

The phone number of the sender for the text message. Optional. When not specified, the contact store's configured SMS gateway default sender number will be used.

Member Of​

queueContactStoreTextMessageCommunication mutation