Skip to main content

create​

create

Path Parameters
    departmentUUID string required
    userUUID string required
Request Body required
    subject object
    type string
    value string
    primaryThreadContext object
    customerUUID string
    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, PAYMENT_REPORT, DISPUTE_EMAIL, ACH_PAYMENT_STATUS]

    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, WHATSAPP_24HR_WINDOW_EXPIRED, WHATSAPP_SENDER_NOT_CONFIGURED, EMAIL_HARD_BOUNCED, CAMPAIGN_OPT_OUT]

    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
  • ]
  • ]
    • internalCommentAttributes object
    usersToNotify object[]
  • Array [
    • uuid string
    name string
    type string

    Possible values: [USER, CUSTOMER]

    departmentUuid string
    dealerName string
  • ]
    • usersFollowing object[]
  • Array [
    • uuid string
    name string
    type string

    Possible values: [USER, CUSTOMER]

    departmentUuid string
    dealerName string
  • ]
    • groupMembers object
    property name* object[]
  • Array [
    • uuid string
    name string
    type string

    Possible values: [USER, CUSTOMER]

    departmentUuid string
    dealerName string
  • ]
    • usersSubscribed object[]
  • Array [
    • uuid string
    name string
    type string

    Possible values: [USER, CUSTOMER]

    departmentUuid string
    dealerName string
  • ]
    • usersUnSubscribed object[]
  • Array [
    • uuid string
    name string
    type string

    Possible values: [USER, CUSTOMER]

    departmentUuid string
    dealerName string
  • ]
    • primaryDealerUUID string
    secondaryDealerUUID string
    customerUUID string
Responses

OK

Schema
    context object
    subjectType string
    subjectValue string
    visibility string

    Possible values: [PRIMARY_ONLY, SHARED, SECONDARY_ONLY]

    usersToNotify object[]
  • Array [
    • uuid string
    name string
    type string

    Possible values: [USER, CUSTOMER]

    departmentUuid string
    dealerName string
  • ]
    • primaryDealerUUID string
    secondaryDealerUUID string
    messages object[]
  • Array [
    • id int64
    uuid string
    messageType string
    protocol string
    fromName string
    fromNumber string
    toName string
    toNumber string
    messageSize int32
    sentOn date-time
    receivedOn date-time
    tags string
    emailMessageId string
    communicationUid string
    messagePurpose string
    deliveryStatus string
    dealerDepartmentUuid string
    twilioDeliveryFailureMessage string
    numberofMessageAttachments int32
    isManual boolean
    customerUuid string
    customerName string
    dealerUuid string
    dealerAssociateUuid string
    isRead boolean
    isArchive boolean
    messageExtnDTO object
    messageUuid string
    messageBody string
    subject string
    draftMessageMetaDataDTO object
    messageUuid string
    status string
    scheduledOn date-time
    reasonForLastFailure string
    addSignature boolean
    messageMetaDataDTO object
    messageUuid string
    metaData string
    docFiles object[]
  • Array [
    • docFileName string
    fileExtension string
    mimeType string
    originalFileName string
    docSize string
    thumbnailFileName string
    mediaPreviewURL string
    messageUuid string
  • ]
    • messagePredictionDTOSet object[]
  • Array [
    • messageUuid string
    predictionFeature object
    id int64
    predictionFeature string
    prediction string
    metadata string
    messagePredictionFeedback object[]
  • Array [
    • messagePredictionID int64
    userFeedback string
    feedbackReason string
    userUUID string
    departmentUUID string
  • ]
  • ]
    • messageTags object
    tagTypes object[]
  • Array [
    • uuid string
    dealerUuid string
    name string
    displayName string
    description string
    dataType string

    Possible values: [BOOLEAN, STRING, NUMBER]

    iconResourceId string
    rank string
    parentTagTypeUuids string[]
    apiPaths object
    searchTags string
    getTagDetails string
    uiFilteringAllowed boolean
    uiStyle string
  • ]
    • tags object[]
  • Array [
    • tagTypeUuid string
    referenceIdentifier string
    value object
    primaryAttribute object
    value string
    secondaryAttributes object[]
  • Array [
    • value string
  • ]
    • parentTags object[]
  • Array [
    • tagTypeUuid string
    referenceIdentifier string
  • ]
  • ]
    • messageSnoozeDataDTO object
    snoozeNote string
    snoozedDate date-time
    unsnoozedDate date-time
    whatsAppMessageDTO object
    messageId int64
    whatsAppMessageType string

    Possible values: [TEXT, IMAGE, VIDEO, AUDIO, DOCUMENT, STICKER, CONTACTS, LOCATION, TEMPLATE, INTERACTIVE, UNKNOWN]

    whatsAppMessageSid string
    profileName string
    waId string
    status string

    Possible values: [ACCEPTED, QUEUED, SENDING, SENT, DELIVERED, READ, FAILED, UNDELIVERED]

    contentSid string
    originalRepliedMessageSid string
    originalRepliedMessageId int64
    isVoiceNote boolean
    forwarded boolean
    frequentlyForwarded boolean
    errorCode int32
    whatsAppPayload object
    mediaList object[]
  • Array [
    • mediaUrl string
    mimeType string
    fileName string
    fileSizeBytes int64
    caption string
    isVoiceNote boolean
  • ]
    • location object
    latitude double
    longitude double
    label string
    address string
    contacts object[]
  • Array [
    • name string
    firstName string
    lastName string
    middleName string
    prefix string
    suffix string
    company string
    department string
    title string
    phones object[]
  • Array [
    • phone string
    type string
  • ]
    • emails object[]
  • Array [
    • email string
    type string
  • ]
    • addresses object[]
  • Array [
    • street string
    city string
    state string
    zip string
    country string
    countryCode string
    type string
  • ]
    • urls object[]
  • Array [
    • url string
    type string
  • ]
    • birthday string
  • ]
    • template object
    templateName string
    templateLanguage string
    contentSid string
    contentVariables object
    property name* string
    referral object
    body string
    headline string
    sourceId string
    sourceType string
    sourceUrl string
    mediaId string
    mediaContentType string
    mediaUrl string
    numMedia int32
    ctwaClid string
    errorMessage string
    buttonPayload string
    buttonText string
    interactiveData string
    originalRepliedMessageSender string
    originalRepliedMessagePreview string
    businessConnectMessage boolean
    businessConnectVisibility string
    originDealerName string
  • ]
    • nextCursor string
    messageUUID string
    errors object[]
  • Array [
    • errorCode string
    errorDescription string
    errorUID string
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
Loading...