--- schema_version: "1" id: 8381a53f9d039337b22284e41676432a3e0d4bbb775010a1cf3102d0a1d937de title: Chatter Connect REST API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/connect-rest/connect-rest-api/references/generated-api-specs/connect-rest-api-chatter.md canonical_url: https://developer.salesforce.com/docs/platform/connect-rest-api/references/connect-rest-api-chatter source_site: developer.salesforce.com content_type: documentation content_hash: 9003b449c7c76199db9d182e392892f797418ebd6416161b9b6b22907b0ea78e products: - Connect REST API Developer Guide - Connect REST APIs --- Chatter Connect REST API # Chatter Connect REST API > **Note**: The API Reference has a new three-panel layout. Browse grouped endpoints on the left, review endpoint details in the center, and access examples on the right. These REST API resources require Chatter and have a per user, per application, per hour rate limit. This rate limit is different from other Connect REST API resources. When you exceed the rate limit, Chatter REST API resources return a 503 Service Unavailable error code. **Important**: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. **Version:** v68.0 ## Servers * `https://{MyDomainName}.my.salesforce.com/services/data/v68.0` API server for your Salesforce org. * ``MyDomainName (default None) Your org's My Domain name, which is used as a subdomain for the URLs that Salesforce uses to serve your org. For example, if your Lightning URL is `https://yourcompanyname.lightning.force.com`, then your My Domain name is `yourcompanyname`. Find your My Domain name and login URL on the My Domain page in Setup, or use the `getMyDomainName()` method in the Apex Domain class.`` ## Tags ### Announcements Resources Get the announcements for the specified parent or create an announcement. Also get information about, update, or delete an announcement. Use an announcement to highlight information. Users can discuss, like, and post comments on announcements. Deleting the feed post deletes the announcement. Creating an announcement also creates a feed item with the announcement text. An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. ### Chatter Resources Get a directory of Chatter feeds, groups, and users resources. Control when Chatter email digests are sent. Get a list of supported emojis. Get extensions. Get link metadata. Get information about, update, and delete Chatter streams. ### Custom Recommendation Audience Resources Target specific audiences for your custom recommendations. Use these resources to get information about, create, update, and delete recommendation audiences. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. These recommendations appear by default on the Customer Service template. They appear on the home and question detail pages and in the feed in Salesforce mobile web. They also appear anywhere community managers add recommendations using Experience Builder in the Customer Service template. So that users don’t see the same recommendations all the time, Salesforce periodically removes and brings back custom recommendations that haven’t been accepted or dismissed. ### Custom Recommendation Definition Resources Recommendation definitions allow you to create custom recommendations that appear in Experience Cloud sites, encouraging users to watch videos, take training and more. Use these resources to get information about, create, modify, and delete recommendation definitions. Also get information about, upload, modify, and delete recommendation definition photos. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. These recommendations appear by default on the Customer Service template. They appear on the home and question detail pages and in the feed in Salesforce mobile web. They also appear anywhere community managers add recommendations using Experience Builder in the Customer Service template. So that users don’t see the same recommendations all the time, Salesforce periodically removes and brings back custom recommendations that haven’t been accepted or dismissed. ### Followers on Records Resources Get information about the followers of the specified record. ### Groups Resources Information about groups, such as the group's members, photo, and the groups in the organization. Create and delete a group, add members to a group, and change the group photo. The groups resource is not a feed. To view the feed for a group, use the [Record Feed URL](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Record-Feed-Resources/operation/get_connect_resource_feeds_record__cc_record_feed_url) resource with a group ID for `{recordId}`. ### Influence Resources List of the percentile thresholds used to categorize an organization’s users by their influence in Chatter. Users are ranked based on the number of posts and comments made, and comments and likes received. The percentile associated with a category represents the bottom threshold for that influencer category. For example: `0.25` defines the cutoff for the `Active Influencer` category, which means it includes users with an influence rank equal to or greater than the 25th percentile (25%) and less than the next highest category threshold. ### Likes Resources Information about the specified like. Also used to delete a like. ### Mentions Resources Get a list of proposed mentions that a user can choose from. Get information about whether the specified mentions are valid for the context user. ### Missions Resources Update a user’s mission activity count. Export and purge mission activity for a user. Purge mission activity for all users. Get a user’s mission progress. ### Question and Answers Suggestions Resources Get question and answers suggestions. ### Scheduled Custom Recommendations Resources Get information about, create, update, or delete scheduled custom recommendations. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. ### Subscriptions Notifications Member Resources Get information about the frequency with which a user receives subscription notifications. Subscribe or unsubscribe a user from receiving notifications. When users opt to receive notifications for the topics they follow, they get an email when the topic is added to a post that they have access to. When users opt to receive notifications for their streams, they get an email on every post in the stream. ### Subscriptions Resources Information about the specified subscription. Also used to delete a subscription, for example, to unfollow a record or a topic. A subscription ID is returned as part of the response body for `follower` and `following` resources, for example, `/records/{recordId}/followers`. In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary. ### Topics Resources Get endorsements for a topic and endorse someone for a topic. Get the groups recently contributing to a topic. Get knowledgeable people for a topic. Opt out of being knowledgeable about a topic and opt back in. ### User Profiles Resources The user profile data populates the profile page (also called the Chatter profile page). This data includes user information (such as address, manager, and phone number), some user capabilities (permissions), and a set of subtab apps, which are custom tabs on the profile page. ### Users Resources Get information about the user, such as who is following the user and the user's recommendations. Post feed items and update conversation status. ## Operations ### GET Chatter Directory `GET /chatter` Operation ID: `getChatterRootDirectory`. Tags: Chatter Resources. Describes the URLs to the sub-resources available under /chatter. Get a directory of Chatter feeds, groups, and users resources. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter` _Available in: v23.0_ #### Responses * **200** _Chatter Directory_ Chatter directory. Media type: `application/json`. Schema: `ChatterDirectory`. #### Code samples _Example: Example 1 · HTTP_ ``` { "feeds": "/services/data/v67.0/chatter/feeds", "groups": "/services/data/v67.0/chatter/groups", "users": "/services/data/v67.0/chatter/users" } ``` ### GET Announcements `GET /chatter/announcements` Operation ID: `getAnnouncementCollection`. Tags: Announcements Resources. Returns a list of announcements for the specified parent. Get the announcements for the specified parent. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/announcements` _Available in: v36.0_ #### Parameters * `page` (query, integer) Number of the page you want returned. Starts at 0. If you pass in `null` or 0, the first page is returned. _Available in: v36.0_ * `pageSize` (query, integer) Specifies the number of announcements per page. _Available in: v36.0_ * `parentId` (query, string, required) ID of the parent entity for the announcement, that is, a group ID when the announcement appears in a group. _Available in: v36.0_ #### Responses * **200** _Announcement Page_ A paginated collection of Announcement response bodies. Media type: `application/json`. Schema: `AnnouncementCollection`. ### POST Announcements `POST /chatter/announcements` Operation ID: `postAnnouncementCollection`. Tags: Announcements Resources. Returns a list of announcements for the specified parent. Create an announcement. Creating an announcement also creates a feed item with the announcement text. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/announcements` _Available in: v36.0_ Returns the same response body as the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation. See that operation for the full response schema. #### Request body Media type: `application/json`. Schema: `AnnouncementInput`. _Example: example\_1_ Payload 1 Creating an announcement ``` { "body": { "messageSegments": [ { "text": "Please install the updates for all iOS devices.", "type": "Text" } ] }, "parentId": "0F9B0000000004S", "expirationDate": "2016-02-22T00:00:00.000Z" } ``` _Example: example\_2_ Payload 2 Creating an announcement using an existing feed item ``` { "feedItemId": "0D5D0000000DaZBKA0", "expirationDate": "2016-02-22T00:00:00.000Z" } ``` #### Responses * **200** _Announcement_ An announcement. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation. See that operation for the full response schema. ### GET Announcement `GET /chatter/announcements/{announcementId}` Operation ID: `getAnnouncement`. Tags: Announcements Resources. Access information about an announcement in a group. Get information about an announcement. _Available in: v31.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/announcements/{announcementId}` _Available in: v31.0_ #### Parameters * `announcementId` (path, string (Id), required) ID of the announcement. Pattern: ^(0Bt)\\w\*. #### Responses * **200** _Announcement_ An announcement. Media type: `application/json`. Schema: `Announcement`. ### DELETE Announcement `DELETE /chatter/announcements/{announcementId}` Operation ID: `deleteAnnouncement`. Tags: Announcements Resources. Access information about an announcement in a group. Delete an announcement. _Available in: v31.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/announcements/{announcementId}` _Available in: v31.0_ #### Parameters * `announcementId` (path, string (Id), required) ID of the announcement. Pattern: ^(0Bt)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH Announcement `PATCH /chatter/announcements/{announcementId}` Operation ID: `patchAnnouncement`. Tags: Announcements Resources. Access information about an announcement in a group. Update an announcement. _Available in: v31.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/announcements/{announcementId}` _Available in: v31.0_ Returns the same response body as the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation. See that operation for the full response schema. #### Parameters * `announcementId` (path, string (Id), required) ID of the announcement. Pattern: ^(0Bt)\\w\*. * `expirationDate` (query, string, required) Date time in ISO 8601 format. The Salesforce UI displays an announcement until 11:59 p.m. on this date unless another announcement is posted first. The Salesforce UI ignores the time value in the `expirationDate`. However, you can use the time value to create your own display logic in your own UI. _Available in: v31.0_ #### Request body (required) _Available in: v31.0_ Media type: `application/json`. Schema: `AnnouncementInput`. _Example: example\_1_ Payload 1 Updating an announcement ``` { "expirationDate": "2016-02-22T00:00:00.000Z", "isArchived": "false" } ``` #### Responses * **200** _Announcement_ An announcement. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation. See that operation for the full response schema. ### POST Chatter Digests `POST /chatter/digests` Operation ID: `submitDigestJob`. Tags: Chatter Resources. Some orgs need more control over when digest emails are sent. To give them this control, the ChatterDigestEmailsApiOnly pref needs to be enabled, which will turn off the normal digest scheduling and allow the admin to trigger the digest processes on demand. Control when daily and weekly Chatter email digests are sent. The times when Chatter sends email digests are not configurable in the UI. To control when email digests are sent and to use this resource, contact Salesforce to enable API-only Chatter Digests. **Caution**: Enabling API-only Chatter Digests disables the scheduled digests for your org. You must call the API for your users to receive their digests. _Available in: v37.0_ #### Parameters * `period` (query, DigestPeriod, required) Time period that’s included in a Chatter email digest. Values are: * `DailyDigest` — The email includes up to the 50 latest posts from the previous day. * `WeeklyDigest` — The email includes up to the 50 latest posts from the previous week. _Available in: v37.0_ #### Request body (required) Submit a daily or weekly Chatter email digest job. _Available in: v37.0_ Media type: `application/json`. Schema: `DigestJobInput`. _Example: example\_1_ Payload 1 ``` { "period": "DailyDigest" } ``` #### Responses * **200** _Digest Job_ Represents a successfully enqueued API digest job request. Media type: `application/json`. Schema: `DigestJob`. ### GET Emojis `GET /chatter/emojis` Operation ID: `getSupportedEmojis`. Tags: Chatter Resources. A list of emojis that will be used to dictate which emojis are allowed in the org. The list will also be used to populate the emoji selector displayed in the UI. The 'emojiEnabled' perm must be turned on for users to retrieve the list, or see the selector. Get a list of emojis that are supported in the org. To get the list, emojis must be enabled in your org. _Available in: v39.0_ #### Responses * **200** _Supported Emoji_ Success Media type: `application/json`. Schema: `SupportedEmojisOutput`. ### GET Chatter Extensions `GET /chatter/extensions` Operation ID: `getExtensionCollection`. Tags: Chatter Resources. Chatter Extension resource. Get extensions. _Available in: v40.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/extensions` _Available in: v40.0_ #### Parameters * `page` (query, string) Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned. _Available in: v40.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. The default size is 15. _Available in: v40.0_ #### Responses * **200** _Extension Definition Collection_ Success Media type: `application/json`. Schema: `ExtensionDefinitionCollection`. ### GET Group Membership Requests—Private `GET /chatter/group-membership-requests/{requestId}` Operation ID: `getGroupMembershipRequest`. Tags: Groups Resources. Update the status of a request by a user to join a private group or get information about a request to join a private group. Get information about a request to join a private group. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-membership-requests/{requestId}` _Available in: v27.0_ #### Parameters * `requestId` (path, string (Id), required) Get the `{requestId}` by making a POST request to `/chatter/groups/{groupId}/members/requests`. Pattern: ^(0I5)\\w\*. #### Responses * **200** _Group Membership Request_ Success Media type: `application/json`. Schema: `GroupMembershipRequest`. #### Code samples _Example: Example 2 · HTTP_ ``` # This example updates a request to join a private group from `Pending` to # `Accepted`. /services/data/v67.0/chatter/group-membership-requests/0I5D000000002fwKAA?status=Accepted ``` ### PATCH Group Membership Requests—Private `PATCH /chatter/group-membership-requests/{requestId}` Operation ID: `patchGroupMembershipRequest`. Tags: Groups Resources. Update the status of a request by a user to join a private group or get information about a request to join a private group. Update the status of a request by a user to join a private group. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-membership-requests/{requestId}` _Available in: v27.0_ #### Parameters * `requestId` (path, string (Id), required) Get the `{requestId}` by making a POST request to `/chatter/groups/{groupId}/members/requests`. Pattern: ^(0I5)\\w\*. * `responseMessage` (query, string) Use this property to provide a message to the user if their membership request is declined. The value of this property is used only when the value of the `status` property is `Declined`. The maximum length is 756 characters. _Available in: v27.0_ * `status` (query, ConnectGroupMembershipRequestStatus) Status of the membership request. _Available in: v27.0_ #### Request body Media type: `application/json`. Schema: `UpdateGroupMembershipRequestInput`. #### Responses * **200** _Group Membership Request_ Success Media type: `application/json`. Schema: `GroupMembershipRequest`. #### Code samples _Example: Example 1 · HTTP_ ``` { "status " : "Accepted" } ``` ### GET Batch Group Memberships `GET /chatter/group-memberships/batch/{membershipIds}` Operation ID: `getGroupMembershipBatch`. Tags: Groups Resources. Access information about a list of group members. The members don’t have to belong to the same group. Each membership ID is associated with a specific group. Membership IDs are returned in the response bodies of several groups resources. Access information about a list of group members. The members don’t have to belong to the same group. Each membership ID is associated with a specific group. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-memberships/batch/{membershipIds}` _Available in: v27.0_ #### Parameters * `membershipIds` (path, array of string (Id), required) Where `{membershipIds}` is a comma-separated list of up to 500 membership IDs. #### Responses * **200** _Batch Results_ Batch results. Media type: `application/json`. Schema: `Batch`. #### Code samples _Example: Example 1 · HTTP_ ``` # This request gets the group membership information for two users: /chatter/group-memberships/batch/0FBD00000003GAPOA2,0FBD00000003GAKOA ``` _Example: Example 2 · HTTP_ ``` # This is the Batch Results response body, which contains nested User Summary # response bodies: # # Note that the second group membership wasn’t found. Batch requests return a # status code for each subrequest. { "hasErrors": true, "results": [ { "result": { "id": "0FBD00000003GAPOA2", "role": "StandardMember", "url": "/services/data/v67.0/chatter/group-memberships/0FBD00000003GAPOA2", "user": { "companyName": "Universal Containers", "firstName": "Gordon", "id": "005D0000001LLO1IAO", "isActive": true, "isInThisCommunity": true, "lastName": "Johnson", "motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png" }, "mySubscription": { "id": "0E8D0000000T5ZUKA0", "url": "/services/data/v67.0/chatter/subscriptions/0E8D0000000T5ZUKA0" }, "name": "Gordon Johnson", "photo": { "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-oFL0K-ff2oe04ZAmT2MqC", "largePhotoUrl": "https:/instance_name/profilephoto/729D00000000LJL/F", "photoVersionId": "729D00000000LJLIA2", "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T", "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-6d5rE2mNaMaBZfGnFX65O", "url": "/services/data/v67.0/chatter/users/005D0000001LLO1IAO/photo" }, "title": "VP Sales", "type": "User", "url": "/services/data/v67.0/chatter/users/005D0000001LLO1IAO", "userType": "Internal" } }, "statusCode": 200 }, { "result": [ { "errorCode": "NOT_FOUND", "message": "The requested resource does not exist" } ], "statusCode": 404 } ] } ``` ### GET Group Memberships Information `GET /chatter/group-memberships/{membershipId}` Operation ID: `getGroupMembership`. Tags: Groups Resources. Access information about a member of a group, or remove a member from a group. Get information about a member of a group. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-memberships/{membershipId}` _Available in: v23.0_ #### Parameters * `membershipId` (path, string (Id), required) Membership IDs are returned from the `/chatter/groups/groupId/memberships` resource. Pattern: ^(0FB)\\w\*. #### Responses * **200** _Group Member_ Chatter group member. Media type: `application/json`. Schema: `GroupMember`. ### DELETE Group Memberships Information `DELETE /chatter/group-memberships/{membershipId}` Operation ID: `deleteGroupMembership`. Tags: Groups Resources. Access information about a member of a group, or remove a member from a group. Remove a member from a group. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-memberships/{membershipId}` _Available in: v23.0_ #### Parameters * `membershipId` (path, string (Id), required) Membership IDs are returned from the `/chatter/groups/groupId/memberships` resource. Pattern: ^(0FB)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH Group Memberships Information `PATCH /chatter/group-memberships/{membershipId}` Operation ID: `patchGroupMembership`. Tags: Groups Resources. Access information about a member of a group, or remove a member from a group. Update a group member’s role. **Note**: PATCH is supported in version 29.0. **Note**: To update a group member’s role in a PATCH request, pass only the `role` property, don’t pass the `userId` property. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-memberships/{membershipId}` _Available in: v23.0_ #### Parameters * `membershipId` (path, string (Id), required) Membership IDs are returned from the `/chatter/groups/groupId/memberships` resource. Pattern: ^(0FB)\\w\*. * `role` (query, ConnectGroupMembershipEnum) The role of the member. _Available in: v29.0_ #### Request body _Available in: v29.0_ Media type: `application/json`. Schema: `GroupMemberInput`. _Example: example\_1_ Payload 1 ``` { "role": "GroupManager", "userId": "005B0000000Ge16" } ``` #### Responses * **200** _Group Member_ Chatter group member. Media type: `application/json`. Schema: `GroupMember`. ### GET Group Record `GET /chatter/group-records/{groupRecordId}` Operation ID: `getGroupRecord`. Tags: Groups Resources. Get or delete a record associated with a group. Get information about a group record. _Available in: v34.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-records/{groupRecordId}` _Available in: v34.0_ #### Parameters * `groupRecordId` (path, string (Id), required) ID of the group record. Pattern: ^(0Aa)\\w\*. #### Responses * **200** _Group Record_ A record associated with a group. Media type: `application/json`. Schema: `GroupRecord`. ### DELETE Group Record `DELETE /chatter/group-records/{groupRecordId}` Operation ID: `deleteGroupRecord`. Tags: Groups Resources. Get or delete a record associated with a group. Remove the association between a record and a group. _Available in: v34.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/group-records/{groupRecordId}` _Available in: v34.0_ #### Parameters * `groupRecordId` (path, string (Id), required) ID of the group record. Pattern: ^(0Aa)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET List of Groups `GET /chatter/groups` Operation ID: `getGroupDetailCollection`. Tags: Groups Resources. Returns a list of groups in the organization. A list of all the groups in the organization. Get information about groups. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups` _Available in: v23.0_ #### Parameters * `archiveStatus` (query, ConnectGroupArchiveStatusEnum) Returns the list of groups filtered by the archive status you specify: * `All` — All groups, including groups that are archived and groups that aren’t archived. * `Archived` — Groups that are archived. * `NotArchived` — Groups that aren’t archived. The default value is `NotArchived`. _Available in: v29.0_ * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v23.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 250. The default value is 25. _Available in: v23.0_ * `q` (query, string) Specifies the string to search. For more information about wildcards, see [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards). _Available in: v23.0_ #### Responses * **200** _Group Page_ Success Media type: `application/json`. Schema: `GroupPage`. #### Code samples _Example: Example 2 · HTTP_ ``` /services/data/v67.0/chatter/groups?name=Chatter+API&visibility=PublicAccess ``` ### POST List of Groups `POST /chatter/groups` Operation ID: `postGroupDetailCollection`. Tags: Groups Resources. Returns a list of groups in the organization. Create a group. _Available in: v29.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups` _Available in: v29.0_ Returns the same response body as the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation. See that operation for the full response schema. #### Parameters * `canHaveChatterGuests` (query, boolean) `true` if this group allows Chatter customers, `false` otherwise. After this property is set to `true`, it cannot be set to `false`. _Available in: v29.0_ * `description` (query, string) The “Description” section of the group _Available in: v29.0_ * `informationText` (query, string) The text in the “Information” section of the group _Available in: v29.0_ * `informationTitle` (query, string) The title of the “Information” section of the group _Available in: v29.0_ * `name` (query, string, required) The name of the group _Available in: v29.0_ * `visibility` (query, ConnectGroupVisibilityEnum, required) Group visibility type. One of the following: * `PrivateAccess` — Only members of the group can see posts to this group. * `PublicAccess` — All users within the Experience Cloud site can see posts to this group. * `Unlisted` — Reserved for future use. _Available in: v29.0_ #### Request body Media type: `application/json`. Schema: `GroupInput`. #### Responses * **200** _Group Detail_ Chatter group detail. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation. See that operation for the full response schema. #### Code samples _Example: Example 2 · HTTP_ ``` { "announcement" : "0D5D0000000K4XT", "canHaveChatterGuests" : "true", "description" : "This group is building a powerful API.", "information" : { "text" : "Read this section before you post to the group.", "title" : "Information" }, "isArchived" : "false", "isAutoArchiveDisabled" : "false", "name" : "Chatter API", "owner" : "00590000000DmPw", "visibility" : "PublicAccess" } ``` ### GET Batch Group Information `GET /chatter/groups/batch/{group_list}` Operation ID: `getGroupBatch`. Tags: Groups Resources. Returns information about more than one group at the same time. Get information about more than one group at the same time. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/batch/{group_list}` _Available in: v23.0_ #### Parameters * `group_list` (path, string, required) Where `{group_list}` is a comma-separated list of up to 500 group IDs. #### Responses * **200** _Batch Results_ Batch results. Media type: `application/json`. Schema: `Batch`. ### POST Group Invites `POST /chatter/groups/group/{groupId}/invite` Operation ID: `postGroupViralInvitations`. Tags: Groups Resources. Use this resource to send viral invitation to internal and external users. Invite internal and external users to join a group. _Available in: v39.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Request body Media type: `application/json`. Schema: `InviteCollectionInput`. _Example: example\_1_ Payload 1 ``` { "invitees": { "emails": [ "emailaddress1@internaldomain.com", "emailaddress2@externaldomain.com" ] }, "message": "Join this group to participate in the discussion about your favorite feature." } ``` #### Responses * **200** _Invite Collection_ A collection of invitations. Media type: `application/json`. Schema: `InviteCollection`. ### GET Group Announcements `GET /chatter/groups/{groupId}/announcements` Operation ID: `getGroupAnnouncementCollection`. Tags: Groups Resources. Returns a list of announcements for the specified group. Get information about the announcements posted to the specified group. Use an announcement to highlight information. Users can discuss, like, and post comments on announcements. Deleting the feed post deletes the announcement. To get information about, update, or delete an announcement, use the [Announcements Resources](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources). _Available in: v31.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/announcements` _Available in: v31.0_ Returns the same response body as the [GET /chatter/announcements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncementCollection) operation. See that operation for the full response schema. #### Parameters * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v31.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v31.0_ * `groupId` (path, string (Id), required) ID of the group. #### Responses * **200** _Announcement Page_ A paginated collection of Announcement response bodies. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/announcements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncementCollection) operation. See that operation for the full response schema. ### POST Group Announcements `POST /chatter/groups/{groupId}/announcements` Operation ID: `postGroupAnnouncementCollection`. Tags: Groups Resources. Returns a list of announcements for the specified group. Post an announcement to a group. Use an announcement to highlight information. Users can discuss, like, and post comments on announcements. Deleting the feed post deletes the announcement. To get information about, update, or delete an announcement, use the [Announcements Resources](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources). _Available in: v31.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/announcements` _Available in: v31.0_ Returns the same response body as the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation. See that operation for the full response schema. #### Parameters * `expirationDate` (query, string) Date time in ISO 8601 format. The Salesforce UI displays an announcement until 11:59 p.m. on this date unless another announcement is posted first. The Salesforce UI ignores the time value in the `expirationDate`. However, you can use the time value to create your own display logic in your own UI. Required for creating an announcement. Optional for updating an announcement _Available in: v31.0_ * `groupId` (path, string (Id), required) ID of the group. #### Request body Media type: `application/json`. Schema: `AnnouncementInput`. _Example example\_1: same as POST /chatter/announcements request._ Payload 1 Creating an announcement _Example: example\_1_ Payload 1 Creating an announcement _Example: example\_2_ Payload 2 Creating an announcement using an existing feed item ``` { "feedItemId": "0D5D0000000DaZBKA0", "expirationDate": "2016-02-22T00:00:00.000Z" } ``` #### Responses * **200** _Announcement_ An announcement. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation. See that operation for the full response schema. ### GET Group Files `GET /chatter/groups/{groupId}/files` Operation ID: `getGroupFilesCollection`. Tags: Groups Resources. Returns information about the files posted to the specified group. Get information about the files posted to the specified group. _Available in: v24.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/files` _Available in: v24.0_ #### Parameters * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v24.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v24.0_ * `q` (query, string) A query string to filter the results. The string must contain at least two characters, not including wildcards. For information about wildcards, see [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards). _Available in: v27.0_ * `groupId` (path, string (Id), required) ID of the group. #### Responses * **200** _File Summary Page_ File summary page. Media type: `application/json`. Schema: `FileSummaryPage`. ### GET Group Records `GET /chatter/groups/{groupId}/records` Operation ID: `getGroupRecordCollection`. Tags: Groups Resources. Returns a list of records associated with a group. Get the list of records associated with a group. _Available in: v33.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/records` _Available in: v33.0_ #### Parameters * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v33.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v33.0_ * `groupId` (path, string (Id), required) ID of the group. #### Responses * **200** _Group Record Page_ A paginated list of records associated with a group. Media type: `application/json`. Schema: `GroupRecordPage`. ### POST Group Records `POST /chatter/groups/{groupId}/records` Operation ID: `postGroupRecordCollection`. Tags: Groups Resources. Returns a list of records associated with a group. Associate a record with a group. **Note**: POST is supported in version 34.0 and later. _Available in: v33.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/records` _Available in: v33.0_ #### Parameters * `recordId` (query, string) ID of the record. _Available in: v34.0_ * `groupId` (path, string (Id), required) ID of the group. #### Request body Media type: `application/json`. Schema: `GroupRecordInput`. _Example: example\_1_ Payload 1 ``` { "recordId": "001D000000Io9cD" } ``` #### Responses * **200** _Group Record_ A record associated with a group. Media type: `application/json`. Schema: `GroupRecord`. ### GET Group Information `GET /chatter/groups/{groupId}` Operation ID: `getGroupDetail`. Tags: Groups Resources. Returns information about the specified group. Get information about a Chatter group. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}` _Available in: v23.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **200** _Group Detail_ Chatter group detail. Media type: `application/json`. Schema: `GroupDetail`. ### DELETE Group Information `DELETE /chatter/groups/{groupId}` Operation ID: `deleteGroupDetail`. Tags: Groups Resources. Returns information about the specified group. Delete a Chatter group. _Available in: v29.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}` _Available in: v29.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **200** Success ### PATCH Group Information `PATCH /chatter/groups/{groupId}` Operation ID: `patchGroupDetail`. Tags: Groups Resources. Returns information about the specified group. Update information about a Chatter group. _Available in: v28.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}` _Available in: v28.0_ Returns the same response body as the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation. See that operation for the full response schema. #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `announcement` (query, string (Id)) The ID of a feed item to use as an announcement. _Available in: v31.0_ Pattern: ^(0Bt)\\w\*. * `canHaveChatterGuests` (query, boolean) `true` if this group allows Chatter customers, `false` otherwise. After this property is set to `true`, it cannot be set to `false`. _Available in: v29.0_ * `description` (query, string) The “Description” section of the group. _Available in: v29.0_ * `informationText` (query, string) If the group is private, the “Information” section is visible only to members. The “Description” section is visible to everyone. _Available in: v28.0_ * `informationTitle` (query, string) The title of the “Information” section of the group. _Available in: v28.0_ * `isArchived` (query, boolean) `true` if the group is archived, `false` otherwise. Defaults to `false`. _Available in: v29.0_ * `isAutoArchiveDisabled` (query, boolean) `true` if automatic archiving is turned off for the group, `false` otherwise. Defaults to `false`. _Available in: v29.0_ * `isBroadcast` (query, boolean) `true` if only group owners and managers can create posts in the group, `false` otherwise. Defaults to `false`. _Available in: v36.0_ * `name` (query, string) The name of the group. _Available in: v29.0_ * `owner` (query, string (Id)) The ID of the group owner. This property is available for PATCH requests only. _Available in: v29.0_ Pattern: ^(005)\\w\*. * `visibility` (query, ConnectGroupVisibilityEnum) Group visibility type. One of the following values: * `PrivateAccess` —Only members of the group can see posts to this group. * `PublicAccess` —All users within the Experience Cloud site can see posts to this group. * `Unlisted` —Reserved for future use. _Available in: v29.0_ #### Request body Chatter group input. Media type: `application/json`. Schema: `GroupInput`. _Example: example\_1_ Payload 1 ``` { "announcement": "0D5D0000000K4XT", "canHaveChatterGuests": "true", "description": "This group is building a powerful API.", "information": { "text": "Read this section before you post to the group.", "title": "Information" }, "isArchived": "false", "isAutoArchiveDisabled": "false", "name": "Chatter API", "owner": "00590000000DmPw", "visibility": "PublicAccess" } ``` #### Responses * **200** _Group Detail_ Chatter group detail. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation. See that operation for the full response schema. #### Code samples _Example: Example 1 · HTTP_ ``` # This request body updates the text and title of the “Information” section of a # group: Content-Type: application/json { "information": { "text": "Post questions about the API to this group. If you have the answer to a question, please post it. This is a private R&D group.", "title": "API Questions Group" } } ``` ### GET Group Banner Photo `GET /chatter/groups/{groupId}/banner-photo` Operation ID: `getGroupBannerPicture`. Tags: Groups Resources. Use this resource to access the banner photo for the specified group, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Get the banner photo for a group. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/banner-photo` _Available in: v36.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **200** _Banner Photo_ A banner photo. Media type: `application/json`. Schema: `BannerPhoto`. ### POST Group Banner Photo `POST /chatter/groups/{groupId}/banner-photo` Operation ID: `postGroupBannerPicture`. Tags: Groups Resources. Use this resource to access the banner photo for the specified group, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Create the banner photo for a group. To use an image from the Files page as a group banner photo, pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. Images uploaded on the Group page don’t have a file ID and can’t be used as the `fileId`. To upload a binary file as the group banner photo, send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). **Note**: Group owners and managers and users with the Manage All Data permission can DELETE and POST group banner photos. **Note**: Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. **Note**: Photos are processed asynchronously and may not be visible right away. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/banner-photo` _Available in: v36.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `cropHeight` (query, integer) The length of an edge in pixels of the crop rectangle. _Available in: v36.0_ * `cropWidth` (query, integer) The width of an edge in pixels of the crop rectangle. _Available in: v36.0_ * `cropX` (query, integer) The position X in pixels from the left edge of the image to start the crop square. Top left is position (0,0). _Available in: v36.0_ * `cropY` (query, integer) The position Y in pixels from the top edge of the image to start the crop square. Top left is position (0,0). _Available in: v36.0_ * `fileId` (query, string) ID of an existing file. The key prefix must be 069 and the file size must be less than 8 MB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Required to use an existing file _Available in: v36.0_ * `versionNumber` (query, integer) Version number of an existing file. If not provided, the latest version is used. _Available in: v36.0_ #### Request body _Available in: v36.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileUpload` (_string (binary)_) * `cropHeight` (_integer_) Height of the crop rectangle in pixels. _Available in: v36.0_ * `cropWidth` (_integer_) Width of the crop rectangle in pixels. _Available in: v36.0_ * `cropX` (_integer_) X position of the crop rectangle from the left edge of the image in pixels. Top left is position (0,0). _Available in: v36.0_ * `cropY` (_integer_) Y position of the crop rectangle from the top edge of the image in pixels. Top left is position (0,0). _Available in: v36.0_ * `fileId` (_string_) 18 character ID of an existing file. The key prefix must be 069 and the file must be an image and be smaller than 2 GB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Required to use an existing file _Available in: v36.0_ * `versionNumber` (_integer_) Version number of an existing file. If not provided, the latest version is used. _Available in: v36.0_ _Example: example\_1_ Payload 1 ``` { "cropHeight": "120", "cropWidth": "240", "fileId": "069D00000001IOh" } ``` #### Responses * **200** _Banner Photo_ A banner photo. Media type: `application/json`. Schema: `BannerPhoto`. ### DELETE Group Banner Photo `DELETE /chatter/groups/{groupId}/banner-photo` Operation ID: `deleteGroupBannerPicture`. Tags: Groups Resources. Use this resource to access the banner photo for the specified group, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Delete the banner photo for a group. **Note**: Group owners and managers and users with the Manage All Data permission can DELETE and POST group banner photos. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/banner-photo` _Available in: v36.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Group Members `GET /chatter/groups/{groupId}/members` Operation ID: `getGroupMemberCollection`. Tags: Groups Resources. Returns a list of members for the specified group. Also use this resource and POST to add members to a group. Get the members of a group. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/members` _Available in: v23.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v23.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 1000. If you don’t specify a size, the default is 25. _Available in: v23.0_ #### Responses * **200** _Group Member Page_ Success Media type: `application/json`. Schema: `GroupMemberPage`. #### Code samples _Example: Example 2 · HTTP_ ``` # If the group is private, the response is 403. To request to join the group, # send a POST request to the Group Members—Private resource # (`/chatter/groups/{groupId}/members/requests`). /services/data/v67.0/chatter/groups/0F9D000000006bOKAQ /members?userId=005D0000001GpHp ``` ### POST Group Members `POST /chatter/groups/{groupId}/members` Operation ID: `postGroupMemberCollection`. Tags: Groups Resources. Returns a list of members for the specified group. Also use this resource and POST to add members to a group. Add a member to a group. To add a member, the context user must be the group owner or moderator. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/members` _Available in: v23.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `role` (query, ConnectGroupMembershipEnum) The role of the member. _Available in: v29.0_ * `userId` (query, string) ID of the user to add to the group. _Available in: v23.0_ #### Request body _Available in: v29.0_ Media type: `application/json`. Schema: `GroupMemberInput`. #### Responses * **200** _Group Member_ Chatter group member. Media type: `application/json`. Schema: `GroupMember`. #### Code samples _Example: Example 1 · HTTP_ ``` {"userId": "005D0000001GpHp" } ``` ### GET Group Members—Private `GET /chatter/groups/{groupId}/members/requests` Operation ID: `getGroupMembershipRequestCollection`. Tags: Groups Resources. Request membership in a private group or get the status of requests to a join a private group. Get the status of requests to join a private group. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/members/requests` _Available in: v27.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `status` (query, ConnectGroupMembershipRequestStatus) Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values: _Available in: v27.0_ #### Responses * **200** _Group Membership Request Collection_ Success Media type: `application/json`. Schema: `GroupMembershipRequestCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` /chatter/groups/0F9D00000000izfKAA/members/requests?status=Accepted ``` ### POST Group Members—Private `POST /chatter/groups/{groupId}/members/requests` Operation ID: `postGroupMembershipRequestCollection`. Tags: Groups Resources. Request membership in a private group or get the status of requests to a join a private group. Request membership in a private group. **Note**: To add a member to a public group, use the [Group Members](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/postGroupMemberCollection) resource. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/members/requests` _Available in: v27.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **200** _Group Membership Request_ This table lists HTTP response code descriptions that are unique to this resource. For descriptions of other HTTP response codes, see Status Codes and Error Responses. * **201** — One of the following: * Success * User already has a membership request for this group * **204** — User is already a member of this group. * **403** — One of the following: * Group is private: `INSUFFICIENT_ACCESS_OR_READONLY` * User is an external user: `INSUFFICIENT_ACCESS` Media type: `application/json`. Schema: `GroupMembershipRequest`. #### Code samples _Example: Example 1 · HTTP_ ``` # Specify the ID ( `0F9D00000000lpK` ) of the group. /chatter/groups/0F9D00000000lpK/members/requests ``` ### GET Group Settings `GET /chatter/groups/{groupId}/my-settings` Operation ID: `getMyGroupSettings`. Tags: Groups Resources. Information about the context user’s Chatter settings for the specified group. Get information about the context user’s Chatter settings for the specified group. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/my-settings` _Available in: v27.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **200** _Group Chatter Settings_ Success Media type: `application/json`. Schema: `GroupChatterSettings`. ### PATCH Group Settings `PATCH /chatter/groups/{groupId}/my-settings` Operation ID: `patchMyGroupSettings`. Tags: Groups Resources. Information about the context user’s Chatter settings for the specified group. Update the context user’s Chatter settings for the specified group. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/my-settings` _Available in: v27.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `emailFrequency` (query, ConnectEmailFrequencyEnum) The frequency with which a group member receives email from a group. _Available in: v27.0_ #### Request body Media type: `application/json`. Schema: `GroupChatterSettingsInput`. #### Responses * **200** _Group Chatter Settings_ Success Media type: `application/json`. Schema: `GroupChatterSettings`. ### GET Group Photo `GET /chatter/groups/{groupId}/photo` Operation ID: `getGroupPicture`. Tags: Groups Resources. Use this resource to access the photo for the specified group, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary filein REST , you must send it in a multipart/form-data message. Get the group photo. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/photo` _Available in: v23.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. ### POST Group Photo `POST /chatter/groups/{groupId}/photo` Operation ID: `postGroupPicture`. Tags: Groups Resources. Use this resource to access the photo for the specified group, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary filein REST , you must send it in a multipart/form-data message. Update and crop the group photo. To use an image from the Files page as a group photo (existing content), pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. Images uploaded on the Group page don’t have a file ID and can’t be used as the `fileId`. To upload a binary file as a group photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). **Note**: Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. **Note**: Photos are processed asynchronously and may not be visible right away. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/photo` _Available in: v23.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. * `cropSize` (query, integer) The length, in pixels, of any edge of the crop square. Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropX` (query, integer) The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropY` (query, integer) The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `fileId` (query, string) 18 character ID of an existing file. The key prefix must be 069 and the file size must be less than 2 GB. Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. Required to choose an existing file. _Available in: v25.0_ * `versionNumber` (query, integer) Version number of the existing content. If not provided, the latest version is used. _Available in: v25.0_ #### Request body _Available in: v29.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileUpload` (_string (binary)_) * `cropSize` (_integer_) The length, in pixels, of any edge of the crop square. Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropX` (_integer_) The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropY` (_integer_) The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `fileId` (_string_) 18 character ID of an existing file. The key prefix must be 069 and the file must be an image and be smaller than 2 GB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Required to choose an existing file. _Available in: v25.0_ * `versionNumber` (_integer_) Version number of an existing file. If not provided, the latest version is used. _Available in: v25.0_ _Example: example\_1_ Payload 1 ``` { "cropSize": "120", "cropX": "0", "cropY": "0", "fileId": "069D00000001IOh" } ``` #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. ### DELETE Group Photo `DELETE /chatter/groups/{groupId}/photo` Operation ID: `deleteGroupPicture`. Tags: Groups Resources. Use this resource to access the photo for the specified group, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary filein REST , you must send it in a multipart/form-data message. Delete the group photo. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/photo` _Available in: v23.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. Pattern: ^(0F9)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Influence `GET /chatter/influence/thresholds` Operation ID: `getGlobalInfluenceThresholdCollection`. Tags: Influence Resources. List of the percentile thresholds used to categorize an organization’s users by their influence in Chatter. Users are ranked based on the number of posts and comments made, and comments and likes received. The percentile associated with a category represents the bottom threshold for that influencer category. For example: 0.25 defines the cutoff for the Active Influencer category, which means it includes users with an influence rank equal to or greater than the 25th percentile (25%) and less than the next highest category threshold. Get the percentile thresholds used to categorize an org’s users by their influence in Chatter. _Available in: v24.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/influence/thresholds` _Available in: v24.0_ #### Responses * **200** _Influence Thresholds_ Success Media type: `application/json`. Schema: `GlobalInfluenceThresholdCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` {"thresholds": [ { "name": "Top Influencer", "threshold": "0.8", } { "name": "Active Influencer", "threshold": "0.25", } { "name": "Observer", "threshold": "0.0", } ]} ``` ### GET Likes `GET /chatter/likes/{likeId}` Operation ID: `getLike`. Tags: Likes Resources. Information about the specified like. Also used to delete a like. You can find the ID for a specific like from any feed, such as a news feed or a record feed. Get information about the specified like. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/likes/{likeId}` _Available in: v23.0_ #### Parameters * `likeId` (path, string (Id), required) ID of the like. Pattern: ^(0I0)\\w\*. #### Responses * **200** _Like_ Chatter like. Media type: `application/json`. Schema: `Like`. ### DELETE Likes `DELETE /chatter/likes/{likeId}` Operation ID: `deleteLike`. Tags: Likes Resources. Information about the specified like. Also used to delete a like. You can find the ID for a specific like from any feed, such as a news feed or a record feed. Delete the specified like. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/likes/{likeId}` _Available in: v23.0_ #### Parameters * `likeId` (path, string (Id), required) ID of the like. Pattern: ^(0I0)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Link Metadata `GET /chatter/link-metadata` Operation ID: `getLinkMetadata`. Tags: Chatter Resources. Gets the metadata information for a given set of URLs. Get link metadata for URLs. _Available in: v42.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/link-metadata` _Available in: v42.0_ #### Parameters * `urls` (query, array of string, required) Comma-separated list of URL-encoded URLs. _Available in: v42.0_ #### Responses * **200** _Link Metadata Collection_ Collection of link metadata. Media type: `application/json`. Schema: `LinkMetadataCollection`. ### GET Mentions Completions `GET /chatter/mentions/completions` Operation ID: `getMentionCompletions`. Tags: Mentions Resources. Provides pages of mention completion proposals. 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. _Available in: v29.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/mentions/completions` _Available in: v29.0_ #### Parameters * `contextId` (query, string (Id)) 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. _Available in: v29.0_ * `page` (query, 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. _Available in: v29.0_ * `pageSize` (query, 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. _Available in: v29.0_ * `q` (query, string, required) 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. _Available in: v29.0_ * `type` (query, ConnectMentionCompletionType) 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`. _Available in: v29.0_ #### Responses * **200** _Mention Completion Page_ Paginated list of Mention Completion response bodies. Media type: `application/json`. Schema: `MentionCompletionPage`. #### Code samples _Example: Example 1 · HTTP_ ``` # Specify the feed item ID in the `contextId` parameter to request mention # completions for a comment on the feed item. /chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g ``` ### GET Mentions Validations `GET /chatter/mentions/validations` Operation ID: `getMentionValidations`. Tags: Mentions Resources. Provides validation information for potential mentions. Information about whether the specified mentions are valid for the context user. For example, the context user can’t mention private groups he doesn’t belong to. If such a group were included in the list of mention validations, the `hasErrors` property of the Mention Validations response body would be `true` and the group would have a `validationStatus` of `Disallowed` in its mention validation. _Available in: v29.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/mentions/validations` _Available in: v29.0_ #### Parameters * `parentId` (query, string, required) The feed item parent ID. _Available in: v29.0_ * `recordIds` (query, array of string, required) A comma-separated list of IDs to be mentioned. The maximum value is 25. _Available in: v29.0_ * `visibility` (query, ConnectFeedItemVisibilityEnum, required) Type of users who can see a feed item. * `AllUsers` — Visibility is not limited to internal users. * `InternalUsers` — Visibility is limited to internal users. _Available in: v29.0_ #### Responses * **200** _Mention Validation_ Information about whether a proposed mention is valid for the context user. Media type: `application/json`. Schema: `MentionValidations`. ### GET Followers on Records `GET /chatter/records/{recordId}/followers` Operation ID: `getFollowers`. Tags: Followers on Records Resources. Returns information about the followers of the specified record. Get information about the followers of the specified record. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/records/{recordId}/followers` _Available in: v23.0_ Returns the same response body as the [GET /chatter/users/{userId}/followers](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getUserFollowerCollection) operation. See that operation for the full response schema. #### Parameters * `recordId` (path, string (IdOrMe), required) As of version 29.0, you can use a topic ID for the `recordId`. * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 1000. If you don't specify a size, the default is 25. #### Responses * **200** _Follower Page_ Success Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/users/{userId}/followers](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getUserFollowerCollection) operation. See that operation for the full response schema. ### GET Chatter Feed Streams `GET /chatter/streams` Operation ID: `getStreams`. Tags: Chatter Resources. Returns a list of streams for the context user. Get or search a list of Chatter feed streams for the context user. **Tip**: If you know the site ID of the streams, we recommend using `/connect/communities/{communityId}/chatter/streams` and not using `globalScope`. _Available in: v39.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/streams` _Available in: v39.0_ #### Parameters * `globalScope` (query, boolean) Specifies whether to get streams from all the context user’s Experience Cloud sites, regardless of the `{communityId}` value. **Tip**: If you know the site ID of the streams, we recommend using `/connect/communities/{communityId}/chatter/streams` and not using `globalScope`. _Available in: v41.0_ * `page` (query, integer) Number of the page you want returned. Starts at 0. If you pass in `null` or 0, the first page is returned. _Available in: v39.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25. _Available in: v39.0_ * `q` (query, string) Specifies the string to search. The search string must contain at least two characters, not including wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards) . _Available in: v40.0_ * `sort` (query, ConnectSortOrderEnum) Specifies the sort order. Values are: * `Ascending` — Items are in ascending alphabetical order (A-Z). * `Descending` — Items are in descending alphabetical order (Z-A). * `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams. If not specified, default value is `Ascending`. _Available in: v40.0_ #### Responses * **200** _Chatter Stream Collection_ A collection of Chatter feed streams. Media type: `application/json`. Schema: `FeedStreamCollection`. ### POST Chatter Feed Streams `POST /chatter/streams` Operation ID: `createStream`. Tags: Chatter Resources. Returns a list of streams for the context user. Create a Chatter feed stream. _Available in: v39.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/streams` _Available in: v39.0_ #### Parameters * `description` (query, string) Description of the stream, up to 1,000 characters. _Available in: v39.0_ * `name` (query, string, required) Name of the stream, up to 120 characters. Required when creating a stream (POST). _Available in: v39.0_ #### Request body _Available in: v39.0_ Media type: `application/json`. Schema: `FeedStreamInput`. _Example: example\_1_ Payload 1 ``` { "description": "Feeds from my management hierarchy.", "name": "Managers Stream", "subscriptionsToAdd": { "subscriptions": [ { "entityId": "00590000000Dk5F" }, { "entityId": "00590000000Fk4M" }, { "entityId": "00590000000Sy7N" }, { "entityId": "00590000000Dk4H" }, { "entityId": "00590000000Uk7L" } ] } } ``` #### Responses * **200** _Chatter Stream_ Success Media type: `application/json`. Schema: `FeedStream`. ### GET Chatter Feed Stream `GET /chatter/streams/{streamId}` Operation ID: `getStream`. Tags: Chatter Resources. Returns information about the specified stream. Get information about a Chatter feed stream. **Tip**: If you know the site ID of the stream, we recommend using `/connect/communities/{communityId}/chatter/streams/{streamId}` and not using `globalScope`. _Available in: v39.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/streams/{streamId}` _Available in: v39.0_ #### Parameters * `streamId` (path, string (Id), required) ID of the stream. Pattern: ^(0Fq)\\w\*. * `globalScope` (query, boolean) Specifies whether to get streams from all the context user’s Experience Cloud sites, regardless of the `{communityId}` value. **Tip**: If you know the site ID of the stream, we recommend using `/connect/communities/{communityId}/chatter/streams/{streamId}` and not using `globalScope`. _Available in: v41.0_ #### Responses * **200** _Chatter Stream_ Success Media type: `application/json`. Schema: `FeedStream`. ### DELETE Chatter Feed Stream `DELETE /chatter/streams/{streamId}` Operation ID: `deleteStream`. Tags: Chatter Resources. Returns information about the specified stream. Delete a Chatter feed stream. _Available in: v39.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/streams/{streamId}` _Available in: v39.0_ #### Parameters * `streamId` (path, string (Id), required) ID of the stream. Pattern: ^(0Fq)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH Chatter Feed Stream `PATCH /chatter/streams/{streamId}` Operation ID: `updateStream`. Tags: Chatter Resources. Returns information about the specified stream. Update a Chatter feed stream. _Available in: v39.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/streams/{streamId}` _Available in: v39.0_ #### Parameters * `streamId` (path, string (Id), required) ID of the stream. Pattern: ^(0Fq)\\w\*. * `description` (query, string) Description of the stream, up to 1,000 characters. _Available in: v39.0_ * `name` (query, string) Name of the stream, up to 120 characters. _Available in: v39.0_ #### Request body _Available in: v39.0_ Media type: `application/json`. Schema: `FeedStreamInput`. _Example example\_1: same as POST /chatter/streams request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Chatter Stream_ Success Media type: `application/json`. Schema: `FeedStream`. ### GET Subscriptions `GET /chatter/subscriptions/{subscriptionId}` Operation ID: `getSubscription`. Tags: Subscriptions Resources. Information about the specified subscription to a record. Also used to delete a subscription, for example, to unfollow a record. A subscription ID is returned as part of the response body for follower and following resources, In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary. Get information about a subscription. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/subscriptions/{subscriptionId}` _Available in: v23.0_ #### Parameters * `subscriptionId` (path, string (Id), required) A subscription ID is returned as part of the response body for `follower` and `following` resources, for example, `/records/{recordId}/followers`. In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary. Pattern: ^(0E8|0CE)\\w\*. #### Responses * **200** _Subscription_ Chatter subscription, or following, information. Media type: `application/json`. Schema: `Subscription`. #### Code samples _Example: Example 1 · HTTP_ ``` /chatter/subscriptions/0E8D00000001JkFKAU ``` ### DELETE Subscriptions `DELETE /chatter/subscriptions/{subscriptionId}` Operation ID: `deleteSubscription`. Tags: Subscriptions Resources. Information about the specified subscription to a record. Also used to delete a subscription, for example, to unfollow a record. A subscription ID is returned as part of the response body for follower and following resources, In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary. Delete a subscription, for example, to unfollow a record or a topic. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/subscriptions/{subscriptionId}` _Available in: v23.0_ #### Parameters * `subscriptionId` (path, string (Id), required) A subscription ID is returned as part of the response body for `follower` and `following` resources, for example, `/records/{recordId}/followers`. In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary. Pattern: ^(0E8|0CE)\\w\*. #### Responses * **200** Success ### GET User Information `GET /chatter/users` Operation ID: `getUserDetailCollection`. Tags: Users Resources. Returns information about all users in an organization. Returns information about all users in an organization. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users` _Available in: v23.0_ #### Parameters * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v23.0_ * `pageSize` (query, integer) The number of items per page. Valid values are between 1 and 250. The default value is 25. _Available in: v23.0_ * `q` (query, string) Specifies the string to search. This parameter searches user names, not email addresses, titles, and so on. _Available in: v23.0_ * `searchContextId` (query, string) Specify a feed item ID that provides context for the search results. Use this parameter for @mention completion. Passing a feed item ID for `searchContextId` matches users already mentioned in the thread earlier in the returned collection. You can also use the Mentions Completions resource, which is specifically designed for @mention completion. When using this parameter, you can’t query more than 500 results and you can’t use wildcards in the search term. _Available in: v28.0_ #### Responses * **200** _User Page_ Page of Chatter users. Media type: `application/json`. Schema: `UserPage`. ### GET Batch User Information `GET /chatter/users/batch/{user_list}` Operation ID: `getUserBatch`. Tags: Users Resources. Returns information about the specified users’ profiles. Returns information about the specified users’ profiles. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/batch/{user_list}` _Available in: v23.0_ #### Parameters * `user_list` (path, string, required) Where `user_list` is a comma-separated list of up to 500 user IDs. #### Responses * **200** _Batch Results_ Batch results. Media type: `application/json`. Schema: `Batch`. #### Code samples _Example: Example 1 · HTTP_ ``` /chatter/users/batch/005D0000001Kl6xIAC,005D0000005J3D4HVB, . . . ``` ### GET User Profile Information `GET /chatter/users/{userId}` Operation ID: `getUser`. Tags: Users Resources. Returns information about the logged-in or specified user's Chatter profile. Get information about the context or specified user. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Detail_ User detail. If the context user doesn’t have permission to see a property, the property is set to `null`. If the user is external, the properties that the User Detail response body shares with the User Summary response body can have non-null values. Other properties are always `null`. Media type: `application/json`. Schema: `UserDetail`. #### Code samples _Example: Example 1 · HTTP_ ``` /chatter/users/me?aboutMe=Staff+Technical+Writer+at+Seattle+Apps ``` _Example: Example 2 · HTTP_ ``` /chatter/users/005D0000001GLowIAB?include=/chatterActivity ``` ### PATCH User Profile Information `PATCH /chatter/users/{userId}` Operation ID: `updateUser`. Tags: Users Resources. Returns information about the logged-in or specified user's Chatter profile. Update information about the context or specified user. _Available in: v29.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}` _Available in: v29.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `aboutMe` (query, string) The `aboutMe` property of a User Detail response body. The maximum length is 1000 characters. This property populates the “About Me” section of the user profile, which is visible to all members of an Experience Cloud site or org. _Available in: v29.0_ #### Request body User input. _Available in: v29.0_ Media type: `application/json`. Schema: `UserInput`. _Example: example\_1_ Payload 1 ``` { "aboutMe": "Staff Technical Writer responsible for the Connect API and Connect in Apex documentation." } ``` #### Responses * **200** _User Detail_ User detail. If the context user doesn’t have permission to see a property, the property is set to `null`. Media type: `application/json`. Schema: `UserDetail`. #### Code samples _Example: Example 1 · HTTP_ ``` /chatter/users/me?aboutMe=Staff+Technical+Writer+at+Seattle+Apps Content-Type: application/json { "aboutMe": "Staff Technical Writer responsible for the Connect API and Connect in Apex documentation." } ``` _Example: Example 2 · HTTP_ ``` /chatter/users/005D0000001GLowIAB?include=/chatterActivity Content-Type: application/json { "aboutMe": "Staff Technical Writer responsible for the Connect API and Connect in Apex documentation." } ``` ### POST User Activity, Export `POST /chatter/users/{userId}/activities/export-job` Operation ID: `exportUserActivities`. Tags: Users Resources. Start a job to export Chatter-related activities for the user. Export Chatter-related activity, such as bookmarks, topic endorsements, and votes, for a user. Export these activities. * `Bookmark` — User bookmarked a post. * `ChatterActivity` — Total counts of posts and comments made and likes and comments received for a user. * `ChatterLike` — User liked a post or comment. * `Comment` — User commented on a post. * `CompanyVerify` — User verified comment. * `DownVote` — User downvoted a post or comment. * `FeedEntityRead` — User read a post. * `FeedRead` — User read a feed. * `Mute` — User muted a post. * `Post` — User made a post. * `TopicEndorsement` — User endorsed another user on a topic or received endorsement on a topic. * `UpVote` — User upvoted a post or comment. **Note**: POST doesn’t take request parameters or a request body. _Available in: v42.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/activities/export-job` _Available in: v42.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Activities Job_ User activities job. Media type: `application/json`. Schema: `UserActivitiesJob`. ### POST User Activity, Purge `POST /chatter/users/{userId}/activities/purge-job` Operation ID: `purgeUserActivities`. Tags: Users Resources. Initiate a job to purge Chatter-related activities for the user. Start a job to purge Chatter-related activity, such as bookmarks, topic endorsements, and votes, for a user. Purge these activities. * `Bookmark` — User bookmarked a post. * `ChatterActivity` — Total counts of posts and comments made and likes and comments received for a user. * `ChatterLike` — User liked a post or comment. * `CompanyVerify` — User verified comment. * `DownVote` — User downvoted a post or comment. * `FeedEntityRead` — User read a post. * `FeedRead` — User read a feed. * `Mute` — User muted a post. * `TopicEndorsement` — User endorsed another user on a topic or received endorsement on a topic. * `UpVote` — User upvoted a post or comment. To delete a user’s posts and comments, use these resources, respectively. * [Feed Element](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/deleteFeedElement) * [Comment](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/deleteComment) **Note**: POST doesn’t take request parameters or a request body. _Available in: v42.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/activities/purge-job` _Available in: v42.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Activities Job_ User activities job. Media type: `application/json`. Schema: `UserActivitiesJob`. ### GET User Conversations, General `GET /chatter/users/{userId}/conversations` Operation ID: `getConversations`. Tags: Users Resources. Returns all private conversations for the logged–in user. Also used to search across all conversations. Get private conversations for the context user and search across private conversations. To get all private messages for a context user, see [User Messages, General](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getMessages). Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, see [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). **Note**: The query parameter only searches message text bodies, not user names, titles, and so on. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/conversations` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `page` (query, string) A page token that indicates where retrieval begins. Get this token from the `NextPageUrl` property in the response body. _Available in: v23.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v23.0_ * `q` (query, string) 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](/docs/platform/connect-rest-api/guide/intro_wildcards). This parameter is optional. The query parameter only searches message text bodies, not user names, titles, and so on. _Available in: v24.0_ #### Responses * **200** _Conversation Summary Collection_ Conversation summary collection. Media type: `application/json`. Schema: `ConversationSummaryCollection`. ### GET Get Unread Count for Conversations `GET /chatter/users/{userId}/conversations/unread-count` Operation ID: `getUnreadCount`. Tags: Users Resources. Returns the number of conversations that have unread messages for the logged-in or specified user. Get the number of private conversations that have unread messages for a user. Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, see [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/conversations/unread-count` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** Success Media type: `application/json`. Schema: `ConversationUnreadCount`. ### GET User Conversations, Specific `GET /chatter/users/{userId}/conversations/{conversationId}` Operation ID: `getConversation`. Tags: Users Resources. Returns information about the specified private conversation for the logged-in user. Also used to search within a specific conversation. Get a private conversation for the context user. Search within a private conversation. To get a specific private message for a context user, see [User Messages, Specific](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getMessage). To get all private conversations for a context user, see [User Conversations, General](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getConversations). Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, see [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). **Note**: The query parameter only searches message text bodies, not user names, titles, and so on. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/conversations/{conversationId}` _Available in: v23.0_ #### Parameters * `conversationId` (path, string (Id), required) ID of the conversation. Pattern: ^(03M)\\w\*. * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `page` (query, string) Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned. _Available in: v23.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25. _Available in: v23.0_ * `q` (query, string) 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](/docs/platform/connect-rest-api/guide/intro_wildcards). This parameter is optional. The query parameter only searches message text bodies, not user names, titles, and so on. _Available in: v24.0_ #### Responses * **200** _Conversation Detail_ Success Media type: `application/json`. Schema: `ConversationDetail`. ### PATCH User Conversations, Specific `PATCH /chatter/users/{userId}/conversations/{conversationId}` Operation ID: `markConversationRead`. Tags: Users Resources. Returns information about the specified private conversation for the logged-in user. Also used to search within a specific conversation. Update the status of a private conversation. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/conversations/{conversationId}` _Available in: v23.0_ #### Parameters * `conversationId` (path, string (Id), required) ID of the conversation. Pattern: ^(03M)\\w\*. * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `read` (query, boolean) Changes the conversation status to unread (`false`) or read (`true`). #### Request body Media type: `application/json`. Schema: `InputRequest`. #### Responses * **200** _Conversation Detail_ Success Media type: `application/json`. Schema: `ConversationDetail`. ### GET User Followers `GET /chatter/users/{userId}/followers` Operation ID: `getUserFollowerCollection`. Tags: Users Resources. Returns information about the followers for the specified user. Get information about the followers for a user. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/followers` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `page` (query, integer) Specifies the page number to return. The default value is 0, which returns the first page. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 1000. If you don't specify a size, the default is 25. #### Responses * **200** _Follower Page_ Page of Chatter followers. Media type: `application/json`. Schema: `FollowerPage`. ### GET Following `GET /chatter/users/{userId}/following` Operation ID: `getUserFollowingCollection`. Tags: Users Resources. Returns a list of people, groups, records, and files that the specified user is following. Returns a list of people, groups, records, topics, and files that the specified user is following. **Note**: You can't use the users resource to add a user to a group. Use the groups resource instead. Following topics is available since version 29.0. **Note**: All parameters are optional. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/following` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `filterType` (query, string) Specifies the key prefix to filter the type of objects returned. The key prefix is the three-character prefix code in the object ID. Object IDs are prefixed with three-character codes that specify the type of the object. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9. Use the [List of Filter Feed URLs](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Filter-Feed-Resources/operation/getFilterFeedDirectory) to see the available key prefixes. * `page` (query, integer) Specifies the page number to return. The default value is 0, which returns the first page. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 1000. If you don't specify a size, the default is 25. #### Responses * **200** _Following Page_ Page of Chatter followers. Media type: `application/json`. Schema: `FollowingPage`. #### Code samples _Example: Example 1 · HTTP_ ``` /services/data/v67.0/chatter/users/005D0000001GLowIAB/following?page=1 ``` _Example: Example 3 · HTTP_ ``` /services/data/v67.0/chatter/users/me/following?subjectId=001D000000Iyu2p ``` ### POST Following `POST /chatter/users/{userId}/following` Operation ID: `postUserFollowingCollection`. Tags: Users Resources. Returns a list of people, groups, records, and files that the specified user is following. Follow records. **Note**: You can't use the users resource to add a user to a group. Use the groups resource instead. Following topics is available since version 29.0. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/following` _Available in: v23.0_ Returns the same response body as the [GET /chatter/subscriptions/{subscriptionId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Subscriptions-Resources/operation/getSubscription) operation. See that operation for the full response schema. #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `subjectId` (query, string) The ID of the record you want to follow, such as a user ID or file ID. Topic IDs are available in 29.0 _Available in: v23.0_ #### Request body Topic IDs are available in 29.0 _Available in: v23.0_ Media type: `application/json`. Schema: `FollowingInput`. #### Responses * **200** _Subscription_ Success Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/subscriptions/{subscriptionId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Subscriptions-Resources/operation/getSubscription) operation. See that operation for the full response schema. #### Code samples _Example: Example 2 · HTTP_ ``` { "subjectId" : "001D000000Iyu2p" } ``` ### GET User Groups `GET /chatter/users/{userId}/groups` Operation ID: `getUserGroupDetailCollection`. Tags: Users Resources. Returns the groups the specified user is a member of. Get the groups that a user is a member of. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/groups` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `page` (query, string) A generated token that indicates the view of feed items. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`. _Available in: v23.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 250. If you don’t specify a size, the default is 25. _Available in: v23.0_ * `q` (query, string) Specifies the string to search. The search string must contain at least two characters, not including wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards) . _Available in: v30.0_ #### Responses * **200** _User Group Detail Collection_ In version 45.0 and later, the response body is User Group Detail Collection. **Note**: In version 44.0 and earlier, the response body is User Group Page. Media type: `application/json`. Schema: `UserGroupDetailCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` # This GET request returns information about all groups the context user is a # member of whose names or descriptions contain the letters `co`. GET /chatter/users/me/groups?q=co ``` ### GET User Messages, General `GET /chatter/users/{userId}/messages` Operation ID: `getMessages`. Tags: Users Resources. Returns all the messages for all the private conversations for the logged-in user. Also used to search across all messages and post a message. Get private messages for the context user. Search across private messages. To get all private conversations for the context user, see [User Conversations, General](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getConversations). Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, see [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/messages` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `page` (query, string) A page token that indicates where retrieval begins. Get this token from the `NextPageUrl` property in the response body. _Available in: v23.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v23.0_ * `q` (query, string) 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](/docs/platform/connect-rest-api/guide/intro_wildcards). This parameter is optional. **Note**: The query parameter only searches message text bodies, not user names, titles, and so on. _Available in: v24.0_ #### Responses * **200** _Message Collection_ Collection of messages. Media type: `application/json`. Schema: `MessageCollection`. ### POST User Messages, General `POST /chatter/users/{userId}/messages` Operation ID: `replyToMessage`. Tags: Users Resources. Returns all the messages for all the private conversations for the logged-in user. Also used to search across all messages and post a message. Post a private message. Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, see [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/messages` _Available in: v23.0_ #### Parameters * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `inReplyTo` (query, string) ID of an existing message that identifies which conversation this message is part of Specify either `recipients` or `inReplyTo`. You cannot specify both. _Available in: v23.0_ * `recipients` (query, string) List of users who are the intended message recipients, up to 9. Comma-separated list of user IDs. Specify either `recipients` or `inReplyTo`. You cannot specify both. _Available in: v23.0_ * `text` (query, string, required) The text of the message, up to 10,000 characters _Available in: v23.0_ #### Request body User message input. _Available in: v23.0_ Media type: `application/json`. Schema: `UserMessagesMessageInput`. _Example: example\_1_ Payload 1 Example JSON format: ``` { "body": "Text of the message", "recipients": [ "userID", "userID" ], "inReplyTo": "messageID" } ``` #### Responses * **200** _Message_ Message. Media type: `application/json`. Schema: `Message`. #### Code samples _Example: Example 1 · HTTP_ ``` Text of the message userID userID messageID Content-Type: application/json { "body": "Text of the message", "recipients": [ "userID", "userID" ], "inReplyTo": "messageID" } ``` ### GET User Messages, Specific `GET /chatter/users/{userId}/messages/{messageId}` Operation ID: `getMessage`. Tags: Users Resources. Returns the specified message. Get a private message for the context user. To get a specific private conversation, see [User Conversations, Specific](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getConversation). To get all private messages for the context user, see [User Messages, General](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getMessages). Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, see [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/messages/{messageId}` _Available in: v23.0_ #### Parameters * `messageId` (path, string (Id), required) ID of the message. Pattern: ^(03J)\\w\*. * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Message_ Message. Media type: `application/json`. Schema: `Message`. ### GET User Settings `GET /chatter/users/{userId}/settings` Operation ID: `getUserChatterSettings`. Tags: Users Resources. Information about the context user’s global Chatter settings. Get information about a user’s global Chatter settings. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/settings` _Available in: v27.0_ #### Parameters * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Chatter Settings_ A user’s global Chatter settings. Media type: `application/json`. Schema: `UserChatterSettings`. _Example: example\_1_ ``` { "defaultGroupEmailFrequency": "Never" } ``` ### PATCH User Settings `PATCH /chatter/users/{userId}/settings` Operation ID: `patchUserChatterSettings`. Tags: Users Resources. Information about the context user’s global Chatter settings. Update a user’s global Chatter settings. _Available in: v27.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/settings` _Available in: v27.0_ #### Parameters * `userId` (path, string (IdOrMe), required) `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `defaultGroupEmailFrequency` (query, ConnectEmailFrequencyEnum) The default frequency with which a user receives email from a group when they join. This setting does not affect groups a user is already a member of. _Available in: v27.0_ #### Request body Media type: `application/json`. Schema: `UserChatterSettingsInput`. #### Responses * **200** _User Chatter Settings_ A user’s global Chatter settings. Media type: `application/json`. Schema: `UserChatterSettings`. ### GET Subscriptions Notifications Member `GET /connect/chatter/subscriptions/notification/{entityId}/members/{userId}` Operation ID: `getNotificationFrequency`. Tags: Subscriptions Notifications Member Resources. Returns information about the Notification Member. Get information about the frequency with which a user receives subscription notifications. _Available in: v38.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/subscriptions/notification/{entityId}/members/{userId}` _Available in: v38.0_ #### Parameters * `entityId` (path, string (Id), required) In version 38.0–39.0, `entityId` must be a topic ID. In version 40.0 and later, `entityId` must be a topic ID or a Chatter feed stream ID. Pattern: ^(0TO|0Fq)\\w\*. * `userId` (path, string (Id), required) ID of the user. Pattern: ^(005)\\w\*. #### Responses * **200** _Notification Member_ A notification member. Media type: `application/json`. Schema: `NotificationMember`. ### POST Subscriptions Notifications Member `POST /connect/chatter/subscriptions/notification/{entityId}/members/{userId}` Operation ID: `subscribeEntityForNotification`. Tags: Subscriptions Notifications Member Resources. Returns information about the Notification Member. Subscribe a user to receive notifications. When users opt to receive notifications for the topics they follow, they get an email when the topic is added to a post that they have access to. When users opt to receive notifications for their streams, they get an email on every post in the stream. _Available in: v38.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/subscriptions/notification/{entityId}/members/{userId}` _Available in: v38.0_ #### Parameters * `entityId` (path, string (Id), required) In version 38.0–39.0, `entityId` must be a topic ID. In version 40.0 and later, `entityId` must be a topic ID or a Chatter feed stream ID. Pattern: ^(0TO|0Fq)\\w\*. * `userId` (path, string (Id), required) ID of the user. Pattern: ^(005)\\w\*. * `notificationFrequency` (query, ConnectEmailFrequencyEnum, required) Frequency with which a user receives email. In version 38.0 and later, `EachPost` is the only valid value. _Available in: v38.0_ #### Request body (required) _Available in: v38.0_ Media type: `application/json`. Schema: `NotificationMemberInput`. _Example: example\_1_ Payload 1 ``` { "notificationFrequency": "EachPost" } ``` #### Responses * **200** _Notification Member_ A notification member. Media type: `application/json`. Schema: `NotificationMember`. ### DELETE Subscriptions Notifications Member `DELETE /connect/chatter/subscriptions/notification/{entityId}/members/{userId}` Operation ID: `unsubscribeEntityForNotification`. Tags: Subscriptions Notifications Member Resources. Returns information about the Notification Member. Unsubscribe a user from receiving notifications. _Available in: v38.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/subscriptions/notification/{entityId}/members/{userId}` _Available in: v38.0_ #### Parameters * `entityId` (path, string (Id), required) In version 38.0–39.0, `entityId` must be a topic ID. In version 40.0 and later, `entityId` must be a topic ID or a Chatter feed stream ID. Pattern: ^(0TO|0Fq)\\w\*. * `userId` (path, string (Id), required) ID of the user. Pattern: ^(005)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET User Reputation `GET /connect/communities/{communityId}/chatter/users/{userId}/reputation` Operation ID: `getReputation`. Tags: Users Resources. Gets the specified user's reputation. Get a user's reputation in an Experience Cloud site. _Available in: v32.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Reputation_ Success Media type: `application/json`. Schema: `Reputation`. ### POST Missions Users Activity, Purge `POST /connect/communities/{communityId}/missions/activities/purge-job` Operation ID: `purgeUserMissionsActivities`. Tags: Missions Resources. Start a job to purge Missions user activities for the user. Start a job to purge mission activity for all users. This resource purges these activities. * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. **Note**: POST doesn’t take request parameters or a request body. _Available in: v49.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. #### Responses * **200** _User Mission Activities Job_ User mission activities job. Media type: `application/json`. Schema: `UserMissionActivitiesJob`. ### PATCH Missions User Activity, Update `PATCH /connect/communities/{communityId}/missions/users/{userId}` Operation ID: `updateUserMissionActivityCount`. Tags: Missions Resources. Update the activity count for the user Update the mission activity count for a user. _Available in: v45.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `activityCount` (query, integer, required) Number of mission activities of the specified type for the user. _Available in: v45.0_ * `activityType` (query, ConnectUserMissionActivityTypeEnum, required) Type of mission activity for a user. Values are: * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. _Available in: v45.0_ #### Request body (required) Mission activity for a user. _Available in: v45.0_ Media type: `application/json`. Schema: `UserMissionActivityInput`. _Example: example\_1_ Payload 1 ``` { "activityCount": 24, "activityType": "FeedItemWriteAPost" } ``` #### Responses * **200** _User Mission Activity Status_ Status of mission activity for a user. Media type: `application/json`. Schema: `UserMissionActivityStatus`. ### GET Missions User Activity, Export `GET /connect/communities/{communityId}/missions/users/{userId}/activities/export-job` Operation ID: `exportUserMissionsActivities`. Tags: Missions Resources. Start a job to export Missions user activities for the user. Export mission activity for a user. You can export these activities with this resource. * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. _Available in: v45.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Mission Activities Job_ Success Media type: `application/json`. Schema: `UserMissionActivitiesJob`. ### POST Missions User Activity, Purge `POST /connect/communities/{communityId}/missions/users/{userId}/activities/purge-job` Operation ID: `purgeUserMissionsActivitiesByUserId`. Tags: Missions Resources. Start a job to purge Missions user activities for the user. Start a job to purge mission activity for the user. This resource purges these activities. * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. **Note**: POST doesn’t take request parameters or a request body. _Available in: v45.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Mission Activities Job_ Success Media type: `application/json`. Schema: `UserMissionActivitiesJob`. ### GET Missions User Activity, Progress `GET /connect/communities/{communityId}/missions/users/{userId}/progress` Operation ID: `getUserMissionsProgress`. Tags: Missions Resources. Connect resource to calculate user's progress on Missions. Get mission activity progress for a user. _Available in: v46.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Mission Activity Collection_ Success Media type: `application/json`. Schema: `UserMissionActivityCollection`. ### GET Top Unanswered Questions (Pilot) `GET /connect/communities/{communityId}/question-and-answers/top-unanswered` Operation ID: `getTopUnansweredQuestions`. Tags: Question and Answers Resources. Used to access top unanswered questions for a community. Get the top unanswered questions for the context user in an Experience Cloud site. **Note**: We provided top-five unanswered questions to selected customers through a pilot program that required agreement to specific terms and conditions. This pilot program is closed and not accepting new participants. _Available in: v42.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `filter` (query, ConnectFeedFilter) Specifies the filter for the feed. `UnansweredQuestionsWithCandidateAnswers` is the only valid value. _Available in: v42.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 0 through 10. If you don’t specify a value, the default size is 5. _Available in: v42.0_ #### Responses * **200** _Feed Element Page_ Container of feed elements with paginated results. Media type: `application/json`. Schema: `FeedElementPage`. ### POST Dashboard Component Snapshot `POST /connect/dashboards/components/{componentId}/snapshots` Operation ID: `postDBCSnapshotCollectionNew`. Tags: Dashboard Component Snapshot Resources. Posts a new dashboard component snapshot to the specified location. A snapshot of a dashboard component. Use this resource to post a snapshot of a dashboard component to a user, group, or dashboard feed to help other users follow changes in the data. _Available in: v25.0_ #### Parameters * `componentId` (path, string (Id), required) ID of the component. Pattern: ^(01a)\\w\*. * `feedItemText` (query, string) Text that accompanies the dashboard component snapshot. * `filter1` (query, string (Id)) Optional. A dashboard filter item Id. Pattern: ^(0IC)\\w\*. * `filter2` (query, string (Id)) Optional. A second dashboard filter item Id. Pattern: ^(0IC)\\w\*. * `filter3` (query, string (Id)) Optional. A third dashboard filter item Id. Pattern: ^(0IC)\\w\*. * `parentId` (query, string) A user, group, or dashboard Id to which you are posting the snapshot. * `runningUser` (query, string (Id)) Optional. A user Id from which the view of the dashboard will be created, if other than the creator. Pattern: ^(005)\\w\*. #### Request body Media type: `application/json`. Schema: `DashboardComponentSnapshotInput`. #### Responses * **200** _Dashboard Component Snapshot_ Represents both dashboard component snapshots and alerts you receive when a dashboard component value crosses a threshold. **Note**: In API versions 23.0–31.0, this resource returned a Feed Item Attachment: Dashboard response body. Media type: `application/json`. Schema: `DashboardComponentSnapshot`. #### Code samples _Example: Example 1 · HTTP_ ``` { "parentId" : "0F9D00000000I4O", "feedItemBody" : { "messageSegments" : [ { "text" : "Sales Heat", "type" : "Text" } ] } } ``` ### GET Question and Answers Suggestions `GET /connect/question-and-answers/suggestions` Operation ID: `getQuestionAndAnswerSuggestion`. Tags: Question and Answers Suggestions Resources. Return question/article deflection search results. Get question and answers suggestions. _Available in: v32.0_ #### Experience Cloud site path `/connect/communities/{communityId}/question-and-answers/suggestions` _Available in: v32.0_ #### Parameters * `includeArticles` (query, boolean) Specify `true` to include knowledge articles in the search results. To return only questions, specify `false`. _Available in: v32.0_ * `maxResults` (query, integer) The maximum number of results to return for each type of item. Possible values are 1–10. The default value is 5. _Available in: v32.0_ * `q` (query, string, required) Specifies the string to search. The search string must contain at least two characters, not including wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards) . The maximum length is 255 characters. _Available in: v32.0_ * `subjectId` (query, string) Specify a subject ID to search only questions on that object. If the ID is a topic or a user, the ID is ignored. _Available in: v32.0_ #### Responses * **200** _Question and Answers Suggestion Collection_ Question and answers suggestions search result. Media type: `application/json`. Schema: `QuestionAndAnswersSuggestionCollection`. ### GET User Profiles `GET /connect/user-profiles/{userId}` Operation ID: `getUserProfile`. Tags: User Profiles Resources. Returns detail about a user's profile. This contains the user information, a set of capabilities (permissions), and the set of configured profile subtab apps for the given user. Get details about a user’s profile. For information about subtab apps, see [What Is a Subtab App?](https://help.salesforce.com/s/articleView?id=platform.apps_classic_subtab_overview.htm&type=5) The capabilities information provides some information about the context user’s capabilities in relation to another user, called the subject user. For example, the capabilities information indicates whether the context user can chat with the subject user and whether the context user can direct message the subject user. Specify the subject user as the `{userID}`. _Available in: v29.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}` _Available in: v29.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _User Profile_ Chatter user profile. Media type: `application/json`. Schema: `UserProfile`. ### GET User Profiles Banner Photo `GET /connect/user-profiles/{userId}/banner-photo` Operation ID: `getUserBannerPicture`. Tags: User Profiles Resources. Use this resource to access the banner photo for the specified user, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Get the banner photo for a user. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}/banner-photo` _Available in: v36.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Banner Photo_ A banner photo. Media type: `application/json`. Schema: `BannerPhoto`. ### POST User Profiles Banner Photo `POST /connect/user-profiles/{userId}/banner-photo` Operation ID: `postUserBannerPicture`. Tags: User Profiles Resources. Use this resource to access the banner photo for the specified user, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Create the banner photo for a user. To use an image from the Files page as a user banner photo, pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. Images uploaded on the User Profile page don’t have a file ID and can’t be used as the `fileId`. To upload a binary file as the user banner photo, send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). **Note**: Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. **Note**: Photos are processed asynchronously and may not be visible right away. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}/banner-photo` _Available in: v36.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `cropHeight` (query, integer) The length of an edge in pixels of the crop rectangle. _Available in: v36.0_ * `cropWidth` (query, integer) The width of an edge in pixels of the crop rectangle. _Available in: v36.0_ * `cropX` (query, integer) The position X in pixels from the left edge of the image to start the crop square. Top left is position (0,0). _Available in: v36.0_ * `cropY` (query, integer) The position Y in pixels from the top edge of the image to start the crop square. Top left is position (0,0). _Available in: v36.0_ * `fileId` (query, string) ID of an existing file. The key prefix must be 069 and the file size must be less than 8 MB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Required to use an existing file _Available in: v36.0_ * `versionNumber` (query, integer) Version number of an existing file. If not provided, the latest version is used. _Available in: v36.0_ #### Request body _Available in: v36.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileUpload` (_string (binary)_) * `cropHeight` (_integer_) Height of the crop rectangle in pixels. _Available in: v36.0_ * `cropWidth` (_integer_) Width of the crop rectangle in pixels. _Available in: v36.0_ * `cropX` (_integer_) X position of the crop rectangle from the left edge of the image in pixels. Top left is position (0,0). _Available in: v36.0_ * `cropY` (_integer_) Y position of the crop rectangle from the top edge of the image in pixels. Top left is position (0,0). _Available in: v36.0_ * `fileId` (_string_) 18 character ID of an existing file. The key prefix must be 069 and the file must be an image and be smaller than 2 GB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Required to use an existing file _Available in: v36.0_ * `versionNumber` (_integer_) Version number of an existing file. If not provided, the latest version is used. _Available in: v36.0_ _Example: example\_1_ Payload 1 ``` { "cropHeight": "120", "cropWidth": "240", "fileId": "069D00000001IOh" } ``` #### Responses * **200** _Banner Photo_ A banner photo. Media type: `application/json`. Schema: `BannerPhoto`. ### DELETE User Profiles Banner Photo `DELETE /connect/user-profiles/{userId}/banner-photo` Operation ID: `deleteUserBannerPicture`. Tags: User Profiles Resources. Use this resource to access the banner photo for the specified user, add, update, or delete the photo. To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Delete the banner photo for a user. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}/banner-photo` _Available in: v36.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **204** _Successful Delete_ Success ### GET User Profiles Photo `GET /connect/user-profiles/{userId}/photo` Operation ID: `getUserProfilePicture`. Tags: User Profiles Resources. Get the URL of a user photo and post a user photo. To use a file from the Files list in REST, use the request body or request parameters in this entry. To upload a binary file, you must send it in a multipart/form-data message. To display user profile photos in a feed, cache the user photos. Then use the photoVersionId to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance. Get the user profile photo. _Available in: v35.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}/photo` _Available in: v35.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. #### Code samples _Example: Example 1 · HTTP_ ``` /connect/user-profiles/me/photo?cropSize=240&cropX=20&cropY=20&fileId=069D00000001IOh ``` ### POST User Profiles Photo `POST /connect/user-profiles/{userId}/photo` Operation ID: `postUserProfilePicture`. Tags: User Profiles Resources. Get the URL of a user photo and post a user photo. To use a file from the Files list in REST, use the request body or request parameters in this entry. To upload a binary file, you must send it in a multipart/form-data message. To display user profile photos in a feed, cache the user photos. Then use the photoVersionId to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance. Post and crop the user profile photo. To use an image from the Files page, pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. Images uploaded on the User page and on the Group page don’t have a file ID and can’t be used as the `fileId`. To upload a binary file as the user photo, send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). To display user profile photos in a feed, cache the user photos. Then use the `photoVersionId` property of the Photo response body to determine when to update a photo. This technique helps you avoid running over limits and may improve mobile client performance. **Note**: Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. **Note**: Photos are processed asynchronously and may not be visible right away. _Available in: v35.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}/photo` _Available in: v35.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `cropSize` (query, integer) The length, in pixels, of any edge of the crop square. Required to crop an uploaded file or an existing file. _Available in: v35.0_ * `cropX` (query, integer) The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v35.0_ * `cropY` (query, integer) The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v35.0_ * `fileId` (query, string) 18 character ID of an existing file. The key prefix must be 069 and the file size must be less than 2 GB. Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. Required to choose an existing file. _Available in: v35.0_ * `versionNumber` (query, integer) Version number of the existing content. If not provided, the latest version is used. _Available in: v35.0_ #### Request body _Available in: v35.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileUpload` (_string (binary)_) * `cropSize` (_integer_) The length, in pixels, of any edge of the crop square. Required to crop an uploaded file or an existing file. _Available in: v35.0_ * `cropX` (_integer_) The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v35.0_ * `cropY` (_integer_) The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v35.0_ * `fileId` (_string_) 18–character ID of an existing file. The key prefix must be 069 and the file size must be less than 2 GB. Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. Required to choose an existing file. _Available in: v35.0_ * `versionNumber` (_integer_) Version number of an existing file. If not provided, the latest version is used. _Available in: v35.0_ #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. ### DELETE User Profiles Photo `DELETE /connect/user-profiles/{userId}/photo` Operation ID: `deleteUserProfilePicture`. Tags: User Profiles Resources. Get the URL of a user photo and post a user photo. To use a file from the Files list in REST, use the request body or request parameters in this entry. To upload a binary file, you must send it in a multipart/form-data message. To display user profile photos in a feed, cache the user photos. Then use the photoVersionId to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance. Delete the user profile photo. _Available in: v35.0_ #### Experience Cloud site path `/connect/communities/{communityId}/user-profiles/{userId}/photo` _Available in: v35.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** Success ### GET Group Topics `GET /chatter/groups/{groupId}/topics` Operation ID: `getGroupTopics`. Tags: Groups Resources. Get information about topics on group profile. By default return the Topics Recently Talked About by given group. Get up to five topics most recently used in a group. #### Experience Cloud site path `/connect/communities/{communityId}/chatter/groups/{groupId}/topics` _Available in: v28.0_ #### Parameters * `groupId` (path, string (Id), required) ID of the group. #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### GET Topics a User Is Knowledgeable About: Batch Users `GET /chatter/users/batch/{userIds}/knowledgeable-about-topics` Operation ID: `getKnowledgeableAboutTopicCollectionBatch`. Tags: Users Resources. Bulk fetches top 5 topics a user is knowledgeable about for a list of users. Get the top five topics a user is knowledgeable about for a list of users. #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/batch/{userIds}/knowledgeable-about-topics` _Available in: v36.0_ #### Parameters * `userIds` (path, array of string (Id), required) Where userIds is a comma-separated list of up to 500 user IDs. #### Responses * **200** _Batch Results_ Batch results. Media type: `application/json`. Schema: `BatchSbi`. ### GET Topics a User Is Knowledgeable About `GET /chatter/users/{userId}/knowledgeable-about-topics` Operation ID: `getKnowledgeableAboutTopicCollection`. Tags: Users Resources. Get topics a user is knowledgeable about. Get a list of topics that the specified user is knowledgeable about. #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/knowledgeable-about-topics` _Available in: v30.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `page` (query, integer) An integer specifying a page of topics. The default value is 0. _Available in: v30.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 to 100. The default value is 25. _Available in: v30.0_ #### Responses * **200** _Topics People Are Knowledgeable About Collection_ A collection of topics people are knowledgeable about response bodies. Media type: `application/json`. Schema: `TopicsPeopleAreKnowledgeableAboutCollection`. ### GET User Recommendations, General `GET /chatter/users/{userId}/recommendations` Operation ID: `getRecommendations`. Tags: Users Resources. Get all recommendations for a user regardless of recommendation type. Get the Chatter recommendations, such as user, group, file, record, topic, and article recommendations, for the context user. Also get custom and static recommendations for the context user. #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations` _Available in: v24.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `channel` (query, ConnectRecommendationChannel) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. _Available in: v36.0_ * `contextAction` (query, ConnectRecommendationActionEnum) Action that the user just performed. Supported values are `follow` and `view`. Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `contextObjectId` (query, string) ID of the object that the user just performed an action on. * If `contextAction` is `follow`, `contextObjectId` is user ID, file ID, record ID, or topic ID (version 36.0 and later). * If `contextAction` is `view`, `contextObjectId` is user ID, file ID, group ID, record ID, or article ID (version 37.0 and later). Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `maxResults` (query, integer) Maximum number of recommendation results; default is 10. Values must be from 1 to 99. _Available in: v23.0_ * `followed` (query, string) ID of a user. Provides new recommendations based on the context of this user ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–32.0_ * `viewed` (query, string) ID of a file. Provides new recommendations based on the context of this file ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–33.0_ #### Responses * **200** _Chatter Recommendations_ A list of Chatter, custom, and static recommendations. Media type: `application/json`. Schema: `ChatterRecommendations`. ### GET User Recommendations for a Specific Action `GET /chatter/users/{userId}/recommendations/{action}` Operation ID: `getRecommendationsWithAction`. Tags: Users Resources. A filtered list (by action) of recommendations for a user. Get the Chatter, custom, and static recommendations for the specified action for the context user. #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}` _Available in: v24.0_ Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `action` (path, ConnectRecommendationActionEnum, required) Valid values for `{action}` and resulting recommendations: * `follow` returns recommendations to follow users, files, records, and topics (version 36.0 and later). * `join` returns recommendations to join groups. * `view` returns recommendations to view users, files, groups, and records (version 25.0 and later). In version 34.0 and later, `view` returns custom recommendations. In version 35.0 and later, `view` returns static recommendations. In version 37.0 and later, `view` returns article recommendations. * `channel` (query, ConnectRecommendationChannel) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. _Available in: v36.0_ * `contextAction` (query, ConnectRecommendationActionEnum) Action that the user just performed. Supported values are `follow` and `view`. Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `contextObjectId` (query, string) ID of the object that the user just performed an action on. * If `contextAction` is `follow`, `contextObjectId` is user ID, file ID, record ID, or topic ID (version 36.0 and later). * If `contextAction` is `view`, `contextObjectId` is user ID, file ID, group ID, record ID, or article ID (version 37.0 and later). Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `maxResults` (query, integer) Maximum number of recommendation results; default is 10. Values must be from 1 to 99. _Available in: v23.0_ * `followed` (query, string) ID of a user. Provides new recommendations based on the context of this user ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–32.0_ * `viewed` (query, string) ID of a file. Provides new recommendations based on the context of this file ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–33.0_ #### Responses * **200** _Chatter Recommendations_ A list of Chatter, custom, and static recommendations. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. ### GET User Recommendations for an Action and Object Category `GET /chatter/users/{userId}/recommendations/{action}/{objectCategory}` Operation ID: `getRecommendationByObjectCategory`. Tags: Users Resources. Get a list of recommendations for a user that involve recommended actions. Get the Chatter, custom, and static recommendations for the specified action and object category for the context user. _Available in: v23.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}/{objectCategory}` _Available in: v23.0_ Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Parameters * `action` (path, ConnectRecommendationActionEnum, required) * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `channel` (query, ConnectRecommendationChannel) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. _Available in: v36.0_ * `contextAction` (query, ConnectRecommendationActionEnum) Action that the user just performed. Supported values are `follow` and `view`. Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `contextObjectId` (query, string) ID of the object that the user just performed an action on. * If `contextAction` is `follow`, `contextObjectId` is user ID, file ID, record ID, or topic ID (version 36.0 and later). * If `contextAction` is `view`, `contextObjectId` is user ID, file ID, group ID, record ID, or article ID (version 37.0 and later). Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `maxResults` (query, integer) Maximum number of recommendation results; default is 10. Values must be from 1 to 99. _Available in: v23.0_ * `followed` (query, string) ID of a user. Provides new recommendations based on the context of this user ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–32.0_ * `viewed` (query, string) ID of a file. Provides new recommendations based on the context of this file ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–33.0_ * `objectCategory` (path, string, required) The category of object the recommendation is for. Valid values depend on `{action}`: * If `{action}` is `follow`, `{objectCategory}` is `users`, `files`, `records`, or `topics` (version 36.0 and later). * If `{action}` is `join`, `{objectCategory}` is `groups`. * If `{action}` is `view`, `{objectCategory}` is `users`, `files`, `groups`, `records`, `custom` (version 34.0 and later), `apps` (version 35.0 and later), or `articles` (version 37.0 and later). #### Responses * **200** _Chatter Recommendations_ A list of Chatter, custom, and static recommendations. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Code samples _Example: Example 1 · HTTP_ ``` /chatter/users/me/recommendations/view/001 ``` ### GET User Recommendations for an Action and Key Prefix `GET /chatter/users/{userId}/recommendations/{action}/{idPrefix}` Operation ID: `getRecommendationByKeyPrefix`. Tags: Users Resources. Get a list of recommendations for a user that involve recommended actions. Get the Chatter, custom, and static recommendations for the specified action and key prefix for the context user. _Available in: v26.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}/{idPrefix}` _Available in: v26.0_ Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Parameters * `action` (path, ConnectRecommendationActionEnum, required) * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. * `channel` (query, ConnectRecommendationChannel) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. _Available in: v36.0_ * `contextAction` (query, ConnectRecommendationActionEnum) Action that the user just performed. Supported values are `follow` and `view`. Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `contextObjectId` (query, string) ID of the object that the user just performed an action on. * If `contextAction` is `follow`, `contextObjectId` is user ID, file ID, record ID, or topic ID (version 36.0 and later). * If `contextAction` is `view`, `contextObjectId` is user ID, file ID, group ID, record ID, or article ID (version 37.0 and later). Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed. _Available in: v33.0_ * `maxResults` (query, integer) Maximum number of recommendation results; default is 10. Values must be from 1 to 99. _Available in: v23.0_ * `followed` (query, string) ID of a user. Provides new recommendations based on the context of this user ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–32.0_ * `viewed` (query, string) ID of a file. Provides new recommendations based on the context of this file ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. _Available in: v23.0–33.0_ * `idPrefix` (path, string, required) The key prefix — the first three characters of the object ID, which indicates the object type. Valid values depend on `{action}`: * If `{action}` is `follow`, `{idPrefix}` is the key prefix for users (005), files (069), topics (0TO), or records (such as 001 or 003). * If `{action}` is `join`, `{idPrefix}` is the key prefix for groups (0F9). * If `{action}` is `view`, `{idPrefix}` is the key prefix for users (005), files (069), groups (0F9), records (such as 001 or 003), custom recommendations (0RD) in version 34.0 and later, static recommendations (T) in version 35.0 and later, or articles (such as kA0) in version 37.0 and later. #### Responses * **200** _Chatter Recommendations_ A list of Chatter, custom, and static recommendations. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Code samples _Example: Example · HTTP_ ``` /chatter/users/me/recommendations/view/001 ``` ### GET User Recommendations for an Action and Object ID `GET /chatter/users/{userId}/recommendations/{action}/{objectId}` Operation ID: `getRecommendation`. Tags: Users Resources. Get or delete specific remommendations to a user. Get the Chatter, custom, and static recommendations for the specified action and object ID for the context user. _Available in: v24.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}/{objectId}` _Available in: v24.0_ Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Parameters * `action` (path, ConnectRecommendationActionEnum, required) * `objectId` (path, string (IdOrMe), required) The object the recommendation is for. Valid values depend on `{action}`: * If `{action}` is `follow`, `{objectId}` is a user ID, file ID, record ID, or topic ID (version 36.0 and later). * If `{action}` is `join`, `{objectId}` is a group ID. * If `{action}` is `view`, `{objectId}` is a user ID, file ID, group ID, record ID, custom recommendation ID (version 34.0 and later), `Today` for static recommendations (version 35.0 and later), or an article ID (version 37.0 and later). * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Chatter Recommendations_ A list of Chatter, custom, and static recommendations. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. ### DELETE User Recommendations for an Action and Object ID `DELETE /chatter/users/{userId}/recommendations/{action}/{objectId}` Operation ID: `deleteRecommendation`. Tags: Users Resources. Get or delete specific remommendations to a user. Delete a recommendation for the specified action and object ID for the context user. _Available in: v24.0_ DELETE is used to remove a recommendation and is only valid for the following resources: * `/chatter/users/{userId}/recommendations/follow/{recommendedUserId}` * `/chatter/users/{userId}/recommendations/follow/{recommendedFileId}` * `/chatter/users/{userId}/recommendations/follow/{recommendedRecordId}` * `/chatter/users/{userId}/recommendations/follow/{recommendedTopicId}` * `/chatter/users/{userId}/recommendations/join/{recommendedGroupId}` * `/chatter/users/{userId}/recommendations/view/{customRecommendationId}` * `/chatter/users/{userId}/recommendations/view/Today` * `/chatter/users/{userId}/recommendations/view/{recommendedArticleId}` #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}/{objectId}` _Available in: v24.0_ #### Parameters * `action` (path, ConnectRecommendationActionEnum, required) * `objectId` (path, string (IdOrMe), required) The object the recommendation is for. Valid values depend on `{action}`: * If `{action}` is `follow`, `{objectId}` is a user ID, file ID, record ID, or topic ID (version 36.0 and later). * If `{action}` is `join`, `{objectId}` is a group ID. * If `{action}` is `view`, `{objectId}` is a user ID, file ID, group ID, record ID, custom recommendation ID (version 34.0 and later), `Today` for static recommendations (version 35.0 and later), or an article ID (version 37.0 and later). * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Status Codes and Error Responses_ The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred. ### GET User Recommendations for an Action and Object Type `GET /chatter/users/{userId}/recommendations/{action}/{objectEnum}` Operation ID: `getRecommendationByObjectType`. Tags: Users Resources. Get or delete specific remommendations to a user. Get the static Chatter recommendation for the specified action and object type for the context user. _Available in: v34.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}/{objectEnum}` _Available in: v34.0_ Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. #### Parameters * `action` (path, ConnectRecommendationActionEnum, required) Valid value is `view`. * `objectEnum` (path, ConnectRecommendedObjectEnum, required) The type of object being recommended. Valid only when `{action}` is `view`. Valid values: * `Today` — Static recommendations that don't have an ID, for example, the Today app recommendation. * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Chatter Recommendations_ A list of Chatter, custom, and static recommendations. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/users/{userId}/recommendations](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Users-Resources/operation/getRecommendations) operation. See that operation for the full response schema. ### DELETE User Recommendations for an Action and Object Type `DELETE /chatter/users/{userId}/recommendations/{action}/{objectEnum}` Operation ID: `deleteRecommendationByObjectType`. Tags: Users Resources. Get or delete specific remommendations to a user. Delete a static recommendation for the specified action and object type for the context user. _Available in: v34.0_ #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/recommendations/{action}/{objectEnum}` _Available in: v34.0_ #### Parameters * `action` (path, ConnectRecommendationActionEnum, required) Valid value is `view`. * `objectEnum` (path, ConnectRecommendedObjectEnum, required) The type of object being recommended. Valid only when `{action}` is `view`. Valid values: * `Today` — Static recommendations that don't have an ID, for example, the Today app recommendation. * `userId` (path, string (IdOrMe), required) ID of the user. `{userId}` must be the ID of the context user or the alias `me`. Pattern: ^(005)\\w\*|me. #### Responses * **204** _Successful Delete_ Success ### GET Topics Recently Used `GET /chatter/users/{userId}/topics` Operation ID: `getUserTopics`. Tags: Users Resources. Information about the topics a user uses most. Get up to five topics most recently used by a user. #### Experience Cloud site path `/connect/communities/{communityId}/chatter/users/{userId}/topics` _Available in: v28.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### GET Custom Recommendation Audiences `GET /connect/recommendation-audiences` Operation ID: `getRecommendationAudienceCollection`. Tags: Custom Recommendation Audience Resources. Get a list of recommendation audiences; Create a recommendation audience Get a list of custom recommendation audiences. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-audiences` _Available in: v35.0_ #### Parameters * `page` (query, integer) Zero-index page number. If not specified, page zero is used. _Available in: v35.0_ * `pageSize` (query, integer) Number of items per page. Default is 25. _Available in: v35.0_ #### Responses * **200** _Custom Recommendation Audience Collection_ A collection of custom recommendation audiences. Media type: `application/json`. Schema: `RecommendationAudienceCollection`. ### POST Custom Recommendation Audiences `POST /connect/recommendation-audiences` Operation ID: `postRecommendationAudienceCollection`. Tags: Custom Recommendation Audience Resources. Get a list of recommendation audiences; Create a recommendation audience Create a custom recommendation audience. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-audiences` _Available in: v35.0_ #### Parameters * `name` (query, string, required) The unique name of the custom recommendation audience. _Available in: v35.0_ #### Request body (required) A custom recommendation audience. _Available in: v35.0_ Media type: `application/json`. Schema: `RecommendationAudienceInput`. _Example: example\_1_ Payload 1 Creating a custom recommendation audience ``` { "name": "Custom App Users" } ``` #### Responses * **200** _Custom Recommendation Audience_ A custom recommendation audience. Media type: `application/json`. Schema: `RecommendationAudience`. ### GET Custom Recommendation Audience `GET /connect/recommendation-audiences/{recommendationAudienceId}` Operation ID: `getRecommendationAudience`. Tags: Custom Recommendation Audience Resources. Get, update or delete the specified recommendation audience. Get information about a custom recommendation audience. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-audiences/{recommendationAudienceId}` _Available in: v35.0_ #### Parameters * `recommendationAudienceId` (path, string (Id), required) ID of the recommendation audience. Pattern: ^(02J)\\w\*. #### Responses * **200** _Custom Recommendation Audience_ A custom recommendation audience. Media type: `application/json`. Schema: `RecommendationAudience`. ### DELETE Custom Recommendation Audience `DELETE /connect/recommendation-audiences/{recommendationAudienceId}` Operation ID: `deleteRecommendationAudience`. Tags: Custom Recommendation Audience Resources. Get, update or delete the specified recommendation audience. Delete a custom recommendation audience. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-audiences/{recommendationAudienceId}` _Available in: v35.0_ #### Parameters * `recommendationAudienceId` (path, string (Id), required) ID of the recommendation audience. Pattern: ^(02J)\\w\*. #### Responses * **200** _Status Codes and Error Responses_ The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred. ### PATCH Custom Recommendation Audience `PATCH /connect/recommendation-audiences/{recommendationAudienceId}` Operation ID: `patchRecommendationAudience`. Tags: Custom Recommendation Audience Resources. Get, update or delete the specified recommendation audience. Update a custom recommendation audience. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-audiences/{recommendationAudienceId}` _Available in: v35.0_ #### Parameters * `recommendationAudienceId` (path, string (Id), required) ID of the recommendation audience. Pattern: ^(02J)\\w\*. * `name` (query, string) The unique name of the custom recommendation audience. _Available in: v35.0_ #### Request body (required) A custom recommendation audience. _Available in: v35.0_ Media type: `application/json`. Schema: `RecommendationAudienceInput`. _Example: example\_1_ Payload 1 Updating a custom list recommendation audience ``` { "criteria": { "memberOperationType": "Add", "members": { "userIds": [ "005B0000000Ge16", "005D0000001GpHp" ] }, "type": "CustomList" }, "name": "My Custom List" } ``` _Example: example\_2_ Payload 2 Updating a new members recommendation audience ``` { "criteria": { "value": "30", "type": "MaxDaysInCommunity" }, "name": "New Hires" } ``` #### Responses * **200** _Custom Recommendation Audience_ A custom recommendation audience. Media type: `application/json`. Schema: `RecommendationAudience`. ### GET Custom Recommendation Audience Members `GET /connect/recommendation-audiences/{recommendationAudienceId}/members` Operation ID: `getAudienceMembership`. Tags: Custom Recommendation Audience Resources. Get all members from a recommendation audience. Get the members of a custom recommendation audience. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-audiences/{recommendationAudienceId}/members` _Available in: v35.0_ #### Parameters * `recommendationAudienceId` (path, string (Id), required) ID of the recommendation audience. Pattern: ^(02J)\\w\*. * `page` (query, integer) Zero-index page number. If not specified, page zero is used. _Available in: v35.0_ * `pageSize` (query, integer) Number of items per page. Default is 25. _Available in: v35.0_ #### Responses * **200** _User Reference Collection_ A collection of user references. Media type: `application/json`. Schema: `UserReferenceCollection`. ### GET Custom Recommendation Definitions `GET /connect/recommendation-definitions` Operation ID: `getRecommendationDefinitionCollection`. Tags: Custom Recommendation Definition Resources. Get a list of recommendation definitions. Get a list of custom recommendation definitions. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-definitions` _Available in: v33.0_ #### Responses * **200** _Custom Recommendation Definition Collection_ Represents a list of custom recommendation definitions. Media type: `application/json`. Schema: `RecommendationDefinitionCollection`. ### POST Custom Recommendation Definitions `POST /connect/recommendation-definitions` Operation ID: `postRecommendationDefinitionCollection`. Tags: Custom Recommendation Definition Resources. Get a list of recommendation definitions. Create a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-definitions` _Available in: v33.0_ #### Parameters * `actionUrl` (query, string, required) URL for acting on the custom recommendation, for example, the URL to join a group. _Available in: v33.0_ * `actionUrlName` (query, string, required) Text label for the action URL in the user interface, for example, “Launch.” _Available in: v34.0_ * `explanation` (query, string, required) Explanation, or body, of the custom recommendation. _Available in: v33.0_ * `name` (query, string, required) Name of the custom recommendation definition. The name is displayed in Setup. _Available in: v33.0_ * `title` (query, string) Title of the custom recommendation definition. _Available in: v33.0_ #### Request body (required) A custom recommendation definition. _Available in: v33.0_ Media type: `application/json`. Schema: `RecommendationDefinitionInput`. _Example: example\_1_ Payload 1 ``` { "actionUrl": "https://www.example.com", "actionUrlName": "Launch", "explanation": "Click this link to learn more!", "name": "Corporate Training Project", "title": "Want to learn more about Corporate Training Project?" } ``` #### Responses * **200** _Custom Recommendation Definition_ A custom recommendation definition. Media type: `application/json`. Schema: `RecommendationDefinition`. ### GET Custom Recommendation Definition `GET /connect/recommendation-definitions/{recommendationDefinitionId}` Operation ID: `getRecommendationDefinition`. Tags: Custom Recommendation Definition Resources. Returns information about the specified recommendation definition. Get information about a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-definitions/{recommendationDefinitionId}` _Available in: v33.0_ #### Parameters * `recommendationDefinitionId` (path, string (Id), required) ID of the recommendation definition. Pattern: ^(0RD)\\w\*. #### Responses * **200** _Custom Recommendation Definition_ A custom recommendation definition. Media type: `application/json`. Schema: `RecommendationDefinition`. ### DELETE Custom Recommendation Definition `DELETE /connect/recommendation-definitions/{recommendationDefinitionId}` Operation ID: `deleteRecommendationDefinition`. Tags: Custom Recommendation Definition Resources. Returns information about the specified recommendation definition. Delete a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-definitions/{recommendationDefinitionId}` _Available in: v33.0_ #### Parameters * `recommendationDefinitionId` (path, string (Id), required) ID of the recommendation definition. Pattern: ^(0RD)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH Custom Recommendation Definition `PATCH /connect/recommendation-definitions/{recommendationDefinitionId}` Operation ID: `patchRecommendationDefinition`. Tags: Custom Recommendation Definition Resources. Returns information about the specified recommendation definition. Modify a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/recommendation-definitions/{recommendationDefinitionId}` _Available in: v33.0_ #### Parameters * `recommendationDefinitionId` (path, string (Id), required) ID of the recommendation definition. Pattern: ^(0RD)\\w\*. * `actionUrl` (query, string) URL for acting on the custom recommendation, for example, the URL to join a group. _Available in: v33.0_ * `actionUrlName` (query, string) Text label for the action URL in the user interface, for example, “Launch.” _Available in: v34.0_ * `explanation` (query, string) Explanation, or body, of the custom recommendation. _Available in: v33.0_ * `name` (query, string) Name of the custom recommendation definition. The name is displayed in Setup. _Available in: v33.0_ * `title` (query, string) Title of the custom recommendation definition. _Available in: v33.0_ #### Request body A custom recommendation definition. _Available in: v33.0_ Media type: `application/json`. Schema: `RecommendationDefinitionInput`. _Example example\_1: same as POST /connect/recommendation-definitions request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Custom Recommendation Definition_ A custom recommendation definition. Media type: `application/json`. Schema: `RecommendationDefinition`. ### GET Custom Recommendation Definition Photo `GET /connect/recommendation-definitions/{recommendationDefinitionId}/photo` Operation ID: `getRecommendationDefinitionPicture`. Tags: Custom Recommendation Definition Resources. Use this resource to read, add, update, or delete the photo for the specified recommendation definition.To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Get information about the photo for a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. To use an existing file as the recommendation definition photo, pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. To upload a binary file as a recommendation definition photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). _Available in: v33.0_ #### Parameters * `recommendationDefinitionId` (path, string (Id), required) ID of the recommendation definition. Pattern: ^(0RD)\\w\*. #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. ### PUT Custom Recommendation Definition Photo `PUT /connect/recommendation-definitions/{recommendationDefinitionId}/photo` Operation ID: `putRecommendationDefinitionPicture`. Tags: Custom Recommendation Definition Resources. Use this resource to read, add, update, or delete the photo for the specified recommendation definition.To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Upload or modify the photo for a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. To use an existing file as the recommendation definition photo, pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. To upload a binary file as a recommendation definition photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). **Note**: Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. **Note:** Photos are processed asynchronously and may not be visible right away. _Available in: v33.0_ #### Parameters * `recommendationDefinitionId` (path, string (Id), required) ID of the recommendation definition. Pattern: ^(0RD)\\w\*. * `cropSize` (query, integer) The length, in pixels, of any edge of the crop square. Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropX` (query, integer) The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropY` (query, integer) The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `fileId` (query, string) 18 character ID of an existing file. The key prefix must be 069 and the file size must be less than 2 GB. Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. Required to choose an existing file. _Available in: v25.0_ * `versionNumber` (query, integer) Version number of the existing content. If not provided, the latest version is used. _Available in: v25.0_ #### Request body Describes a photo input. _Available in: v29.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileUpload` (_string (binary)_) * `cropSize` (_integer_) The length, in pixels, of any edge of the crop square. Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropX` (_integer_) The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `cropY` (_integer_) The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). Required to crop an uploaded file or an existing file. _Available in: v29.0_ * `fileId` (_string_) 18 character ID of an existing file. The key prefix must be 069 and the file must be an image and be smaller than 2 GB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Required to choose an existing file. _Available in: v25.0_ * `versionNumber` (_integer_) Version number of an existing file. If not provided, the latest version is used. _Available in: v25.0_ _Example: example\_1_ Payload 1 ``` { "cropSize": "120", "cropX": "0", "cropY": "0", "fileId": "069D00000001IOh" } ``` #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. ### DELETE Custom Recommendation Definition Photo `DELETE /connect/recommendation-definitions/{recommendationDefinitionId}/photo` Operation ID: `deleteRecommendationDefinitionPicture`. Tags: Custom Recommendation Definition Resources. Use this resource to read, add, update, or delete the photo for the specified recommendation definition.To add a file from the Files list, use the request body or request parameters in this entry. To upload a binary file in REST , you must send it in a multipart/form-data message. Delete the photo for a custom recommendation definition. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. To use an existing file as the recommendation definition photo, pass the file ID in the `fileId` property of the request body or in the `fileId` request parameter. To upload a binary file as a recommendation definition photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). _Available in: v33.0_ #### Parameters * `recommendationDefinitionId` (path, string (Id), required) ID of the recommendation definition. Pattern: ^(0RD)\\w\*. #### Responses * **200** Success ### GET Scheduled Custom Recommendations `GET /connect/scheduled-recommendations` Operation ID: `getScheduledRecommendationCollection`. Tags: Scheduled Custom Recommendations Resources. Get a list of scheduled recommendations. Get a list of scheduled custom recommendations. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/scheduled-recommendations` _Available in: v33.0_ #### Parameters * `channel` (query, ConnectRecommendationChannel) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2`–`CustomChannel5` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` — Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. Use these channel values; you can’t rename or create other channels. If not specified, defaults to `DefaultChannel`. _Available in: v33.0_ #### Responses * **200** _Scheduled Custom Recommendation Collection_ A list of scheduled custom recommendations. Media type: `application/json`. Schema: `ScheduledRecommendationCollection`. ### POST Scheduled Custom Recommendations `POST /connect/scheduled-recommendations` Operation ID: `postScheduledRecommendationCollection`. Tags: Scheduled Custom Recommendations Resources. Get a list of scheduled recommendations. Create a scheduled custom recommendation. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/scheduled-recommendations` _Available in: v33.0_ #### Parameters * `channel` (query, ConnectRecommendationChannel) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. Use these channel values; you can’t rename or create other channels. If not specified, defaults to `DefaultChannel`. Optional for creating a scheduled recommendation. If not specified, defaults to `DefaultChannel`. Don’t use when updating a scheduled recommendation _Available in: v36.0_ * `enabled` (query, boolean) Indicates whether scheduling is enabled. If `true`, the custom recommendation is enabled and appears in Experience Cloud sites. If `false`, custom recommendations in feeds in Salesforce mobile web aren’t removed, but no new custom recommendations appear. In Customer Service and Partner Central sites, disabled custom recommendations no longer appear. _Available in: v34.0_ * `rank` (query, integer) Relative rank of the scheduled custom recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled custom recommendation is inserted into the position specified by the `rank`. The `rank` of all the scheduled custom recommendations after it is pushed down. See Ranking scheduled custom recommendations example. If the specified `rank` is larger than the size of the list, the scheduled custom recommendation is put at the end of the list. The `rank` of the scheduled custom recommendation is the size of the list, instead of the one specified. If a `rank` is not specified, the scheduled custom recommendation is put at the end of the list. _Available in: v33.0_ * `recommendationAudienceId` (query, string) ID of the audience for this scheduled custom recommendation. _Available in: v35.0_ * `recommendationDefinitionId` (query, string, required) ID of the custom recommendation definition that this scheduled recommendation schedules. Required for creating a scheduled recommendation. You can’t specify a `recommendationDefinitionId` when updating a scheduled custom recommendation. _Available in: v33.0_ #### Request body A scheduled custom recommendation. _Available in: v36.0_ Media type: `application/json`. Schema: `ScheduledRecommendationInput`. _Example: example\_1_ Payload 1 Creating a new scheduled custom recommendation ``` { "rank": "2", "recommendationDefinitionId": "0RDD00000004CEhOAM" } ``` #### Responses * **200** _Scheduled Custom Recommendation_ Represents a scheduled custom recommendation. Media type: `application/json`. Schema: `ScheduledRecommendation`. ### GET Scheduled Custom Recommendation `GET /connect/scheduled-recommendations/{scheduledRecommendationId}` Operation ID: `getScheduledRecommendation`. Tags: Scheduled Custom Recommendations Resources. Provides interaction with scheduled recommendations. Get information about a scheduled custom recommendation. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/scheduled-recommendations/{scheduledRecommendationId}` _Available in: v33.0_ #### Parameters * `scheduledRecommendationId` (path, string (Id), required) ID of a scheduled recommendation. Pattern: ^(0sr)\\w\*. #### Responses * **200** Represents a scheduled custom recommendation. Media type: `application/json`. Schema: `ScheduledRecommendation`. ### DELETE Scheduled Custom Recommendation `DELETE /connect/scheduled-recommendations/{scheduledRecommendationId}` Operation ID: `deleteScheduledRecommendation`. Tags: Scheduled Custom Recommendations Resources. Provides interaction with scheduled recommendations. Delete a scheduled custom recommendation. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/scheduled-recommendations/{scheduledRecommendationId}` _Available in: v33.0_ #### Parameters * `scheduledRecommendationId` (path, string (Id), required) ID of a scheduled recommendation. Pattern: ^(0sr)\\w\*. * `deleteDefinitionIfLast` (query, boolean) If `true` and if the DELETE request is for the last scheduled custom recommendation of a custom recommendation definition, deletes the custom recommendation definition. Default is `false` . _Available in: v35.0_ #### Responses * **204** _Successful Delete_ Success ### PATCH Scheduled Custom Recommendation `PATCH /connect/scheduled-recommendations/{scheduledRecommendationId}` Operation ID: `patchScheduledRecommendation`. Tags: Scheduled Custom Recommendations Resources. Provides interaction with scheduled recommendations. Update a scheduled custom recommendation. Community managers can access, create, and delete audiences, definitions, and schedules for custom recommendations. (Community managers are users with the Create and Set Up Experiences or Manage Experiences permission.) Users with the Modify All Data permission can also access, create, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations. #### Experience Cloud site path `/connect/communities/{communityId}/scheduled-recommendations/{scheduledRecommendationId}` _Available in: v33.0_ #### Parameters * `scheduledRecommendationId` (path, string (Id), required) ID of a scheduled recommendation. Pattern: ^(0sr)\\w\*. * `enabled` (query, boolean) Indicates whether scheduling is enabled. If `true`, the custom recommendation is enabled and appears in Experience Cloud sites. If `false`, custom recommendations in feeds in Salesforce mobile web aren’t removed, but no new custom recommendations appear. In Customer Service and Partner Central sites, disabled custom recommendations no longer appear. _Available in: v34.0_ * `rank` (query, integer) Relative rank of the scheduled custom recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled custom recommendation is inserted into the position specified by the `rank`. The `rank` of all the scheduled custom recommendations after it is pushed down. See Ranking scheduled custom recommendations example. If the specified `rank` is larger than the size of the list, the scheduled custom recommendation is put at the end of the list. The `rank` of the scheduled custom recommendation is the size of the list, instead of the one specified. If a `rank` is not specified, the scheduled custom recommendation is put at the end of the list. _Available in: v33.0_ * `recommendationAudienceId` (query, string) ID of the audience for this scheduled custom recommendation. When updating a scheduled custom recommendation, specify `ALL` to remove the association between a custom recommendation audience and a scheduled custom recommendation. _Available in: v35.0_ #### Request body A scheduled custom recommendation. _Available in: v34.0_ Media type: `application/json`. Schema: `ScheduledRecommendationInput`. _Example: example\_1_ Payload 1 Updating a scheduled custom recommendation ``` { "rank": "2" } ``` #### Responses * **200** _Scheduled Custom Recommendation_ Represents a scheduled custom recommendation. Media type: `application/json`. Schema: `ScheduledRecommendation`. ### GET Topic Endorsement `GET /connect/topic-endorsements/{topicEndorsementId}` Operation ID: `getTopicEndorsement`. Tags: Topics Resources. Allows a user to endorse and unendorse another user on a topic. Get information about an endorsement. #### Experience Cloud site path `/connect/communities/{communityId}/topic-endorsements/{topicEndorsementId}` _Available in: v30.0_ #### Parameters * `topicEndorsementId` (path, string (Id), required) ID of a topic endorsement. Pattern: ^(0en)\\w\*. #### Responses * **200** _Topic Endorsement_ Represents one user endorsing another user for a single topic. Media type: `application/json`. Schema: `TopicEndorsement`. ### DELETE Topic Endorsement `DELETE /connect/topic-endorsements/{topicEndorsementId}` Operation ID: `deleteTopicEndorsement`. Tags: Topics Resources. Allows a user to endorse and unendorse another user on a topic. Remove an endorsement. #### Experience Cloud site path `/connect/communities/{communityId}/topic-endorsements/{topicEndorsementId}` _Available in: v30.0_ #### Parameters * `topicEndorsementId` (path, string (Id), required) ID of a topic endorsement. Pattern: ^(0en)\\w\*. #### Responses * **200** _Status Codes and Error Responses_ The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred. #### Code samples _Example: Example 1 · HTTP_ ``` # When you endorse someone for a topic, an endorsement record is created with # the key prefix `0en`. To remove an endorsement, delete the endorsement record. DELETE /connect/topic-endorsements/0enD0000000003UIAQ ``` _Example: Example 2 · HTTP_ ``` # This is the response: HTTP 204 ``` ### GET Topics, Opt Out from Knowledgeable People List `GET /connect/topic-opt-outs/{topicOptOutId}` Operation ID: `getTopicOptOut`. Tags: Topics Resources. Allows a user to opt back in to a previously opted out topic. Get a topic opt out. #### Experience Cloud site path `/connect/communities/{communityId}/topic-opt-outs/{topicOptOutId}` _Available in: v30.0_ #### Parameters * `topicOptOutId` (path, string (Id), required) ID of a topic opt out. Pattern: ^(0eb)\\w\*. #### Responses * **200** _Topic Opt Out_ An “opt out” from a topic. Indicates that a user doesn’t want to be identified as knowledgeable about a topic. Media type: `application/json`. Schema: `TopicOptOut`. ### DELETE Topics, Opt Out from Knowledgeable People List `DELETE /connect/topic-opt-outs/{topicOptOutId}` Operation ID: `deleteTopicOptOut`. Tags: Topics Resources. Allows a user to opt back in to a previously opted out topic. After hiding yourself from the Knowledgeable People list, show yourself again. #### Experience Cloud site path `/connect/communities/{communityId}/topic-opt-outs/{topicOptOutId}` _Available in: v30.0_ #### Parameters * `topicOptOutId` (path, string (Id), required) ID of a topic opt out. Pattern: ^(0eb)\\w\*. #### Responses * **204** _Successful Delete_ Success #### Code samples _Example: Example 1 · HTTP_ ``` # When you opt out of the knowledgeable people list for a topic, a topic opt out # record is created with the key prefix `0eb`. To show yourself in the # knowledgeable people list after you’ve opted out, delete the topic opt out # record. DELETE /connect/topic-opt-outs/0ebD0000000003oIAA ``` _Example: Example 2 · HTTP_ ``` # This is the response: HTTP 204 ``` ### GET Topics, Endorse People `GET /connect/topics/{topicId}/endorsements` Operation ID: `getTopicEndorsementCollection`. Tags: Topics Resources. Allows a user to get a collection of topic endorsements. Also allows a user to endorse another user on a specific topic. Get endorsements for a topic. #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/endorsements` _Available in: v30.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. * `endorseeId` (query, string) Specifies the ID of the user who received endorsements. _Available in: v31.0_ * `endorserId` (query, string) Specifies the ID of the user who endorsed others. _Available in: v31.0_ * `page` (query, integer) An integer greater than 0 specifying a page of endorsements. The default value is zero. _Available in: v30.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 100. The default value is 25. _Available in: v30.0_ #### Responses * **200** _Topic Endorsement Collection_ A collection of topic endorsement response bodies. Media type: `application/json`. Schema: `TopicEndorsementCollection`. ### POST Topics, Endorse People `POST /connect/topics/{topicId}/endorsements` Operation ID: `postTopicEndorsementCollection`. Tags: Topics Resources. Allows a user to get a collection of topic endorsements. Also allows a user to endorse another user on a specific topic. Endorse a user for a topic. _Available in: v30.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. * `userId` (query, string) ID of the user to endorse for the topic. You must specify the user ID in a query parameter or in the request body. _Available in: v30.0_ #### Request body Endorse a user who’s knowledgeable about a topic. _Available in: v30.0_ Media type: `application/json`. Schema: `TopicEndorsementOnTopicInput`. #### Responses * **200** _Topic Endorsement_ Represents one user endorsing another user for a single topic. Media type: `application/json`. Schema: `TopicEndorsement`. #### Code samples _Example: Example 1 · HTTP_ ``` { "userId" : "005B0000000Ge16" } ``` ### GET Topic Groups `GET /connect/topics/{topicId}/groups` Operation ID: `getTopicGroups`. Tags: Topics Resources. Get information about groups on topic page. By default return the Groups that most often talk about a topic. Get information about the five groups that most recently contributed to a topic. In version 28.0, use `/chatter/topics/{topicId}/groups` #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/groups` _Available in: v29.0_ Returns the same response body as the [GET /chatter/groups](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetailCollection) operation. See that operation for the full response schema. #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. #### Responses * **200** _Group Page_ Page of Chatter groups. Media type: `application/json`. Schema: `object`. Returns the same response body as the [GET /chatter/groups](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetailCollection) operation. See that operation for the full response schema. ### GET Topics, Knowledgeable People List `GET /connect/topics/{topicId}/knowledgeable-users` Operation ID: `getKnowledgeableUserCollection`. Tags: Topics Resources. Get all of the knowledgeable people on a specific topic. Get a list of knowledgeable people for the specified topic. #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/knowledgeable-users` _Available in: v30.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. * `page` (query, integer) An integer greater than 0 specifying a page of topics. The default value is zero. _Available in: v30.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 100. The default value is 25. _Available in: v30.0_ #### Responses * **200** _Knowledgeable People Collection_ A collection of knowledgeable people response bodies. Media type: `application/json`. Schema: `KnowledgeableUserCollection`. ### GET Topics, Opt Outs from Knowledgeable People List `GET /connect/topics/{topicId}/topic-opt-outs` Operation ID: `getTopicOptOutCollection`. Tags: Topics Resources. Allows a user to opt out of a topic and determine whether they have opted out of a particular topic. Get a list of topic opt outs for the specified topic. #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/topic-opt-outs` _Available in: v30.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. #### Responses * **200** _Topic Opt Out Collection_ A collection of topic opt out response bodies. Media type: `application/json`. Schema: `TopicOptOutCollection`. ### POST Topics, Opt Outs from Knowledgeable People List `POST /connect/topics/{topicId}/topic-opt-outs` Operation ID: `postTopicOptOutCollection`. Tags: Topics Resources. Allows a user to opt out of a topic and determine whether they have opted out of a particular topic. Hide yourself from the Knowledgeable People list for the specified topic. #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/topic-opt-outs` _Available in: v30.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. #### Responses * **200** _Topic Opt Out_ An “opt out” from a topic. Indicates that a user doesn’t want to be identified as knowledgeable about a topic. Media type: `application/json`. Schema: `TopicOptOut`. ## Schemas ### ChatterDirectory Chatter directory. * `feeds` (_string_) URL to the feeds resource. _Available in: v24.0_ _Filter group: Small_ * `extensions` (_string_) URL to the extensions resource. _Available in: v40.0_ _Filter group: Small_ * `groups` (_string_) URL to the groups resource. _Available in: v24.0_ _Filter group: Small_ * `organization` (_string_) **Note**: This property is no longer available as of version 26.0. Use the `organization` property in the Connect Directory instead. URL to the organization resource. _Available in: v24.0–26.0_ * `streams` (_string_) URL to the streams resource. _Available in: v39.0_ _Filter group: Small_ * `users` (_string_) Returns a URL to the users resource. _Available in: v24.0_ _Filter group: Small_ ### AnnouncementCollection A paginated collection of Announcement response bodies. * `announcements` (_array of object_) A collection of Announcement response bodies. An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. _Available in: v31.0_ _Filter group: Small_ See the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. Each item: See the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v31.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v31.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v31.0_ _Filter group: Medium_ ### AnnouncementInput An announcement. * `body` (_object_) MessageBodyInput Text of the announcement. Required for creating an announcement if `feedItemId` isn’t specified. Don’t specify for updating an announcement. _Available in: v31.0_ Includes all fields of `MessageBodyInput`. * `expirationDate` (_string (date-time)_) Date time in ISO 8601 format. The Salesforce UI displays an announcement until 11:59 p.m. on this date unless another announcement is posted first. The Salesforce UI ignores the time value in the `expirationDate`. However, you can use the time value to create your own display logic in your own UI. Required for creating an announcement. Optional for updating an announcement _Available in: v31.0_ * `feedItemId` (_string_) ID of an `AdvancedTextPost` feed item that is the body of the announcement. Required for creating an announcement if `body` isn’t specified. Don’t specify for updating an announcement. _Available in: v36.0_ * `isArchived` (_boolean_) Specifies whether the announcement is archived. _Available in: v36.0_ * `parentId` (_string_) ID of the parent entity for the announcement, that is, a group ID when the announcement appears in a group. Required for creating an announcement if `feedItemId` isn’t specified. Don’t specify for updating an announcement. _Available in: v36.0_ * `sendEmails` (_boolean_) Specifies whether the announcement is sent as an email to all group members regardless of their email setting for the group. If Chatter emails aren’t enabled for the organization, announcement emails aren’t sent. Default value is `false`. Optional for creating an announcement. Don’t specify for updating an announcement _Available in: v36.0_ ### Announcement An announcement. * `expirationDate` (_string (date-time)_) Date time in ISO 8601 format. The Salesforce UI displays an announcement until 11:59 p.m. on this date unless another announcement is posted first. The Salesforce UI ignores the time value in the `expirationDate`. However, you can use the time value to create your own display logic in your own UI. _Available in: v31.0_ _Filter group: Small_ * `feedElement` (_object_) FeedItem The feed element that contains the body of the announcement and its associated comments, likes, and so on. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedItem`. * `id` (_string (Id)_) 18-character ID of the announcement. _Available in: v31.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies whether the announcement is archived. _Available in: v36.0_ _Filter group: Small_ * `sendEmails` (_boolean_) Specifies whether the announcement is sent as an email to all group members. _Available in: v36.0_ _Filter group: Medium_ * `url` (_string (url)_) The URL to the announcement. _Available in: v33.0_ _Filter group: Small_ ### DigestPeriod Time period that’s included in a Chatter email digest. Values are: * `DailyDigest` — The email includes up to the 50 latest posts from the previous day. * `WeeklyDigest` — The email includes up to the 50 latest posts from the previous week. _Available in: v37.0_ _Filter group: Small_ Type: `string`. Allowed values: `DailyDigest`, `WeeklyDigest`. ### DigestJobInput Submit a daily or weekly Chatter email digest job. * `period` (_object_, required) DigestPeriod Time period that’s included in a Chatter email digest. Values are: * `DailyDigest` — The email includes up to the 50 latest posts from the previous day. * `WeeklyDigest` — The email includes up to the 50 latest posts from the previous week. _Available in: v37.0_ Includes all fields of `DigestPeriod`. ### DigestJob Represents a successfully enqueued API digest job request. * `period` (_object_) DigestPeriod Time period that’s included in a Chatter email digest. Values are: * `DailyDigest` — The email includes up to the 50 latest posts from the previous day. * `WeeklyDigest` — The email includes up to the 50 latest posts from the previous week. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `DigestPeriod`. ### SupportedEmojisOutput A collection of supported emoji. * `supportedEmojis` (_object_) EmojiCollection A collection of supported emoji. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `EmojiCollection`. ### ExtensionDefinitionCollection Collection of extension definitions. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v40.0_ _Filter group: Small_ * `extensionDefinitions` (_array of ExtensionDefinition_) Collection of extension definitions. _Available in: v40.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `total` (_integer_) Total number of extensions returned. _Available in: v40.0_ _Filter group: Small_ ### GroupMembershipRequest Group membership request. * `createdDate` (_string (date-time)_) ISO 8601 date string specifying the date of the membership request. _Available in: v27.0_ _Filter group: Big_ * `id` (_string (Id)_) ID for the group membership request object. _Available in: v27.0_ _Filter group: Small_ * `lastUpdateDate` (_string (date-time)_) ISO 8601 date string specifying the last time the request was updated. _Available in: v27.0_ _Filter group: Small_ * `requestedGroup` (_object_) Reference Information about the group the user is requesting to join. _Available in: v27.0_ _Filter group: Big_ Includes all fields of `ReferenceCore`. * `responseMessage` (_string_) Message to display to the user if their membership request is declined. The value of this property is used only when the value of the `status` property is `Declined`. The maximum length is 756 characters. _Available in: v27.0_ _Filter group: Big_ * `status` (_object_) ConnectGroupMembershipRequestStatus Status of the request to join a private group. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `ConnectGroupMembershipRequestStatus`. * `url` (_string (url)_) URL to this group membership request object. _Available in: v27.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the user requesting membership in a group. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `UserSummary`. ### ConnectGroupMembershipRequestStatus Status of the request to join a private group. _Available in: v27.0_ _Filter group: Small_ Type: `string`. Allowed values: `Accepted`, `Declined`, `Pending`. ### UpdateGroupMembershipRequestInput Describes a group membership request input. * `responseMessage` (_string_) Use this property to provide a message to the user if their membership request is declined. The value of this property is used only when the value of the `status` property is `Declined`. The maximum length is 756 characters. * `status` (_object_) ConnectGroupMembershipRequestStatus Status of the membership request. Includes all fields of `ConnectGroupMembershipRequestStatus`. ### Batch Result of an entire batch request operation. Results are ordered in the same order in which the requests were given. Results may either be a successful result with a response body, a successful result without a response body, or an error result without a response body. Success and error are determined by the status code in each result. * `hasErrors` (_boolean_) True if at least one of the results is an error (a status code in the 400 or 500 range). _Available in: v28.0_ _Filter group: Small_ * `results` (_array of BatchResultItem_) Collection of batch result items. One for each request input. _Available in: v23.0_ _Filter group: Small_ ### GroupMember Chatter group member. * `id` (_string (Id)_) 18-character ID of the group membership _Available in: v23.0_ _Filter group: Small_ * `lastFeedAccessDate` (_string (date-time)_) The date and time at which the group member last accessed the group feed. Format is ISO 8601. _Available in: v31.0_ _Filter group: Small_ * `role` (_object_) ConnectGroupMembershipEnum Role of the group member. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `ConnectGroupMembershipEnum`. * `url` (_string (url)_) URL to this membership _Available in: v23.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the user who is subscribed to this group _Available in: v23.0_ _Filter group: Small_ Includes all fields of `UserSummary`. ### ConnectGroupMembershipEnum _Available in: v23.0_ _Filter group: Small_ Type: `string`. Allowed values: `GroupManager`, `GroupOwner`, `NotAMember`, `NotAMemberPrivateRequested`, `StandardMember`. ### GroupMemberInput Chatter group member input. * `role` (_object_) ConnectGroupMembershipEnum The role of the member. _Available in: v29.0_ Includes all fields of `ConnectGroupMembershipEnum`. * `userId` (_string_) The user ID of the member to be added to the group. To update a group member’s role, pass only the `role` property, don’t pass the `userId` property. _Available in: v23.0_ ### GroupRecord A record associated with a group. * `id` (_string (Id)_) 18-character ID of the record associated with the group _Available in: v33.0_ _Filter group: Small_ * `record` (_RecordSummary | UserSummary_) Information about the record associated with the group. The record is one of these types: * Record Summary * User Summary _Available in: v33.0_ _Filter group: Small_ One of: `RecordSummary`, `UserSummary`. * `url` (_string (url)_) URL to the record associated with the group _Available in: v33.0_ _Filter group: Small_ ### ConnectGroupArchiveStatusEnum Specifies archive status of groups. Type: `string`. Allowed values: `All`, `Archived`, `NotArchived`. ### GroupPage Page of Chatter groups. * `currentPageUrl` (_string_) URL to this page of groups _Available in: v23.0_ _Filter group: Medium_ * `groups` (_array of object_) Collection of group details _Available in: v23.0_ _Filter group: Small_ See the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. Each item: See the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `nextPageUrl` (_string_) URL to the next page of groups _Available in: v23.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL to the previous page of groups _Available in: v23.0_ _Filter group: Medium_ ### ConnectGroupVisibilityEnum Group visibility type. One of the following values: * `PrivateAccess` — Only members of the group can see posts to this group. * `PublicAccess` — All users within the Experience Cloud site can see posts to this group. * `Unlisted` — Reserved for future use. _Available in: v29.0_ Type: `string`. Allowed values: `PrivateAccess`, `PublicAccess`, `UnlistedAccess`. ### GroupInput Chatter group input. * `announcement` (_string_) An announcement ID. An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. _Available in: v31.0_ * `canHaveChatterGuests` (_boolean_) `true` if this group allows Chatter customers, `false` otherwise. After this property is set to `true`, it cannot be set to `false`. _Available in: v29.0_ * `description` (_string_) The “Description” section of the group _Available in: v29.0_ * `information` (_object_) GroupInformationInput The “Information” section of the group If the group is private, the “Information” section is visible only to members. The “Description” section is visible to everyone. _Available in: v28.0_ Includes all fields of `GroupInformationInput`. * `isArchived` (_boolean_) `true` if the group is archived, `false` otherwise. Defaults to `false`. _Available in: v29.0_ * `isAutoArchiveDisabled` (_boolean_) `true` if automatic archiving is turned off for the group, `false` otherwise. Defaults to `false`. _Available in: v29.0_ * `isBroadcast` (_boolean_) `true` if only group owners and managers can create posts in the group, `false` otherwise. Defaults to `false`. _Available in: v36.0_ * `name` (_string_, required) The name of the group _Available in: v29.0_ * `owner` (_string_) The ID of the group owner. This property is available for PATCH requests only. _Available in: v29.0_ * `visibility` (_object_, required) ConnectGroupVisibilityEnum Group visibility type. One of the following values: * `PrivateAccess` — Only members of the group can see posts to this group. * `PublicAccess` — All users within the Experience Cloud site can see posts to this group. * `Unlisted` — Reserved for future use. _Available in: v29.0_ Includes all fields of `ConnectGroupVisibilityEnum`. ### InviteCollectionInput Invitation collection input. * `invitees` (_array of string_, required) List of email addresses to send the invitation to. _Available in: v39.0_ * `message` (_string_) Message to include in the invitation. _Available in: v39.0_ ### InviteCollection A collection of invitations. * `invitations` (_array of Invite_) Collection of invitations. _Available in: v39.0_ _Filter group: Small_ ### FileSummaryPage File summary page. * `currentPageUrl` (_string_) URL to the current page of files. _Available in: v24.0_ _Filter group: Medium_ * `files` (_array of FileSummary_) Collection of one or more files. _Available in: v24.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of files. _Available in: v24.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL to the previous page of files. _Available in: v24.0_ _Filter group: Medium_ ### GroupRecordPage A paginated list of records associated with a group. * `currentPageUrl` (_string_) URL to the current page _Available in: v33.0_ _Filter group: Medium_ * `nextPageUrl` (_string_) URL to the next page. If there is no next page, returns `null` _Available in: v33.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL to the previous page. If there is no previous page, returns `null` _Available in: v33.0_ _Filter group: Medium_ * `records` (_array of GroupRecord_) Collection of records associated with a group _Available in: v33.0_ _Filter group: Small_ * `totalRecordCount` (_integer_) Total number of records associated with a group _Available in: v33.0_ _Filter group: Small_ ### GroupRecordInput Record to add to a Chatter group. * `recordId` (_string_, required) ID of the record. _Available in: v34.0_ ### GroupDetail Chatter group detail. * `additionalLabel` (_string_) An extra label for the group, for example, “Archived,” “Private,” or “Private With Customers.” If there isn’t an extra label, the value is `null`. _Available in: v30.0_ _Filter group: Small_ * `announcement` (_object_) An announcement for the group. _Available in: v31.0_ _Filter group: Big_ See the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `bannerPhoto` (_object_) BannerPhoto The banner photo for the group. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhoto`. * `canHaveChatterGuests` (_boolean_) `true` if this group allows Chatter customers, `false` otherwise. _Available in: v23.0_ _Filter group: Small_ * `community` (_object_) ReferenceCore Information about the Experience Cloud site. Returns `null` if the group exists in the default site or if digital experiences isn’t enabled. _Available in: v26.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `description` (_string_) Text-only description of the group. _Available in: v23.0_ _Filter group: Big_ * `emailToChatterAddress` (_string_) Group’s email address for posting to this group by email. Returns `null` if Chatter emails and posting to Chatter by email aren’t both enabled in your organization. _Available in: v30.0_ _Filter group: Medium_ * `fileCount` (_integer_) Number of files posted to this group. _Available in: v28.0_ _Filter group: Big_ * `id` (_string_) 18-character ID of the group. _Available in: v23.0_ _Filter group: Small_ * `information` (_object_) GroupInformation The Information section of the group. If the group is private, this section is visible only to members. If the context user is not a member of the group or does not have Modify All Data or View All Data permission, the value is `null`. _Available in: v28.0_ _Filter group: Big_ Includes all fields of `GroupInformation`. * `isArchived` (_boolean_) Specifies whether the group is archived (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Big_ * `isAutoArchiveDisabled` (_boolean_) Specifies whether automatic archiving is disabled for the group (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Big_ * `isBroadcast` (_boolean_) Specifies whether the group is a broadcast group (`true`) or not (`false`). In a broadcast group, only group owners and managers can post to the group. _Available in: v36.0_ _Filter group: Big_ * `lastFeedElementPostDate` (_string_) Date of the most recent feed element posted to the group. _Available in: v31.0_ _Filter group: Big_ * `lastFeedItemPostDate` (_string_) Date of the most recent feed item posted to the group. After API version 30.0, use `lastFeedElementPostDate`. _Available in: v24.0–30.0_ _Filter group: Big_ * `memberCount` (_integer_) Total number of group members. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `myRole` (_ConnectGroupMembershipEnum_) * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Name of the group. _Available in: v23.0_ _Filter group: Small_ * `owner` (_object_) UserSummary Information about the owner of the group. _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `UserSummary`. * `pendingRequests` (_integer_) The number of pending requests to join a private group. For public groups, the value is `null`. _Available in: v29.0_ _Filter group: Medium_ * `photo` (_object_) Photo Information about the group photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `type` (_string_) Value is `CollaborationGroup`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) Relative URL string to the group. _Available in: v23.0_ _Filter group: Small_ * `visibility` (_ConnectGroupVisibilityEnum_) ### BannerPhoto A banner photo. * `bannerPhotoUrl` (_string (url)_) URL to the banner photo in a large format. This URL is available only to authenticated users. _Available in: v36.0_ _Filter group: Medium_ * `bannerPhotoVersionId` (_string (Id)_) 18-character version ID of the banner photo. _Available in: v36.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the banner photo. _Available in: v36.0_ _Filter group: Small_ ### GroupMemberPage Group member page. * `currentPageUrl` (_string_) URL to this page of members _Available in: v23.0_ _Filter group: Medium_ * `members` (_array of GroupMember_) Collection of group members _Available in: v23.0_ _Filter group: Small_ * `myMembership` (_object_) ReferenceCore If the context user is a member of this group, returns information about that membership, or returns `null` otherwise _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `nextPageUrl` (_string_) URL to the next page of members _Available in: v23.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL to the previous page of members _Available in: v23.0_ _Filter group: Medium_ * `totalMemberCount` (_integer_) Total number of group members _Available in: v23.0_ _Filter group: Small_ ### GroupMembershipRequestCollection Group membership request collection. * `requests` (_object_) GroupMembershipRequest Information about all requests to join a private group _Available in: v27.0_ _Filter group: Small_ Includes all fields of `GroupMembershipRequest`. * `total` (_integer_) The total number of requests to join a private group _Available in: v27.0_ _Filter group: Small_ ### GroupChatterSettings A user’s Chatter settings for a specific group. * `emailFrequency` (_object_) ConnectEmailFrequencyEnum The frequency with which a group member receives email from a group. The value `UseDefault` uses the user’s default global setting defined in User Chatter Settings. In communities, the Email on every post option is disabled after more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `ConnectEmailFrequencyEnum`. ### ConnectEmailFrequencyEnum The frequency with which a group member receives email from a group. One of the following values: The value `UseDefault` uses the user’s default global setting defined in User Chatter Settings. In communities, the Email on every post option is disabled after more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. _Available in: v27.0_ _Filter group: Small_ Type: `string`. Allowed values: `DailyDigest`, `EachPost`, `Never`, `UseDefault`, `WeeklyDigest`. ### GroupChatterSettingsInput Group Chatter settings input. * `emailFrequency` (_object_) ConnectEmailFrequencyEnum The frequency with which a group member receives email from a group. In communities, the Email on every post option is disabled after more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. _Available in: v27.0_ Includes all fields of `ConnectEmailFrequencyEnum`. ### Photo Photo. * `fullEmailPhotoUrl` (_string (url)_) A temporary URL to the large profile picture that expires after 30 days. This URL is available to unauthenticated users. _Available in: v27.0_ _Filter group: Medium_ * `largePhotoUrl` (_string (url)_) URL to the large profile picture. The default width is 200 pixels, while the length is scaled so the original image proportions are maintained. If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org. _Available in: v23.0_ _Filter group: Medium_ * `mediumPhotoUrl` (_string (url)_) URL to the medium profile picture. The default width is 160 pixels, and the height is scaled so the original image proportions are maintained. If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org. _Available in: v37.0_ _Filter group: Small_ * `photoVersionId` (_string (Id)_) 18-character ID to that version of the photo. _Available in: v24.0_ _Filter group: Small_ * `smallPhotoUrl` (_string (url)_) URL to the small profile picture. The default size is 64x64 pixels. If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org. _Available in: v23.0_ _Filter group: Small_ * `standardEmailPhotoUrl` (_string (url)_) A temporary URL to the small profile picture that expires after 30 days. This URL is available to unauthenticated users. _Available in: v27.0_ _Filter group: Small_ * `url` (_string (url)_) URL to a resource that returns a Photo response body: for example, `/services/data/v67.0/chatter/users/005D0000001LL8OIAW/photo`. _Available in: v27.0_ _Filter group: Small_ ### GlobalInfluenceThresholdCollection Representation for an influence threshold definition. * `thresholds` (_array of GlobalInfluenceThreshold_) Collection of influence threshold descriptions. ### Like Chatter like. * `id` (_string (Id)_) 18-character ID of the like _Available in: v23.0_ _Filter group: Small_ * `likedItem` (_object_) Reference A reference to the liked comment or feed element _Available in: v27.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `url` (_string (url)_) URL to this like _Available in: v23.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the user who liked this comment or feed element _Available in: v23.0_ _Filter group: Small_ Includes all fields of `UserSummary`. ### LinkMetadataCollection Collection of link metadata. * `linkMetadataList` (_array of LinkMetadata_) List of metadata for links. _Available in: v42.0_ _Filter group: Small_ ### ConnectMentionCompletionType Specifies the type of desired mention completions. Type: `string`. Allowed values: `All`, `Group`, `User`. ### MentionCompletionPage Paginated list of Mention Completion response bodies. * `currentPageUrl` (_string_) URL of the current page _Available in: v29.0_ _Filter group: Medium_ * `mentionCompletions` (_array of MentionCompletion_) Collection of Mention Completion response bodies to use in a mention. _Available in: v29.0_ _Filter group: Small_ * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v29.0_ _Filter group: Small_ * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v29.0_ _Filter group: Medium_ ### ConnectFeedItemVisibilityEnum Specifies the type of users who can see a feed item. Type: `string`. Allowed values: `AllUsers`, `InternalUsers`. ### MentionValidations Information about whether a set of mentions is valid for the context user. * `hasErrors` (_boolean_) Indicates whether at least one of the proposed mentions has an error ( `true` ), or not ( `false` ). For example, context users can’t mention private groups they don’t belong to. If such a group is included in the list of mention validations, `hasErrors` is `true` and the group has a `validationStatus` of `Disallowed` in its mention validation. _Available in: v29.0_ _Filter group: Small_ * `mentionValidations` (_array of MentionValidation_) Information about whether a set of mentions is valid for the context user. _Available in: v29.0_ _Filter group: Medium_ ### ConnectSortOrderEnum The order in which to sort the column. One of these values: * `Ascending` — Items are in ascending alphabetical order (A-Z). * `Descending` — Items are in descending alphabetical order (Z-A). * `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams. _Available in: v29.0_ _Filter group: Small_ Type: `string`. Allowed values: `Ascending`, `Descending`, `MostRecentlyViewed`. ### FeedStreamCollection A collection of Chatter feed streams. * `currentPageUrl` (_string (url)_) URL to the current page of streams. _Available in: v39.0_ _Filter group: Medium_ * `items` (_array of FeedStream_) List of streams. _Available in: v39.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of streams. In version 39.0, all streams are included in `currentPageUrl` and `nextPageUrl` is `null`. _Available in: v39.0_ _Filter group: Medium_ * `total` (_integer_) Total number of streams in the collection. _Available in: v39.0_ _Filter group: Small_ ### FeedStreamInput Chatter feed stream input. * `description` (_string_) Description of the stream, up to 1,000 characters. _Available in: v39.0_ * `name` (_string_) Name of the stream, up to 120 characters. Required when creating a stream (POST). Optional when updating a stream (PATCH) _Available in: v39.0_ * `subscriptionsToAdd` (_array of StreamSubscriptionInput_) List of up to 25 entities whose feeds are included in the stream. Adding an entity that is already added results in no operation. Including the same entity in `subscriptionsToAdd` and `subscriptionsToRemove` results in no operation. _Available in: v39.0_ * `subscriptionsToRemove` (_array of StreamSubscriptionInput_) List of entities whose feeds are removed from the stream. Removing an entity that is already removed results in no operation. Including the same entity in `subscriptionsToAdd` and `subscriptionsToRemove` results in no operation. Optional when updating a stream (PATCH). Not supported when creating a stream (POST) _Available in: v39.0_ ### FeedStream A Chatter feed stream. * `community` (_object_) CommunitySummary Experience Cloud site where the stream is. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `CommunitySummary`. * `createdDate` (_string (date-time)_) Date the stream was created. Format is ISO 8601. _Available in: v39.0_ _Filter group: Small_ * `description` (_string_) Description of the stream. _Available in: v39.0_ _Filter group: Small_ * `id` (_string (Id)_) 18-character ID of the stream. _Available in: v39.0_ _Filter group: Small_ * `name` (_string_) Name of the stream. _Available in: v39.0_ _Filter group: Small_ * `subscriptions` (_array of FeedEnabledEntitySummary_) List of entities whose feeds are included in the stream. _Available in: v39.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the stream. _Available in: v39.0_ _Filter group: Small_ ### Subscription Chatter subscription, or following, information. * `community` (_object_) Reference Information about the Experience Cloud site. Returns `null` if the subscription exists in the default site or if digital experiences isn’t enabled. _Available in: v26.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `id` (_string (Id)_) 18-character ID of the subscription. _Available in: v23.0_ _Filter group: Small_ * `subject` (_Group | RecordSummary | Topic | UserSummary_) Information about the parent, that is, the thing or person being followed. Valid values are: * Group (23.0) * Record Summary (23.0) * Topic (29.0) * User Summary (23.0) _Filter group: Small_ One of: `Group`, `RecordSummary`, `Topic`, `UserSummary`. * `subscriber` (_Group | UserSummary_) Information about the subscriber, that is, the person following this item. _Available in: v23.0_ _Filter group: Small_ One of: `Group`, `UserSummary`. * `url` (_string (url)_) Relative URL to this specific subscription. _Available in: v23.0_ _Filter group: Small_ ### UserPage Page of Chatter users. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) URL to the current page. _Available in: v23.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page. If there is no next page, returns `null`. _Available in: v23.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v37.0_ _Filter group: Medium_ * `previousPageUrl` (_string_) URL to the previous page. If there is no previous page, returns `null`. _Available in: v23.0_ _Filter group: Medium_ * `users` (_array of UserDetail_) Collection of user detail information. _Available in: v24.0_ _Filter group: Small_ ### UserDetail User detail. If the context user doesn’t have permission to see a property, the property is set to `null`. * `aboutMe` (_string_) Text from user's profile. _Available in: v23.0_ _Filter group: Big_ * `additionalLabel` (_string_) If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” _Available in: v30.0_ _Filter group: Small_ * `address` (_object_) Address User’s address. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `Address`. * `bannerPhoto` (_object_) BannerPhoto User’s banner photo. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhoto`. * `chatterActivity` (_object_) ChatterActivity Chatter activity statistics. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ChatterActivity`. * `chatterInfluence` (_object_) ChatterInfluence User’s influence rank. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ChatterInfluence`. * `communityNickname` (_string_) User’s nickname in the site. _Available in: v32.0_ _Filter group: Medium_ * `companyName` (_string_) Company name. _Available in: v23.0_ _Filter group: Small_ * `currentStatus` (_object_) UserStatus User's current status. _Available in: v23.0–25.0_ Includes all fields of `UserStatus`. * `displayName` (_string_) User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. _Available in: v32.0_ _Filter group: Small_ * `email` (_string_) User's email address. _Available in: v23.0_ _Filter group: Medium_ * `firstName` (_string_) User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `followersCount` (_integer_) Number of users following this user. _Available in: v23.0_ _Filter group: Big_ * `followingCounts` (_object_) FollowingCounts Information about items the user is following. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `FollowingCounts`. * `groupCount` (_integer_) Number of groups user is following. _Available in: v23.0_ _Filter group: Big_ * `hasChatter` (_boolean_) `true` if user has access to Chatter; `false` otherwise. _Available in: v31.0_ _Filter group: Small_ * `id` (_string_) 18-character ID of the user. _Available in: v23.0_ _Filter group: Small_ * `isActive` (_boolean_) `true` if user is active, `false` otherwise. _Available in: v23.0_ _Filter group: Small_ * `isChatterGuest` (_boolean_) `true` if user is a Chatter customer, `false` otherwise. In version 26.0 and later, use the `userType` property. _Available in: v23.0–25.0_ * `isInThisCommunity` (_boolean_) `true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.” _Available in: v28.0_ _Filter group: Small_ * `lastName` (_string_) User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `managerId` (_string (Id)_) 18-character ID of the user’s manager. _Available in: v23.0_ _Filter group: Big_ * `managerName` (_string_) Locale-based concatenation of manager's first and last names. _Available in: v23.0_ _Filter group: Big_ * `motif` (_object_) Motif Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile picture. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `outOfOffice` (_object_) OutOfOffice If one exists, extra out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `phoneNumbers` (_array of PhoneNumber_) Collection of user's phone numbers. _Available in: v23.0_ _Filter group: Big_ * `photo` (_object_) Photo Information about the user's photos. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `reputation` (_object_) Reputation Reputation of the user in the site, which is determined by the number of points earned from events and actions performed in the site. _Available in: v32.0_ _Filter group: Big_ Includes all fields of `Reputation`. * `stamps` (_array of Stamp_) Collection of the user’s stamps. In version 44.0 and later, use SOQL to get a user’s stamps. _Available in: v39.0–43.0_ _Filter group: Small_ * `thanksReceived` (_integer_) Number of thanks the user has received. _Available in: v29.0_ _Filter group: Big_ * `title` (_string_) Title of the user. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Value is `User`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) URL to the user's Chatter profile. _Available in: v23.0_ _Filter group: Small_ * `username` (_string_) User name of the user, such as [Admin@mycompany.com](mailto:Admin@mycompany.com) . _Available in: v24.0_ _Filter group: Small_ * `userType` (_ConnectUserTypeEnum_) ### UserInput User input. * `aboutMe` (_string_) The `aboutMe` property of a User Detail response body. The maximum length is 1000 characters. This property populates the “About Me” section of the user profile, which is visible to all members of an Experience Cloud site or org. _Available in: v29.0_ ### UserActivitiesJob User activities job. * `jobToken` (_string_) Token that identifies the user activities job. _Available in: v42.0_ _Filter group: Small_ * `jobType` (_string_) Type of user activities job. Value is `export` or `purge`. _Available in: v42.0_ _Filter group: Small_ * `message` (_string_) Message describing the status and expected outcome of the job. When the job completes, you receive an email with information about the Salesforce file that contains User Activity Collection. _Available in: v42.0_ _Filter group: Small_ ### ConversationSummaryCollection Conversation summary collection. * `conversations` (_array of ConversationSummary_) Collection of zero or more conversations. _Available in: v23.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) URL to the current page of conversations. _Available in: v23.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of messages, that is, older conversations. _Available in: v23.0_ _Filter group: Small_ ### ConversationUnreadCount Conversation unread count. * `hasMore` (_boolean_) `true` if the actual number of unread conversations is greater than 50, `false` otherwise _Available in: v23.0_ _Filter group: Small_ * `unreadCount` (_integer_) Number of unread conversations, that is, conversations that have unread messages. Is an exact value up to the maximum of 50, and is capped at 50 if the value is greater. _Available in: v23.0_ _Filter group: Small_ ### ConversationDetail Conversation detail. * `conversationId` (_string_) 18-character ID of the conversation _Available in: v23.0_ _Filter group: Medium_ * `conversationUrl` (_string_) URL to the conversation detail page _Available in: v23.0_ _Filter group: Small_ * `members` (_array of UserSummary_) Collection of users participating in this conversation _Available in: v23.0_ _Filter group: Small_ * `messages` (_object_) MessageCollection Messages in this conversation _Available in: v23.0_ _Filter group: Small_ Includes all fields of `MessageCollection`. * `read` (_boolean_) Does the context user have unread messages in this conversation? _Available in: v23.0_ _Filter group: Small_ ### InputRequest User stream conversation input. * `read` (_boolean_) Changes the conversation status to unread (`false`) or read (`true`). _Available in: v24.0_ ### FollowerPage Page of Chatter followers. * `currentPageUrl` (_string_) URL of the current page _Available in: v23.0_ _Filter group: Medium_ * `followers` (_array of object_) Collection of one or more subscriptions of those that follow a record _Available in: v23.0_ _Filter group: Small_ See the [GET /chatter/subscriptions/{subscriptionId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Subscriptions-Resources/operation/getSubscription) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. Each item: See the [GET /chatter/subscriptions/{subscriptionId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Subscriptions-Resources/operation/getSubscription) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `mySubscription` (_object_) ReferenceCore **Note**: This field is no longer available as of version 24.0. If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0–24.0_ Includes all fields of `ReferenceCore`. * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v23.0_ _Filter group: Small_ * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v23.0_ _Filter group: Medium_ * `total` (_integer_) Total number of followers _Available in: v23.0_ _Filter group: Small_ ### FollowingPage Page of Chatter followers. * `currentPageUrl` (_string_) URL to the current page _Available in: v23.0_ _Filter group: Medium_ * `following` (_array of object_) Collection of one or more subscriptions _Available in: v23.0_ _Filter group: Small_ See the [GET /chatter/subscriptions/{subscriptionId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Subscriptions-Resources/operation/getSubscription) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. Each item: See the [GET /chatter/subscriptions/{subscriptionId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Subscriptions-Resources/operation/getSubscription) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `nextPageUrl` (_string_) URL of the next page _Available in: v23.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL of the previous page _Available in: v23.0_ _Filter group: Medium_ * `total` (_integer_) Total number of records being followed _Available in: v23.0_ _Filter group: Small_ ### FollowingInput Following input. * `subjectId` (_string_) The ID of the record you want to follow, such as a user ID or file ID. **Note**: Use Group Member Input for adding members to groups. _Available in: v23.0_ ### UserGroupDetailCollection A page of groups that a user is a member of. * `currentPageUrl` (_string (url)_) URL to the current page. _Available in: v45.0_ _Filter group: Medium_ * `groups` (_array of object_) Collection of groups that the user is a member of. _Available in: v45.0_ _Filter group: Small_ See the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. Each item: See the [GET /chatter/groups/{groupId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Groups-Resources/operation/getGroupDetail) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `nextPageUrl` (_string (url)_) URL to the next page, or `null` if there is no next page. _Available in: v45.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page, or `null` if there is no previous page. _Available in: v45.0_ _Filter group: Medium_ * `total` (_integer_) Total number of groups that the user is a member of. _Available in: v45.0_ _Filter group: Small_ ### MessageCollection Collection of messages. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) Connect REST API URL identifying the current page. _Available in: v23.0_ _Filter group: Medium_ * `messages` (_array of Message_) Collection of one or more messages. _Available in: v23.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v23.0_ _Filter group: Small_ ### UserMessagesMessageInput Description of a user message input. * `body` (_string_) Text of the message body _Available in: v23.0_ * `inReplyTo` (_string_) ID of an existing message that identifies which conversation this message is part of . Specify either `recipients` or `inReplyTo`. Specify one or the other, not both. _Available in: v23.0_ * `recipients` (_array of string_) List of users who are the intended message recipients, up to 9. Comma-separated list of user IDs. Specify either `recipients` or `inReplyTo`. Specify one or the other, not both. _Available in: v23.0_ ### Message Message. * `body` (_object_) FeedItemBody Text of the message. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `conversationId` (_string_) 18-character ID of the conversation the message is part of. _Available in: v23.0_ _Filter group: Big_ * `conversationUrl` (_string_) URL to the conversation the message is part of. _Available in: v23.0_ _Filter group: Small_ * `id` (_string_) 18-character ID of the message. _Available in: v23.0_ _Filter group: Small_ * `recipients` (_array of UserSummary_) Collection of one or more message recipients. The collection of recipients is empty for these resources because the conversation participants are already identified in the conversation’s `members` property in Conversation Detail and Conversation Summary. * /chatter/users/me/conversations * /chatter/users/me/conversations/{conversationId} _Available in: v23.0_ _Filter group: Small_ * `sentDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `sender` (_object_) UserSummary Information about the user who sent the message. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `sendingCommunity` (_object_) ReferenceCore Information about the Experience Cloud site from which the message was sent. Returns `null` for the default site or if digital experiences isn’t enabled. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `url` (_string_) URL to this message. _Available in: v23.0_ _Filter group: Small_ ### UserChatterSettings A user’s global Chatter settings. * `defaultGroupEmailFrequency` (_object_) ConnectEmailFrequencyEnum The default frequency with which a user receives email from a group when they join it. In communities, the Email on every post option is disabled after more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `ConnectEmailFrequencyEnum`. ### UserChatterSettingsInput A user’s global Chatter settings. * `defaultGroupEmailFrequency` (_object_) ConnectEmailFrequencyEnum The default frequency with which a user receives email from a group when they join. In communities, the Email on every post option is disabled after more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. _Available in: v27.0_ Includes all fields of `ConnectEmailFrequencyEnum`. ### NotificationMember A notification member. * `notificationFrequency` (_object_) ConnectEmailFrequencyEnum Frequency with which a user receives email. In version 38.0 and later, `EachPost` is the only valid value. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `ConnectEmailFrequencyEnum`. * `url` (_string (url)_) URL to the notification member. _Available in: v38.0_ _Filter group: Small_ ### NotificationMemberInput Notification member input. * `notificationFrequency` (_object_, required) ConnectEmailFrequencyEnum Frequency with which a user receives email. In version 38.0 and later, `EachPost` is the only valid value. _Available in: v38.0_ Includes all fields of `ConnectEmailFrequencyEnum`. ### Reputation Reputation for a user. * `reputationLevel` (_object_) ReputationLevel User’s reputation level. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReputationLevel`. * `reputationPoints` (_number (double)_) User's reputation points, which can be earned by performing different activities. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to the reputation. _Available in: v32.0_ _Filter group: Small_ ### UserMissionActivitiesJob User mission activities job. * `jobToken` (_string_) Token that identifies the mission user activities job. _Available in: v45.0_ _Filter group: Small_ * `jobType` (_string_) Type of user activities job, either `export` or `purge`. _Available in: v45.0_ _Filter group: Small_ * `message` (_string_) Message describing the status and expected outcome of the job. When the job completes, you receive an email with information about the Salesforce file that contains User Mission Activity Collection. _Available in: v45.0_ _Filter group: Small_ ### ConnectUserMissionActivityTypeEnum Type of mission activity for a user. Values are: * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. _Available in: v45.0_ Type: `string`. Allowed values: `FeedItemAnswerAQuestion`, `FeedItemLikeSomething`, `FeedItemMarkAnswerAsBest`, `FeedItemPostQuestion`, `FeedItemReceiveAComment`, `FeedItemReceiveALike`, `FeedItemReceiveAnAnswer`, `FeedItemWriteAComment`, `FeedItemWriteAPost`, `FeedItemYourAnswerMarkedBest`. ### UserMissionActivityInput Mission activity for a user. * `activityCount` (_integer_, required) Number of mission activities of the specified type for the user. _Available in: v45.0_ * `activityType` (_object_, required) ConnectUserMissionActivityTypeEnum Type of mission activity for a user. Values are: * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. _Available in: v45.0_ Includes all fields of `ConnectUserMissionActivityTypeEnum`. ### UserMissionActivityStatus Status of mission activity for a user. * `message` (_string_) Success or error message. _Available in: v45.0_ _Filter group: Small_ * `status` (_string_) Status of mission activity for a user. _Available in: v45.0_ _Filter group: Small_ ### UserMissionActivityCollection List of mission activities for a user. * `community` (_object_) CommunitySummary Experience Cloud site in which the user performed activities. _Available in: v45.0_ _Filter group: Medium_ Includes all fields of `CommunitySummary`. * `userId` (_string_) ID of the user. _Available in: v45.0_ _Filter group: Medium_ * `userMissionActivities` (_array of AbstractUserMissionActivity_) List of mission activities performed by the user. A mission activity can be any of these: * User Mission Activity * User Mission _Available in: v45.0_ _Filter group: Medium_ * `userName` (_string_) Name of the user. _Available in: v45.0_ _Filter group: Medium_ ### ConnectFeedFilter Filter for the feed specified in `redirectedFeedType`. Otherwise, `null`. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `AllQuestions`, `AuthoredBy`, `CommunityScoped`, `QuestionsWithCandidateAnswers`, `QuestionsWithCandidateAnswersReviewedPublished`, `Read`, `SolvedQuestions`, `UnansweredQuestions`, `UnansweredQuestionsWithCandidateAnswers`, `Unread`, `UnsolvedQuestions`. ### FeedElementPage Container of feed elements with paginated results. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) Connect REST API URL identifying the current page. _Available in: v31.0_ _Filter group: Medium_ * `elements` (_array of AbstractFeedElement_) Collection of feed elements. A feed element can be any of these: * Generic Feed Element * Feed Item _Available in: v31.0_ _Filter group: Small_ * `isModifiedToken` (_string_) An opaque polling token that describes when a news feed was last modified. Use this as the value in the `{since}` request parameter of the `/chatter/feeds/news/me/feed-elements/is-modified` resource. This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants. _Available in: v31.0_ _Filter group: Medium_ * `isModifiedUrl` (_string_) Connect REST API URL with a `{since}` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if the feed isn’t a news feed. Use this URL to poll a news feed for updates. This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants. _Available in: v31.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Page token to access the next page of feed elements. _Available in: v31.0_ _Filter group: Small_ * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v31.0_ _Filter group: Small_ * `updatesToken` (_string_) Token to use in an updatedSince parameter, or `null` if not available. An opaque polling token that describes when a news feed was last modified. Use this token as the value in the updatedSince request parameter of the `/chatter/feeds/news/me/feed-elements` resource. _Available in: v31.0_ _Filter group: Big_ * `updatesUrl` (_string_) A resource with the feed elements updated since the feed was refreshed. Value is `null` if the feed doesn’t support updates polling. _Available in: v31.0_ _Filter group: Big_ ### DashboardComponentSnapshotInput Dashboard component snapshot input. * `feedItemBody` (_object_) MessageBodyInput Contains the text that accompanies the feed item associated with the dashboard component snapshot. _Available in: v25.0_ Includes all fields of `MessageBodyInput`. * `filter1Id` (_string_) Optional. A dashboard filter item. * `filter2Id` (_string_) Optional. A second dashboard filter item. * `filter3Id` (_string_) Optional. A third dashboard filter item. * `parentId` (_string_) A user, group, or dashboard ID to which you are posting the snapshot. _Available in: v25.0_ * `runningUserId` (_string_) Optional. A user ID from which the view of the dashboard will be created, if other than the creator. _Available in: v25.0_ * `filterId1` (_string_) Optional. A dashboard filter item ID. _Available in: v25.0_ * `filterId2` (_string_) Optional. A second dashboard filter item ID. _Available in: v25.0_ * `filterId3` (_string_) Optional. A third dashboard filter item ID. _Available in: v25.0_ ### DashboardComponentSnapshot Represents both dashboard component snapshots and alerts you receive when a dashboard component value crosses a threshold. * `componentId` (_string (Id)_) 18-character ID of the dashboard component. _Available in: v32.0_ _Filter group: Small_ * `componentName` (_string_) The dashboard component name. _Available in: v32.0_ _Filter group: Small_ * `dashboardBodyText` (_string_) Display this text next to the actor in the feed element.Use this text in place of the default body text. _Available in: v32.0_ _Filter group: Small_ * `dashboardId` (_string (Id)_) 18-character ID of the dashboard. _Available in: v32.0_ _Filter group: Small_ * `dashboardName` (_string_) The name of the dashboard. _Available in: v32.0_ _Filter group: Small_ * `fullSizeImageUrl` (_string (url)_) The source URL to retrieve the full-size image of a snapshot. Access this URL with OAuth credentials. _Available in: v32.0_ _Filter group: Small_ * `lastRefreshDate` (_string (date-time)_) ISO 8601 date specifying when this dashboard component was last refreshed. _Available in: v32.0_ _Filter group: Small_ * `lastRefreshDateDisplayText` (_string_) Display text for the last refresh date, for example, “Last Refreshed on October 31, 2013.” _Available in: v32.0_ _Filter group: Small_ * `runningUser` (_object_) UserSummary The running user of the dashboard at the time the snapshot was posted. This value may be `null`. Each dashboard has a running user, whose security settings determine which data to display in a dashboard. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `thumbnailUrl` (_string (url)_) The source URL to retrieve the thumbnail image of a snapshot. Access this URL with OAuth credentials. _Available in: v32.0_ _Filter group: Small_ ### QuestionAndAnswersSuggestionCollection Question and answers suggestions search result. * `articles` (_array of ArticleItem_) Collection of articles. _Available in: v32.0_ _Filter group: Small_ * `questions` (_array of AbstractFeedElement_) Collection of questions, which can be any of these: * Generic Feed Element * Feed Item _Available in: v32.0_ _Filter group: Small_ ### UserProfile Chatter user profile. * `capabilities` (_object_) UserCapabilities The context user’s capabilities specific to the subject user’s profile _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `UserCapabilities`. * `id` (_string (Id)_) The ID of the user attached to the profile _Available in: v29.0_ _Filter group: Small_ * `tabs` (_array of UserProfileTab_) The tabs visible to the context user for that user type _Available in: v29.0_ _Filter group: Big_ * `url` (_string (url)_) The URL of the user’s profile _Available in: v29.0_ _Filter group: Small_ * `userDetail` (_object_) UserDetail The details about the user attached to the profile _Available in: v29.0_ _Filter group: Small_ Includes all fields of `UserDetail`. ### TopicCollection Used to return a list of topics. * `currentPageUrl` (_string (url)_) Returns the current page of topics _Available in: v29.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) Returns the next page of topics. If there is no next page, returns the string “null” _Available in: v29.0_ _Filter group: Small_ * `topics` (_array of Topic_) Collection of topics _Available in: v24.0_ _Filter group: Small_ ### BatchSbi Result of an entire batch request operation. Results are ordered in the same order in which the requests were given. Results may either be a successful result with a response body, a successful result without a response body, or an error result without a response body. Success and error are determined by the status code in each result. * `hasErrors` (_boolean_) `true` if at least one of the results in the result set is an HTTP status code in the 400 or 500 range; `false` otherwise _Available in: v28.0_ _Filter group: Small_ * `results` (_object_) Collection of batch result items _Available in: v23.0_ _Filter group: Small_ ### TopicsPeopleAreKnowledgeableAboutCollection A collection of topics people are knowledgeable about response bodies. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v30.0_ _Filter group: Medium_ * `knowledgeableAboutTopics` (_array of TopicsPeopleAreKnowledgeableAbout_) Collection of topics people are knowledgeable about response bodies. _Available in: v30.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v30.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v30.0_ _Filter group: Medium_ * `userId` (_string_) ID of the user who is knowledgeable about the topics. _Available in: v36.0_ _Filter group: Small_ ### ConnectRecommendationChannel Defines the channel the scheduled recommendation will be shown in Type: `string`. Allowed values: `CustomChannel1`, `CustomChannel2`, `CustomChannel3`, `CustomChannel4`, `CustomChannel5`, `DefaultChannel`. ### ConnectRecommendationActionEnum Specifies the type of action to take from a recommendation. Type: `string`. Allowed values: `follow`, `join`, `view`. ### ChatterRecommendations Representation for a list of recommendations. * `recommendations` (_array of ChatterRecommendation_) Collection of recommendations. _Available in: v23.0_ _Filter group: Small_ ### ConnectRecommendedObjectEnum Defines the type of static recommendations Type: `string`. Allowed values: `Other`, `Today`. ### RecommendationAudienceCollection A collection of custom recommendation audiences. * `audienceCount` (_integer_) The total number of custom recommendation audiences. _Available in: v35.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page. _Available in: v35.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page. _Available in: v35.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page. _Available in: v35.0_ _Filter group: Small_ * `recommendationAudiences` (_array of RecommendationAudience_) A collection of custom recommendation audiences. _Available in: v35.0_ _Filter group: Small_ ### RecommendationAudienceInput A custom recommendation audience. * `criteria` (_CustomListAudienceCriteriaInput | NewUserAudienceCriteriaInput_) List of audience criteria to update or add. An audience can have up to 100 criteria. Required when creating an audience. Optional when updating an audience _Available in: v36.0_ One of: `CustomListAudienceCriteriaInput`, `NewUserAudienceCriteriaInput`. * `name` (_string_, required) The unique name of the custom recommendation audience. Optional to update a recommendation audience. Required to create a recommendation audience _Available in: v35.0_ * `memberOperationType` (_string_) This property is available only in version 35.0. In version 36.0 and later, use Custom List Audience Criteria Input. The operation to carry out on the audience members. Values are: * `Add` —Adds specified members to the audience. * `Remove` —Removes specified members from the audience. Required to update a recommendation audience. Don’t use or specify `null` to create a recommendation audience _Available in: v35.0 only_ Allowed values: `Add`, `Remove`. * `members` (_object_) UserIdCollectionInput This property is available only in version 35.0. In version 36.0 and later, use Custom List Audience Criteria Input. A collection of user IDs. When updating an audience, you can include up to 100 members. An audience can have up to 100,000 members, and each Experience Cloud site can have up to 100 audiences. Required to update a recommendation audience. Don’t use or specify `null` to create a recommendation audience _Available in: v35.0 only_ Includes all fields of `UserIdCollectionInput`. ### RecommendationAudience A custom recommendation audience. * `criteria` (_CustomListAudienceCriteria | NewUserAudienceCriteria_) The criteria for the custom recommendation audience type. _Available in: v36.0_ _Filter group: Small_ One of: `CustomListAudienceCriteria`, `NewUserAudienceCriteria`. * `id` (_string (Id)_) 18-character ID of the custom recommendation audience. _Available in: v35.0_ _Filter group: Small_ * `modifiedBy` (_object_) AbstractUser User who last modified the custom recommendation audience. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `AbstractUser`. * `modifiedDate` (_string (date-time)_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. _Available in: v36.0_ _Filter group: Small_ * `name` (_string_) Name of the custom recommendation audience. _Available in: v35.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the custom recommendation audience. _Available in: v35.0_ _Filter group: Small_ * `memberCount` (_integer_) This property is available only in version 35.0. In version 36.0 and later, this property is available in Custom List Audience Criteria. Number of members in the custom recommendation audience. _Available in: v35.0 only_ _Filter group: Small_ * `members` (_object_) This property is available only in version 35.0. In version 36.0 and later, this property is available in Custom List Audience Criteria. Members of the custom recommendation audience. _Available in: v35.0 only_ _Filter group: Big_ Includes all fields of `UserReferenceCollection`. ### UserReferenceCollection A collection of user references. * `currentPageUrl` (_string (url)_) URL to the current page. _Available in: v35.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page. _Available in: v35.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page. _Available in: v35.0_ _Filter group: Small_ * `userCount` (_integer_) Number of users in the collection. _Available in: v35.0_ _Filter group: Small_ * `users` (_array of ReferenceCore_) A collection of user references. _Available in: v35.0_ _Filter group: Small_ ### RecommendationDefinitionCollection Represents a list of custom recommendation definitions. * `recommendationDefinitions` (_array of RecommendationDefinition_) A list of custom recommendation definitions. _Available in: v33.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the Connect REST API resource for the recommendation definition collection. _Available in: v33.0_ _Filter group: Small_ ### RecommendationDefinitionInput A custom recommendation definition. * `actionUrl` (_string_) URL for acting on the custom recommendation, for example, the URL to join a group. Required for creating a recommendation definition. Optional for updating a recommendation definition _Available in: v33.0_ * `actionUrlName` (_string_) Text label for the action URL in the user interface, for example, “Launch.” Required for creating a recommendation definition. Optional for updating a recommendation definition _Available in: v34.0_ * `explanation` (_string_) Explanation, or body, of the custom recommendation. Required for creating a recommendation definition. Optional for updating a recommendation definition _Available in: v33.0_ * `name` (_string_) Name of the custom recommendation definition. The name is displayed in Setup. Required for creating a recommendation definition. Optional for updating a recommendation definition _Available in: v33.0_ * `title` (_string_) Title of the custom recommendation definition. _Available in: v33.0_ ### RecommendationDefinition A custom recommendation definition. * `actionUrl` (_string_) The URL for acting on this custom recommendation. _Available in: v33.0_ _Filter group: Small_ * `actionUrlName` (_string_) The text label for the action URL in the user interface. _Available in: v34.0_ _Filter group: Small_ * `explanation` (_string_) Explanation of the custom recommendation definition. _Available in: v33.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the custom recommendation definition. _Available in: v33.0_ _Filter group: Small_ * `name` (_string_) Name of the custom recommendation definition. The name is displayed in Setup. _Available in: v33.0_ _Filter group: Medium_ * `photo` (_object_) Photo Photo of the custom recommendation definition. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `Photo`. * `title` (_string_) Title of the custom recommendation definition. _Available in: v33.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the Connect REST API resource for the custom recommendation definition. _Available in: v33.0_ _Filter group: Small_ ### ScheduledRecommendationCollection A list of scheduled custom recommendations. * `scheduledRecommendations` (_array of ScheduledRecommendation_) A list of scheduled custom recommendations. _Available in: v33.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the Connect REST API resource for the scheduled custom recommendation collection. _Available in: v33.0_ _Filter group: Small_ ### ScheduledRecommendationInput A scheduled custom recommendation. * `channel` (_object_) A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. Use these channel values; you can’t rename or create other channels. Optional for creating a scheduled recommendation. If not specified, defaults to `DefaultChannel`. Don’t use when updating a scheduled recommendation _Available in: v36.0_ Includes all fields of `ConnectRecommendationChannel`. * `enabled` (_boolean_) Indicates whether scheduling is enabled. If `true`, the custom recommendation is enabled and appears in Experience Cloud sites. If `false`, custom recommendations in feeds in Salesforce mobile web aren’t removed, but no new custom recommendations appear. In Customer Service and Partner Central sites, disabled custom recommendations no longer appear. _Available in: v34.0_ * `rank` (_integer_) Relative rank of the scheduled custom recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled custom recommendation is inserted into the position specified by the `rank`. The `rank` of all the scheduled custom recommendations after it is pushed down. See Ranking scheduled custom recommendations example. If the specified `rank` is larger than the size of the list, the scheduled custom recommendation is put at the end of the list. The `rank` of the scheduled custom recommendation is the size of the list, instead of the one specified. If a `rank` is not specified, the scheduled custom recommendation is put at the end of the list. _Available in: v33.0_ * `recommendationAudienceId` (_string_) ID of the audience for this scheduled custom recommendation. When updating a scheduled custom recommendation, specify `ALL` to remove the association between a custom recommendation audience and a scheduled custom recommendation. _Available in: v35.0_ * `recommendationDefinitionId` (_string_) ID of the custom recommendation definition that this scheduled recommendation schedules. Required for creating a scheduled recommendation. You can’t specify a `recommendationDefinitionId` when updating a scheduled custom recommendation. _Available in: v33.0_ ### ScheduledRecommendation Represents a scheduled custom recommendation. * `channel` (_object_) ConnectRecommendationChannel A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations. Values are: * `CustomChannel1` — Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear. * `CustomChannel2` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel3` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel4` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `CustomChannel5` —Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. * `DefaultChannel` —Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationChannel`. * `enabled` (_boolean_) Indicates whether scheduling is enabled. If `true`, the custom recommendation is enabled and appears in Experience Cloud sites. If `false`, custom recommendations in feeds in Salesforce mobile web aren’t removed, but no new custom recommendations appear. In Customer Service and Partner Central sites, disabled custom recommendations no longer appear. _Available in: v34.0_ _Filter group: Small_ * `id` (_string (Id)_) 18-character ID of the scheduled custom recommendation. _Available in: v33.0_ _Filter group: Small_ * `rank` (_integer_) The rank determining the order of this scheduled custom recommendation. _Available in: v33.0_ _Filter group: Small_ * `recommendationAudienceId` (_string_) ID of the audience for the scheduled custom recommendation. _Available in: v35.0_ _Filter group: Small_ * `recommendationDefinitionRepresentation` (_object_) RecommendationDefinition Custom recommendation definition that this scheduled recommendation schedules. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `RecommendationDefinition`. * `url` (_string (url)_) URL to the Connect REST API resource for the scheduled custom recommendation. _Available in: v33.0_ _Filter group: Small_ ### TopicEndorsement Represents one user endorsing another user for a single topic. * `endorsee` (_object_) UserSummary User being endorsed _Available in: v30.0_ _Filter group: Small_ Includes all fields of `UserSummarySbi`. * `endorsementId` (_string (Id)_) ID of the endorsement record _Available in: v30.0_ _Filter group: Small_ * `endorser` (_object_) UserSummary User performing the endorsement _Available in: v30.0_ _Filter group: Small_ Includes all fields of `UserSummarySbi`. * `topic` (_object_) Topic Topic the user is being endorsed for _Available in: v30.0_ _Filter group: Small_ Includes all fields of `Topic`. * `url` (_string (url)_) Connect REST API resource URL for the endorsement record _Available in: v30.0_ _Filter group: Small_ ### TopicOptOut An “opt out” from a topic. Indicates that a user doesn’t want to be identified as knowledgeable about a topic. * `id` (_string (Id)_) ID of the topic opt out record. _Available in: v30.0_ _Filter group: Small_ * `reason` (_object_) ConnectTopicOptOutReasonEnum The reason the user is opting out of the topic. The only valid value is `topicInfluenceHide`. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `ConnectTopicOptOutReasonEnum`. * `topic` (_object_) Topic Topic the user opted out of. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `Topic`. * `url` (_string (url)_) Connect REST API resource URL to the topic opt out. _Available in: v30.0_ _Filter group: Small_ * `user` (_object_) UserSummary User that opted out of the topic. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `UserSummarySbi`. ### TopicEndorsementCollection A collection of topic endorsement response bodies. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v30.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v30.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v30.0_ _Filter group: Medium_ * `topicEndorsements` (_array of TopicEndorsement_) Collection of topic endorsement response bodies _Available in: v30.0_ _Filter group: Small_ ### TopicEndorsementOnTopicInput Input required for creating a TopicEndorsement. * `userId` (_string_) ID of the user to endorse for the topic. You must specify the user ID in a query parameter or in the request body. _Available in: v30.0_ ### KnowledgeableUserCollection A collection of knowledgeable people response bodies. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v30.0_ _Filter group: Medium_ * `knowledgeableUsers` (_array of KnowledgeableUser_) Collection of knowledgeable people response bodies _Available in: v30.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v30.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v30.0_ _Filter group: Medium_ ### TopicOptOutCollection A collection of topic opt out response bodies. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v30.0_ _Filter group: Medium_ * `topicOptOuts` (_array of TopicOptOut_) Collection of topic opt out response bodies. _Available in: v30.0_ _Filter group: Small_ ### MessageBodyInput Message body input. * `messageSegments` (_array of MessageSegmentInput_) Collection of message segments, based on type. Segments can be one of the following: * Message Segment Input: Entity Link (version 43.0 and later) * Message Segment Input: Hash Tag * Message Segment Input: Inline Image (version 35.0 and later) * Message Segment Input: Link * Message Segment Input: Markup Begin (version 35.0 and later) * Message Segment Input: Markup End (version 35.0 and later) * Message Segment Input: Mention * Message Segment Input: Text _Available in: v23.0_ ### FeedItem A feed is made up of feed elements. A feed item is a type of feed element. * `actor` (_object_) AbstractActor The entity that created the feed item. Values are: * Record Summary —if a record (23.0) * User Summary —if a user (23.0) * Unauthenticated User —if a Chatter customer (24.0) If the actor is a user, a User Summary response body is returned, not a Record Summary of type user. _Filter group: Small_ Includes all fields of `AbstractActor`. * `attachment` (_string_) Depends on the `type` value of the attachment. Values include: * `Approval` — Feed Item Attachment: Approval (v27.0–31.0) * `BasicTemplate` — Feed Item Attachment: Basic Template (v27.0–31.0) * `Canvas` — Feed Item Attachment: Canvas Template (v29.0–31.0) * `CaseComment` — Feed Item Attachment: Case Comment (v24.0–31.0) * `Content` — Feed Item Attachment: Content or `null` if the content is unavailable (v23.0–31.0) * `DashboardComponent` — Feed Item Attachment: Dashboard (v24.0–31.0) * `EmailMessage` — Feed Item Attachment: Email Message (v29.0–31.0) * `Link` — Feed Item Attachment: Link (v23.0–31.0) * `Poll` — Feed Item Attachment: Poll (v26.0–31.0) * `RecordSnapshot` — Feed Item Attachment: Record Snapshot (v29.0–31.0) * `TrackedChange` — Feed Item Attachment: Tracked Change (v29.0–31.0) **Important**: As of API version 32.0, use the `capabilities` property. _Filter group: Medium_ * `body` (_object_) FeedItemBody Information about the feed element. _Available in: v22.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `canShare` (_boolean_) Indicates whether the feed item can be shared. If a feed item has multiple file attachments and at least one attachment has been deleted or is inaccessible, the feed item can’t be shared. The `canShare` value is incorrectly set to `true` in these cases. **Important**: As of API version 39.0, use the `isSharable` property. _Available in: v27.0–38.0_ _Filter group: Medium_ * `capabilities` (_object_) FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `clientInfo` (_object_) ClientInfo Information about the client app used to authenticate the connection. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ClientInfo`. * `comments` (_object_) CommentPage Comments for this feed item. **Important**: As of API version 32.0, use the `capabilities.comments.page` property. _Available in: v23.0–31.0_ _Filter group: Small_ Includes all fields of `CommentPage`. * `createdDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v23.0_ _Filter group: Small_ * `currentUserLike` (_object_) ReferenceCore **Note**: This property is no longer available as of version 24.0. Use the `myLike` property instead. A reference to a like object if applicable, `null` otherwise. _Available in: v23.0–24.0_ Includes all fields of `ReferenceCore`. * `event` (_boolean_) `true` if feed item created due to an event change, `false` otherwise. _Available in: v23.0_ _Filter group: Medium_ * `feedElementType` (_object_) ConnectFeedElementTypeEnum Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: * `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v31.0_ Example: `FeedItem`. Includes all fields of `ConnectFeedElementTypeEnum`. Example: `FeedItem`. * `hasVerifiedComment` (_boolean_) `true` if the feed item has a verified comment, otherwise `false`. _Available in: v41.0_ _Filter group: Small_ * `header` (_object_) FeedItemBody The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string_) 18-character ID of the feed item. _Available in: v23.0_ _Filter group: Small_ * `isBookmarkedByCurrentUser` (_boolean_) `true` if the context user has bookmarked this feed item, `false` otherwise. **Important**: As of API version 32.0, use the `capabilities.bookmarks.isBookmarkedByCurrentUser` property. _Available in: v24.0–31.0_ _Filter group: Medium_ * `isDeleteRestricted` (_boolean_) Returns `true` if the context user can’t delete a feed item. If it returns `false`, possibly the context users can delete the feed item. _Available in: v25.0_ _Filter group: Medium_ * `isLikedByCurrentUser` (_boolean_) `true` if the context user has liked this feed item, `false` otherwise. As of API version 32.0, use the `capabilities.chatterLikes.isLikedByCurrentUser` property. _Available in: v23.0–31.0_ _Filter group: Medium_ * `isSharable` (_boolean_) Indicates whether the feed item can be shared. _Available in: v39.0_ _Filter group: Medium_ * `likes` (_object_) LikePage Likes for this feed item, **Important**: As of API version 32.0, use the `capabilities.chatterLikes.page` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `LikePage`. * `likesMessage` (_object_) LikeMessageBody A message body that describes who likes the feed item. As of API version 32.0, use the `capabilities.chatterLikes.likesMessage` property. _Available in: v27.0–31.0_ _Filter group: Small_ Includes all fields of `LikeMessageBody`. * `moderationFlags` (_object_) ModerationFlags Flags for this feed item. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. **Important**: As of API version 32.0, use the `capabilities.moderation.moderationFlags` property. _Available in: v29.0–31.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. * `modifiedDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `myLike` (_object_) ReferenceCore If the context user has liked the comment, this property is a reference to the specific like, `null` otherwise. **Important**: As of API version 32.0, use the `capabilities.chatterLikes.myLike` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `originalFeedItem` (_object_) Reference A reference to the original feed item if this feed item is a shared feed item, `null` otherwise. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `ReferenceCore`. * `originalFeedItemActor` (_object_) AbstractActor Value depends on type of original feed item. Values are: * Record Summary –if original feed item is a record * User Summary –if original feed item is a user * Unauthenticated User —if original feed item is from a Chatter customer * `null` if this feed item is not a shared feed item _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `AbstractActor`. * `parent` (_object_) AbstractIdable Value depends on type of parent. Values are: * File Summary—if parent is a file * Group—if parent is a group * Record Summary—if parent is a record * User Summary—if parent is a user **Note**: If the parent is a user, a User Summary response body is returned, not a Record Summary of type user. The same applies for both groups and files. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `photoUrl` (_string (url)_) URL of the photo associated with the feed item. _Available in: v23.0_ _Filter group: Medium_ * `preamble` (_string_) The preamble is the title of the post. This property contains renderable plain text for all the segments of the message, for example, “App Builders - Pam Jones”. In API versions to 28.0, use the `/body/text` property as the default case for rendering text. In API versions 29.0–30.0, use the `/preamble/text` property as the default case for rendering text. In API versions 31.0 and later, use the `/header/text` property as the default case for rendering text. _Available in: v27.0–30.0_ _Filter group: Medium_ * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” . _Available in: v28.0_ _Filter group: Small_ * `topics` (_object_) FeedItemTopics Topics for this feed item. **Important**: As of API version 32.0, use the `capabilities.topics.items` property. _Available in: v28.0–31.0_ _Filter group: Medium_ Includes all fields of `FeedItemTopics`. * `type` (_object_) ConnectFeedItemTypeEnum The `type` property always returns all types, regardless of API version. However, not all types are valid with all API versions. **Important**: As of API version 32.0, use the `capabilities` property to determine what can be done with a feed item. See [Feeds and Feed Elements](/docs/platform/connect-rest-api/guide/features_feeds_feed_elements#capabilities). Values are: * `ActivityEvent` — Feed item generated in Case Feed when an event or task associated with a parent record with a feed enabled is created or updated. * `AdvancedTextPost` — A feed item with advanced text formatting, such as a group announcement post. * `ApprovalPost` — Feed item with an approval capability. Approvers can act on the feed item parent. * `AttachArticleEvent` — Feed item generated when an article is attached to a case in Case Feed. * `BasicTemplateFeedItem` — Feed item with an enhanced link capability. * `CallLogPost` — Feed item generated when a call log is saved to a case in Case Feed. * `CanvasPost` — Feed item generated by a canvas app in the publisher or from Connect REST API or Connect in Apex. The post itself is a link to a canvas app. * `CaseCommentPost` — Feed item generated when a case comment is saved in Case Feed. * `ChangeStatusPost` — Feed item generated when the status of a case is changed in Case Feed. * `ChatTranscriptionPost` — Feed item generated in Case Feed when a Live Agent chat transcript is saved to a case. * `CollaborationGroupCreated` — Feed item generated when a new public group is created. Contains a link to the new group. * `CollaborationGroupUnarchived` — Deprecated. Feed item generated when an archived group is activated. * `ContentPost` — Feed item with a content capability. * `CreateRecordEvent` — Feed item that describes a record created in the publisher. * `DashboardComponentAlert` — Feed item with a dashboard alert. * `DashboardComponentSnapshot` — Feed item with a dashboard component snapshot capability. * `EmailMessageEvent` — Feed item generated when an email is sent from a case in Case Feed. * `FacebookPost` — Deprecated. Feed item generated when a Facebook post is created from a case in Case Feed. * `LinkPost` — Feed item with a link capability. * `MilestoneEvent` — Feed item generated when a case milestone is either completed or reaches a violation status. Contains a link to the case milestone. * `PollPost` — Feed item with a poll capability. Viewers of the feed item are allowed to vote on the options in the poll. * `ProfileSkillPost` — Feed item generated when a skill is added to a user’s profile. * `QuestionPost` — Feed item generated when a question is asked. As of API version 33.0, a feed item of this type can have a content capability and a link capability. * `ReplyPost` — Feed item generated by a Chatter Answers reply. * `RypplePost` — Feed item generated when a user posts thanks. * `SocialPost` — Feed item generated when a social post is created from a case in Case Feed. * `TextPost` — Feed item containing text only. * `TrackedChange` — Feed item created when one or more fields on a record have been changed. * `UserStatus` — Deprecated. A user's post to their own profile. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `ConnectFeedItemTypeEnum`. * `url` (_string_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ * `visibility` (_object_) ConnectFeedItemVisibilityEnum Who can see this feed item. Values are: * `InternalUsers` — If digital experiences is enabled, only members of the default, internal site can see the feed item. * `AllUsers` — If digital experiences is enabled, all members of the site can see the feed item. _Available in: v26.0_ _Filter group: Small_ Includes all fields of `ConnectFeedItemVisibilityEnum`. ### EmojiCollection A collection of emoji. * `emojis` (_array of Emoji_) A collection of emoji. _Available in: v39.0_ _Filter group: Small_ ### ExtensionDefinition An extension's definition. * `canAccess` (_boolean_) Indicates whether users can access the extension when it’s associated with a feed element. _Available in: v40.0_ _Filter group: Small_ * `canCreate` (_boolean_) Indicates whether users can create a feed element with the extension in the org. _Available in: v40.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the extension was created. Format is ISO 8601. _Available in: v40.0_ _Filter group: Small_ * `description` (_string_) Description of the extension. _Available in: v40.0_ _Filter group: Big_ * `iconUrl` (_string_) URL to the icon for the extension. _Available in: v40.0_ _Filter group: Small_ * `id` (_string_) ID of the extension. _Available in: v40.0_ _Filter group: Small_ * `informationCollection` (_array of LightningExtensionInformation_) Collection of extension information. _Available in: v40.0_ _Filter group: Small_ * `name` (_string_) Name of the extension. _Available in: v40.0_ _Filter group: Medium_ * `position` (_integer_) Position in which the extension is displayed in the publisher. _Available in: v41.0_ _Filter group: Small_ * `isEnabledInCommunity` (_boolean_) Indicates whether the extension is enabled in the site. _Available in: v40.0 only_ _Filter group: Small_ * `isEnabledInLightningPublisher` (_boolean_) Indicates whether the extension is enabled in the Lightning publisher. _Available in: v40.0 only_ _Filter group: Small_ ### ReferenceCore A reference to a record. * `id` (_string_) The ID of the record being referenced, which could be an 18-character ID or some other string identifier. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The URL to the resource endpoint. _Available in: v23.0_ _Filter group: Small_ ### UserSummary The User Summary response body is a subset of the User Detail response body. * `additionalLabel` (_string_) If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” _Available in: v30.0_ _Filter group: Small_ * `communityNickname` (_string_) User’s nickname in the site. _Available in: v32.0_ _Filter group: Medium_ * `companyName` (_string_) Name of the company. _Available in: v23.0_ _Filter group: Small_ * `displayName` (_string_) User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. _Available in: v32.0_ _Filter group: Small_ * `firstName` (_string_) User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `id` (_string_) 18-character ID of the user. _Available in: v23.0_ _Filter group: Small_ * `isActive` (_boolean_) `true` if user is active, `false` otherwise. _Available in: v25.0_ _Filter group: Small_ * `isChatterGuest` (_boolean_) `true` if user is a Chatter customer, `false` otherwise In version 26.0 and later, user the `userType` property. _Available in: v23.0–26.0_ * `isInThisCommunity` (_boolean_) `true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.” _Available in: v28.0_ _Filter group: Small_ * `lastName` (_string_) User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `outOfOffice` (_object_) OutOfOffice If one exists, extra out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `photo` (_object_) Photo Information about the user's photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `reputation` (_object_) Reputation Reputation of the user in the site, which is determined by the number of points earned from events and actions performed in the site. _Available in: v32.0_ _Filter group: Big_ Includes all fields of `Reputation`. * `stamps` (_array of Stamp_) Collection of the user’s stamps. In version 44.0 and later, use SOQL to get a user’s stamps. _Available in: v39.0–43.0_ _Filter group: Small_ * `title` (_string_) Title of the user. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Value is `User`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) URL to the user's Chatter profile. _Available in: v23.0_ _Filter group: Small_ * `userType` (_ConnectUserTypeEnum_) ### BatchResultItem Batch result item. * `result` (_string_) Dependent on the type of batch. Value could be one of the following: * Asset File for `/connect/file-assets/batch/{assetIds}` (v43.0) * Audience for `/connect/communities/{communityId}/personalization/audiences/batch/{audienceIds}` (v48.0) * Cart Item for `/commerce/webstores/{webstoreId}/carts/{cartId}/cart-items/batch` (v49.0) and `/commerce/webstores/{webstoreId}/carts/active/cart-items/batch` (v49.0) * Comment for `/chatter/comments/batch/{commentIds}` (v42.0) * Error Message (v23.0) * Feed Item for `/chatter/feed-elements/batch` (v32.0) and `/chatter/feed-elements/batch/{feedElementIds}` (v32.0) * File Summary for `/connect/files/batch/{fileIds}` (v26.0) * Group for `/chatter/groups/batch/{groupIds}` (v23.0) * Group Member for `/chatter/group-memberships/batch/{membershipIds}` (v27.0) * Motif for `/connect/motifs/batch/{idOrPrefixList}` (v27.0) * Read By Capability for `/chatter/feed-elements/batch/{feedElementIds}/capabilities/read-by` (v40.0) * Target for `/connect/communities/{communityId}/personalization/targets/batch/{targetIds}` (v47.0) * Topics People Are Knowledgeable About Collection for `/chatter/users/batch/{userIds}/knowledgeable-about-topics` (v36.0) * User Detail for `/chatter/users/batch/{userIds}` (v23.0) * For `/connect/batch`, the value can be any response body depending on the subrequest in the batch. (v28.0) _Filter group: Small_ * `statusCode` (_integer_) HTTP status code indicating the status of this individual request in the batch. _Available in: v23.0_ _Filter group: Small_ ### RecordSummary Record summary. * `entityLabel` (_object_) EntityLabel Label of the record’s entity. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `EntityLabel`. * `id` (_string_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) The localized name . _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### GroupInformationInput Chatter group information input. * `text` (_string_) The text in the “Information” section of the group. HTML is not supported. The maximum length is 4000 characters (bytes). _Available in: v28.0_ * `title` (_string_) The title in the “Information” section of the group. The maximum length is 240 characters (bytes). _Available in: v28.0_ ### Invite An invitation. * `email` (_string_) Email address of the user. _Available in: v39.0_ _Filter group: Small_ * `status` (_object_) ConnectGroupViralInvitationsStatusEnum Specifies the status of an invitation to join a group. Values are: * `ActedUponUser` — The user was added to the group. An email was sent asking the user to visit the group. * `Invited` — An email was sent asking the user to sign up for the org. * `MaxedOutUsers` — The group has the maximum allowed members. * `MultipleError` — The user wasn’t invited due to multiple errors. * `NoActionNeededUser` — The user is already a member of the group. * `NotVisibleToExternalInviter` — The user is not accessible to the user sending the invitation. * `Unhandled` — The user couldn’t be added to the group for an unknown reason. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `ConnectGroupViralInvitationsStatusEnum`. * `userId` (_string_) ID of the user. _Available in: v39.0_ _Filter group: Small_ ### FileSummary Description of a file. For all rendition properties, note the following: For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. * `checksum` (_string_) MD5 checksum for the file. _Available in: v26.0_ _Filter group: Big_ * `contentHubRepository` (_object_) FilesConnectRepository External data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentModifiedDate` (_string_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. File-specific modified date, which is updated only for direct file operations, such as rename. Modifications to the file from outside of Salesforce can update this date. _Available in: v32.0_ _Filter group: Small_ * `contentSize` (_integer_) Size of the file in bytes. _Available in: v24.0_ _Filter group: Small_ * `contentUrl` (_string_) If the file is a link, returns the URL, otherwise the string `null`. _Available in: v24.0_ _Filter group: Small_ * `contentVersionId` (_string_) ID of the content version. _Available in: v62.0_ _Filter group: Small_ * `createdDate` (_string_) ISO 8601 date string when the file was created. _Available in: v41.0_ _Filter group: Small_ * `description` (_string_) Description of the file. _Available in: v24.0_ _Filter group: Medium_ * `downloadUrl` (_string_) URL to the file. _Available in: v26.0_ _Filter group: Small_ * `externalDocumentUrl` (_string_) External URL this file points to, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `externalFilePermissionInformation` (_object_) ExternalFilePermissionInformation External file permission information, such as available groups, available permission types, and current sharing status, or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Big_ Includes all fields of `ExternalFilePermissionInformation`. * `fileExtension` (_string_) Extension of the file. _Available in: v26.0_ _Filter group: Small_ * `fileType` (_string_) Type of file, such as PDF, PowerPoint. _Available in: v24.0_ _Filter group: Medium_ * `flashRenditionStatus` (_string_) Specifies if a flash preview version of the file has been rendered. Flash renditions were retired on July 16, 2021. _Available in: v24.0_ _Filter group: Big_ * `id` (_string_) 18-character ID of the file. _Available in: v24.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies if the file is archived (`true`) or not (`false`). _Available in: v68.0_ _Filter group: Small_ * `isFileAsset` (_boolean_) Specifies whether the file is an asset. _Available in: v46.0_ _Filter group: Small_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v26.0_ _Filter group: Medium_ * `isMajorVersion` (_boolean_) `true` if the file is a major version; `false` if the file is a minor version. Major versions can’t be replaced. _Available in: v31.0_ _Filter group: Medium_ * `mimeType` (_string_) MIME type of the file. _Available in: v26.0_ _Filter group: Medium_ * `moderationFlags` (_object_) ModerationFlags Flags for this file. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. _Available in: v30.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. * `modifiedDate` (_string_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. Modifications to the file from within Salesforce update this date. _Available in: v24.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Name of the file. _Available in: v24.0_ _Filter group: Small_ * `origin` (_string_) Specifies the file source. Valid values are: * `Chatter` — file came from Chatter * `Content` — file came from content * `FileField` — file came from a record or other form _Available in: v24.0_ _Filter group: Big_ * `owner` (_object_) UserSummary Owner of the file. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `parentFolder` (_object_) ReferenceCore Reference to the parent folder. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `ReferenceCore`. * `pdfRenditionStatus` (_string_) Specifies if a PDF preview version of the file has been rendered. _Available in: v24.0_ _Filter group: Big_ * `publishStatus` (_ConnectFilePublishStatusEnum_) * `renditionUrl` (_string_) URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v26.0_ _Filter group: Medium_ * `renditionUrl240By180` (_string_) URL to the 240px by 180px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v29.0_ _Filter group: Medium_ * `renditionUrl720By480` (_string_) URL to the 720px by 480px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v29.0_ _Filter group: Medium_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string_) URL to the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `sharingOption` (_ConnectFileSharingOptionEnum_) * `sharingPrivacy` (_ConnectFileSharingPrivacyEnum_) * `sharingRole` (_ConnectFileSharingRoleEnum_) * `systemModstamp` (_string_) ISO 8601 date string indicating when a user or any automated system process, such as a trigger, updated the file. _Available in: v41.0_ _Filter group: Small_ * `textPreview` (_string_) Text preview of the file if available; `null` otherwise. _Available in: v30.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `thumb240By180RenditionStatus` (_string_) Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `thumb720By480RenditionStatus` (_string_) Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `title` (_string_) Title of the file. _Available in: v24.0_ _Filter group: Small_ * `type` (_string_) _Available in: v24.0_ _Filter group: Small_ * `url` (_string_) URL to the file. _Available in: v24.0_ _Filter group: Small_ * `versionNumber` (_string_) Version number of the file. _Available in: v24.0_ _Filter group: Medium_ ### GroupInformation Describes the “Information” section of a Chatter group. Information about groups, such as the group's members, photo, and the groups in the organization. Create and delete a group, add members to a group, and change the group photo. * `text` (_string_) The text of the “Information” section of a group _Available in: v28.0_ _Filter group: Small_ * `title` (_string_) The title of the “Information” section of a group _Available in: v28.0_ _Filter group: Small_ ### Motif The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color. The motif images are icons, not user uploaded images or photos. For example, every user has the same set of motif icons. Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style: `"motif": { "color": "8C004C", "largeIconUrl": "/img/icon/custom51_100/boat64.png", "mediumIconUrl": "/img/icon/custom51_100/boat32.png", "smallIconUrl": "/img/icon/custom51_100/boat16.png", "svgIconUrl": null },` Users use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png", "svgIconUrl": null },` Groups use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/groups64.png", "mediumIconUrl": "/img/icon/groups32.png", "smallIconUrl": "/img/icon/groups16.png" },` Files use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png", "svgIconUrl": null },` To view the icons in the previous examples, preface the URL with https:// `{instance_name}`. For example, https:// `{instance_name}` /img/icon/profile64.png. * `color` (_string_) A hex value representing the base color of the record type, or `null`. _Available in: v29.0_ _Filter group: Small_ * `largeIconUrl` (_string_) A large icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `mediumIconUrl` (_string_) A medium icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `smallIconUrl` (_string_) A small icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `svgIconUrl` (_string_) An icon in SVG format indicating the record type, or `null` if the icon doesn’t exist. _Available in: v34.0_ _Filter group: Small_ ### GlobalInfluenceThreshold An individual influence definition. * `name` (_string_) Description of this influencer category. For example: 'Active Influencer.' _Available in: v24.0_ _Filter group: Small_ * `threshold` (_number (double)_) Number expressed as a raw percentile that defines the bottom threshold for this influencer category. For example: 0.25 defines the cutoff for the Active Influencer category, which means it includes users with an influence rank equal to or greater than the 25th percentile (25%) and less than the next highest category threshold. _Available in: v24.0_ _Filter group: Small_ ### LinkMetadata Metadata for a link. * `description` (_string_) Description of the link. _Available in: v42.0_ _Filter group: Small_ * `frameSource` (_string_) HTML required to display the resource. _Available in: v42.0_ _Filter group: Small_ * `height` (_integer_) Height required to display the HTML. _Available in: v42.0_ _Filter group: Small_ * `originalUrl` (_string_) Original URL that was used to request the metadata. _Available in: v42.0_ _Filter group: Small_ * `providerUrl` (_string_) URL of the provider that the information is retrieved from. _Available in: v42.0_ _Filter group: Small_ * `source` (_object_) ConnectLinkMetadataSourceEnum Source of the link metadata. Values are: * `None` — Link metadata wasn’t retrieved. * `Sfdc` — Salesforce is the source. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `ConnectLinkMetadataSourceEnum`. * `thumbnailUrl` (_string_) Thumbnail of the resource. _Available in: v42.0_ _Filter group: Small_ * `title` (_string_) Title of the link. _Available in: v42.0_ _Filter group: Small_ * `type` (_object_) ConnectLinkMetadataTypeEnum Type of link that the metadata represents. Values are: * `Error` — Link metadata couldn’t be retrieved. * `Link` — Represents a link. * `None` — Link metadata wasn’t retrieved because the link isn’t an allowed domain. * `Photo` — Represents a photo. * `Rich` — Represents rich content, typically HTML content. * `Unknown` — Link metadata was retrieved, but the type is unknown. * `Video` — Represents a video. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `ConnectLinkMetadataTypeEnum`. * `url` (_string_) URL of the image to display, if one is available. _Available in: v42.0_ _Filter group: Small_ * `width` (_integer_) Width required to display the HTML. _Available in: v42.0_ _Filter group: Small_ ### MentionCompletion Information about a record that could be used to @mention a user or group. * `additionalLabel` (_string_) If one exists, an additional label for the record represented by this completion, for example, “(Customer)” or “(Acme Corporation)”. _Available in: v29.0_ _Filter group: Big_ * `description` (_string_) Description for the record represented by this completion. If the record represented by this completion is an internal user, the description shows the user’s title. For users who aren’t internal, the description is `null`. _Available in: v29.0_ _Filter group: Medium_ * `name` (_string_) Name for the record represented by this completion. _Available in: v29.0_ _Filter group: Small_ * `outOfOffice` (_object_) OutOfOffice If the record represented by this completion is a user, an additional out-of-office message, if one exists, for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `photoUrl` (_string (url)_) URL to the photo or icon for the record represented by this completion. _Available in: v29.0_ _Filter group: Medium_ * `recordId` (_string (Id)_) 18-character ID for the record represented by this completion. _Available in: v29.0_ _Filter group: Small_ * `userType` (_object_) ConnectUserTypeEnum If the record represented by this completion is a user, this value is the user type associated with that user; otherwise the value is `null`. Values are: * `ChatterGuest` — User is an external user in a private group. * `ChatterOnly` — User is a Chatter Free customer. * `Guest` — User is unauthenticated. * `Internal` — User is a standard org member. * `Portal` — User is an external user in an Experience Cloud site. * `System` — User is Chatter Expert or a system user. * `Undefined` — User is a user type that is a custom object. _Available in: v30.0_ _Filter group: Medium_ Includes all fields of `ConnectUserTypeEnum`. ### MentionValidation Information about whether a proposed mention is valid for the context user. * `recordId` (_string (Id)_) The ID of the mentioned record. _Available in: v29.0_ _Filter group: Small_ * `validationStatus` (_object_) ConnectMentionValidationStatusEnum Type of validation error for a proposed mention, if any. One of these values: * `Disallowed` — The proposed mention is invalid and is rejected because the context user is trying to mention something that is not allowed. For example, a user who is not a member of a private group is trying to mention the private group. * `Inaccessible` — The proposed mention is allowed, but the user or record being mentioned isn’t notified. They don't have access to the parent record that’s being discussed. * `Ok` — There is no validation error for this proposed mention. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectMentionValidationStatusEnum`. ### StreamSubscriptionInput An entity to subscribe to for a feed stream. * `entityId` (_string_, required) The ID of any feed-enabled entity, such as a group, record, or user, that the context user can access. When subscribed, the entity’s feed is included in the feed stream. _Available in: v39.0_ ### CommunitySummary Summary of an Experience Cloud site. * `id` (_string (Id)_) 18-character ID of the site. _Available in: v41.0_ _Filter group: Small_ * `name` (_string_) Localized name of the site. _Available in: v41.0_ _Filter group: Small_ ### FeedEnabledEntitySummary An entity that can have feeds associated with it. * `id` (_string (Id)_) The 18-character ID of the record. _Available in: v39.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the record's type. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `Motif`. * `name` (_string_) The localized name of the record. _Available in: v39.0_ _Filter group: Small_ * `type` (_string_) The type of the record. _Available in: v39.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the record. _Available in: v39.0_ _Filter group: Small_ ### Group Chatter group. * `additionalLabel` (_string_) An extra label for the group, for example, “Archived,” “Private,” or “Private With Customers.” If there isn’t an extra label, the value is `null`. _Available in: v30.0_ _Filter group: Small_ * `announcement` (_object_) An announcement for the group. _Available in: v31.0_ _Filter group: Big_ See the [GET /chatter/announcements/{announcementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter#tag/Announcements-Resources/operation/getAnnouncement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses. * `bannerPhoto` (_object_) BannerPhoto The banner photo for the group. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhoto`. * `canHaveChatterGuests` (_boolean_) `true` if this group allows Chatter customers, `false` otherwise. _Available in: v23.0_ _Filter group: Small_ * `community` (_object_) ReferenceCore Information about the Experience Cloud site. Returns `null` if the group exists in the default site or if digital experiences isn’t enabled. _Available in: v26.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `description` (_string_) Text-only description of the group. _Available in: v23.0_ _Filter group: Big_ * `emailToChatterAddress` (_string_) Group’s email address for posting to this group by email. Returns `null` if Chatter emails and posting to Chatter by email aren’t both enabled in your organization. _Available in: v30.0_ _Filter group: Medium_ * `fileCount` (_integer_) Number of files posted to this group. The `fileCount` property is in the Group Detail response body _Available in: v24.0–27.0_ _Filter group: Big_ * `id` (_string_) 18-character ID of the group. _Available in: v23.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies whether the group is archived (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Big_ * `isAutoArchiveDisabled` (_boolean_) Specifies whether automatic archiving is disabled for the group (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Big_ * `isBroadcast` (_boolean_) Specifies whether the group is a broadcast group (`true`) or not (`false`). In a broadcast group, only group owners and managers can post to the group. _Available in: v36.0_ _Filter group: Big_ * `lastFeedElementPostDate` (_string_) Date of the most recent feed element posted to the group in ISO 8601 format. _Available in: v31.0_ _Filter group: Big_ * `lastFeedItemPostDate` (_string_) Date of the most recent feed item posted to the group in ISO 8601 format. After API version 30.0, use `lastFeedElementPostDate`. _Available in: v24.0–30.0_ _Filter group: Big_ * `memberCount` (_integer_) Total number of group members. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `myRole` (_ConnectGroupMembershipEnum_) * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Name of the group. _Available in: v23.0_ _Filter group: Small_ * `owner` (_object_) UserSummary Information about the owner of the group. _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `UserSummary`. * `photo` (_object_) Photo Information about the group photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `type` (_string_) Value is `CollaborationGroup`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) Relative URL string to the group. _Available in: v23.0_ _Filter group: Small_ * `visibility` (_ConnectGroupVisibilityEnum_) ### Topic Topic. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v28.0_ _Filter group: Big_ * `description` (_string_) Description of the topic _Available in: v28.0_ _Filter group: Big_ * `id` (_string (Id)_) 18-character ID of the topic _Available in: v28.0_ _Filter group: Small_ * `images` (_object_) TopicImages Images associated with the topic _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `TopicImages`. * `isBeingDeleted` (_boolean_) `true` if the topic is currently being deleted; `false` otherwise. After the topic is deleted, when attempting to retrieve the topic, the response is 404: Not Found. _Available in: v33.0_ _Filter group: Small_ * `name` (_string_) Name of the topic _Available in: v28.0_ _Filter group: Small_ * `nonLocalizedName` (_string_) Non-localized name of the topic _Available in: v36.0_ _Filter group: Medium_ * `talkingAbout` (_integer_) Number of people talking about this topic over the last two months, based on factors such as topic additions and comments on posts with the topic _Available in: v28.0_ _Filter group: Medium_ * `url` (_string (url)_) URL to the topic detail page _Available in: v29.0_ _Filter group: Small_ ### Address Address input representation for a payment method, payment intent, or card payment method. * `city` (_string_) City _Available in: v49.0_ * `country` (_string_) Country, specified using the ISO country code. _Available in: v49.0_ * `formattedAddress` (_string_) Address formatted by locale _Available in: v25.0_ _Filter group: Small_ * `state` (_string_) State _Available in: v49.0_ * `street` (_string_) Street _Available in: v49.0_ * `zip` (_string_) Zip or postal code _Available in: v23.0_ _Filter group: Small_ * `companyName` (_string_) Company name _Available in: v49.0_ * `postalCode` (_string_) Postal code _Available in: v49.0_ ### ChatterActivity Chatter activity, such as the number of posts and comments made, and comments, likes, and upvotes received, for a user. * `commentCount` (_integer_) Total number of comments in the org or site made by the user. _Available in: v23.0_ _Filter group: Small_ * `commentReceivedCount` (_integer_) Total number of comments in the org or site received by the user. _Available in: v23.0_ _Filter group: Small_ * `likeReceivedCount` (_integer_) Total number of likes and upvotes (in version 45.0 and later) on posts and comments in the org or site received by the user. _Available in: v23.0_ _Filter group: Small_ * `postCount` (_integer_) Total number of posts in the org or site made by the user. _Available in: v23.0_ _Filter group: Small_ ### ChatterInfluence Chatter influence. * `percentile` (_string_) Percentile value for the user’s influence rank within the org or Experience Cloud site. _Available in: v24.0_ _Filter group: Small_ * `rank` (_integer_) Number indicating the user’s influence rank, relative to all other users within the org or Experience Cloud site. _Available in: v24.0_ _Filter group: Small_ ### UserStatus User status. * `body` (_object_) FeedBody Body of the post _Available in: v23.0–25.0_ _Filter group: Small_ Includes all fields of `FeedBody`. * `parentId` (_string (Id)_) 18-character ID _Available in: v23.0–25.0_ _Filter group: Small_ * `url` (_string (url)_) URL to this user status post _Available in: v23.0–25.0_ _Filter group: Small_ ### FollowingCounts Chatter following counts. * `people` (_integer_) Number of people the user is following _Available in: v23.0_ _Filter group: Small_ * `records` (_integer_) Number of records the user is following Topics are a type of record that can be followed as of version 29.0. _Available in: v23.0_ _Filter group: Small_ * `total` (_integer_) Total number of items the user is following _Available in: v23.0_ _Filter group: Small_ ### OutOfOffice User's out-of-office message. * `message` (_string_) Out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ ### PhoneNumber A phone number. * `label` (_string_) Localized string indicating the phone type _Available in: v30.0_ _Filter group: Small_ * `phoneNumber` (_string_) Phone number _Available in: v27.0_ _Filter group: Small_ * `phoneType` (_string_) Phone type. One of these values: * `Fax` * `Mobile` * `Work` These values are not localized. _Available in: v30.0_ _Filter group: Small_ * `number` (_string_) This property is not available after version 26.0. Use the `phoneNumber` property instead. Phone number _Available in: v23.0–26.0_ * `type` (_string_) This property is not available after version 29.0. Use the `phoneType` property instead. Values are: * `Fax` * `Mobile` * `Work` _Available in: v23.0–29.0_ _Filter group: Small_ ### Stamp A user stamp. * `description` (_string_) Description of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ * `id` (_string_) ID of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ * `imageUrl` (_string_) Image URL of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ * `label` (_string_) Label of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ ### ConnectUserTypeEnum If the record represented by this completion is a user, this value is the user type associated with that user; otherwise the value is `null`. Values are: * `ChatterGuest` — User is an external user in a private group. * `ChatterOnly` — User is a Chatter Free customer. * `Guest` — User is unauthenticated. * `Internal` — User is a standard org member. * `Portal` — User is an external user in an Experience Cloud site. * `System` — User is Chatter Expert or a system user. * `Undefined` — User is a user type that is a custom object. _Available in: v30.0_ _Filter group: Medium_ Type: `string`. Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`. ### ConversationSummary Conversation summary. * `id` (_string_) 18-character ID of the conversation _Available in: v23.0_ _Filter group: Small_ * `latestMessage` (_object_) Message The most recent message in this conversation _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Message`. * `members` (_array of UserSummary_) Collection of users participating in the conversation _Available in: v23.0_ _Filter group: Small_ * `read` (_boolean_) Does the context user have unread messages in this conversation? _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) URL to the conversation detail page _Available in: v23.0_ _Filter group: Small_ ### FeedItemBody Chatter feed item body. * `isRichText` (_boolean_) Indicates if the body is rich text. _Available in: v35.0_ _Filter group: Small_ * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. Segments can be one or more of the following: * Message Segment: Entity Link * Message Segment: Field Change * Message Segment: Field Change Name * Message Segment: Field Change Value * Message Segment: Hashtag * Message Segment: Inline Image (version 35.0 and later) * Message Segment: Link * Message Segment: Markup Begin (version 35.0 and later) * Message Segment: Markup End (version 35.0 and later) * Message Segment: Mention * Message Segment: More Changes * Message Segment: Text The collection of message segments could contain message segment types introduced in later API versions. All message segment types are guaranteed to have text and type properties that are available in version 23.0 and later. If a client encounters an unknown message segment type, it can render the text value as a fallback. _Available in: v23.0_ _Filter group: Medium_ * `text` (_string_) Display-ready text of the message. Use this text if you don’t want to process the message segments. _Available in: v23.0_ _Filter group: Small_ ### ReputationLevel Reputation level for a user. * `levelImageUrl` (_string (url)_) URL to the reputation level image. _Available in: v32.0_ _Filter group: Small_ * `levelName` (_string_) Name of the reputation level. _Available in: v32.0_ _Filter group: Small_ * `levelNumber` (_integer_) Reputation level number, which is the numerical rank of the level, with the lowest level at 1. Administrators define the reputation level point ranges. _Available in: v32.0_ _Filter group: Small_ ### AbstractUserMissionActivity Abstract Representation used to represent user activity associated with mission * `activityCount` (_integer_) Number of mission activities of the specified type for the user. _Available in: v46.0_ _Filter group: Small_ * `activityType` (_string_) Type of mission activity for a user. Values are: * `FeedItemAnswerAQuestion` — User answered a question. * `FeedItemLikeSomething` — User liked a post or comment. * `FeedItemMarkAnswerAsBest` — User marked an answer as the best answer. * `FeedItemPostQuestion` — User posted a question. * `FeedItemReceiveAComment` — User received a comment on a post. * `FeedItemReceiveALike` — User received a like on a post or comment. * `FeedItemReceiveAnAnswer` — User received an answer to a question. * `FeedItemWriteAComment` — User commented on a post. * `FeedItemWriteAPost` — User made a post. * `FeedItemYourAnswerMarkedBest` — User’s answer was marked as the best answer. _Available in: v46.0_ _Filter group: Small_ ### AbstractFeedElement Since a Feed now contains more than Feed Items, let Feed Elements be the abstract object that all things in the Feed extend. Feed Items and Bundles are each Feed Elements. All Feed Elements have shared properties: id, feedElementType, body, and capabilities. Discriminator: `feedElementType` selects the concrete type. Mapping: `FeedItem` → `FeedItem`, `Bundle` → `FeedElement`, `Recommendation` → `FeedElement`. * `body` (_object_) FeedItemBody Information about the feed element. _Available in: v22.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v23.0_ _Filter group: Small_ * `feedElementType` (_object_) ConnectFeedElementTypeEnum Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: * `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v31.0_ Includes all fields of `ConnectFeedElementTypeEnum`. * `header` (_object_) FeedItemBody The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string (Id)_) 18-character ID of the feed item. _Available in: v23.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `parent` (_object_) AbstractIdable The parent of the feed element. _Available in: v28.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” . _Available in: v28.0_ _Filter group: Small_ * `url` (_string (url)_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ ### ArticleItem Article item in question and answer search results. * `id` (_string_) ID of the article. _Available in: v32.0_ _Filter group: Small_ * `rating` (_number (double)_) Rating of the article. _Available in: v32.0_ _Filter group: Small_ * `title` (_string_) Title of the article. _Available in: v32.0_ _Filter group: Small_ * `urlLink` (_string (url)_) Link URL to the article. _Available in: v32.0_ _Filter group: Small_ * `viewCount` (_integer_) Number of votes given to the article. _Available in: v32.0_ _Filter group: Small_ ### UserCapabilities User capabilities. * `canChat` (_boolean_) Specifies if the context user can use Chatter Messenger with the subject user ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `canDirectMessage` (_boolean_) Specifies if the context user can direct message the subject user ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `canEdit` (_boolean_) Specifies if the context user can edit the subject user’s account ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `canFollow` (_boolean_) Specifies if the context user can follow the subject user’s feed ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `canViewFeed` (_boolean_) Specifies if the context user can view the feed of the subject user ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `canViewFullProfile` (_boolean_) Specifies if the context user can view the full profile of the subject user ( `true` ) or only the limited profile ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `isModerator` (_boolean_) Specifies if the subject user is a Chatter moderator or admin ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ ### UserProfileTab User profile tab. * `id` (_string_) The tab’s unique identifier or 18–character Id _Available in: v29.0_ _Filter group: Small_ * `isDefault` (_boolean_) Specifies if the tab appears first when clicking the user profile ( `true` ) or not ( `false` ) _Available in: v29.0_ _Filter group: Small_ * `tabType` (_object_) ConnectUserProfileTabTypeEnum Specifies the type of user profile tab: * `CustomVisualForce` — Tab that displays data from a Visualforce page. * `CustomWeb` — Tab that displays data from any external web-based application or web page. * `Element` — Tab that displays generic content inline. * `Feed` — Tab that displays the Chatter feed. * `Overview` — Tab that displays user details. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectUserProfileTabTypeEnum`. * `tabUrl` (_string_) The current tab’s content URL (for non built-in tab types) _Available in: v29.0_ _Filter group: Small_ ### TopicsPeopleAreKnowledgeableAbout Represents a topic that a specified user is knowledgeable about. * `isEndorsedByMe` (_boolean_) Specifies if the knowledgeable user is endorsed for the topic by the context user, `true` if so, `false` otherwise _Available in: v30.0_ _Filter group: Small_ * `knowledgeableId` (_string_) ID of the knowledgeable record _Available in: v30.0_ _Filter group: Small_ * `numEndorsements` (_integer_) Number of endorsements received by the knowledgeable user for the topic _Available in: v30.0_ _Filter group: Medium_ * `reasons` (_array of ConnectKnowledgeableReasonEnum_) Reason why the user is considered knowledgeable about the topic. * `Influential` —User was mentioned in posts or in comments on posts with the topic or received likes on comments on posts with the topic. * `Endorsed` —User received endorsement from another user for the topic. _Available in: v30.0_ _Filter group: Medium_ * `topic` (_object_) Topic that the user is knowledgeable about _Available in: v30.0_ _Filter group: Small_ Includes all fields of `Topic`. ### ChatterRecommendation A Chatter, custom, or static recommendation. Includes all fields of `AbstractRecommendation`. * `actOnUrl` (_string_) For user, file, group, topic, and record `entity` types, use this Connect REST URL with a POST request to follow the recommended user, file, topic, or record, or join the recommended group. For example: /services/data/v /chatter/users/005D0000001AzOAIA0/following ?subjectId=005D0000001B4CvIAK For recommended object `entity` types, such as custom recommendations, use the `actionUrl` property of the Platform Action response body to take action on the recommendation. _Available in: v23.0_ _Filter group: Small_ * `action` (_string_) Specifies the action to take on the recommendation. Values are: * `follow` (V23.0) * `join` (V23.0) * `view` (V25.0) _Filter group: Small_ Allowed values: `follow`, `join`, `view`. * `entity` (_ArticleSummary | FileSummary | Group | RecommendedObject | RecordSummary | Topic | UserSummary_) The entity with which the receiver is recommended to take action. _Available in: v32.0_ _Filter group: Small_ One of: `ArticleSummary`, `FileSummary`, `Group`, `RecommendedObject`, `RecordSummary`, `Topic`, `UserSummary`. ### CustomListAudienceCriteriaInput Criteria for the custom list type of custom recommendation audience. * `type` (_object_, required) ConnectRecommendationAudienceCriteriaType Value must be `MaxDaysInCommunity` . _Available in: v36.0_ Includes all fields of `ConnectRecommendationAudienceCriteriaType`. * `criterion` (_array of AudienceCriterionValueInputRequest_) List of mappings of audience criteria fields and values. Required when creating an audience. Optional when updating an audience _Available in: v47.0_ * `criterionNumber` (_integer_) Number associated with the audience criterion in a formula. For example, (1 AND 2) OR 3. If unspecified, criteria are assigned numbers in the order that they’re added. _Available in: v47.0_ * `criterionOperator` (_string_) Operator used in the personalization audience criterion. Values are: * `Contains` * `Equal` * `GreaterThan` * `GreaterThanOrEqual` * `Includes` * `LessThan` * `LessThanOrEqual` * `NotEqual` * `NotIncludes` * `StartsWith` Required when creating an audience. Optional when updating an audience _Available in: v47.0_ * `criterionType` (_string_) Type of personalization audience criterion. Values are: * `Audience` —Criterion based on audience. * `Default` —Audience has no criteria. * `Domain` —Criterion based on domain. * `FieldBased` —Criterion based on object fields. * `GeoLocation` —Criterion based on location. * `Permission` —Criterion based on standard or custom permissions. * `Profile` —Criterion based on profile. Required when creating an audience. Optional when updating an audience _Available in: v47.0_ Allowed values: `Audience`, `Default`, `Domain`, `FieldBased`, `GeoLocation`, `Permission`, `Profile`. * `memberOperationType` (_object_) ConnectRecommendationAudienceMemberOperationType The operation to carry out on the audience members. Values are: * `Add` —Adds specified members to the audience. * `Remove` —Removes specified members from the audience. Required to update a recommendation audience. Don’t use or specify `null` to create a recommendation audience _Available in: v36.0_ Includes all fields of `ConnectRecommendationAudienceMemberOperationType`. * `members` (_object_) A collection of user IDs. When updating an audience, you can include up to 100 members. An audience can have up to 100,000 members, and each Experience Cloud site can have up to 100 audiences. Required to update a recommendation audience. Don’t use or specify `null` to create a recommendation audience _Available in: v36.0_ Includes all fields of `UserIdCollectionInput`. ### NewUserAudienceCriteriaInput Criteria for the new members type of custom recommendation audience. * `type` (_object_, required) ConnectRecommendationAudienceCriteriaType Value must be `MaxDaysInCommunity` . _Available in: v36.0_ Includes all fields of `ConnectRecommendationAudienceCriteriaType`. * `criterion` (_array of AudienceCriterionValueInputRequest_) List of mappings of audience criteria fields and values. Required when creating an audience. Optional when updating an audience _Available in: v47.0_ * `criterionNumber` (_integer_) Number associated with the audience criterion in a formula. For example, (1 AND 2) OR 3. If unspecified, criteria are assigned numbers in the order that they’re added. _Available in: v47.0_ * `criterionOperator` (_string_) Operator used in the personalization audience criterion. Values are: * `Contains` * `Equal` * `GreaterThan` * `GreaterThanOrEqual` * `Includes` * `LessThan` * `LessThanOrEqual` * `NotEqual` * `NotIncludes` * `StartsWith` Required when creating an audience. Optional when updating an audience _Available in: v47.0_ * `criterionType` (_string_) Type of personalization audience criterion. Values are: * `Audience` —Criterion based on audience. * `Default` —Audience has no criteria. * `Domain` —Criterion based on domain. * `FieldBased` —Criterion based on object fields. * `GeoLocation` —Criterion based on location. * `Permission` —Criterion based on standard or custom permissions. * `Profile` —Criterion based on profile. Required when creating an audience. Optional when updating an audience _Available in: v47.0_ Allowed values: `Audience`, `Default`, `Domain`, `FieldBased`, `GeoLocation`, `Permission`, `Profile`. * `value` (_number (double)_, required) The maximum number of days since a user became a site member. For example, if you specify 30, anyone who became a site member in the last 30 days is included in the new members audience. _Available in: v36.0_ ### UserIdCollectionInput A collection of user IDs. * `userIds` (_array of string_, required) A list of user IDs. _Available in: v35.0_ ### CustomListAudienceCriteria The criteria for the custom list type of recommendation audience. * `type` (_object_) ConnectRecommendationAudienceCriteriaType _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationAudienceCriteriaType`. * `memberCount` (_integer_) Total number of members in the custom recommendation audience. _Available in: v36.0_ _Filter group: Small_ * `members` (_object_) UserReferenceCollection Members of the custom recommendation audience. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `UserReferenceCollection`. ### NewUserAudienceCriteria The criteria for the new members type of recommendation audience. * `type` (_object_) ConnectRecommendationAudienceCriteriaType _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationAudienceCriteriaType`. * `maxDaysInCommunity` (_number (double)_) The maximum number of days since a user became a site member. _Available in: v36.0_ _Filter group: Small_ ### AbstractUser Basic details of a user in the organization. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `id` (_string (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `MotifSbi`. * `mySubscription` (_object_) If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ * `additionalLabel` (_string_) If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” _Available in: v30.0_ _Filter group: Small_ * `communityNickname` (_string_) User’s nickname in the site. _Available in: v32.0_ _Filter group: Medium_ * `companyName` (_string_) Name of the company. _Available in: v23.0_ _Filter group: Small_ * `displayName` (_string_) User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. _Available in: v32.0_ _Filter group: Small_ * `firstName` (_string_) User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `isInThisCommunity` (_boolean_) `true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.” _Available in: v28.0_ _Filter group: Small_ * `lastName` (_string_) User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `outOfOffice` (_object_) If one exists, extra out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `photo` (_object_) Information about the user's photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `reputation` (_object_) Reputation of the user in the Experience Cloud site, which is determined by the number of points earned from events and actions performed in the site. _Available in: v32.0_ _Filter group: Big_ Includes all fields of `Reputation`. * `title` (_string_) Title of the user. _Available in: v23.0_ _Filter group: Small_ * `userType` (_object_) ConnectUserTypeEnum Type of user. Valid values are: * `ChatterGuest` —User is an external user in a private group. * `ChatterOnly` —User is a Chatter Free customer. * `Guest` —User is unauthenticated. * `Internal` —User is a standard org member. * `Portal` —User is an external user in an Experience Cloud site. * `System` —User is Chatter Expert or a system user. * `Undefined` —User is a user type that is a custom object. _Available in: v26.0_ _Filter group: Medium_ Includes all fields of `ConnectUserTypeEnumSbi`. ### UserSummarySbi The User Summary response body is a subset of the User Detail response body. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `id` (_string (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `MotifSbi`. * `mySubscription` (_object_) If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ * `additionalLabel` (_string_) If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” _Available in: v30.0_ _Filter group: Small_ * `communityNickname` (_string_) User’s nickname in the site. _Available in: v32.0_ _Filter group: Medium_ * `companyName` (_string_) Name of the company. _Available in: v23.0_ _Filter group: Small_ * `displayName` (_string_) User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. _Available in: v32.0_ _Filter group: Small_ * `firstName` (_string_) User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `isInThisCommunity` (_boolean_) `true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.” _Available in: v28.0_ _Filter group: Small_ * `lastName` (_string_) User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `outOfOffice` (_object_) If one exists, extra out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `photo` (_object_) Information about the user's photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `reputation` (_object_) Reputation of the user in the Experience Cloud site, which is determined by the number of points earned from events and actions performed in the site. _Available in: v32.0_ _Filter group: Big_ Includes all fields of `Reputation`. * `title` (_string_) Title of the user. _Available in: v23.0_ _Filter group: Small_ * `userType` (_object_) ConnectUserTypeEnum Type of user. Valid values are: * `ChatterGuest` —User is an external user in a private group. * `ChatterOnly` —User is a Chatter Free customer. * `Guest` —User is unauthenticated. * `Internal` —User is a standard org member. * `Portal` —User is an external user in an Experience Cloud site. * `System` —User is Chatter Expert or a system user. * `Undefined` —User is a user type that is a custom object. _Available in: v26.0_ _Filter group: Medium_ Includes all fields of `ConnectUserTypeEnumSbi`. * `isActive` (_boolean_) `true` if user is active, `false` otherwise. _Available in: v25.0_ _Filter group: Small_ * `isChatterGuest` (_boolean_) `true` if user is a Chatter customer, `false` otherwise In version 26.0 and later, user the `userType` property. _Available in: v23.0–26.0_ * `stamps` (_array of Stamp_) Collection of the user’s stamps. In version 44.0 and later, use SOQL to get a user’s stamps. _Available in: v39.0–43.0_ _Filter group: Small_ ### ConnectTopicOptOutReasonEnum The reason the user is opting out of the topic. The only valid value is `topicInfluenceHide`. _Available in: v30.0_ _Filter group: Small_ Type: `string`. Allowed values: `topicInfluenceHide`. ### KnowledgeableUser A knowledgeable user. * `isEndorsedByMe` (_boolean_) Specifies if the knowledgeable user is endorsed for the topic by the context user, `true` if so, `false` otherwise. _Available in: v30.0_ _Filter group: Small_ * `knowledgeableId` (_string (Id)_) ID of the knowledgeable record. _Available in: v30.0_ _Filter group: Small_ * `numEndorsements` (_integer_) Number of endorsements received by the knowledgeable user for the topic. _Available in: v30.0_ _Filter group: Medium_ * `reasons` (_array of ConnectKnowledgeableReasonEnum_) Reason why the user is considered knowledgeable about the topic. Values are: * `Influential`—User was mentioned in posts or in comments on posts with the topic or received likes on comments on posts with the topic. * `Endorsed`—User received endorsement from another user for the topic. _Available in: v30.0_ _Filter group: Medium_ * `user` (_UserSummarySbi_) ### MessageSegmentInput Input description of a message segment. * `type` (_ConnectMessageSegmentTypeEnum_) ### AbstractActor Describing a person or thing that can act or be acted on in the organization. May or may not correspond to an actual record in the organization, as some actors, such as certain system users, are synthetic in nature. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ ### FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. If a capability value is null, that indicates that the capability can not exist on that feed element. If the capability exists but contains null values, then the feed element may have that capability's feature, but that it has not yet been applied. For example, a feed element with a null associated actions capability indicates that no actions may be added to that feed element, whereas an empty associated actions capability means that the feed element may have actions, but none have been provided. Note, that in REST, this output is treated in a special way: null values are not included in the output (effectively making this a traditional JSON map). * `approval` (_object_) ApprovalCapability If a feed element has this capability, it includes information about an approval. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ApprovalCapability`. * `associatedActions` (_object_) AssociatedActionsCapability If a feed element has this capability, it has platform actions associated with it. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `AssociatedActionsCapability`. * `banner` (_object_) BannerCapability If this feed element has this capability, it has a banner motif and style. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `BannerCapability`. * `bookmarks` (_object_) BookmarksCapability If a feed element has this capability, the context user can bookmark it. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `BookmarksCapability`. * `bundle` (_object_) AbstractBundleCapability If a feed element has this capability, the feed element may be a group of other feed elements condensed into one. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `AbstractBundleCapability`. * `callCollaboration` (_object_) CallCollaborationCapability If a feed element has this capability, it has a recording comment. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `CallCollaborationCapability`. * `canvas` (_object_) CanvasCapability If a feed element has this capability, it renders a canvas app. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `CanvasCapability`. * `caseComment` (_object_) CaseCommentCapability If a feed element has this capability, it has a case comment on the case feed. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `CaseCommentCapability`. * `chatterLikes` (_object_) ChatterLikesCapability If a feed element has this capability, the context user can like it. Exposes information about existing likes. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ChatterLikesCapability`. * `close` (_object_) CloseCapability If a feed element has this capability, users with permission can close it. _Available in: v43.0_ _Filter group: Small_ Includes all fields of `CloseCapability`. * `comments` (_object_) CommentsCapability If a feed element or comment has this capability, the context user can add a comment. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `CommentsCapability`. * `dashboardComponentSnapshot` (_object_) DashboardComponentSnapshotCapability If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `DashboardComponentSnapshotCapability`. * `directMessage` (_object_) DirectMessageCapability If a feed element has this capability, it’s a direct message. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `DirectMessageCapability`. * `edit` (_object_) EditCapability If a feed element has this capability, users who have permission can edit it. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `EditCapability`. * `emailMessage` (_object_) EmailMessageCapability If a feed element has this capability, it has an email message from a case. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `EmailMessageCapability`. * `enhancedLink` (_object_) EnhancedLinkCapability If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `EnhancedLinkCapability`. * `extensions` (_object_) ExtensionsCapability If a feed element has this capability, it has one or more extension attachments. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ExtensionsCapability`. * `feedEntityShare` (_object_) FeedEntityShareCapability If a feed element or comment has this capability, a feed entity is shared with it. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedEntityShareCapability`. * `files` (_object_) MultipleContentCapability If a feed element has this capability, it has one or more file attachments. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `MultipleContentCapability`. * `interactions` (_object_) InteractionsCapability If a feed element has this capability, it has information about user interactions. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `InteractionsCapability`. * `link` (_object_) LinkCapability If a feed element has this capability, it has a link. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LinkCapability`. * `mediaReferences` (_object_) MediaReferenceCapability If a feed element has this capability, it has one or more media references. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `MediaReferenceCapability`. * `moderation` (_object_) ModerationCapability If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ModerationCapability`. * `mute` (_object_) MuteCapability If a feed element has this capability, users can mute it. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `MuteCapability`. * `origin` (_object_) OriginCapability If a feed element has this capability, it was created by a feed action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `OriginCapability`. * `pin` (_object_) PinCapability If a feed element has this capability, users who have permission can pin it to a feed. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `PinCapability`. * `poll` (_object_) PollCapability If a feed element has this capability, the feed element can include a poll for voting. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `PollCapability`. * `questionAndAnswers` (_object_) QuestionAndAnswersCapability If a feed element has this capability, it has a question and comments on the feed element are answers to the question. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `QuestionAndAnswersCapability`. * `readBy` (_object_) ReadByCapability If a feed element has this capability, the context user can mark it as read. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ReadByCapability`. * `recommendations` (_object_) RecommendationsCapability If a feed element has this capability, it has a recommendation. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RecommendationsCapability`. * `recordSnapshot` (_object_) RecordSnapshotCapability If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RecordSnapshotCapability`. * `socialPost` (_object_) SocialPostCapability If a feed element has this capability, it can interact with a social post on a social network. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialPostCapability`. * `status` (_object_) StatusCapability If a feed post or comment has this capability, it has a status that determines its visibility. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `StatusCapability`. * `topics` (_object_) TopicsCapability If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `TopicsCapability`. * `trackedChanges` (_object_) TrackedChangesCapability If a feed element has this capability, it contains all changes to a record for a single tracked change event. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `TrackedChangesCapability`. * `upDownVote` (_object_) UpDownVoteCapability If a feed post or comment has this capability, users can upvote or downvote it. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UpDownVoteCapability`. ### ClientInfo Client information. * `applicationName` (_string_) Name of app used for authentication. _Available in: v23.0_ _Filter group: Small_ * `applicationUrl` (_string (url)_) URL to the app used for authentication _Available in: v23.0_ _Filter group: Small_ ### CommentPage A page of comments. * `comments` (_array of Comment_) Collection of comments. **Important**: Use the `items` property as of version 32.0. _Available in: v23.0–31.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) URL to the current page of comments, that is, the most recent comments. The default is 25 comments per page. _Available in: v23.0_ _Filter group: Medium_ * `items` (_array of Comment_) Collection of comments. _Available in: v32.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of comments, that is, older comments. The default is 25 comments per page. If you want to read more of the comments in search results, all the comments in the thread are refreshed, not just the ones that match the search term. Avoid using `nextPageUrl` until the comments are refreshed. _Available in: v23.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v44.0_ _Filter group: Small_ * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v44.0_ _Filter group: Small_ * `total` (_integer_) Total number of published comments across all pages for the parent feed item. _Available in: v23.0_ _Filter group: Small_ ### ConnectFeedElementTypeEnum The type of feed element this input represents. The only valid value is `FeedItem`. Required when creating a feed item (POST). Optional when updating a feed item (PATCH) _Available in: v31.0_ Type: `string`. Allowed values: `Bundle`, `FeedItem`, `Recommendation`. ### LikePage Page of Chatter likes. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) URL to the current page of likes. _Available in: v23.0_ _Filter group: Medium_ * `items` (_array of Like_) Collection of likes. _Available in: v32.0_ _Filter group: Small_ * `likes` (_array of Like_) Collection of likes. **Important**: As of API version 32.0, use the `items` property. _Available in: v23.0–31.0_ _Filter group: Small_ * `myLike` (_object_) ReferenceCore **Note**: This field is no longer available as of version 24.0. Either returns a reference to the specific like or returns `null`. _Available in: v23.0–24.0_ Includes all fields of `ReferenceCore`. * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of likes. _Available in: v23.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v37.0_ _Filter group: Medium_ * `previousPageUrl` (_string_) URL to the previous page of likes. _Available in: v23.0_ _Filter group: Medium_ * `total` (_integer_) Total number of likes for the item. _Available in: v23.0_ _Filter group: Small_ ### LikeMessageBody Chatter like message body. * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. Segments can be one or more of the following: * Message Segment: Entity Link * Message Segment: Resource Link * Message Segment: Text _Available in: v27.0_ _Filter group: Medium_ * `text` (_string_) Text summary of the users who like the feed item or comment. For example, “You like this.” or “Renee Moreau, Gordon Johnson, and Pam Jones like this.” _Available in: v27.0_ _Filter group: Small_ ### ModerationFlags Moderation flags. * `flagCount` (_integer_) If the context user is a community moderator, the total number of flags on the post, comment, or file. If the context user isn’t a community moderator, value is `null`. Flags on files is available starting in version 30.0. _Available in: v29.0_ _Filter group: Small_ * `flagCountByReason` (_object_) Number of moderation flags categorized by reason. Values for String are: * `FlaggedByRule` — Moderation rule flagged the item. * `FlaggedBySystem` — Einstein flagged the item. * `FlaggedByUserAsInappropriate` — User flagged the item as inappropriate. * `FlaggedByUserAsSpam` — User flagged the item as spam. _Available in: v40.0_ _Filter group: Small_ Additional properties: `integer`. * `flaggedByMe` (_boolean_) Indicates whether the post, comment, or file was flagged by the context user ( `true` ) or not ( `false` ). Flags on files is available starting in version 30.0. _Available in: v29.0_ _Filter group: Small_ * `flags` (_object_) ModerationFlagsCollection Collection of flags. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ModerationFlagsCollection`. ### AbstractIdable Describing a person or thing that can act or be acted on in the organization. Corresponds directly to an actual record in the organization with an addressible ID. * `id` (_string (Id)_) 18-character ID of the object _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The Connect REST API URL resource for this object. _Available in: v23.0_ _Filter group: Small_ ### FeedItemTopics Feed item topics. **Important**: This response body isn’t available in version 32.0 and later. In version 32.0 and later, Topics Capability is used. * `canAssignTopics` (_boolean_) `true` if a topic can be assigned to the feed item, `false` otherwise _Available in: v28.0–31.0_ _Filter group: Small_ * `topics` (_array of Topic_) Collection of topics _Available in: v28.0–31.0_ _Filter group: Small_ ### ConnectFeedItemTypeEnum Specifies the type of a feed item. Type: `string`. Allowed values: `ActivityEvent`, `AdvancedTextPost`, `AnnouncementPost`, `ApprovalPost`, `AttachArticleEvent`, `AttachExternalDocumentEvent`, `BasicTemplateFeedItem`, `CallLogPost`, `CanvasPost`, `CaseCommentPost`, `ChangeStatusPost`, `ChatTranscriptPost`, `CollaborationGroupCreated`, `CollaborationGroupUnarchived`, `ContentPost`, `CreateRecordEvent`, `DashboardComponentAlert`, `DashboardComponentSnapshot`, `EmailMessageEvent`, `FacebookPost`, `LinkPost`, `MilestoneEvent`, `PollPost`, `ProfileSkillPost`, `QuestionPost`, `ReplyPost`, `RypplePost`, `SocialPost`, `TestItem`, `TextPost`, `TrackedChange`, `UserStatus`. ### Emoji An emoji. * `category` (_string_) Emoji category. _Available in: v39.0_ _Filter group: Small_ * `shortcut` (_string_) Emoji shortcut. _Available in: v39.0_ _Filter group: Small_ * `unicodeCharacter` (_string_) Emoji’s unicode character. _Available in: v39.0_ _Filter group: Small_ ### LightningExtensionInformation Lightning extension information. * `compositionComponent` (_string_) Component to use in compose state. _Available in: v40.0_ _Filter group: Small_ * `extensionInformationType` (_object_) ConnectExtensionInformationType Value is `Lightning`. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectExtensionInformationType`. * `headerTextLabel` (_string_) Label for the extension’s header. _Available in: v40.0_ _Filter group: Small_ * `hoverTextLabel` (_string_) Label for hovering over the extension. _Available in: v40.0_ _Filter group: Small_ * `renderComponent` (_string_) Component to use in render or preview state. _Available in: v40.0_ _Filter group: Small_ ### EntityLabel An entity's label. * `label` (_string_) Localized singular label of the entity. _Available in: v40.0_ _Filter group: Small_ * `labelPlural` (_string_) Localized plural label of the entity. _Available in: v40.0_ _Filter group: Small_ ### ConnectGroupViralInvitationsStatusEnum Specifies the status of an invitation to join a group. Values are: * `ActedUponUser` — The user was added to the group. An email was sent asking the user to visit the group. * `Invited` — An email was sent asking the user to sign up for the org. * `MaxedOutUsers` — The group has the maximum allowed members. * `MultipleError` — The user wasn’t invited due to multiple errors. * `NoActionNeededUser` — The user is already a member of the group. * `NotVisibleToExternalInviter` — The user is not accessible to the user sending the invitation. * `Unhandled` — The user couldn’t be added to the group for an unknown reason. _Available in: v39.0_ _Filter group: Small_ Type: `string`. Allowed values: `ActedUponUser`, `Invited`, `MaxedOutUsers`, `MultipleError`, `NoActionNeededUser`, `NotVisibleToExternalInviter`, `Unhandled`. ### FilesConnectRepository Information about a Files Connect repository. * `authentication` (_object_) FilesConnectRepositoryAuthentication Repository authentication information. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepositoryAuthentication`. * `features` (_object_) FilesConnectRepositoryFeatures Repository features. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepositoryFeatures`. * `id` (_string_) 18-character ID of the external data source. _Available in: v32.0_ _Filter group: Small_ * `label` (_string_) Repository label. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `providerType` (_object_) FilesConnectProviderType Repository provider type. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectProviderType`. * `rootFolderItemsUrl` (_string (url)_) URL to the repository root folder items, or `null` if the repository does not support browsing. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Type of record, `ContentHubRepository`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string_) Connect REST API resource URL to the Files Connect repository. _Available in: v32.0_ _Filter group: Small_ ### ExternalFilePermissionInformation External file permissions information. * `externalFilePermissionTypes` (_array of FilesConnectPermissionType_) Available permission types for the parent folder of the external file, or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ * `externalFilePermissionsFailure` (_boolean_) `true` if the retrieval of external file information failed or if `includeExternalFilePermissionsInfo` is `false`; `false` otherwise. _Available in: v35.0_ _Filter group: Small_ * `externalFilePermissionsInfoFailureReason` (_string_) Explanation of the failure if a failure occurred and `includeExternalFilePermissionsInfo` is `true`; `null` otherwise. _Available in: v35.0_ _Filter group: Small_ * `externalFileSharingStatus` (_object_) ConnectExternalItemSharingTypeEnum Sharing status for the external file. Values are: * `DomainSharing` — File is shared with the domain. * `PrivateSharing` — File is private or shared only with individuals. * `PublicSharing` — File is publicly shared. Value is `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectExternalItemSharingTypeEnum`. * `repositoryPublicGroups` (_array of RepositoryGroupSummary_) Available public groups in the external repository or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ ### ConnectFilePublishStatusEnum Specifies the publish status of a file. Type: `string`. Allowed values: `PendingAccess`, `PrivateAccess`, `PublicAccess`. ### ConnectFileSharingOptionEnum Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v36.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Allowed`, `Restricted`. ### ConnectFileSharingPrivacyEnum Specifies the sharing privacy of a file. Type: `string`. Allowed values: `None`, `PrivateOnRecords`. ### ConnectFileSharingRoleEnum Sharing role of the file. One of these values: * `Admin` — Owner permission, but doesn’t own the file. * `Collaborator` — Viewer permission, and can edit, change permissions, and upload a new version of a file. * `Owner` — Collaborator permission, and can make a file private, and delete a file. * `Viewer` — Can view, download, and share a file. * `WorkspaceManaged` — Permission controlled by the library. _Available in: v29.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Admin`, `Collaborator`, `Owner`, `Viewer`, `WorkspaceManaged`. ### ConnectLinkMetadataSourceEnum Source of the link metadata. Values are: * `None` — Link metadata wasn’t retrieved. * `Sfdc` — Salesforce is the source. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `None`, `Sfdc`. ### ConnectLinkMetadataTypeEnum Type of link that the metadata represents. Values are: * `Error` — Link metadata couldn’t be retrieved. * `Link` — Represents a link. * `None` — Link metadata wasn’t retrieved because the link isn’t an allowed domain. * `Photo` — Represents a photo. * `Rich` — Represents rich content, typically HTML content. * `Unknown` — Link metadata was retrieved, but the type is unknown. * `Video` — Represents a video. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `Error`, `Link`, `None`, `Photo`, `Rich`, `Unknown`, `Video`. ### ConnectMentionValidationStatusEnum Type of validation error for a proposed mention, if any. One of these values: * `Disallowed` — The proposed mention is invalid and is rejected because the context user is trying to mention something that is not allowed. For example, a user who is not a member of a private group is trying to mention the private group. * `Inaccessible` — The proposed mention is allowed, but the user or record being mentioned isn’t notified. They don't have access to the parent record that’s being discussed. * `Ok` — There is no validation error for this proposed mention. _Available in: v29.0_ _Filter group: Small_ Type: `string`. Allowed values: `Disallowed`, `Inaccessible`, `Ok`. ### TopicImages Images associated with a topic. * `coverImageUrl` (_string (url)_) URL to a topic’s cover image, which appears on the topic page. Both topics and managed topics can have cover images. _Available in: v32.0_ _Filter group: Small_ * `featuredImageUrl` (_string (url)_) URL to a managed topic’s featured image, which appears wherever you feature it, for example, on your Experience Cloud site home page. _Available in: v32.0_ _Filter group: Small_ ### FeedBody Information about the feed item. * `isRichText` (_boolean_) Whether this is a rich text body. * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. The segment types you may encounter will depend on the body type. * `text` (_string_) Unformatted text of the message. This can be an easy summary to use if you don't want to process the message segments. ### MessageSegment Superclass of all message segment representations. * `text` (_string_) Empty string, `""`, for segments of this type. _Available in: v35.0_ _Filter group: Small_ * `type` (_ConnectMessageSegmentTypeEnum_) ### ConnectUserProfileTabTypeEnum Specifies the type of user profile tab: * `CustomVisualForce` — Tab that displays data from a Visualforce page. * `CustomWeb` — Tab that displays data from any external web-based application or web page. * `Element` — Tab that displays generic content inline. * `Feed` — Tab that displays the Chatter feed. * `Overview` — Tab that displays user details. _Available in: v29.0_ _Filter group: Small_ Type: `string`. Allowed values: `CustomVisualForce`, `CustomWeb`, `Element`, `Feed`, `Overview`. ### ConnectKnowledgeableReasonEnum Reason why the user is considered knowledgeable about the topic. One of these values: * `Endorsed`: User received endorsement from another user for the topic. * `Influential`: User was mentioned in posts or in comments on posts with the topic or received likes on comments on posts with the topic. Type: `string`. Allowed values: `Endorsed`, `Influential`. ### AbstractRecommendation Describing a single recommendation object. * `platformActionGroup` (_PlatformActionGroup_) A platform action group instance with state appropriate for the context user. _Available in: v34.0_ _Filter group: Small_ * `recommendationType` (_object_) ConnectRecommendationTypeEnum Specifies the type of record being recommended. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationTypeEnum`. * `url` (_string (url)_) URL to the recommendation. _Available in: v34.0_ _Filter group: Small_ * `explanation` (_object_) The recommendation explanation. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `RecExplanationSummary`. ### ArticleSummary A knowledge article summary. * `articleType` (_string_) Type of the knowledge article. _Available in: v37.0_ _Filter group: Small_ * `knowledgeArticleVersionId` (_string_) ID of the knowledge article version. _Available in: v39.0_ _Filter group: Small_ * `id` (_string_) 18-character ID of the knowledge article. _Available in: v37.0_ _Filter group: Small_ * `lastPublishedDate` (_string_) Last published date of the knowledge article. Format is ISO 8601. _Available in: v37.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating that the object is a knowledge article. The motif can also contain the object’s base color. The icon is not a preview of the article. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this article, it contains information about the subscription. Otherwise, it returns `null` . _Available in: v37.0_ _Filter group: Medium_ Includes all fields of `Reference`. * `name` (_string_) Name of the article. _Available in: v37.0_ _Filter group: Small_ * `rating` (_number (double)_) The rating of the article. _Available in: v37.0_ _Filter group: Small_ * `summary` (_string_) Summary of the knowledge article contents. _Available in: v37.0_ _Filter group: Small_ * `title` (_string_) Title of the knowledge article. _Available in: v37.0_ _Filter group: Small_ * `type` (_string_) Value is `KnowledgeArticle` . _Available in: v37.0_ _Filter group: Small_ * `url` (_string_) URL to the knowledge article. _Available in: v37.0_ _Filter group: Small_ * `urlName` (_string_) URL name of the knowledge article. _Available in: v37.0_ _Filter group: Small_ * `viewCount` (_integer_) Number of times the knowledge article has been viewed. _Available in: v38.0_ _Filter group: Small_ ### RecommendedObject A custom or static recommendation. * `idOrEnum` (_string_) ID of a recommendation definition for a custom recommendation or the enum value `Today` for static recommendations that don’t have an ID (version 35.0 and later). _Available in: v34.0_ _Filter group: Small_ * `motif` (_object_) Motif Motif of the recommended object. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `Motif`. * `name` (_string_) Name of the recommended object. _Available in: v22.0_ _Filter group: Small_ * `type` (_string_) `RecommendedObject` _Available in: v22.0_ _Filter group: Small_ ### ConnectRecommendationAudienceCriteriaType Custom recommendation audience criteria type. One of these values: * `CustomList`: A custom list of users makes up the audience. * `MaxDaysInCommunity`: New members make up the audience. Type: `string`. Allowed values: `CustomList`, `MaxDaysInCommunity`. ### AudienceCriterionValueInputRequest Audience criterion value. * `audienceId` (_string_) ID of an audience. Required if creating or updating an audience with the `Audience` criterion type. _Available in: v53.0_ * `city` (_string_) City of a user. Optional if creating or updating an audience with the `GeoLocation` criterion type _Available in: v48.0_ * `country` (_string_) Country of a user. Required if creating or updating an audience with the `GeoLocation` criterion type _Available in: v48.0_ * `domainId` (_string_) Domain ID of a user. Required if creating or updating an audience with the `Domain` criterion type _Available in: v48.0_ * `entityField` (_string_) Field of an object. Required if creating or updating an audience with the `FieldBased` criterion type _Available in: v48.0_ * `entityType` (_string_) Type of object. Required if creating or updating an audience with the `FieldBased` criterion type _Available in: v48.0_ * `fieldValue` (_string_) Value of a field. Required if creating or updating an audience with the `FieldBased` criterion type _Available in: v48.0_ * `isEnabled` (_boolean_) Specifies whether the permission is enabled (`true`) or not (`false`) for a user. Required if creating or updating an audience with the `Permission` criterion type _Available in: v48.0_ * `permission` (_string_) Valid API name of a standard user or custom permission. Required if creating or updating an audience with the `Permission` criterion type _Available in: v48.0_ * `profileId` (_string_) Profile ID of a user. Required if creating or updating an audience with the `Profile` criterion type _Available in: v48.0_ * `subdivision` (_string_) Subdivision of a user. Required if creating or updating an audience with the `GeoLocation` criterion type and using the `city` property _Available in: v48.0_ ### ConnectRecommendationAudienceMemberOperationType Operation to carry out on the custom recommendation audience members. One of these values: * `Add`: Adds specified members to the audience. * `Remove`: Removes specified members from the audience. Type: `string`. Allowed values: `Add`, `Remove`. ### MotifSbi The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color. The motif images are icons, not user uploaded images or photos. For example, every user has the same set of motif icons. Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style: `"motif": { "color": "8C004C", "largeIconUrl": "/img/icon/custom51_100/boat64.png", "mediumIconUrl": "/img/icon/custom51_100/boat32.png", "smallIconUrl": "/img/icon/custom51_100/boat16.png", "svgIconUrl": null },` Users use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png", "svgIconUrl": null },` Groups use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/groups64.png", "mediumIconUrl": "/img/icon/groups32.png", "smallIconUrl": "/img/icon/groups16.png" },` Files use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png", "svgIconUrl": null },` To view the icons in the previous examples, preface the URL with `https://{instance_name}`. For example, `https://{instance_name}/img/icon/profile64.png`. * `color` (_string_) A hex value representing the base color of the record type, or `null` . _Available in: v29.0_ _Filter group: Small_ * `largeIconUrl` (_string_) A large icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `mediumIconUrl` (_string_) A medium icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `smallIconUrl` (_string_) A small icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `svgIconUrl` (_string_) An icon in SVG format indicating the record type, or `null` if the icon doesn’t exist. _Available in: v34.0_ _Filter group: Small_ ### ConnectUserTypeEnumSbi Type of user. One of these values: * `ChatterGuest`: User is an external user in a private group. * `ChatterOnly`: User is a Chatter Free customer. * `Guest`: User is unauthenticated. * `Internal`: User is a standard org member. * `Portal`: User is an external user in an Experience Cloud site. * `System`: User is Chatter Expert or a system user. * `Undefined`: User is a user type that is a custom object. Type: `string`. Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`. ### ConnectMessageSegmentTypeEnum Feed items may have complex information within the post and is therefore broken into rich segments each containing complex information stored in the feed body. Specifies the type of segment and the additional information within. Type: `string`. Allowed values: `EntityLink`, `FieldChange`, `FieldChangeName`, `FieldChangeValue`, `Hashtag`, `InlineImage`, `Link`, `MarkupBegin`, `MarkupEnd`, `Mention`, `MoreChanges`, `ResourceLink`, `Text`. ### ApprovalCapability If a feed element has this capability, it includes information about an approval. * `id` (_string (Id)_) The work item ID. The work item ID is `null` if there isn’t a pending work item associated with the approval record. _Available in: v32.0_ _Filter group: Small_ * `postTemplateFields` (_array of ApprovalPostTemplateField_) The details of the approval post template field. _Available in: v32.0_ _Filter group: Small_ * `processInstanceStepId` (_string (Id)_) The process instance step ID. The associated record represents one step in an approval process. _Available in: v32.0_ _Filter group: Small_ * `status` (_object_) ConnectWorkflowProcessStatusEnum The status of the approval. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectWorkflowProcessStatusEnum`. ### AssociatedActionsCapability If a feed element has this capability, it has platform actions associated with it. * `platformActionGroups` (_array of PlatformActionGroup_) The platform action groups associated with a feed element. Platform action groups are returned in the order specified in the Associated Actions Capability Input request body. _Available in: v33.0_ _Filter group: Medium_ ### BannerCapability If this feed element has this capability, it has a banner motif and style. * `motif` (_object_) Motif A banner motif. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `Motif`. * `style` (_object_) ConnectBannerStyleEnum Decorates a feed item with a color and set of icons. * `Announcement` — An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBannerStyleEnum`. ### BookmarksCapability If a feed element has this capability, the context user can bookmark it. * `isBookmarkedByCurrentUser` (_boolean_) Indicates whether the feed element has been bookmarked by the context user (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ ### AbstractBundleCapability Existence of this capability on a Feed Element means the Feed Element may be a group of other Feed Elements condensed into one. The type of nesting depends on the bundle type. Discriminator: `bundleType` selects the concrete type. Mapping: `GenericBundle` → `GenericBundleCapability`, `TrackedChanges` → `TrackedChangeBundleCapability`. * `bundleType` (_object_) ConnectBundleTypeEnum Type of bundle. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBundleTypeEnum`. * `page` (_object_) FeedElementCollection A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementCollection`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.0_ _Filter group: Small_ ### CallCollaborationCapability If a feed element has this capability, it has a recording comment. * `commentEndTime` (_integer_) End time of the comment on the media player, in seconds. _Available in: v51.0_ _Filter group: Small_ * `commentStartTime` (_integer_) Start time of the comment on the media player, in seconds. _Available in: v51.0_ _Filter group: Small_ ### CanvasCapability If a feed element has this capability, it renders a canvas app. * `description` (_string_) A description of the canvas app. The maximum size is 255 characters. _Available in: v32.0_ _Filter group: Small_ * `developerName` (_string_) The API name (developer name) of the client app. _Available in: v32.0_ _Filter group: Small_ * `height` (_string_) The height of the canvas app in pixels. _Available in: v32.0_ _Filter group: Small_ * `icon` (_object_) Icon The icon for the canvas app. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Icon`. * `namespacePrefix` (_string_) A unique namespace prefix for the canvas app. _Available in: v32.0_ _Filter group: Small_ * `parameters` (_string_) JSON parameters passed to the canvas app. _Available in: v32.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) A thumbnail URL to a preview image. The maximum thumbnail size is 120 pixels by 120 pixels. _Available in: v32.0_ _Filter group: Small_ * `title` (_string_) A title for the canvas link. _Available in: v32.0_ _Filter group: Small_ ### CaseCommentCapability If a feed element has this capability, it has a case comment on the case feed. * `actorType` (_object_) ConnectCaseActorTypeEnum Specifies the type of user who made the comment. * `Customer` — if a Chatter customer made the comment * `CustomerService` — if a service representative made the comment _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectCaseActorTypeEnum`. * `createdBy` (_object_) UserDetail Information about the user who created the comment. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `UserDetail`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z. _Available in: v32.0_ _Filter group: Small_ * `eventType` (_object_) ConnectCaseCommentEventTypeEnum Specifies an event type for a comment in the case feed. * `NewInternal` — A case comment that has newly been marked Internal Only. * `NewPublished` — A newly published case comment. * `NewPublishedByCustomer` — A case comment by a customer that was newly published. * `PublishExisting` — An existing case comment that was republished. * `PublishExistingByCustomer` — An existing case comment by a customer that was republished. * `UnpublishExistingByCustomer` — An existing case comment by a customer that was unpublished. * `UnpublishExsiting` — An existing case comment that was unpublished. Unfortunately, this typo is in the code, not the documentation. Use this spelling in your code. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectCaseCommentEventTypeEnum`. * `id` (_string (Id)_) 18-character ID of case comment. _Available in: v32.0_ _Filter group: Small_ * `published` (_boolean_) Specifies whether the comment has been published. _Available in: v32.0_ _Filter group: Small_ * `text` (_string_) Text of the case comment. _Available in: v32.0_ _Filter group: Small_ ### ChatterLikesCapability If a feed element has this capability, the context user can like it. Exposes information about existing likes. * `isLikedByCurrentUser` (_boolean_) Indicates whether the feed element is liked by the context user (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `likesMessage` (_object_) LikeMessageBody A message body that describes who likes the feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LikeMessageBody`. * `myLike` (_object_) Reference If the context user has liked the feed element, this property is a reference to the specific like, `null` otherwise. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `page` (_object_) LikePage Likes information for this feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LikePage`. ### CloseCapability If a feed element has this capability, users with permission can close it. Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer. Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements. * `canContextUserUpdateIsClosed` (_boolean_) Specifies whether the context user has permission to set the feed element to closed (`true`) or not (`false`). _Available in: v43.0_ _Filter group: Small_ * `isClosed` (_boolean_) Specifies whether the feed element is closed (`true`) or not (`false`). _Available in: v43.0_ _Filter group: Small_ ### CommentsCapability If a feed element or comment has this capability, the context user can add a comment. * `page` (_object_) CommentPage The comments information for this feed element or comment. Threaded comments are supported in version 44.0 and later. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `CommentPage`. ### DashboardComponentSnapshotCapability If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time. * `dashboardComponentSnapshot` (_object_) DashboardComponentSnapshot The dashboard component snapshot. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `DashboardComponentSnapshot`. ### DirectMessageCapability If a feed element has this capability, it’s a direct message. * `memberChanges` (_object_) DirectMessageMembershipActivityCollection Member activities of the direct message, with the most recent activity first. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `DirectMessageMembershipActivityCollection`. * `members` (_object_) DirectMessageMemberCollection Members included in the direct message. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `DirectMessageMemberCollection`. * `originalMembers` (_object_) DirectMessageMemberCollection Original members of the direct message. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `DirectMessageMemberCollection`. * `subject` (_string_) Subject of the direct message. _Available in: v39.0_ _Filter group: Small_ ### EditCapability If a feed element or comment has this capability, it can be edited by users who have permission. * `isEditableByMeUrl` (_string (url)_) The URL to check if the context user is able to edit this feed element or comment. _Available in: v34.0_ _Filter group: Medium_ * `isEditRestricted` (_boolean_) Specifies whether editing this feed element or comment is restricted. If `true`, the context user can’t edit this feed element or comment. If `false`, the context user may or may not have permission to edit this feed element or comment. To determine if a feed element or comment is editable by the context user, use the Feed Elements, Editability or Comment Capability, Editability resource. _Available in: v34.0_ _Filter group: Small_ * `lastEditedBy` (_object_) UserDetail Who last edited this feed element or comment. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `UserDetail`. * `lastEditedDate` (_string (date-time)_) The most recent edit date of this feed element or comment. Format is ISO 8601. _Available in: v34.0_ _Filter group: Small_ * `latestRevision` (_integer_) The most recent revision of this feed element or comment. _Available in: v34.0_ _Filter group: Small_ * `relativeLastEditedDate` (_string_) Relative last edited date, for example, “2h ago.” _Available in: v34.0_ _Filter group: Small_ ### EmailMessageCapability If a feed element has this capability, it has an email message from a case. * `attachments` (_array of EmailAttachment_) Attachments in the email message. _Available in: v36.0_ _Filter group: Big_ * `automationType` (_object_) ConnectEmailMessageAutomationTypeEnum Automation type of the email message. Values are: * `aiAssisted` — The email message was created with the assistance of AI. * `aiAutomated` — The email message was created automatically by AI. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageAutomationTypeEnum`. * `bccAddresses` (_array of EmailAddress_) BCC addresses for the email message. _Available in: v36.0_ _Filter group: Small_ * `body` (_string_) Body of the email message. _Available in: v36.0_ _Filter group: Big_ * `ccAddresses` (_array of EmailAddress_) CC addresses for the email message. _Available in: v36.0_ _Filter group: Small_ * `direction` (_object_) ConnectEmailMessageDirectionEnum Direction of the email message. Values are: * `Inbound` — An inbound message (sent by a customer). * `Outbound` — An outbound message (sent to a customer by a support agent). _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageDirectionEnum`. * `emailMessageId` (_string_) ID of the email message. _Available in: v32.0_ _Filter group: Small_ * `emailMessageSize` (_string_) Size of a case’s email message HTML body. * `Large` — `UseLargeHtmlBody` permission is set, HTML body exceeds 131K characters, and HTML email display is enabled. * `Normal` — Email message doesn’t meet the `Large` criteria. _Available in: v66.0_ _Filter group: Small_ * `emailSize` (_object_) ConnectEmailMessageSizeEnum Size of a case’s email message HTML body. Values are: * `Large` — `UseLargeHtmlBody` permission is set, HTML body exceeds 131K characters, and HTML email display is enabled. * `Normal` — Email message doesn’t meet the `Large` criteria. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageSizeEnum`. * `fromAddress` (_object_) EmailAddress From address for the email message. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `EmailAddress`. * `htmlExpandEmailThread` (_integer_) Start location of previous email thread. _Available in: v47.0_ _Filter group: Small_ * `isRichText` (_boolean_) Indicates whether the body of the email message is in rich text format. _Available in: v36.0_ _Filter group: Small_ * `status` (_object_) ConnectEmailMessageStatusEnum Status of an email message on a case. _Available in: v47.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageStatusEnum`. * `subject` (_string_) Subject of the email message. _Available in: v32.0_ _Filter group: Small_ * `textBody` (_string_) Body of the email message. **Important**: In version 36.0 and later, use the `body` property. _Available in: v32.0–35.0_ _Filter group: Big_ * `toAddresses` (_array of EmailAddress_) To addresses of the email message. _Available in: v32.0_ _Filter group: Small_ * `totalAttachments` (_integer_) Total number of attachments in the email message. _Available in: v38.0_ _Filter group: Small_ ### EnhancedLinkCapability If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description. * `description` (_string_) A description with a 500 character limit. _Available in: v32.0_ _Filter group: Small_ * `icon` (_object_) Icon An icon. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Icon`. * `linkRecordId` (_string (Id)_) An ID associated with the link if the link URL refers to a Salesforce record. _Available in: v32.0_ _Filter group: Small_ * `linkUrl` (_string (url)_) A link URL to a detail page if available content can’t display inline. _Available in: v32.0_ _Filter group: Small_ * `title` (_string_) A title to a detail page. _Available in: v32.0_ _Filter group: Small_ ### ExtensionsCapability If a feed element has this capability, it has one or more extensions associated with it. * `items` (_array of Extension_) Collection of extensions. _Available in: v40.0_ _Filter group: Small_ ### FeedEntityShareCapability If a feed element or comment has this capability, a feed entity is shared with it. * `feedEntity` (_FeedItemSummary | FeedEntityNotAvailableSummary_) The summary of the feed entity that is shared with the feed element or comment. One of these response bodies: * Feed Item Summary * Feed Entity Not Available Summary _Available in: v39.0_ _Filter group: Small_ One of: `FeedItemSummary`, `FeedEntityNotAvailableSummary`. ### MultipleContentCapability If a feed element has this capability, it has one or more file attachments. * `items` (_array of Content_) Collection of files. _Available in: v36.0_ _Filter group: Small_ ### InteractionsCapability If a feed element has this capability, it has information about user interactions. * `count` (_integer (int64)_) The number of individual views, likes, and comments on a feed post. This count appears in the UI under the feed post as the number of views, for example, “5 views.” _Available in: v37.0_ _Filter group: Small_ ### LinkCapability If a feed element has this capability, it has a link. * `url` (_string (url)_) Link URL. The URL can be to an external site. _Available in: v32.0_ _Filter group: Small_ * `urlName` (_string_) Description of the link. _Available in: v32.0_ _Filter group: Small_ ### MediaReferenceCapability If a feed element has this capability, it has one or more media references. * `media` (_array of MediaReference_) Collection of media references. _Available in: v41.0_ _Filter group: Small_ ### ModerationCapability If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content. * `moderationFlags` (_object_) ModerationFlags Flags for this feed element. Moderators can view and take action on flagged items. _Available in: v31.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. ### MuteCapability If a feed element has this capability, users can mute it. Muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute. * `isMutedByMe` (_boolean_) Indicates whether the context user muted the feed element. _Available in: v35.0_ _Filter group: Small_ ### OriginCapability If a feed element has this capability, it was created by a feed action. * `actor` (_object_) UserSummary The user who executed the feed action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `originRecord` (_object_) Reference A reference to the feed element containing the feed action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ReferenceCore`. ### PinCapability If a feed element has this capability, users who have permission can pin it to a feed. * `isPinnableByMe` (_boolean_) Specifies whether the context user can pin or unpin the entity to the feed (`true`) or not (`false`). _Available in: v41.0_ _Filter group: Small_ * `isPinned` (_boolean_) Specifies whether the entity is pinned (`true`) or not pinned (`false`) to the feed. _Available in: v41.0_ _Filter group: Small_ ### PollCapability If a feed element has this capability, the feed element can include a poll for voting. * `choices` (_array of FeedPollChoice_) Collection of poll choices that make up the poll. _Available in: v32.0_ _Filter group: Small_ * `myChoiceId` (_string (Id)_) 18-character ID of the poll choice that the context user has voted for in this poll. Returns `null` if the context user has not voted. _Available in: v32.0_ _Filter group: Small_ * `totalVoteCount` (_string_) Total number of votes cast on the feed poll element. _Available in: v32.0_ _Filter group: Small_ ### QuestionAndAnswersCapability If a feed element has this capability, it has a question and comments on the feed element are answers to the question. * `bestAnswer` (_object_) Comment Comment selected as the best answer for the question. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Comment`. * `bestAnswerSelectedBy` (_object_) UserSummary User who selected the best answer for the question. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `canCurrentUserSelectOrRemoveBestAnswer` (_boolean_) Indicates whether the context user can select or remove a best answer (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `candidateAnswers` (_object_) CandidateAnswersStatus Status of candidate answers for the question. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `CandidateAnswersStatus`. * `escalatedCase` (_object_) Reference If a question post is escalated, this is the case to which it was escalated. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `questionTitle` (_string_) Title for the question. _Available in: v32.0_ _Filter group: Small_ ### ReadByCapability If a feed element has this capability, the context user can mark it as read. * `isReadByMe` (_boolean_) Specifies whether the feed element has been read (`true`) or not (`false`) by the context user. _Available in: v40.0_ _Filter group: Small_ * `lastReadDateByMe` (_string (date-time)_) Last date when the feed element was marked read for the context user in ISO 8601 format. Otherwise, `null`. _Available in: v40.0_ _Filter group: Small_ * `page` (_object_) ReadByCollection First page of information about who read the feed element and when. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `ReadByCollection`. ### RecommendationsCapability If a feed element has this capability, it has a recommendation. * `items` (_array of ChatterRecommendation_) A collection of recommendations. _Available in: v32.0_ _Filter group: Small_ ### RecordSnapshotCapability If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event. * `recordView` (_object_) RecordView A record representation that includes metadata and data so you can display the record easily. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RecordView`. ### SocialPostCapability If a feed element has this capability, it can interact with a social post on a social network. * `author` (_object_) SocialAccount Social account that authored the social post. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialAccount`. * `content` (_string_) Content body of the social post. _Available in: v36.0_ _Filter group: Medium_ * `deletedBy` (_object_) UserSummary User who deleted the social post. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `hiddenBy` (_object_) UserSummary User who hid the social post. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `icon` (_object_) Icon Icon of the social network. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `Icon`. * `id` (_string_) ID associated with the social post Salesforce record. _Available in: v36.0_ _Filter group: Small_ * `isOutbound` (_boolean_) If `true`, the social post originated from the Salesforce application. _Available in: v36.0_ _Filter group: Small_ * `likedBy` (_string_) External social account who liked the social post. _Available in: v40.0_ _Filter group: Small_ * `messageType` (_object_) ConnectSocialPostMessageTypeEnum Message type of the social post. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `ConnectSocialPostMessageTypeEnum`. * `name` (_string_) Title or heading of the social post. _Available in: v36.0_ _Filter group: Small_ * `postUrl` (_string (url)_) External URL to the social post on the social network. _Available in: v36.0_ _Filter group: Small_ * `provider` (_object_) ConnectSocialNetworkProviderEnum Social network that this social post belongs to. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectSocialNetworkProviderEnum`. * `recipient` (_object_) SocialAccount Social account that is the recipient of the social post. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialAccount`. * `recipientId` (_string_) ID of the recipient of the social post. _Available in: v38.0_ _Filter group: Small_ * `reviewScale` (_number (double)_) Review scale of the social post. _Available in: v40.0_ _Filter group: Small_ * `reviewScore` (_number (double)_) Review score of the social post. _Available in: v40.0_ _Filter group: Small_ * `status` (_object_) SocialPostStatus Status of the social post. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialPostStatus`. ### StatusCapability If a feed post or comment has this capability, it has a status that determines its visibility. * `feedEntityStatus` (_object_) ConnectFeedEntityStatusEnum Status of the feed post or comment. Values are: * `Draft` — The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts. * `Isolated` — The feed post or comment is isolated, and only admins can see it. * `PendingReview` — The feed post or comment isn’t approved yet and therefore isn’t published or visible. * `Published` — The feed post or comment is approved and visible. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `ConnectFeedEntityStatusEnum`. * `isApprovableByMe` (_boolean_) Specifies whether the context user can change the status of the feed post or comment. _Available in: v37.0_ _Filter group: Small_ ### TopicsCapability If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations. * `canAssignTopics` (_boolean_) `true` if a topic can be assigned to the feed element, `false` otherwise. _Available in: v32.0_ _Filter group: Small_ * `items` (_array of Topic_) A collection of topics associated with this feed element. _Available in: v32.0_ _Filter group: Small_ ### TrackedChangesCapability If a feed element has this capability, it contains all changes to a record for a single tracked change event. * `changes` (_array of FeedTrackedChange_) Collection of feed tracked changes. _Available in: v32.0_ _Filter group: Small_ ### UpDownVoteCapability If a feed post or comment has this capability, users can upvote or downvote it. * `downVoteCount` (_integer (int64)_) Number of downvotes. _Available in: v41.0_ _Filter group: Small_ * `myVote` (_object_) ConnectUpDownVoteValueEnum Specifies the context user’s vote. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `ConnectUpDownVoteValueEnum`. * `upVoteCount` (_integer (int64)_) Number of upvotes. _Available in: v41.0_ _Filter group: Small_ ### Comment A comment. * `body` (_object_) FeedItemBody Message body for the comment. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) CommentCapabilities Capabilities associated with the comment. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `CommentCapabilities`. * `clientInfo` (_object_) ClientInfo Information about the client app used to authenticate the connection. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ClientInfo`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `feedElement` (_object_) Reference Feed element on which the comment is posted. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `id` (_string (Id)_) 18-character ID of the comment. _Available in: v23.0_ _Filter group: Small_ * `isDeleteRestricted` (_boolean_) Returns `true` if the context user can’t delete the comment. If it returns `false`, possibly the context user can delete the comment. _Available in: v25.0_ _Filter group: Medium_ * `likes` (_object_) LikePage Page of likes associated with the comment. This property has no information for comments on direct messages. _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `LikePage`. * `likesMessage` (_object_) LikeMessageBody Message body that describes who likes the comment. This property is `null` for comments on direct messages. _Available in: v27.0_ _Filter group: Medium_ Includes all fields of `LikeMessageBody`. * `moderationFlags` (_object_) ModerationFlags Flags for this comment. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. Includes all fields of `ModerationFlags`. * `myLike` (_object_) Reference If the context user liked the comment, returns a reference to that like or returns `null`. This property is `null` for comments on direct messages. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `parent` (_object_) Reference Information about the parent of the feed-item associated with this comment. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ReferenceCore`. * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” _Available in: v28.0_ _Filter group: Medium_ * `threadLevel` (_integer_) Level of nesting for a comment. 0 indicates a standard comment with a parent post. 1 indicates a threaded comment with a parent comment and a parent post. 2 indicates a threaded comment with two parent comments and a parent post. The UI is limited to these three levels. _Available in: v44.0_ _Filter group: Small_ * `threadParentId` (_string (Id)_) ID of the parent comment for a threaded comment. _Available in: v44.0_ _Filter group: Small_ * `type` (_object_) ConnectCommentTypeEnum Indicates the type of comment. Valid values are: * `ContentComment` — the comment contains an attachment * `TextComment` — the comment contains only text _Available in: v24.0_ _Filter group: Small_ Includes all fields of `ConnectCommentTypeEnum`. * `url` (_string (url)_) URL to this comment. _Available in: v23.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the comment author. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `attachment` (_string_) If the comment does not contain an attachment or if the attachment, returns `null`. Otherwise, returns Feed Item Attachment: Content . **Important**: As of version 32.0, use the `capabilities` property. _Available in: v24.0–31.0_ _Filter group: Medium_ * `feedItem` (_object_) ReferenceCore Feed item on which the comment is posted. **Important**: As of version 32.0, use the `feedElement` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `isDeletable` (_boolean_) **Note**: This property is no longer available as of version 25.0. Use the `isDeleteRestricted` property instead. Specifies if the context user can delete the comment. _Available in: v23.0–24.0_ ### ModerationFlagsCollection Collection of flags on a feed item, comment, or file. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v40.0_ _Filter group: Small_ * `flags` (_array of ModerationFlagItem_) List of flag details. _Available in: v40.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `pageSize` (_integer_) Number of items per page. _Available in: v40.0_ _Filter group: Small_ ### ConnectExtensionInformationType Represents a type of information in Chatter Extension representation Type: `string`. Allowed values: `Lightning`. ### FilesConnectRepositoryAuthentication Authentication information for a repository. * `authFlowUrl` (_string_) Depends on the `authProtocol`. * `NoAuthentication` — `null`. * `Oauth` — URL to start the OAuth flow. * `Password` — URL to the authentication settings for external systems. _Available in: v40.0_ _Filter group: Small_ * `authProtocol` (_object_) ConnectContenHubAuthenticationProtocolEnum Authentication protocol used for the repository. Values are: * `NoAuthentication` — Repository doesn’t require authentication. * `Oauth` — Repository uses OAuth authentication protocol. * `Password` — Repository uses user name and password authentication protocol. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectContenHubAuthenticationProtocolEnum`. * `userHasAuthSettings` (_boolean_) Specifies whether the user has credentials or the administrator configured the external data source to use the same set of credentials for every user (`true`). Otherwise, `false`. _Available in: v40.0_ _Filter group: Small_ ### FilesConnectRepositoryFeatures Information about the features of a Files Connect repository. * `canBrowse` (_boolean_) Specifies whether the repository’s folder hierarchy can be browsed (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `canSearch` (_boolean_) Specifies whether the repository can be searched (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ ### FilesConnectProviderType Information about the Files Connect provider. * `label` (_string_) Localized label of the provider type. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Provider type. One of these values: * `ContentHubBox` * `ContentHubGDrive` * `ContentHubSharepoint` * `ContentHubSharepointOffice365` * `ContentHubSharepointOneDrive` * `SimpleUrl` _Available in: v32.0_ _Filter group: Small_ ### FilesConnectPermissionType A permission type. * `id` (_string_) The internal ID of the permission type in the repository. _Available in: v35.0_ _Filter group: Medium_ * `label` (_string_) The label as returned by the repository. _Available in: v35.0_ _Filter group: Medium_ ### ConnectExternalItemSharingTypeEnum Sharing status for the external file. Values are: * `DomainSharing` — File is shared with the domain. * `PrivateSharing` — File is private or shared only with individuals. * `PublicSharing` — File is publicly shared. Value is `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `DomainSharing`, `PrivateSharing`, `PublicSharing`. ### RepositoryGroupSummary Detailed description of a group entry. * `domain` (_string_) Domain of the group. _Available in: v35.0_ _Filter group: Medium_ * `email` (_string_) Email of the group. _Available in: v35.0_ _Filter group: Small_ * `groupType` (_object_) FilesConnectGroupTypeEnum Type of group. Values are: * `Everybody` — Group is public to everybody. * `EverybodyInDomain` — Group is public to everybody in the same domain. * `Unknown` — Group type is unknown. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectGroupTypeEnum`. * `id` (_string_) ID of the group. _Available in: v35.0_ _Filter group: Small_ * `name` (_string_) Name of the group. _Available in: v35.0_ _Filter group: Medium_ * `type` (_ConnectDirectoryEntryTypeEnum_) ### PlatformActionGroup A platform action group instance with state appropriate for the context user. Action link groups are one type of platform action group and are therefore represented as platform action group response bodies. * `category` (_object_) ConnectPlatformActionGroupCategoryEnum Indicates the priority and relative locations of platform actions. Values are: * `Primary` — The action link group is displayed in the body of the feed element. * `Overflow` — The action link group is displayed in the overflow menu of the feed element. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `ConnectPlatformActionGroupCategoryEnum`. * `id` (_string_) An 18-character ID or an opaque string ID for the platform action group. If the Platform Action `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v33.0_ _Filter group: Small_ * `platformActions` (_array of PlatformAction_) The platform action instances for this group. Within an action link group, action links are displayed in the order listed in the `actionLinks` property of the Action Link Group Definition Input request body. Within a feed item, action link groups are displayed in the order specified in the `actionLinkGroupIds` property of the Associated Actions Capability Input request body. _Available in: v33.0_ _Filter group: Medium_ * `url` (_string (url)_) Connect REST API resource URL for the platform action group. If the Platform Action `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ ### ConnectRecommendationTypeEnum Specifies the type of record that is the subject of a recommendation. Type: `string`. Allowed values: `apps`, `articles`, `custom`, `files`, `groups`, `records`, `topics`, `users`. ### RecExplanationSummary Explanation for a system-generated recommendations of Chatter actions for the logged-in user. * `detailsUrl` (_string (url)_) URL for explanation details. If the recommendation doesn’t have a detailed explanation, the string “null”. * `summary` (_string_) Explanation of recommendation. * `type` (_ConnectRecommendationExplanationEnum_) ### Reference Record field containing a reference to another object. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `reference` (_object_) ReferenceCore Object referenced by the record field. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### ApprovalPostTemplateField Description of an approval post template field. * `displayName` (_string_) The field name _Available in: v28.0_ _Filter group: Small_ * `displayValue` (_string_) The field value or `null` if the field is set to `null`. _Available in: v28.0_ _Filter group: Small_ * `record` (_object_) Reference A record ID If no record exists or if the reference is `null`, this value is `null`. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `ReferenceCore`. ### ConnectWorkflowProcessStatusEnum Status of the workflow associated with an approval post feed item attachment. Type: `string`. Allowed values: `Approved`, `Fault`, `Held`, `NoResponse`, `Pending`, `Reassigned`, `Rejected`, `Removed`, `Started`. ### ConnectBannerStyleEnum A Banner is used to decorate a Feed Element at presentation time and consists of a color and set of icons. Type: `string`. Allowed values: `Announcement`. ### ConnectBundleTypeEnum Defines a sub-type for the Bundle capability. Type: `string`. Allowed values: `GenericBundle`, `TrackedChanges`. ### FeedElementCollection Container of feed-elements URL and isModified resource URL for a feed. * `currentPageToken` (_string_) Page token to access the current page of feed elements. * `currentPageUrl` (_string (url)_) URL to the current page of feed elements. * `elements` (_array of AbstractFeedElement_) Collection of zero or more feed elements. * `isModifiedToken` (_string_) Since request parameter that can be used in an isModified request. * `isModifiedUrl` (_string (url)_) A News Feed Is-Modified resource with a since request parameter that contains an opaque token that describes when the feed was last modified. Returns null if feed is not a news feed. * `nextPageToken` (_string_) Page token to access the next page of feed elements. * `nextPageUrl` (_string (url)_) URL to the next page of feed elements. * `updatesToken` (_string_) Since request parameter that can be used in an updatedSince request. * `updatesUrl` (_string (url)_) A feed resource with the feed elements updated since the feed was refreshed. Null if not supported by this feed. ### Icon Icon. * `height` (_integer_) The height of the icon, in pixels _Available in: v27.0_ _Filter group: Small_ * `url` (_string (url)_) The URL of the icon. This URL is available to unauthenticated users. The URL doesn’t expire. _Available in: v27.0_ _Filter group: Small_ * `width` (_integer_) The width of the icon, in pixels _Available in: v27.0_ _Filter group: Small_ ### ConnectCaseActorTypeEnum Specifies the type of user who made a case comment. Type: `string`. Allowed values: `Customer`, `CustomerService`. ### ConnectCaseCommentEventTypeEnum Specifies the event type of a Case's case comment. Type: `string`. Allowed values: `NewInternal`, `NewPublished`, `NewPublishedByCustomer`, `PublishExisting`, `PublishExistingByCustomer`, `UnpublishExistingByCustomer`, `UnpublishExsiting`. ### DirectMessageMembershipActivityCollection A collection of direct message member activities. * `activities` (_array of DirectMessageMembershipActivity_) Collection of direct message member activities. _Available in: v40.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Medium_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v40.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ ### DirectMessageMemberCollection A collection of direct message members. * `currentPageToken` (_string_) Page token to access the current page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `nextPageToken` (_string_) Page token to access the next page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `users` (_array of UserSummary_) Collection of direct message members. _Available in: v39.0_ _Filter group: Small_ ### EmailAttachment An email attachment in an email message. * `attachment` (_object_) RecordSummary Record summary of the attachment. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `RecordSummary`. * `contentType` (_string_) Type of attachment. _Available in: v36.0_ _Filter group: Small_ * `fileName` (_string_) Name of the attachment. _Available in: v36.0_ _Filter group: Small_ ### ConnectEmailMessageAutomationTypeEnum If a feed element has this capability, it has an email message from a case. _Available in: v32.0_ _Filter group: Small_ Type: `string`. Allowed values: `AiAssisted`, `AiAutomated`. ### EmailAddress An email address for an email message sent from a case record in Case Feed. * `displayName` (_string_) Display name for an email address _Available in: v29.0_ _Filter group: Small_ * `emailAddress` (_string_) Email address _Available in: v29.0_ _Filter group: Small_ * `relatedRecord` (_object_) RecordSummary The summary of a related record, for example, a contact or user summary. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `RecordSummary`. ### ConnectEmailMessageDirectionEnum Specifies the direction of a Case's email message. Type: `string`. Allowed values: `Inbound`, `Outbound`. ### ConnectEmailMessageSizeEnum Specifies the size category of a Case's email message HTML body. Type: `string`. Allowed values: `Large`, `Normal`. ### ConnectEmailMessageStatusEnum Specifies the status of a Case's email message. Type: `string`. Allowed values: `DraftStatus`, `ForwardedStatus`, `NewStatus`, `ReadStatus`, `RepliedStatus`, `SentStatus`. ### Extension An extension. * `alternativeRepresentation` (_object_) Alternative Alternative representation of the extension. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `Alternative`. * `attachmentId` (_string_) Attachment ID of the extension. _Available in: v41.0_ _Filter group: Small_ * `extensionId` (_string_) ID of the extension. _Available in: v40.0_ _Filter group: Small_ * `payload` (_string_) Payload associated with the extension. _Available in: v40.0_ _Filter group: Small_ * `payloadVersion` (_string_) Payload version that identifies the structure of the payload associated with the extension. _Available in: v40.0_ _Filter group: Small_ ### FeedItemSummary Representation for a single feed item summary. * `actor` (_AbstractActor_) * `body` (_object_) FeedItemBody Information about the feed entity. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) FeedElementCapabilitySet The capabilities of the feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the entity was created. _Available in: v39.0_ _Filter group: Small_ * `feedElementType` (_ConnectFeedElementTypeEnum_) * `header` (_object_) MessageBody The header of the feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `MessageBody`. * `id` (_string (Id)_) 18-character ID of the feed entity. _Available in: v39.0_ _Filter group: Small_ * `isEntityAvailable` (_boolean_) Specifies whether the entity is available. If `false`, either the user doesn’t have access to the entity or the entity was deleted. _Available in: v39.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the feed item was last modified. _Available in: v39.0_ _Filter group: Small_ * `originalFeedItem` (_object_) Reference A reference to the original feed item, for a shared feed item. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `ReferenceCore`. * `originalFeedItemActor` (_object_) AbstractActor The actor of the original feed item, for a shared feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `AbstractActor`. * `parent` (_AbstractIdable_) * `photoUrl` (_string (url)_) URL of the photo associated with the feed item. _Available in: v39.0_ _Filter group: Medium_ * `relativeCreatedDate` (_string_) Relative created date, for example, “2h ago.” _Available in: v39.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the feed entity. _Available in: v39.0_ _Filter group: Small_ * `visibility` (_object_) ConnectFeedItemVisibilityEnum The visibility of the feed item. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `ConnectFeedItemVisibilityEnum`. ### FeedEntityNotAvailableSummary Representation when the feed entity is not available. The `isEntityAvailable` property is `false` and all other properties are null. * `actor` (_AbstractActor_) * `body` (_object_) FeedItemBody Information about the feed entity. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the entity was created. _Available in: v39.0_ _Filter group: Small_ * `feedElementType` (_ConnectFeedElementTypeEnum_) * `id` (_string (Id)_) 18-character ID of the feed entity. _Available in: v39.0_ _Filter group: Small_ * `isEntityAvailable` (_boolean_) The value is `false` because the user doesn’t have access to the entity or the entity was deleted. _Available in: v39.0_ _Filter group: Small_ * `parent` (_AbstractIdable_) * `relativeCreatedDate` (_string_) Relative created date, for example, “2h ago.” _Available in: v39.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the feed entity. _Available in: v39.0_ _Filter group: Small_ ### Content A file attached to a feed item. * `checksum` (_string_) MD5 checksum for the file. _Available in: v36.0_ _Filter group: Small_ * `contentHubRepository` (_object_) FilesConnectRepository External data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentUrl` (_string (url)_) URL of the content for links and Google docs. _Available in: v36.0_ _Filter group: Small_ * `description` (_string_) Description of the attachment. _Available in: v36.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the content. _Available in: v36.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) External URL this file points to, or `null` if it doesn’t point to an external file. _Available in: v36.0_ _Filter group: Small_ * `fileExtension` (_string_) Extension of the file. _Available in: v36.0_ _Filter group: Small_ * `fileSize` (_string_) Size of the file in bytes. If size can’t be determined, returns `unknown`. _Available in: v36.0_ _Filter group: Small_ * `fileType` (_string_) Type of file, such as PDF. _Available in: v36.0_ _Filter group: Small_ * `hasPdfPreview` (_boolean_) `true` if the file has a PDF preview available, `false` otherwise. _Available in: v36.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the content. _Available in: v36.0_ _Filter group: Small_ * `imageDetails` (_object_) ImageFileDetail Image details, or `null` if the file isn’t an image. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `ImageFileDetail`. * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync. Salesforce Files Sync was retired on May 25, 2018. _Available in: v36.0_ _Filter group: Small_ * `mimeType` (_string_) MIME type of the file. _Available in: v36.0_ _Filter group: Small_ * `renditionUrl` (_string (url)_) URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v36.0_ _Filter group: Small_ * `renditionUrl240By180` (_string (url)_) URL to the 240 x 180 pixel rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v36.0_ _Filter group: Small_ * `renditionUrl720By480` (_string (url)_) URL to the 720 x 480 pixel rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string (url)_) URL to the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v36.0_ _Filter group: Small_ * `sharingOption` (_object_) ConnectFileSharingOptionEnum Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v36.0_ _Filter group: Medium_ Includes all fields of `ConnectFileSharingOptionEnum`. * `textPreview` (_string_) Text preview of the file if available; `null` otherwise. _Available in: v36.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v36.0_ _Filter group: Medium_ * `thumb240By180RenditionStatus` (_string_) Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v36.0_ _Filter group: Medium_ * `thumb720By480RenditionStatus` (_string_) Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v36.0_ _Filter group: Medium_ * `title` (_string_) Title of the file. _Available in: v36.0_ _Filter group: Small_ * `versionId` (_string (Id)_) Version ID of the file. _Available in: v36.0_ _Filter group: Medium_ ### MediaReference A media reference. * `mediaUrl` (_string (url)_) URL to stream or download the media. _Available in: v41.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) If one exists, URL of the media’s thumbnail. _Available in: v41.0_ _Filter group: Small_ ### FeedPollChoice Feed poll choice. * `id` (_string (Id)_) 18-character ID of the poll choice _Available in: v26.0_ _Filter group: Small_ * `position` (_integer_) The location in the poll where this poll choice exists. The first poll choice starts at 1. _Available in: v26.0_ _Filter group: Small_ * `text` (_string_) Label text associated with the poll choice _Available in: v26.0_ _Filter group: Small_ * `voteCount` (_integer_) Total number of votes for this poll choice _Available in: v26.0_ _Filter group: Small_ * `voteCountRatio` (_number (double)_) The ratio of total number of votes for this poll choice to all votes cast in the poll. Multiply the ratio by 100 to get the percentage of votes cast for this poll choice. _Available in: v26.0_ _Filter group: Small_ ### CandidateAnswersStatus The status of candidate answers on a feed element. * `hasCandidateAnswers` (_boolean_) Indicates whether candidate answers are available for a question. _Available in: v41.0_ _Filter group: Small_ * `hasCandidateAnswersPublished` (_boolean_) Indicates whether any candidate answers are published. _Available in: v41.0_ _Filter group: Small_ * `hasCandidateAnswersRated` (_boolean_) Indicates whether any candidate answers are rated. _Available in: v41.0_ _Filter group: Small_ ### ReadByCollection A collection of information about who read the feed element and when. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Medium_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. The default is 25 items per page. _Available in: v40.0_ _Filter group: Medium_ * `items` (_array of ReadBy_) Collection of read-by information, including users and when they last read the feed element. _Available in: v40.0_ _Filter group: Big_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `previousPageToken` (_string_) Reserved for future use. _Available in: v40.0_ _Filter group: Medium_ * `previousPageUrl` (_string (url)_) Reserved for future use. _Available in: v40.0_ _Filter group: Medium_ * `total` (_integer_) Total number of users who read the feed element. This count appears in the UI under feed posts in private and unlisted Chatter groups as the “seen by” number, for example, “Seen by 48.” _Available in: v40.0_ _Filter group: Small_ ### RecordView A view of any record in the org, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, isn’t available for the record type. Contains data and metadata so you can render a record with one response. * `id` (_string_) 18-character ID of the object _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) ReferenceCore If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `name` (_string_) The localized name _Available in: v29.0_ _Filter group: Small_ * `relatedListDefinitions` (_array of ListViewDefinition_) Related list definitions (metadata) for this object. These list definitions don’t include the related list data. _Available in: v29.0_ _Filter group: Medium_ * `sections` (_array of RecordViewSection_) List of record view sections. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) The Connect REST API URL resource for this object. _Available in: v23.0_ _Filter group: Small_ ### SocialAccount A social account on a social network. * `externalSocialAccountId` (_string_) ID of the external social account, if available. _Available in: v38.0_ _Filter group: Small_ * `handle` (_string_) Social handle, screen name, or alias that identifies this account. _Available in: v36.0_ _Filter group: Small_ * `name` (_string_) Name of the account as defined by the account's owner. _Available in: v36.0_ _Filter group: Small_ * `profileUrl` (_string (url)_) URL to the account's profile. _Available in: v36.0_ _Filter group: Small_ * `socialPersonaId` (_string_) ID of the social persona account, if the external social account ID isn’t available. _Available in: v39.0_ _Filter group: Small_ ### ConnectSocialPostMessageTypeEnum The message type of a social post. Type: `string`. Allowed values: `Comment`, `Direct`, `Post`, `PrivateMessage`, `Reply`, `Retweet`, `Tweet`. ### ConnectSocialNetworkProviderEnum The social network provider. Type: `string`. Allowed values: `Facebook`, `GooglePlus`, `Instagram`, `InstagramBusiness`, `KakaoTalk`, `Kik`, `Line`, `LinkedIn`, `Messenger`, `Other`, `Pinterest`, `QQ`, `Rypple`, `SMS`, `SinaWeibo`, `Snapchat`, `Telegram`, `Twitter`, `VKontakte`, `WeChat`, `WhatsApp`, `YouTube`. ### SocialPostStatus The status of a social post. * `message` (_string_) Status message. _Available in: v36.0_ _Filter group: Small_ * `type` (_object_) ConnectSocialPostStatusTypeEnum Status type. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectSocialPostStatusTypeEnum`. ### ConnectFeedEntityStatusEnum Describes the status of a feed item Type: `string`. Allowed values: `Draft`, `Isolated`, `PendingReview`, `Published`. ### FeedTrackedChange Feed tracked change. * `fieldName` (_string_) The name of the field that was updated. _Available in: v29.0_ _Filter group: Small_ * `newValue` (_string_) The new value of the field or `null` if the field length is long or empty. _Available in: v29.0_ _Filter group: Small_ * `oldValue` (_string_) The old value of the field or `null` if the field length is long or empty. _Available in: v29.0_ _Filter group: Small_ ### ConnectUpDownVoteValueEnum Type of vote for a feed element or comment. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `Down`, `None`, `Up`. ### CommentCapabilities A container for all capabilities that can be included with a comment. * `comments` (_object_) CommentsCapability If a comment has this capability, it has threaded comments. _Available in: v44.0_ _Filter group: Small_ Includes all fields of `CommentsCapability`. * `content` (_object_) ContentCapability Content, such as a file attachment, associated with this comment. Most Content Capability properties are null if the content has been deleted from the feed element or if the access has changed to private. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ContentCapability`. * `edit` (_object_) EditCapability If a comment has this capability, users who have permission can edit it. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `EditCapability`. * `feedEntityShare` (_object_) FeedEntityShareCapability If a comment has this capability, a feed entity is shared with it. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `FeedEntityShareCapability`. * `record` (_object_) RecordCapability If a comment has this capability, it has a record attachment. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `RecordCapability`. * `status` (_object_) StatusCapability If a comment has this capability, it has a status that determines its visibility. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `StatusCapability`. * `upDownVote` (_object_) UpDownVoteCapability If a comment has this capability, users can upvote or downvote it. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UpDownVoteCapability`. * `verified` (_object_) VerifiedCapability If a comment has this capability, users with permission can mark it as verified or unverified. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `VerifiedCapability`. ### ConnectCommentTypeEnum Indicates the type of comment. Valid values are: * `ContentComment` — the comment contains an attachment * `TextComment` — the comment contains only text _Available in: v24.0_ _Filter group: Small_ Type: `string`. Allowed values: `ContentComment`, `TextComment`. ### ModerationFlagItem Flag details on a feed item, comment, or file. * `createdBy` (_string_) ID of the user who flagged the item. _Available in: v40.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the item was flagged. Format is ISO 8601. _Available in: v40.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the moderation flag. _Available in: v40.0_ _Filter group: Small_ * `moderationType` (_object_) ConnectNetworkModerationTypeEnum Type of moderation flag. Values are: * `FlagAsInappropriate` — Flag for inappropriate content. * `FlagAsSpam` — Flag for spam. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectNetworkModerationTypeEnum`. * `note` (_string_) Note from user who flagged the item. _Available in: v40.0_ _Filter group: Small_ * `visibility` (_object_) ConnectNetworkModerationVisibilityEnum Visibility behavior of a flag for various user types. Values are: * `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item. * `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectNetworkModerationVisibilityEnum`. ### ConnectContenHubAuthenticationProtocolEnum Authentication protocol used for the repository. Values are: * `NoAuthentication` — Repository doesn’t require authentication. * `Oauth` — Repository uses OAuth authentication protocol. * `Password` — Repository uses user name and password authentication protocol. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `NoAuthentication`, `Oauth`, `Password`. ### FilesConnectGroupTypeEnum The detailed information of a directory entry. _Available in: v35.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Everybody`, `EverybodyInDomain`, `Unknown`. ### ConnectDirectoryEntryTypeEnum Specifies the type of directory entry. Type: `string`. Allowed values: `GroupEntry`, `UserEntry`. ### ConnectPlatformActionGroupCategoryEnum Indicates the priority and relative locations of platform actions. Values are: * `Primary` — The action link group is displayed in the body of the feed element. * `Overflow` — The action link group is displayed in the overflow menu of the feed element. _Available in: v33.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Overflow`, `Primary`. ### PlatformAction A platform action instance with state information for the context user. Action links are one type of platform action and are therefore represented as platform action response bodies. * `actionUrl` (_string (url)_) For action links of `subtype` `Ui` or `Download`, direct the user to download or visit the UI from this link. Salesforce issues a Javascript redirect for the link in this format: `/action-link-redirect/{communityId}/{actionLinkId}?_bearer={bearerToken}`. For `Api` and `ApiAsync` action links and for all platform actions, this value is `null`. Salesforce handles the callout to `Api` or and `ApiAsync` action links. To call an `Api` or an `ApiAsync` action link, you can also make a PATCH request to the /connect/action-links/actionLinkId resource and set `status` to `PendingStatus`. _Available in: v33.0_ _Filter group: Medium_ * `apiName` (_string_) The API name. This value may be `null`. _Available in: v33.0_ _Filter group: Medium_ * `confirmationMessage` (_string_) If this action requires a confirmation and has a status of `NewStatus`, this is a default localized message that should be shown to an end user prior to invoking the action. Otherwise, this is `null`. _Available in: v33.0_ _Filter group: Medium_ * `createdRecords` (_array of RecordSummary_) The collection of records that this action created after it was invoked by the context user. This collection is empty if the action hasn’t been performed yet by the context user or if the action doesn’t create a record. Only records created by the context user are shown. _Available in: v33.0_ _Filter group: Medium_ * `executingUser` (_object_) UserSummary User who initiated execution of the platform action. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `UserSummary`. * `groupDefault` (_boolean_) `true` if this platform action is the default or primary platform action in the platform action group; `false` otherwise. There can be only one default platform action per platform action group. _Available in: v33.0_ _Filter group: Small_ * `iconUrl` (_string (url)_) The URL of the icon for the platform action. This value may be `null`. _Available in: v33.0_ _Filter group: Medium_ * `id` (_string_) The ID of the platform action. If the `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ * `label` (_string_) The localized label for this platform action. _Available in: v33.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v33.0_ _Filter group: Small_ * `platformActionGroup` (_object_) Reference A reference to the platform action group containing this platform action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ReferenceCore`. * `status` (_object_) ConnectPlatformActionStatusEnum The execution status of the platform action. Values are: * `FailedStatus` — The action link execution failed. * `NewStatus` — The action link is ready to be executed. Available for `Download` and `Ui` action links only. * `PendingStatus` — The action link is executing. Choosing this value triggers the API call for `Api` and `ApiAsync` action links. * `SuccessfulStatus` — The action link executed successfully. For action links only, you can update the `status` by making a PATCH request to the `/connect/action-links/{actionLinkId}` resource. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ConnectPlatformActionStatusEnum`. * `subtype` (_string_) The subtype of a platform action or `null`. If the `type` property is `ActionLink`, possible values are: * `Api` — The action link calls a synchronous API at the action URL. Salesforce sets the status to `SuccessfulStatus` or `FailedStatus` based on the HTTP status code returned by your server. * `ApiAsync` — The action link calls an asynchronous API at the action URL. The action remains in a `PendingStatus` state until a third party makes a request to `/connect/action-links/{actionLinkId}` to set the status to `SuccessfulStatus` or `FailedStatus` when the asynchronous operation is complete. * `Download` — The action link downloads a file from the action URL. * `Ui` — The action link takes the user to a web page at the action URL. _Available in: v33.0_ _Filter group: Small_ * `type` (_object_) ConnectPlatformActionTypeEnum The type of platform action. Values are: * `ActionLink` — An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce UI. * `CustomButton` — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript. * `ProductivityAction` — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions. * `QuickAction` — A global or object-specific action. * `StandardButton` — A predefined Salesforce button such as New, Edit, or Delete. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ConnectPlatformActionTypeEnum`. * `url` (_string (url)_) Connect REST API resource URL for the platform action. If the `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ ### ConnectRecommendationExplanationEnum Indicates the reason-type for a suggested recommendation. Type: `string`. Allowed values: `ArticleHasRelatedContent`, `ArticleViewedTogether`, `ArticleViewedTogetherWithViewers`, `Custom`, `FilePopular`, `FileViewedTogether`, `FollowedTogetherWithFollowees`, `GroupMembersFollowed`, `GroupNew`, `GroupPopular`, `ItemViewedTogether`, `PopularApp`, `RecordOwned`, `RecordParentOfFollowed`, `RecordViewed`, `TopicFollowedTogether`, `TopicFollowedTogetherWithFollowees`, `TopicPopularFollowed`, `TopicPopularLiked`, `UserDirectReport`, `UserFollowedTogether`, `UserFollowsSameUsers`, `UserManager`, `UserNew`, `UserPeer`, `UserPopular`, `UserViewingSameRecords`. ### DirectMessageMembershipActivity Direct message membership activity. * `activityDate` (_string (date-time)_) Direct message member activity date. Format is ISO 8601. _Available in: v40.0_ _Filter group: Small_ * `actor` (_object_) UserSummary User who changed the direct message membership. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `membersAdded` (_object_) DirectMessageMemberCollection Members added to the direct message as part of the activity. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `DirectMessageMemberCollection`. * `membersRemoved` (_object_) DirectMessageMemberCollection Members removed from the direct message as part of the activity. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `DirectMessageMemberCollection`. ### Alternative Alternative representation for an extension on a feed element. * `textRepresentation` (_string_) Text representation of the extension. _Available in: v40.0_ _Filter group: Small_ * `thumbnailUrl` (_string_) Thumbnail URL to the extension. _Available in: v40.0_ _Filter group: Small_ * `title` (_string_) Title of the extension. _Available in: v40.0_ _Filter group: Small_ ### MessageBody Representation for a structured text item. * `isRichText` (_boolean_) Whether this is a rich text body. * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. The segment types you may encounter will depend on the body type. * `text` (_string_) Unformatted text of the message. This can be an easy summary to use if you don't want to process the message segments. ### ImageFileDetail Image file details. * `height` (_integer_) Image’s height in pixels. _Available in: v39.0_ _Filter group: Small_ * `imageFormat` (_string_) Image’s format. _Available in: v39.0_ _Filter group: Small_ * `orientation` (_string_) Image’s EXIF orientation value, if present. _Available in: v39.0_ _Filter group: Small_ * `width` (_integer_) Image’s width in pixels. _Available in: v39.0_ _Filter group: Small_ ### ReadBy Information about who read the feed element and when. * `lastReadDateByUser` (_string (date-time)_) When the user last read the feed element in ISO 8601 format. _Available in: v40.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the user who read the feed element. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `UserSummary`. ### ListViewDefinition Related list structure or a search list structure on a record view. There’s no data in the list. * `columns` (_array of ListViewColumn_) The columns of fields shown in this list view. _Available in: v29.0_ _Filter group: Big_ * `label` (_string_) The localized label of this list view. _Available in: v29.0_ _Filter group: Small_ * `objectType` (_object_) ListViewObject The definition of the type of the objects in this list view. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ListViewObject`. * `rowLimit` (_integer_) The maximum number of objects per page in this list view. To view all objects in this related list, page through the data in pages no larger than this size. To build a SOQL statement from this describe, the SOQL statement must include a LIMIT value equal to this value or an error is thrown on execution. _Available in: v29.0_ _Filter group: Medium_ * `sortColumns` (_array of ListViewSort_) The columns in which to sort this list view. The sort columns are given in the order of their priority (for example, primary sort, secondary sort, and so on). _Available in: v29.0_ _Filter group: Medium_ ### RecordViewSection Section of record fields and values on a record detail. * `columnCount` (_integer_) Number of columns to use to lay out the fields in a record section. _Available in: v29.0_ _Filter group: Small_ * `columnOrder` (_string_) Order of the fields to use in the `fields` property to lay out the fields in a record section. * `LeftRight` — Fields are rendered from left to right. * `TopDown` — Fields are rendered from the top down. _Available in: v29.0_ _Filter group: Small_ * `fields` (_array of RecordField | Blank | Compound | Currency | Date | Percent | Picklist | Reference | ReferenceWithDate_) Fields and values for the record contained in this section. A collection of these response bodies: * Record Field * Record Field: Blank * Record Field: Compound * Record Field: Currency * Record Field: Date * Record Field: Percent * Record Field: Picklist * Record Field: Reference * Record Field: Reference with Date _Available in: v29.0_ _Filter group: Small_ * `heading` (_string_) Localized label to display when rendering this section of fields. _Available in: v29.0_ _Filter group: Small_ * `isCollapsible` (_boolean_) Indicates whether the section can be collapsed to hide all the fields (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Small_ ### ConnectSocialPostStatusTypeEnum Status type. _Available in: v36.0_ _Filter group: Small_ Type: `string`. Allowed values: `ApprovalPending`, `ApprovalRecalled`, `ApprovalRejected`, `Deleted`, `Failed`, `Hidden`, `Pending`, `Replied`, `Sent`, `Unknown`. ### ContentCapability If a comment has this capability, it has a file attachment. For files attached to a feed post (instead of a comment) in version 36.0 and later, use Files Capability. If content is deleted from a feed element after it’s posted or if the access to the content is changed to private, the Content Capability exists, however most of its properties are null. * `checksum` (_string_) MD5 checksum for the file. _Available in: v32.0_ _Filter group: Small_ * `contentHubRepository` (_object_) FilesConnectRepository The external data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentUrl` (_string (url)_) URL of the content for links and Google docs. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Description of the attachment. _Available in: v32.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the content. _Available in: v32.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) The external URL this file points to, or `null` if it does not point to an external file. _Available in: v32.0_ _Filter group: Small_ * `fileExtension` (_string_) Extension of the file. _Available in: v32.0_ _Filter group: Small_ * `fileSize` (_string_) Size of the file in bytes. If size cannot be determined, returns `Unknown`. _Available in: v32.0_ _Filter group: Small_ * `fileType` (_string_) Type of file. _Available in: v32.0_ _Filter group: Small_ * `hasPdfPreview` (_boolean_) `true` if the file has a PDF preview available, `false` otherwise. _Available in: v32.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the content. _Available in: v32.0_ _Filter group: Small_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v32.0_ _Filter group: Small_ * `mimeType` (_string_) MIME type of the file. _Available in: v32.0_ _Filter group: Small_ * `renditionUrl` (_string (url)_) URL to the rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded. _Available in: v32.0_ _Filter group: Small_ * `renditionUrl240By180` (_string (url)_) URL to the 240x180 size rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded. _Available in: v32.0_ _Filter group: Small_ * `renditionUrl720By480` (_string (url)_) URL to the 720x480 size rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded. _Available in: v32.0_ _Filter group: Small_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string (url)_) The URL of the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `sharingOption` (_object_) ConnectFileSharingOptionEnum Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `ConnectFileSharingOptionEnum`. * `textPreview` (_string_) Text preview of the file if available, `null` otherwise. The maximum number of characters is 200. _Available in: v32.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) The status of the rendering of the 120x90 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable. _Available in: v32.0_ _Filter group: Medium_ * `thumb240By180RenditionStatus` (_string_) The status of the rendering of the 240x180 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable. _Available in: v32.0_ _Filter group: Medium_ * `thumb720By480RenditionStatus` (_string_) The status of the rendering of the 720x480 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable. _Available in: v32.0_ _Filter group: Medium_ * `title` (_string_) Title of the file. _Available in: v32.0_ _Filter group: Small_ * `versionId` (_string (Id)_) Version ID of the file. _Available in: v32.0_ _Filter group: Medium_ ### RecordCapability If a comment has this capability, it has a record attachment. * `recordId` (_string_) ID of the record. _Available in: v42.0_ _Filter group: Small_ * `url` (_string_) URL to the record. _Available in: v42.0_ _Filter group: Small_ ### VerifiedCapability If a comment has this capability, users with permission can mark it as verified or unverified. * `isVerifiableByMe` (_boolean_) Specifies whether the context user has permission to mark comments as verified or unverified (`true`) or not (`false`). _Available in: v41.0_ _Filter group: Small_ * `isVerified` (_boolean_) Specifies whether the comment is marked as verified (`true`) or not (`false`). _Available in: v41.0_ _Filter group: Small_ * `isVerifiedByAnonymized` (_boolean_) Specifies whether the comment is marked as verified by an anonymous user (`true`) or not (`false`). If the comment has never been marked as verified or unverified, `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified. _Available in: v43.0_ _Filter group: Small_ * `lastVerifiedByUser` (_object_) UserSummary User who last marked the comment as verified or unverified, otherwise `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `lastVerifiedDate` (_string (date-time)_) ISO 8601 date string. Date when the comment was last marked as verified or unverified, otherwise `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified. _Available in: v41.0_ _Filter group: Small_ ### ConnectNetworkModerationTypeEnum Type of moderation flag. Values are: * `FlagAsInappropriate` — Flag for inappropriate content. * `FlagAsSpam` — Flag for spam. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `FlagAsInappropriate`, `FlagAsSpam`. ### ConnectNetworkModerationVisibilityEnum Visibility behavior of a flag for various user types. Values are: * `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item. * `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `ModeratorsOnly`, `SelfAndModerators`. ### ConnectPlatformActionStatusEnum The execution status of the platform action. Values are: * `FailedStatus` — The action link execution failed. * `NewStatus` — The action link is ready to be executed. Available for `Download` and `Ui` action links only. * `PendingStatus` — The action link is executing. Choosing this value triggers the API call for `Api` and `ApiAsync` action links. * `SuccessfulStatus` — The action link executed successfully. For action links only, you can update the `status` by making a PATCH request to the `/connect/action-links/{actionLinkId}` resource. _Available in: v33.0_ _Filter group: Small_ Type: `string`. Allowed values: `FailedStatus`, `NewStatus`, `PendingStatus`, `SuccessfulStatus`. ### ConnectPlatformActionTypeEnum The type of platform action. Values are: * `ActionLink` — An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce UI. * `CustomButton` — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript. * `ProductivityAction` — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions. * `QuickAction` — A global or object-specific action. * `StandardButton` — A predefined Salesforce button such as New, Edit, or Delete. _Available in: v33.0_ _Filter group: Small_ Type: `string`. Allowed values: `ActionLink`, `CustomButton`, `ProductivityAction`, `QuickAction`, `StandardButton`. ### ListViewColumn Single column of a record’s related list. Describes how to lay out the column; doesn’t contain the column’s data. * `dataType` (_string_) The object type for this column’s field. This is the object type used in REST API and SOAP API. _Available in: v29.0_ _Filter group: Medium_ * `fieldId` (_string_) The fully qualified API field ID, for example, `Contact.Name`. _Available in: v29.0_ _Filter group: Big_ * `label` (_string_) The localized label of this column. _Available in: v29.0_ _Filter group: Small_ * `name` (_string_) The short name of the API field, for example, `Name`. _Available in: v29.0_ _Filter group: Medium_ ### ListViewObject Type of record displayed in the rows of a related list. * `fieldId` (_string_) The API field ID that refers to the parent record. For example, if an Account record has a related list of Contact records, then in the Contact related list definition on the Account this value might be `"Account"`. _Available in: v29.0_ _Filter group: Big_ * `type` (_string_) The object type name for this object. This is the object type used in REST API and SOAP API. _Available in: v29.0_ _Filter group: Small_ ### ListViewSort Ordinal of a sort order in a related list. * `column` (_string_) The field ID on the related list column to sort. _Available in: v29.0_ _Filter group: Small_ * `order` (_object_) ConnectSortOrderEnum The order in which to sort the column. One of these values: * `Ascending` — Items are in ascending alphabetical order (A-Z). * `Descending` — Items are in descending alphabetical order (Z-A). * `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectSortOrderEnum`. ### RecordField Generic record field containing a label and text value. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `Boolean` * `Email` * `Number` * `Phone` * `Text` _Available in: v29.0_ _Filter group: Small_ ### Blank Record field displayed as a place holder in a grid of fields. * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Compound Record field that is a composite of subfields. * `fields` (_array of RecordField | Blank | Compound | Currency | Date | Percent | Picklist | Reference | ReferenceWithDate_) Collection of subfields that make up the compound field. A collection of these response bodies: * Record Field * Record Field: Blank * Record Field: Compound * Record Field: Currency * Record Field: Date * Record Field: Percent * Record Field: Picklist * Record Field: Reference * Record Field: Reference with Date _Available in: v29.0_ _Filter group: Big_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `Address` * `Compound` * `Location` * `Name` _Available in: v29.0_ _Filter group: Small_ ### Currency Record field containing a currency value. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. Currency is formatted in the default currency of the organization. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Date Record field containing a date. * `dateValue` (_string_) Date that a machine can read. Format is ISO 8601. _Available in: v29.0_ _Filter group: Medium_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `Date` * `DateTime` * `Time` _Available in: v29.0_ _Filter group: Small_ ### Percent Record field containing a percentage value. * `value` (_number (double)_) Value of the percentage. _Available in: v29.0_ _Filter group: Medium_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Picklist Record field containing an enumerated value. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### ReferenceWithDate Record field containing a referenced object that acted at a specific time, for example, “Created By...”. * `dateValue` (_string_) Time at which the referenced object acted. Format is ISO 8601. _Available in: v29.0_ _Filter group: Medium_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `reference` (_object_) ReferenceCore Object referenced by the record field. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `CreatedBy` * `LastModifiedBy` _Available in: v29.0_ _Filter group: Small_ ### TrackedChangeBundleCapability If a feed element has this capability, it has a group of other feed elements aggregated into one feed element called a bundle. This type of bundle aggregates feed tracked changes. Bundled posts contain feed-tracked changes and are in record feeds only. * `bundleType` (_object_) ConnectBundleTypeEnum Type of bundle. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBundleTypeEnum`. * `changes` (_array of FeedTrackedChange_) Collection of feed tracked changes. _Available in: v31.0_ _Filter group: Small_ * `page` (_object_) FeedElementCollection A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementCollection`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.0_ _Filter group: Small_ ### GenericBundleCapability If a feed element has this capability, the feed element may be a group of other feed elements condensed into one. Bundled posts contain feed-tracked changes and are in record feeds only. * `bundleType` (_object_) ConnectBundleTypeEnum Type of bundle. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBundleTypeEnum`. * `page` (_object_) FeedElementCollection A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementCollection`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.0_ _Filter group: Small_ ### FeedElement A concrete instance of a generic Feed Element. Unless otherwise specified, a generic Feed Element can have shared properties: id, feedElementType, body, and capabilities. * `body` (_object_) FeedItemBody Information about the feed element. _Available in: v22.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_, required) FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v23.0_ _Filter group: Small_ * `feedElementType` (_object_) ConnectFeedElementTypeEnum Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: * `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v31.0_ Includes all fields of `ConnectFeedElementTypeEnum`. * `header` (_object_, required) FeedItemBody The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string (Id)_, required) 18-character ID of the feed item. _Available in: v23.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `parent` (_object_, required) AbstractIdable The parent of the feed element. _Available in: v28.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” . _Available in: v28.0_ _Filter group: Small_ * `url` (_string (url)_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ ### AbstractIdableSbi Describing a person or thing that can act or be acted on in the organization. Corresponds directly to an actual record in the organization with an addressible ID. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `id` (_string (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `MotifSbi`. * `mySubscription` (_object_) If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceCore`. * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### PlatformActionGroupSbi Representation of a platform action group instance with state appropriate for the logged in user. A platform action group is simply a grouping of platform actions used to indicate mutual exclusivity of actions as well as specify some properties that must be shared across the actions. Stand-alone actions should be in their own action group. * `category` (_ConnectPlatformActionGroupCategoryEnumSbi_) * `id` (_string_) The ID for the platform action group. This could be the same 18-character ID or an opaque string ID depending on how it was defined. * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2014-02-25T18:24:31.000Z. * `platformActions` (_array of PlatformActionSbi_) The platform actions for this group. * `url` (_string (url)_) The url for this platform action group. ### ConnectPlatformActionGroupCategoryEnumSbi Defines the categories of platform action groups. Type: `string`. Allowed values: `Overflow`, `Primary`. ### PlatformActionSbi Representation of an platform action instance with state appropriate for the logged in user. * `actionUrl` (_string (url)_) For action links, this is the URL to the UI or download link if the subtype is Ui or Download, otherwise null. * `apiName` (_string_) The API name. May be null. * `confirmationMessage` (_string_) If this action requires confirmation and is in the New state, this is a default localized message that should be shown to an end user prior to invoking the action. Otherwise this will be null. * `createdRecords` (_array of RecordSummarySbi_) The collection of records that this action created after the action has been invoked by the current user. This will be empty if the action has yet to be performed by the current user. Records created from other users will not be shown. * `executingUser` (_UserSummarySbi_) * `groupDefault` (_boolean_) True if this action should be represented as the default in the group. * `iconUrl` (_string (url)_) The icon URL. May be null. * `id` (_string_) The ID for the platform action. This could be an 18-character ID or an opaque string ID depending on how it was defined. * `label` (_string_) The localized label for this platform action. * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2014-02-25T18:24:31.000Z. * `platformActionGroup` (_ReferenceCore_) * `status` (_ConnectPlatformActionStatusEnumSbi_) * `subtype` (_string_) The subtype of the platform action, e.g. for action links possible values include Api, ApiAsync, Ui, Download * `type` (_ConnectPlatformActionTypeEnumSbi_) * `url` (_string (url)_) The REST URL for this platform action. ### ConnectPlatformActionStatusEnumSbi Defines platform action statuses. Type: `string`. Allowed values: `FailedStatus`, `NewStatus`, `PendingStatus`, `SuccessfulStatus`. ### ConnectPlatformActionTypeEnumSbi Defines the types of platform actions. Type: `string`. Allowed values: `ActionLink`, `CustomButton`, `ProductivityAction`, `QuickAction`, `StandardButton`. ### RecordSummarySbi Any record in the organization including custom objects. Typically, a user, group, file, or other detailed object is returned if it is available for that record type. Includes all fields of `AbstractRecordView`. * `entityLabel` (_EntityLabelSbi_) ### EntityLabelSbi Representation of an entity's label. * `label` (_string_) Localized singular label of the entity. * `labelPlural` (_string_) Localized plural label of the entity. ### AbstractRecordView Any record in the organization including custom objects. Typically, a user, group, file, or other detailed object is returned if it is available for that record type. Includes all fields of `AbstractIdableSbi`. * `name` (_string_) A locale-based name of this record.