Skip to main content

queueContactStoreTextMessageCommunication

Queues a text message (SMS) communication 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 messageBody field is empty.
  • NOT_FOUND if a contact store matching the input's contactStoreId field cannot be found.
  • NOT_FOUND if contacts matching the input's contactIds field cannot be found within the contact store specified by the contactStoreId input field.
  • NOT_FOUND if a communication tag code matching the input's communicationTagCode field cannot be found within the contact store specified by the contactStoreId input field.
queueContactStoreTextMessageCommunication(
  input: QueueContactStoreTextMessageCommunicationInput!
): QueueTextMessageCommunicationPayload!

Arguments​

queueContactStoreTextMessageCommunication.input ● QueueContactStoreTextMessageCommunicationInput! non-null input​

Type​

QueueTextMessageCommunicationPayload object​

The payload object returned when queuing a text message communication.