User Conversations, Specific

Returns information about a private conversation for the context user. Also used to search within a conversation and to change the status of a conversation.

Resource

1/chatter/users/userId/conversations/conversationId

1/connect/communities/communityId/chatter/users/userId/conversations/conversationId

userId must be the ID of the context user or the alias me.

Note

Available since version

23.0

Requires Chatter

Yes

HTTP methods

GET, PATCH, or HEAD

Request parameter for GET

Parameter Name	Type	Required or Optional	Description	Available Version
`q`	String	Optional	Specifies the string to search. The search string must contain at least two characters, not including any wildcards. For more information about wildcards, see Wildcards. This parameter is optional. The query parameter only searches message text bodies, not user names, titles, and so on. Note	24.0

Request body for PATCH

Root XML tag

<conversation>

Properties

Name	Type	Description	Available Version
`read`	Boolean	Changes the conversation status to unread (`false`) or read (`true`).	24.0

Request parameters for PATCH

Parameter Name	Type	Description
`read`	Boolean	Changes the conversation status to unread (`false`) or read (`true`).

Response body for GET or HEAD

Conversation Detail

Chatter REST API Developer's Guide

User Conversations, Specific