Message Schemas

Message Schema

Field Name Sub-Field Name Format Description
attachments   Urn[] The list of attachments for this message. The urns are digitalMediaAssetUrn. For more information, see here.
author   Urn The identity that created this message. It represents the sole owner of a mailbox in the given domain. Can be one of the following:
  • personUrn - member mailbox in the format urn:li:person:XXX
  • hireMailboxUrn - Recruiter mailbox in the format urn:li:hireMailbox:XXX
  • salesIdentityUrn - Sales Navigator mailbox in the format urn:li:salesIdentity:XXX
  • corporateMemberUrn - [LEGACY] Sales Navigator or Recruiter mailbox in the format urn:li:corporateMember:XXX
content     The content of the message. This field is identical for all viewers and will show the latest edit, if any.
  content optional string  The content of the message. If missing, rely on the fallback value for text to display. Use the format field to determine what type to expect in this field.
  fallback string Text to display if the format is not understood by the client.
  format string The encoding format for this message. Can be one of the follow enums:
  • TEXT - Text-only format. Because the fallback field would end up containing the same string as the content, for efficiency, the content is not provided and will be null. The fallback field will be the only text.
  • EXPERIMENTAL - Experimental format. Nothing of this type should be member authorable. Renderers may ignore messages with this format.
  • LITTLE - Lightweight markup format. The content field consists of a string in the LITTLE markup language. The fallback field contains a textual version of the content.
  • SYSTEM - System message format. The content field contains a SystemMessageContent object which defines the system message type and what changes it describes. The fallback field contains an English textual description of the system message.
  • INDIRECT - The content that provides an Urn reference to message data.
  formatVersion int The version of the format being used. Versions are used to indicate additions of features within a format that are backward compatible. Versions start at 1 and increase with features. Breaking changes require a new format.
createdAt   optional long Time when the content of the message was created. Represented in epoch milliseconds.
deliveredAt optional long Time when the message was delivered to the owner's mailbox. This value reflects only the message as viewed by the owner rather than any indication of what happened with the delivery of the message to other viewers.
id   string The entity ID of the message.
lastEditedAt   optional long Time when the content and attachments of the Message changed since it was originally authored. A missing value means nothing has changed. Represented in epoch milliseconds.
owner   Urn The identity Urn that represents the owner of the mailbox in this domain where this message is stored. It is typically a personUrn but can be other URN type as well, such as salesIdentityUrn.
readAt   optional long Time when the message was read by the viewer. A missing value means the message is unread. Represented in epoch milliseconds.
thread   messagingThreadUrn The thread that ties this message to other related messages. A message can only belong to one thread.

Messaging Thread Schema

Field Name Sub-Field Name Format Description
membership Array The current list of participants in this thread. Each participant is an identity that owns a mailbox where messages will be delivered.
createdAt long Time when the thread participant was created
identity Urn The identity Urn that is participating in the Thread. It represents the owner of a Mailbox in a given Domain and can be an author or a recipient in a Thread. Can be one of the following:
  • personUrn - member mailbox in the format urn:li:person:XXX
  • hireMailboxUrn - Recruiter mailbox in the format urn:li:hireMailbox:XXX
  • salesIdentityUrn - Sales Navigator mailbox in the format urn:li:salesIdentity:XXX
  • corporateMemberUrn - [LEGACY] Sales Navigator or Recruiter mailbox in the format urn:li:corporateMember:XXX
owner Urn The identity Urn that represents the owner of the mailbox in this domain where this thread is stored. Can be one of the following:
  • personUrn - member mailbox in the format urn:li:person:XXX
  • hireMailboxUrn - Recruiter mailbox in the format urn:li:hireMailbox:XXX
  • salesIdentityUrn - Sales Navigator mailbox in the format urn:li:salesIdentity:XXX
  • corporateMemberUrn - [LEGACY] Sales Navigator or Recruiter mailbox in the format urn:li:corporateMember:XXX
title string Optional. The title of the thread. This field is identical but editable for all viewers of the thread.

Sales Identity Schema

Field Name Format Description
id long The unique identifier of the sales identity entity.
member personUrn The member of the Sales Navigator user.