Message

Table:
message
Model Version:
0698abe6f9ba5106
JSON Schema:
Message
appointmentEvent
Nullable
Rescheduled, Scheduled, Reminder, Confirm, Canceled, Acknowledgement
appointmentId
Nullable
string
appointment associated with this message
authorType
Customer, User, System
the one who sent/authored this message
automatedCampaignId
Nullable
string
the id of the automated campaign that generated this message
avoidSMSQuietHours
boolean
companyId
string
conversationId
Nullable
string
createdDate
date-time
customerId
Nullable
string
the id of the customer that authored or was sent the message
deleted
boolean
if the record has been deleted
deletedDate
Nullable
date-time
the date that the record was deleted or null if not deleted
deletedReason
Nullable
string
the reason that the record was deleted
deletedUserId
Nullable
string
the user that deleted the record or null if not deleted
detached
Nullable
boolean
true if message is public but has no reference to a customer (only for migration purposes)
emailError
Nullable
string
error sending email, if any
emailId
Nullable
string
the id of the customer email that authored or was sent the message
emailStatus
Nullable
Pending, Sent, Read, Error, Delivered, Unknown
status of sending email, is null if author is a Customer
emailSubject
Nullable
string
overrides default email subject
id
Primary Key
string
imported
boolean
internal
Nullable
boolean
true if internal note, is null if author is a Customer
isOrderShare
boolean
true if this message created via Order Share modal
locationId
string
locationReviewRequestId
Nullable
string
the id of the review request
metadata
Nullable
object
metadata reserved for customers to control
oneTimeCampaignId
Nullable
string
the id of the one time campaign that generated this message
orderId
Nullable
string
an order associated with this message
orderShareType
Nullable
Inspection, Order
the type of order content being shared
origin
ChatBot, Scheduler, Campaign, Web, Mobile, CustomerOrderPage, SMS, Email
what medium the message originated from
phoneNumberId
Nullable
string
the id of the customer phone number that authored or was sent the message
requestAppointmentConfirmation
Nullable
boolean
if true, the email/sms will contain actions to confirm/decline an appointment
sendEmail
Nullable
boolean
if an email should be sent, is null if author is a Customer
sendSms
Nullable
boolean
if an sms should be sent, is null if author is a Customer
shopRead
Nullable
boolean
true if someone at the shop has read a Customer message, is null if author is a User
smsError
Nullable
string
error sending sms, if any
smsStatus
Nullable
Pending, Sent, Read, Error, Delivered, Unknown
status of sending sms , is null if author is a Customer
suggestedReply
Nullable
string
if we can suggest a reply, this will have a value to suggest to the user in the app
suggestedReplyState
None, Partial, Full
the state of the suggestion
text
string
appears in message center/thread (content of message if SMS, plaintext/preview if email)
type
Transactional, Marketing
Transactional or Marketing. Marketing messages are sent from a different email/phone and have different opt-in requirements
updatedDate
Nullable
date-time
userId
Nullable
string
the user who authored the message
vehicleId
Nullable
string
a vehicle associated with this message
vendorId
Nullable
string
a vendor associated with this message