Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Resources
Chatter Resources
Announcements Resources
Chatter Resources
Comments Resources
Custom Recommendation Audience Resources
Custom Recommendation Definition Resources
Dashboard Component Snapshot Resource
Experience Cloud Sites Chatter Moderation Resources
Feed Elements Resources
Feeds Resources
Followers on Records Resource
Groups Resources
Influence Resource
Likes Resource
Mentions Resources
Mentions Completions
Mentions Validations
Missions Resources
Question and Answers Resources
Scheduled Custom Recommendations Resources
Subscriptions Notifications Member Resource
Subscriptions Resource
Topics Resources
User Profiles Resources
Users Resources
Request Bodies
Response Bodies
Appendices
PDF

Mentions Completions

Information about users and groups to mention in a feed item body or comment body. Use this resource to generate a list of proposed mentions that a user can choose from. A mention is an “@” character followed by a user or group name. When a user or group is mentioned, they receive a notification.
Resource
1/chatter/mentions/completions
1/connect/communities/communityId/chatter/mentions/completions
Available since version
29.0
Requires Chatter
Yes
HTTP methods
GET, HEAD
Request parameters for GET
Parameter Name Type Description Required or Optional Available Since
contextId String A feed item ID (for a mention in a comment) or a feed subject ID (for a mention in a feed item) that narrows search results, with more useful results listed first. Use a group ID for groups that allow customers to ensure mention completion results include customers. Optional 29.0
page Integer The number of the page you want returned. Numbering starts at 0. If you pass 0 or omit the property, the first page is returned.

Attempting to page beyond 500 results returns an empty response.

 Optional 29.0
pageSize Integer The number of items per page. Valid values are from 1 through 100. The default size is 25.

Attempting to retrieve more than 500 results returns an empty response.

 Optional 29.0
q String A search term for matching user and group names. Searching for a group requires a minimum of 2 characters. Searching for a user doesn’t require a minimum number of characters. This parameter does not support wildcards. Required 29.0
type String The type of mention completion. One of these values:
  • All—All mention completions, regardless of the type of record to which the mention refers.
  • Group—Mention completions for groups.
  • User—Mention completions for users.

The default value is All.

 Optional 29.0
Response body for GET
Mention Completion Page
Example for getting mention completions for a comment
Specify the feed item ID in the contextId parameter to request mention completions for a comment on the feed item.
1/chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g