DirectMessage

A direct message from one person to a defined set of participants, which are enumerated in the participants field. Corresponds to creating a "Message" from the Create menu in Jive. See the /dms service.

Example:
Example JSON

JSON including important fields and a Direct Message's resources. See the tables below for a list of all fields and resources.

{
  "type" : "dm",
  "status" : "published",
  "subject" : "Message for you",
  "parent" : "https://example.jiveon.com/api/core/v3/people/2001",
  "content" : {
    "type" : "text/html",
    "text" : "Let's meet at 4"
  },
  "author" : {
    "name" : {
      "givenName" : "Vicky",
      "familyName" : "Employee",
      "formatted" : "Vicky Employee"
    },
    "type" : "person",
    "displayName" : "Vicky Employee",
    "id" : "2001"
  },
  "participants" : [ {
    "name" : {
      "formatted" : "Bob Goodwin"
    },
    "type" : "person",
    "displayName" : "Bob Goodwin",
    "id" : "1"
  } ],
  "id" : "1004",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/dms/1004",
      "allowed" : [ "DELETE", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/inbox/dm/1004",
      "allowed" : [ "GET" ]
    },
    "comments" : {
      "ref" : "https://example.jiveon.com/api/core/v3/dms/1004/comments",
      "allowed" : [ "POST", "GET" ]
    }
  }
}

Fields

FieldTypeMode †Description
authorPersonread-only

Author of this content object.

contentContentBodyrequired

Content of this content object.

followerCountIntegerread-only

Number of people following this object.

Availability:

Will be present only for object types that support being followed.

highlightBodyStringread-only

Highlight snippet of a search match in the body or description.

Availability:

Will be present in search results only.

highlightSubjectStringread-only

Highlight snippet of a search match in the subject or name.

Availability:

Will be present in search results only.

highlightTagsStringread-only

Highlight snippet of a search match in tags.

Availability:

Will be present in search results only.

idStringread-only

Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.

likeCountIntegerread-only

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

parentStringrequired

URI of the parent place (or person, for personal content) of this content object.

parentContentSummaryread-only

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

participantsPerson[]read-only

The people to whom this direct message was sent.

publishedISO 8601 Dateread-only

Date and time when this content object was originally created.

replyCountIntegerread-only

Number of replies to this object.

Availability:

Will be present only for object types that support replies.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

statusStringread-only

Published status of this content object.

  • incomplete - Content object is in draft mode
  • pending_approval - Content object is waiting for approval
  • rejected - Content object has been rejected for publication by an approver
  • published - Content object has been published
subjectStringread-only

Subject of this content object.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringrequired

The object type of this object ("dm"). This field is required when creating new content.

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanread-only

Flag indicating that this content object is potentially visible to external contributors.

†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Resources

ResourceMethodDescription
imagesGET

Return metadata about the images attached to this direct message.

Retrieves:
  • Image[]
    • htmlGET

    Return the HTML representation of this direct message.

    readPOST

    Mark this direct message as having been read.

    Since: 3.2
    readDELETE

    Mark this direct message as having not been read.

    Since: 3.2
    messagesGET

    Return a paginated list of replies to this direct message.

    Retrieves:
  • Comment[]
    • commentsPOST

    Create a new reply to this message, and return a Comment representing the new object.

    Takes:
    • Comment fields describing the new reply
    Retrieves:
  • Comment describing the newly created reply
    • selfGET

    Return an updated version of this direct message.

    Retrieves:
  • DirectMessage representing the updated direct message
    • selfDELETE

    Delete this direct message and all replies associated with it.