Skip to content
Home/
REST API Reference
/
/
Message

Message

Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.

typestringrequired

The type of the message

Example:"user_message"
idstringrequired

The id representing the message.

Example:"1488971108"
created_atinteger, (date-time)required

The time the conversation was created.

Example:1667560812
subjectstring

The subject of the message. Only present if message_type: email.

Example:"Greetings"
bodystringrequired

The message body, which may contain HTML.

Example:"Hello"
message_typestringrequired

The type of message that was sent. Can be email, inapp, facebook, twitter or whatsapp.

Enum:"email""inapp""facebook""twitter""whatsapp"
Example:"inapp"
conversation_idstring

The associated conversation_id

Example:"64619700005570"
ownerobject or null(Admin)

The admin who sent the message. Only present when the message has an owner.

templatestring

The style of the email, such as plain or personal. Only present when message_type is email.

Example:"plain"
external_idstring

The external identifier of the message, if one was set when the message was created. Only returned for messages started by a contact.

Example:"api:order-1234"
whatsapp_message_idstring

The id WhatsApp gave the message. Only present for whatsapp messages that WhatsApp accepted.

Example:"wamid.EXAMPLE123"
{
  "type": "user_message",
  "id": "1488971108",
  "created_at": 1667560812,
  "subject": "Greetings",
  "body": "Hello",
  "message_type": "inapp",
  "conversation_id": "64619700005570",
  "owner": {
    "type": "admin",
    "id": "1295",
    "name": "Joe Example",
    "email": "jdoe@example.com",
    "job_title": "Associate",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "away_status_reason_id": 12345,
    "has_inbox_seat": true,
    "team_ids": [ … ],
    "avatar": { … },
    "team_priority_level": { … },
    "role": { … }
  },
  "template": "plain",
  "external_id": "api:order-1234",
  "whatsapp_message_id": "wamid.EXAMPLE123"
}