Messages

Object

Use live API calls for an example of the object.

Fields

Field Type Description
created_at string The time at which the message was created in ISO 8601 format.
id string Primary identifier for a message. This will be an integer, but it is always expressed as a string to avoid limitations with the way JavaScript integers are expressed. This id space is unique to Message objects. There can be a Post and User with the same ID; no relation is implied.
is_deleted boolean Only set if true.
is_sticky boolean Whether a full-access user has stickied the message.
source object
Field Type Description
name string Description of the API consumer that created this message.
link string Link provided by the API consumer that created this message.
id string The public client id of the API consumer that created this message.
reply_to string Optional id of the message this message is replying to.
thread_id string The id of the message at the root of the thread that this message is a part of. If thread_id==id then this property does not guarantee that the thread has > 1 message.
user object This is an embedded User object. Note: In certain cases (e.g., when a user account has been deleted), this key may be omitted.
content object

NOTE: Not included if the message has been deleted.

Field Type Description
text string User supplied text of the message. All Unicode characters allowed. Maximum length 2048 characters. The maximum length can be retrieved from the Configuration endpoint.
html string Server-generated annotated HTML rendering of message text.
entities object Rich text information for this message. See Entities.

General Message Parameters

Any endpoint that returns message objects can be subject to these parameters.

General Parameters

Name Type Description
include_deleted integer (0 or 1) Include deleted messages. Defaults to true.
include_html integer (0 or 1) Should the message and user html field be included alongside the text field in the response objects? Defaults to true.
include_message_html integer (0 or 1) Should the message html field be included alongside the text field in the response objects? Defaults to true. Note that include_html takes priority if present.
include_raw integer (0 or 1) Include raw on all objects. Defaults to false.
include_message_raw integer (0 or 1) Include raw on all message objects. Defaults to false.
include_client integer (0 or 1) Include the client object with the post. Defaults to true.