create/send Message/Notification

create/send Message/Notification

Path Parameters

departmentUUID string required
userUUID string required
customerUUID string required

application/json

Request Body required

isFreeMarkerMessage boolean
editor object
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
messageAttributes object
body string
type string
Possible values: [DRAFT, DISCARDED_DRAFT, OUTGOING, INCOMING, NOTE]
protocol string
Possible values: [TEXT, EMAIL, VOICE_CALL, NONE, WHATSAPP]
purpose string
Possible values: [F, OPTIN_APP, OPTIN_REJ, OPTIN_REQ, OPTIN_ACT, D, PDINOTIFY, INS_NOTIFY, INSPECT_RESTORED, TECH_INS_NOTIFY, VWA_REGULAR_MANUAL, VWA_TECH_MANUAL, VWA_TECH_AUTO, APPT_ESTIMATE_SIGN_REQUEST, AUTORESPOND, CONSENT, TIRE_PROFILE_INSP, TIRE_RECOMM_APPROVAL, W, P, R, S, A, CIWNotOp, PR, APR, AUTOMATIC_PREQUALIFICATION, AC, AU, AD, V, TF, CF, CWM, AER, ATR, OOO_DELEGATION_DELEGATEE_NOTIFY, DELEGATION_OOO_NOTE, MANUAL_DELEGATION_NOTE, MANUAL_DELEGATION_NOTIFICATION, MESSAGE_SEND_FAILURE_NOTIFICATION, UNASSIGNED_MESSAGE_NOTIFICATION, AUTOCSI_FAILED_NOTIFICATION, AUTOCSI_SENT_MANUALLY, TIRE_RECOMMENDATION_MANUAL, CUSTOMER_DOCUMENT_VERIFICATION, PAYMENT_MANAGER_APPROVAL_PAYMENT_REQUEST, PAYMENT_MANAGER_APPROVAL_NAME_MATCHING, MDLCACT, RECALL, PDMSG, NE, APPNOTIFY, MDLLACT, DRIV_CALL, PDM_CALL, FDNOTIFY, CARDDELETE, WTNS, FinInviteM, FIN_ALERT, PAY_RCPT, REF_RCPT, SCH_TXT, CIWOptIn, MDLLRSA, MDLCWSA, MDLCASA, PDNOTIFY, CASessStrt, PDNOTES, DRIV_SA, DRIV_PDM, ACNOT, APP_NOTIF, AUTH, JAUTH, LEAD_NOTIF, CardSave_RCPT, DO_VEH_OPT_ALERT, OPT_OUT, REF_REQ, MPI_AUTO, MPI_NOTIF, MPI_MANUAL, LEAD_NOTIF_MISSED, WFR, CUSTOMER_SENTIMENT_STATUS, BDC_CALL_FORWARD, FOLLOWUP, THREE_D_S_APPROVAL, THREE_D_S_APPROVAL_UNDO, SIGNED_INVOICE_NOTIFICATION, INCOMING_MESSAGE, COMMUNICATION_PREFERENCE_CHANGE_NOTIFICATION, UBER_RIDE_COMPLETION, UBER_RIDE_CANCELLATION, SHARED_RIDE_MESSAGE, THREAD_OWNERSHIP_CHANGED_NOTIFICATION, USER_ONBOARDING_INVITE, OUT_OF_OFFICE_TURN_OFF_REMINDER, RETRY_AUTORESPONDER, DUE_FOLLOWUPS_NOTE, DO_NEG_AMT_ALERT, PAYMENT_FIRSTTIME_CUSTOMER, OPB, MBNOTES, SIGNED_ESTIMATE_NOTIFICATION, RSNOTES, READY_TO_SEND_NOTIFICATION, VOICEBOT_ASSIST, VOICEBOT_ASSIST_BOOK_AN_APPOINTMENT_REPLY, VOICEBOT_CALL_SUMMARY, ESCALATION_NOTIFICATION, SERVICE_PREDIAG_NOTIFICATION]
isManual boolean
subject string
metaData object
property name* string
tags string[]
Possible values: [TRASH]
draftAttributes object
draftStatus string
Possible values: [SCHEDULED, FAILED, DISCARDED, SENT, DRAFTED, QUEUED]
scheduledOn string
draftFailureReason string
Possible values: [MDL_EVENT_UNDER_TIME_LIMIT_REASON, MIN_DELAY_FOR_CEP_NOT_PASSED_REASON, UNCLOSED_RO_EXISTS_REASON, TIME_NOT_CORRECT_FOR_SENDING_REASON, MESSAGE_NOT_ALLOWED_FOR_LABEL, PREFERRED_COMMUNICATION_NOT_FOUND, NUMBER_OPTED_OUT, NOT_OK_TO_EMAIL, NOT_OK_TO_TEXT, FAILED_AUTO_CSI_OLD_CLOSE_DATE, USER_DOES_NOT_HAVE_AUTHORITY_TEXING_MANUAL, USER_DOES_NOT_HAVE_AUTHORITY_TEXTING_AUTOMATIC, OLD_INSPECTION, DEALERSHIP_NOT_AUTHORIZED_TO_SEND_MESSAGE, NO_CUSTOMER_FOUND, INVALID_PHONE_NUMBER, INVALID_COMMUNICATION_VALUE, CUSTOMER_OPTED_OUT, USER_DOES_NOT_HAVE_AUTHORITY_TO_SEND_MESSAGE, FAILED_TO_SEND_TEXT, NO_PHONE_NUMBER, GENERIC_FAILURE_REASON, NO_EMAIL_ID, CANT_SEND_EMAIL_TO_THIS_CUSTOMER, USER_DOES_NOT_HAVE_AUTHORITY_TO_EMAIL_MESSAGE, USER_NOT_FOUND_OR_INVALID, AUTO_CSI_ALREADY_SENT, CUSTOMER_DELAYED_TEXT_NOT_ALLOWED, CUSTOMER_DELAYED_EMAIL_NOT_ALLOWED, CUSTOMER_DELAYED_TEXT_AND_EMAIL_NOT_ALLOWED, TO_NUMBER_INVALID, FROM_NUMBER_INVALID, TO_AND_FROM_NUMBER_SAME, TO_AND_FROM_COMBINATION_INVALID, CUSTOMER_LOCKED, RATE_LIMIT_REACHED]
attachments object[]
Array [
fileURL string
attachmentExtension string
mimeType string
originalFileName string
docSize string
thumbnailURL string
mediaPreviewURL string
]
defaultReplyAction string
updateThreadTimestamp boolean
updateTotalMessageCount boolean
showInCustomerConversation boolean
messageTags object[]
Array [
tagTypeUuid string
referenceIdentifier string
value object
primaryAttribute object
value string
secondaryAttributes object[]
Array [
value string
]
parentTags object[]
Array [
tagTypeUuid string
referenceIdentifier string
]
]
messageSendingAttributes object
addSignature boolean
addTCPAFooter boolean
overrideOptoutRules boolean
sendVCard boolean
communicationValueOfCustomer string
communicationLabel string
overrideHolidays boolean
overrideHoursOfOperations boolean
listOfEmailsToBeCCed string[]
listOfEmailsToBeBCCed string[]
doNotBCCSender boolean
callbackURL string
callbackMetaData object
property name* string
addFooter boolean
sendSynchronously boolean
delay int32
queueIfOptedOut boolean
notificationAttributes object
internalSubscribersNotifierPop boolean
externalSubscribersNotifierPop boolean
threadOwnerNotifierPop boolean
sendPhoneNotification boolean
additionalNotifierNotificationDAUUIDs string[]
notificationButtons object[]
Array [
buttonTextTranslationWidgetKey string
buttonTextTranslationKey string
buttonDefaultText string
buttonTheme string
Possible values: [PRIMARY, SECONDARY, TERTIARY, QUATERNARY]
buttonActionEventData object
property name* string
isPrimaryButton boolean
]
incomingMessageAttributes object
fromNumber string
communicationUID string
forwardText boolean
forwardedEmailReference string
internalCommentAttributes object
usersToNotify object[]
Array [
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
]
usersFollowing object[]
Array [
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
]
groupMembers object
property name* object[]
Array [
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
]
usersSubscribed object[]
Array [
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
]
usersUnSubscribed object[]
Array [
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
]
messageMetadata object
property name* object
property name* string
freeMarkerMetadata object
property name* object
property name* object
whatsAppAttributes object
location object
latitude double
longitude double
label string
address string
isVoiceNote boolean
contentSid string
contentVariables object
property name* string
profileName string
waId string
forwarded boolean
frequentlyForwarded boolean
buttonPayload string
buttonText string
interactiveData string
originalRepliedMessageSid string
originalRepliedMessageSender string
referral object
body string
headline string
sourceId string
sourceType string
sourceUrl string
mediaId string
mediaContentType string
mediaUrl string
numMedia int32
ctwaClid string
errorCode int32
errorMessage string

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

messageUUID string
status string

Possible values: [SUCCESS, FAILURE]

requestUUID string
metaData object
property name* string
customerUUID string
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "messageUUID": "string",
  "status": "SUCCESS",
  "requestUUID": "string",
  "metaData": {},
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...