Skip to main content

Message

A message exchanged between a user in Endear & an external contact

Fields

auto_response_detectedBoolean!

Whether the Message is an automatic reply

body_htmlString!

An HTML version of the Message

body_markdownString!

A markdown version of the Message

body_textString!

An SMS-text version of the Message

body_text_previewString!

A preview of the Message

campaignCampaign

If the message was created by a Campaign, the Campaign

campaign_draftCampaignDraft

The Campaign Draft that originated this message, if message is part of a Campaign

contact_methodContactMethod!

The ContactMethod used to send or receive the Message

conversationConversation!

The Conversation the Message belongs to

created_atDateTime!

The date the Message was created

delivered_atDateTime

The date the Message was delivered

directionMessageDirection!

Whether the Message was sent (outbound) or received (inbound)

draftDraft

The Draft that was used to create the Message

expiration_reasonMessageExpirationReason

The reason the Message expired

expired_atDateTime

The date the Message expired

external_contact_addressID!

The email address or phone number of the external contact

fail_reasonMessageFailReason

The reason the Message failed to send

failed_atDateTime

The date the Message failed to send

first_clicked_atDateTime

The date when the Message was first clicked

first_inbound_replyMessage

The first inbound reply to this Message

first_opened_atDateTime

The date when the Message was first opened or read

first_outbound_replyMessage

The first outbound reply to this Message

first_replyMessage

The first reply to this Message

idID!

The unique identifier of the Message

in_reply_toMessage

The Message this Message is in reply to

is_opt_out_messageBoolean!

Whether the Message is an opt-out message

is_replyBoolean!

Whether the Message is a reply

last_clicked_atDateTime

The date when the Message was last clicked

last_inbound_replyMessage

The last inbound reply to this Message

last_opened_atDateTime

The date when the Message was last opened or read

last_opened_at_for_reportingDateTime

The date when the Message was last opened or read

last_outbound_replyMessage

The last outbound reply to this Message

last_replyMessage

The last reply to this Message

latest_replyMessage

The latest reply to the Message

Deprecated — Use last_reply instead

messaging_applicationMessagingApplication

The MessagingApplication that created the Message

permanently_redacted_atDateTime

The date the Message was permanently redacted

provider_fail_reasonString

The reason the Message failed to send from the provider

redacted_atDateTime

The date the Message was redacted

sender_messaging_applicationMessagingApplication

The MessagingApplication that sent the Message

sent_asUser

The User that sent the Message was sent as

sent_atDateTime

The date the Message was sent

sent_from_teamTeam

The Team that sent the Message was sent from

sent_or_created_atDateTime!

The date the Message was sent or created (if not sent)

source_body_htmlString

The original body of an inbound Message (null on outbound messages)

statusMessageStatus!

The delivery status of the Message

subjectNonEmptyString

The subject line of the Message (if any)

teamTeam

The Team that sent the Message was sent from

Deprecated — Use Message.sent_from_team instead

templateTemplate

The Template that was used to create the Message

threadThread

The Thread this Message is in

ttl_expires_atDateTime

The date when the ability to reply to the message expires

typeContactMethodType!

The type of the Message

updated_atDateTime!

The date the Message was last updated

utm_codeString

The UTM code of the Message

viaMessageSentVia!

The method by which the Message was sent

web_urlURL!

The URL to the Message inside the web application

whatsapp_message_typeWhatsAppMessageType

The type of WhatsApp message