--- schema_version: "1" id: 3b727544fe709eae663f40b0ae86c27abb4fdbb72c2f6690ce5d897139ef6ca2 title: Connect REST API (Core) 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-core.md canonical_url: https://developer.salesforce.com/docs/platform/connect-rest-api/references/connect-rest-api-core source_site: developer.salesforce.com content_type: documentation content_hash: 677f6c4c19b80b51ba795e1d9e4f468a3c9aa6549bd467f06de6a68f096faa2f products: - Connect REST API Developer Guide - Connect REST APIs --- Connect REST API (Core) # Connect REST API (Core) > **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. **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 ### Action Links Resources An action link is a button on a feed element. Clicking an action link can take a user to a Web page, initiate a file download, or invoke an API call to Salesforce or to an external server. An action link includes a URL and an HTTP method, and can include a request body and header information, such as an OAuth token for authentication. Use action links to integrate Salesforce and third-party services into the feed so that users can drive productivity and accelerate innovation. There are two views of an action link and an action link group: the definition, and the context user’s view. The definition includes potentially sensitive information, such as authentication information. The context user’s view is filtered by visibility options and the values reflect the state of the context user. ### Bot Version Activation Resources Get and change the activation information of a bot version. ### Call Coaching Resources Einstein Conversation Insights is available to provide insights about customer calls and offer call coaching for sales and service users. Get the current status of Einstein Conversation Insights. Post metadata about a new voice call and recording. Upload an audio recording of a voice call. ### Clean Resources Get information about active data integration rules, including data services, update metrics, and the statuses of rules for a record. ### Connect Resources Information about the context user’s org and settings, and information about the Experience Cloud sites the context user is a member of. **Note**: These resources have the base URL of `/services/data/v67.0/connect`, not `/services/data/v67.0/chatter`. ### Content Taxonomy Resources Create, get, update, delete, and search content taxonomy terms. ### Conversations Resources Get and update conversation entries. Upload bulk conversations and get the statuses of the uploads. ### Custom Domain Resources Get information about the custom domains in your org. A custom domain is a domain that you own, such as `https://www.example.com`, that serves content from your Experience Cloud sites or Salesforce Sites. ### Customer Asset Lifecycle Management Resources Generate, cancel, and change lifecycle-managed assets for sales and account reps to view in Lightning Experience. ### Data 360 Resources Use Salesforce Data 360 Connect REST API to build custom solutions on top of Data 360 and take advantage of uniform implementation and testing practices. See the [Data 360 Connect REST API](https://developer.salesforce.com/docs/platform/connectapi/overview) guide for the Salesforce Data 360 Connect REST API resources. ### Data Integration Resources Get external object names, and use those names to get contract credit information. ### Duplicate Resources Get a directory of duplicate resources, job definitions, and jobs. Update a job status, run a job, and delete job results. ### Einstein Prediction Service Resources Einstein Prediction Service resources enable you to programmatically get predictions from deployed models, work with prediction definitions and models, and manage model refresh and bulk prediction scoring jobs. See the [Analytics REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_dev_guide_rest_sdd_resources.htm) for the Einstein Prediction Service resources. ### Einstein Recommendation Resources Get runtime metrics for Einstein Article and Einstein Reply Recommendations. ### Employee Profiles Resources Get, upload and crop, and delete an employee photo or banner photo. ### Environment Hub Resources Use Environment Hub resources to create new orgs and connect existing orgs to the hub. ### Field Service Shifts from Pattern Resources Preview and create up to 2,000 shifts from a pattern. ### Forecasts Resources Get information about forecast users, managers, and the forecast hierarchy. ### List Share Resources Share list views with different groups in your org and use sharing to limit who is able to see a list view. ### Managed Topics Resources Managed topics for an Experience Cloud site. Get a list of managed topics. Create a managed topic hierarchy. Create, delete, or reorder managed topics. ### Messaging Channels Resources Manage Messaging channels. You can get Messaging channels using the GET method. If a channel doesn't already have an ID, you can add and register it by taking the data from the GET method and passing it to the POST method. ### Microbatching Resources Ingest microbatching records. Get and delete microbatching errors and resubmit microbatching error records. ### Motifs Resources Returns URLs for sets of small, medium, and large motif icons. Records have different sets of motif icons depending on the record type. The motif can also include the record type’s base color. ### Named Credentials Resources Get, create, refresh, replace, update, and delete a credential. Get the URL for the OAuth token flow for an external credential. Get, create, update, and delete external credentials. Get, create, update, and delete named credentials. Get, create, update, and delete external auth identity providers. ### Network Data Category Resources Get or update the network data category tree. Get articles for a network data category. Get catalog items for a network data category. Get category groups. ### Next Best Action Resources Get a recommendation, execute a recommendation strategy, and manage reactions to recommendations. Community users can't access this resource. Portal and guest users can access strategies only through the Suggested Actions component. ### Notification Settings Resources Get, set, and reset notification settings and notification app settings. ### Notifications Resources Get or update notifications. Execute an action for a notification. Get the status of notifications. Get supported notification type details and actions. ### OAuth Credentials Resources Find information about OAuth credentials. ### OAuth Usage Resources Find information about OAuth Usage. ### Optimization Files Resources Fetch the files generated for an optimization request in Enhanced Scheduling and Optimization. This resource requires Field Service to be enabled for the org and requires the context user to have Field Service enabled. #### Requires Field Service Yes ### Orchestration Resources Get orchestration instances or details about an orchestration instance. ### Privacy Center Resources Resources for managing [Privacy Center](https://help.salesforce.com/s/articleView?id=xcloud.about_privacy_center.htm) features and policies. ### Private Connect Resources Get the inbound and outbound network topologies for a private connection type. Provision, sync, or tear down an inbound or outbound connection. ### Salesforce Scheduler Resources Get service territories and create service appointments using Salesforce Scheduler resources. ### Search Resources Search objects using keywords or questions. Use filter parameters to return only the data the application needs. Use `filterGroup` as a request parameter or in a request body. ### Surveys Resources Understand customer feedback as it evolves over time by engaging customers and users with relevant, personalized surveys. Incorporate survey data into your feedback management process and gain actionable insights at every stage of the customer lifecycle. **Note**: Salesforce Feedback Management (SFM) Business API performance can be impacted if a POST request exceeds 5,400 calls per minute and if a PATCH request exceeds 2,700 calls per minute at the org level. For more rate limit information, see [Connect REST API Limits](/docs/platform/connect-rest-api/guide/intro_rate_limits). ### Topics on Records Resources Get information about topics assigned to a record or feed item and add, remove, and replace topics on a record or feed item. Optionally, suggest a list of topics to assign to a record or feed item to improve future topic suggestions. Only users with the Assign Topics permission can remove topics from records or feed items and add existing topics to records or feed items. Only users with the Create Topics permission can add new topics to records or feed items. Administrators must enable topics for objects before users can add topics to records of that object type. ### Topics Resources Get, update, merge, and delete topics. Assign and unassign topics from articles. Get, create, and reassign topic and article assignment rules. Get suggested topics for a string of text, feed item, or record. Get trending topics. Get the files posted recently to a topic. Get topics related to another topic. Get top viewed articles for a topic. ### Translation Workbench Resources (Beta) Create an asynchronous Translation Workbench export or import job. Get the status of a Translation Workbench export or import job. **Note**: Translation Workbench Connect API is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. To enable the beta, follow these steps. From Setup, in the Quick Find box, enter **Translation Language Settings**, then enable **Translation Workbench Connect REST API (Beta)**. ### Type System Resources Use Type System resources to retrieve information about the types available in your org. ### Voice Resources Update the email address of the AWS root user that's associated with the Voice account. These resources apply to the Service Cloud Voice with Amazon Connect partner telephony model. ### Workforce Scheduling Resources Use Workforce Scheduling REST APIs to schedule, reschedule, and cancel service appointments across in-business contexts. ## Operations ### POST Action Link Group Definitions `POST /connect/action-link-group-definitions` Operation ID: `postActionLinkGroupDefinitionCollection`. Tags: Action Links Resources. Allows creation of new action link group definitions. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group. #### Experience Cloud site path `/connect/communities/{communityId}/action-link-group-definitions` _Available in: v33.0_ #### Request body The definition of an action link group. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group. Information in the action link definition can be sensitive to a third party (for example, OAuth bearer token headers). For this reason, only requests made via the client app that created the action link definition can read, modify, or delete the definition. In addition, the user making the request must have created the definition or have View All Data permission. Media type: `application/json`. Schema: `ActionLinkGroupDefinitionInput`. _Example: example\_1_ Payload 1 This example instantiates an action link group definition without a template: ``` { "actionLinks": [ { "actionType": "Api", "labelKey": "Like", "groupDefault": "true", "actionUrl": "https://test.com/this", "method": "HttpPost", "requiresConfirmation": "false" }, { "actionType": "Api", "labelKey": "Unlike", "groupDefault": "false", "actionUrl": "https://test.com/that", "method": "HttpPost", "requiresConfirmation": "false" } ], "executionsAllowed": "OncePerUser", "expirationDate": "2014-07-07T23:59:11.168Z", "category": "Primary" } ``` _Example: example\_2_ Payload 2 This example instantiates an action link group definition from a template: ``` { "templateId": "07gD00000004C9r", "templateBindings": [ { "key": "Bindings.version", "value": "v33.0" } ] } ``` #### Responses * **200** _Action Link Group Definition_ The definition of an action link group. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group. Media type: `application/json`. Schema: `ActionLinkGroupDefinition`. #### Code samples _Example: Example 1 · HTTP_ ``` # To associate an action link group with a feed item, first create an action # link group definition: # # An `actionUrl` to a Salesforce resource can be relative. All others must be # absolute and start with `https://`. POST /connect/action-link-group-definitions { "actionLinks": [ { "actionType" : "Api", "actionUrl" : "https://www.example.com/api/v1/confirm", "groupDefault" : "true", "headers" : [ { "name" : "Authorization", "value" : "OAuth 00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1 VNprqTeD12xYnvygD3JgPnNR._nmE6thZakAbBVJUsjUInMUaKMlkNKaWXdHO" }, { "name" : "Content-Type", "value" : "application/json" }, { "name" : "Accept", "value" : "application/json" }, { "name" : "X-PrettyPrint", "value" : "1" } ], "labelKey" : "Confirm", "method" : "HttpPost", "requiresConfirmation" : "true" }, { "actionType" : "Api", "actionUrl" : "https://www.example.com/api/v1/deny", "groupDefault" : "false", "headers" : [ { "name" : "Authorization", "value" : "OAuth 00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1 VNprqTeD12xYnvygD3JgPnNR._nmE6thZakAbBVJUsjUInMUaKMlkNKaWXdHO" }, { "name" : "Content-Type", "value" : "application/json" }, { "name" : "Accept", "value" : "application/json" }, { "name" : "X-PrettyPrint", "value" : "1" } ], "labelKey": "Deny", "method" : "HttpPost", "requiresConfirmation" : "true" }, { "actionType": "Ui", "actionUrl" : "https://www.example.com/reviewPage.html", "groupDefault" : "false", "labelKey" : "Review", "method" : "HttpGet", "requiresConfirmation" : "false" }, "executionsAllowed" : "OncePerUser", "category" : "Primary", "expirationDate" : "2014-05-09T18:45:39.000Z" } # Next, associate the action link group with the feed item and post the feed # item. Grab the action link group ID from the # `/connect/action-link-group-definitions` response and pass it in a POST # request to # [`/chatter/feed-elements`](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection). # # Different types of action links have different workflows to set their `status` # property, whose value displays in the UI. See # [`/connect/action-links/{actionLinkId}`](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Action-Links-Resources/operation/getActionLink) # for more information. # # This example doesn’t include other capabilities, but feed items with action # links do support other capabilities, such as content, polls, and links. POST /chatter/feed-elements { "body": { "messageSegments": [ { "type": "Text", "text": "Please confirm or deny this item. You can also click Review to provide more feedback." } ] }, "subjectId": "me", "feedElementType": "FeedItem", "capabilities": { "associatedActions": { "actionLinkGroupIds": ["0AgRR0000004CTr0AM"] } } } ``` ### GET Action Link Group Definition `GET /connect/action-link-group-definitions/{actionLinkGroupId}` Operation ID: `getActionLinkGroupDefinition`. Tags: Action Links Resources. Provides information about an action link group definition and allow for deletion. Get information about an action link group definition. To get or delete the action link group definition, the client must be the same client app that created the definition and the user must either be the user who created the definition or have View all Data permission. #### Experience Cloud site path `/connect/communities/{communityId}/action-link-group-definitions/{actionLinkGroupId}` _Available in: v33.0_ #### Parameters * `actionLinkGroupId` (path, string, required) The ID of the action link group. #### Responses * **200** _Action Link Group Definition_ The definition of an action link group. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group. Media type: `application/json`. Schema: `ActionLinkGroupDefinition`. ### DELETE Action Link Group Definition `DELETE /connect/action-link-group-definitions/{actionLinkGroupId}` Operation ID: `deleteActionLinkGroupDefinition`. Tags: Action Links Resources. Provides information about an action link group definition and allow for deletion. Delete an action link group definition. Deleting an action link group definition removes all references to it from feed elements. To get or delete the action link group definition, the client must be the same client app that created the definition and the user must either be the user who created the definition or have View all Data permission. #### Experience Cloud site path `/connect/communities/{communityId}/action-link-group-definitions/{actionLinkGroupId}` _Available in: v33.0_ #### Parameters * `actionLinkGroupId` (path, string, required) The ID of the action link group. #### 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 Action Link Group `GET /connect/action-link-groups/{actionLinkGroupId}` Operation ID: `getActionLinkGroup`. Tags: Action Links Resources. Resource for getting action link groups suitable for use by an individual user and containing the state appropriate for that user. Get information about an action link group including state for the context user. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Note that action link groups are accessible by clients, unlike [action link group definitions](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Action-Links-Resources/operation/getActionLinkGroupDefinition). #### Experience Cloud site path `/connect/communities/{communityId}/action-link-groups/{actionLinkGroupId}` _Available in: v33.0_ #### Parameters * `actionLinkGroupId` (path, string, required) The ID of the action link group. #### Responses * **200** _Platform Action Group_ 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. Media type: `application/json`. Schema: `PlatformActionGroup`. ### GET Action Link `GET /connect/action-links/{actionLinkId}` Operation ID: `getActionLink`. Tags: Action Links Resources. Resource for getting action link groups suitable for use by an individual user and containing the state appropriate for that user. Get information about an action link. #### Experience Cloud site path `/connect/communities/{communityId}/action-links/{actionLinkId}` _Available in: v33.0_ #### Parameters * `actionLinkId` (path, string, required) The ID of the action link. #### Responses * **200** _Platform Action_ 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. Media type: `application/json`. Schema: `PlatformAction`. ### PATCH Action Link `PATCH /connect/action-links/{actionLinkId}` Operation ID: `patchActionLink`. Tags: Action Links Resources. Resource for getting action link groups suitable for use by an individual user and containing the state appropriate for that user. Different types of action links have different `status` workflows. You can’t PATCH the `status` of an action link: * Back to `NewStatus` from a different `status`. * From a terminal `status` (`FailedStatus` or `SuccessfulStatus`) to `NewStatus` or `PendingStatus`. * When the action link belongs to an action link group whose `executionsAllowed` property is `Unlimited`. * For an `Api` or `ApiAsync` action link whose `executionsAllowed` property is `Once`, when a user PATCHes the `status` to `PendingStatus` for the first time, the callout is made to the action link. If the same user PATCHes it to `PendingStatus` again, Salesforce returns the current action link information. However, if another user PATCHes the status to `PendingStatus`, Salesforce throws an error. In both cases, the callout to the action link is not resent. #### Api To invoke an `Api` action link from an app, make a PATCH request to mark the link `PendingStatus`. Salesforce handles the call out to the `actionUrl` that was provided in the Action Link Definition Input. For an `Api` action link, Salesforce sets the `status` to `SuccessfulStatus` or `FailedStatus` based on the HTTP status code returned by your server. #### ApiAsync To invoke this action from an app, make a PATCH request to mark the link `PendingStatus`. Salesforce handles the call out to the `actionUrl` that was provided in the Action Link Definition Input. For an `ApiAsync` action link, the callout starts an asynchronous operation on your server. Salesforce sets `status` to `PendingStatus` unless the call returned an error status code, in which case it sets `status` to `FailedStatus`. When your server has finished the asynchronous processing it should call back and PATCH the action link to `SuccessfulStatus` or `FailedStatus`. #### Download and Ui Direct the user to download or visit the UI from the link in the `actionUrl` of the Platform Action response body. Your application must decide when to make a PATCH request to set `status` to `SuccessfulStatus` or `FailedStatus`. #### Experience Cloud site path `/connect/communities/{communityId}/action-links/{actionLinkId}` _Available in: v33.0_ #### Parameters * `actionLinkId` (path, string, required) The ID of the action link. * `status` (query, ConnectPlatformActionStatusEnum) 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. _Available in: v33.0_ #### Request body The desired execution status of an action link. _Available in: v33.0_ Media type: `application/json`. Schema: `ActionLinkInput`. _Example: example\_1_ Payload 1 ``` { "status": "SuccessfulStatus" } ``` #### Responses * **200** _Platform Action_ 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. Media type: `application/json`. Schema: `PlatformAction`. #### Code samples _Example: Example 1 · HTTP_ ``` PATCH /connect/action-links/0AnRR0000004CTS0A2?status=FailedStatus Content-Type: application/json { "status": "SuccessfulStatus" } ``` ### GET Action Link Diagnostic Information `GET /connect/action-links/{actionLinkId}/diagnostic-info` Operation ID: `getActionLinkDiagnostic`. Tags: Action Links Resources. Resource for getting any diagnostic information that may exist for an action link that has been executed. Diagnostic info is only given for logged in users who can access the action link. Get diagnostic information returned when an action link executes. Diagnostic information is given only for users who can access the action link. #### Experience Cloud site path `/connect/communities/{communityId}/action-links/{actionLinkId}/diagnostic-info` _Available in: v33.0_ #### Parameters * `actionLinkId` (path, string, required) The ID of the action link. #### Responses * **200** _Action Link Diagnostic_ Any diagnostic information that is returned from the REST endpoint when an action link has been executed. Diagnostic information is given only for users who can access the action link. Media type: `application/json`. Schema: `ActionLinkDiagnostic`. ### GET Notifications `GET /connect/notifications` Operation ID: `getNotificationCollection`. Tags: Notifications Resources. Returns a collection of notifications and/or changes read state and seen state. Get notifications for the context user. When the context user makes a GET request, the API returns the context user’s notifications. The API uses the context of the requesting client app and returns notifications for the appropriate types. If a client app makes a GET request, the API returns only custom notifications for the types that the client app subscribes to with org-level settings applied. For example, if an admin disabled a notification type for the app, the API doesn’t return notifications for that type. If a third party (not a client app) makes a GET request, the API returns only custom notifications for the types that are enabled for desktop. _Available in: v49.0_ #### Parameters * `after` (query, string) Notifications occurring after this ISO 8601 formatted date string to mark as read, unread, seen, or unseen. This parameter can’t be used with the `before` parameter. _Available in: v49.0_ * `before` (query, string) Notifications occurring before this ISO 8601 formatted date string to mark as read, unread, seen, or unseen. If unspecified, the default is the current date and time. _Available in: v49.0_ * `size` (query, integer) Number of notifications to return. Values are from 1 through 50. If you specify a number greater than 50, only 50 notifications are returned. If unspecified, the default is 10. _Available in: v49.0_ * `trimMessages` (query, boolean) Specifies whether the content of notifications is trimmed ( `true` ) or returned in full ( `false` ). If `true` , the title of notifications returns up to 120 characters and the body returns up to 320 characters. If `false` , the title of notifications returns up to 250 characters and the body returns up to 750 characters. If unspecified, the default is `true` . _Available in: v50.0_ #### Responses * **200** _Notification Collection_ Collection of notifications. Media type: `application/json`. Schema: `NotificationCollection`. ### PATCH Notifications `PATCH /connect/notifications` Operation ID: `patchNotificationCollection`. Tags: Notifications Resources. Returns a collection of notifications and/or changes read state and seen state. Mark notifications as read, unread, seen, or unseen. _Available in: v49.0_ #### Parameters * `before` (query, string) Notifications occurring before this ISO 8601 formatted date string to mark as read, unread, seen, or unseen. If unspecified, the default is the current date and time. _Available in: v49.0_ * `notificationIds` (query, array of string) List of up to 50 notification IDs to mark as read, unread, seen, or unseen. _Available in: v49.0_ * `read` (query, boolean) Marks notifications as read (`true`) or unread (`false`). If notifications are marked as read, they are also marked as seen. If you set `read` to `true` and `seen` to `false`, you get an error. Required if `seen` isn’t specified _Available in: v49.0_ * `seen` (query, boolean) Marks notifications as seen (`true`) or unseen (`false`). Required if `read` isn’t specified _Available in: v49.0_ #### Request body Collection of notifications to update. _Available in: v49.0_ Media type: `application/json`. Schema: `NotificationCollectionInput`. _Example: example\_1_ Payload 1 ``` { "before": "2019-06-25T18:24:31.000Z", "read": "true" } ``` #### Responses * **200** _Notification Collection_ Collection of notifications. Media type: `application/json`. Schema: `NotificationCollection`. ### GET Notification App Settings `GET /connect/notifications/app-settings/organization` Operation ID: `getNotificationOrgAppSettingsCollection`. Tags: Notification Settings Resources. Notification app settings for the organization. Get notification app settings for the org. _Available in: v47.0_ **Note**: Starting in API version 64.0, this resource supports external client apps, in addition to connected apps. Mobile, push notification, and notification plugins for external client apps are available in API version 64.0. #### Parameters * `applicationId` (query, string) ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session. _Available in: v47.0_ #### Responses * **200** _Notification App Settings Collection_ Notification app settings. Media type: `application/json`. Schema: `NotificationAppSettingsCollection`. ### GET Notification App Setting `GET /connect/notifications/app-settings/organization/{notificationTypeOrId}` Operation ID: `getNotificationOrgAppSetting`. Tags: Notification Settings Resources. Notification App Setting for the organization. Get a notification app setting for the org. Notification app settings have default values that come from the notification type definition and application settings. Admins can disable standard notification app settings that are enabled by default; however, they can’t enable standard notification app settings that are disabled by default. If your app accepts custom notification app settings, admins can enable custom notification app settings that are disabled by default. _Available in: v47.0_ #### Parameters * `notificationTypeOrId` (path, string, required) Notification type or ID of the custom notification type. * `applicationId` (query, string) ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session. _Available in: v47.0_ #### Responses * **200** _Notification App Settings Collection_ Notification app settings. Media type: `application/json`. Schema: `NotificationAppSettingsCollection`. ### POST Notification App Setting `POST /connect/notifications/app-settings/organization/{notificationTypeOrId}` Operation ID: `postNotificationOrgAppSetting`. Tags: Notification Settings Resources. Notification App Setting for the organization. Set a notification app setting for the org. Notification app settings have default values that come from the notification type definition and application settings. Admins can disable standard notification app settings that are enabled by default; however, they can’t enable standard notification app settings that are disabled by default. If your app accepts custom notification app settings, admins can enable custom notification app settings that are disabled by default. _Available in: v47.0_ #### Parameters * `notificationTypeOrId` (path, string, required) Notification type or ID of the custom notification type. * `applicationId` (query, string) ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session. _Available in: v47.0_ * `enabled` (query, boolean) Specifies whether to enable delivery of the notification type for the connected app or external client app (`true`) or not (`false`). _Available in: v47.0_ * `pushEnabled` (query, boolean) #### Request body Notification app setting. _Available in: v47.0_ Media type: `application/json`. Schema: `NotificationApplicationSettingsInput`. _Example: example\_1_ Payload 1 ``` { "enabled": "false" } ``` #### Responses * **200** _Notification App Setting_ Notification app setting. Media type: `application/json`. Schema: `NotificationAppSettings`. ### DELETE Notification App Setting `DELETE /connect/notifications/app-settings/organization/{notificationTypeOrId}` Operation ID: `deleteNotificationOrgAppSetting`. Tags: Notification Settings Resources. Notification App Setting for the organization. Reset a notification app setting for the org. Notification app settings have default values that come from the notification type definition and application settings. Admins can disable standard notification app settings that are enabled by default; however, they can’t enable standard notification app settings that are disabled by default. If your app accepts custom notification app settings, admins can enable custom notification app settings that are disabled by default. _Available in: v47.0_ **Note:** Use DELETE to reset a notification app setting to the default. #### Parameters * `notificationTypeOrId` (path, string, required) Notification type or ID of the custom notification type. * `applicationId` (query, string) ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session. _Available in: v40.0_ #### 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 Notification Settings `GET /connect/notifications/settings/organization` Operation ID: `getNotificationOrgSettingsCollection`. Tags: Notification Settings Resources. Notification target settings for the organization. Get notification settings for the org. _Available in: v47.0_ #### Responses * **200** _Notification Settings Collection_ Notification settings. Media type: `application/json`. Schema: `NotificationSettingsCollection`. ### GET Notification Setting `GET /connect/notifications/settings/organization/{notificationTypeOrId}` Operation ID: `getNotificationOrgSetting`. Tags: Notification Settings Resources. Notification type target setting for the organization. Get a notification setting for the org. Notification settings have default values that come from the notification type definition and application settings. Admins can disable notification settings that are enabled by default; however, they can’t enable notification settings that are disabled by default. _Available in: v47.0_ #### Parameters * `notificationTypeOrId` (path, string, required) Notification type or ID of the custom notification type. #### Responses * **200** _Notification Setting_ Notification setting. Media type: `application/json`. Schema: `NotificationSettings`. ### POST Notification Setting `POST /connect/notifications/settings/organization/{notificationTypeOrId}` Operation ID: `postNotificationOrgSetting`. Tags: Notification Settings Resources. Notification type target setting for the organization. Set a notification setting for the org. Notification settings have default values that come from the notification type definition and application settings. Admins can disable notification settings that are enabled by default; however, they can’t enable notification settings that are disabled by default. _Available in: v47.0_ #### Parameters * `notificationTypeOrId` (path, string, required) Notification type or ID of the custom notification type. * `desktopEnabled` (query, boolean) Specifies whether to enable desktop delivery for the notification type (`true`) or not (`false`). If not specified, the setting doesn’t change. _Available in: v47.0_ * `emailEnabled` (query, boolean) Specifies whether to enable email delivery for the notification type (`true`) or not (`false`). If not specified, the setting doesn’t change. _Available in: v47.0_ * `mobileEnabled` (query, boolean) Specifies whether to enable mobile delivery for the notification type (`true`) or not (`false`). If not specified, the setting doesn’t change. _Available in: v47.0_ * `slackEnabled` (query, boolean) Reserved for future use. _Available in: v52.0_ #### Request body Notification setting input. _Available in: v47.0_ Media type: `application/json`. Schema: `NotificationSettingInput`. _Example: example\_1_ Payload 1 ``` { "desktopEnabled": "false" } ``` #### Responses * **200** _Notification Setting_ Notification setting. Media type: `application/json`. Schema: `NotificationSettings`. ### DELETE Notification Setting `DELETE /connect/notifications/settings/organization/{notificationTypeOrId}` Operation ID: `deleteNotificationOrgSetting`. Tags: Notification Settings Resources. Notification type target setting for the organization. Reset a notification setting for the org. Notification settings have default values that come from the notification type definition and application settings. Admins can disable notification settings that are enabled by default; however, they can’t enable notification settings that are disabled by default. _Available in: v47.0_ Use DELETE to reset a notification setting to the default. #### Parameters * `notificationTypeOrId` (path, string, required) Notification type or ID of the custom notification type. #### Responses * **204** _Successful Delete_ Success ### GET Notifications Status `GET /connect/notifications/status` Operation ID: `getNotificationStatus`. Tags: Notifications Resources. Returns the status of notifications. Get the status of notifications for the context user. _Available in: v49.0_ #### Responses * **200** _Notification Status_ Status of notifications for the context user. Media type: `application/json`. Schema: `NotificationStatus`. ### GET Notifications Types `GET /connect/notifications/types` Operation ID: `getNotificationTypes`. Tags: Notifications Resources. Returns list of supported notification type details and/or actions. Get supported notification type details and actions. _Available in: v66.0_ #### Responses * **200** _Notification Type Collection_ Collection of notification types. Media type: `application/json`. Schema: `NotificationTypeCollection`. ### GET Notification `GET /connect/notifications/{notificationId}` Operation ID: `getNotification`. Tags: Notifications Resources. Returns an individual notification and/or changes read state. Get a notification for the context user. _Available in: v49.0_ #### Parameters * `notificationId` (path, string, required) ID of the notification. * `trimMessages` (query, boolean) Specifies whether the content of a notification is trimmed ( `true` ) or returned in full ( `false` ). If `true` , the title of a notification returns up to 120 characters and the body returns up to 320 characters. If `false` , the title of a notification returns up to 250 characters and the body returns up to 750 characters. If unspecified, the default is `true` . _Available in: v50.0_ #### Responses * **200** _Notification_ Notification. Media type: `application/json`. Schema: `Notification`. ### PATCH Notification `PATCH /connect/notifications/{notificationId}` Operation ID: `patchNotification`. Tags: Notifications Resources. Returns an individual notification and/or changes read state. Mark a notification as read, unread, seen, or unseen. _Available in: v49.0_ #### Parameters * `notificationId` (path, string, required) ID of the notification. * `read` (query, boolean) Marks a notification as read (`true`) or unread (`false`). Required if `seen` isn’t specified _Available in: v49.0_ * `seen` (query, boolean) Marks a notification as seen (`true`) or unseen (`false`). Required if `read` isn’t specified _Available in: v49.0_ #### Request body Notification to update. _Available in: v49.0_ Media type: `application/json`. Schema: `NotificationInput`. _Example: example\_1_ Payload 1 ``` { "read": "true" } ``` #### Responses * **200** _Notification_ Notification. Media type: `application/json`. Schema: `Notification`. ### POST Notification Action `POST /connect/notifications/{notificationId}/actions/{actionKey}` Operation ID: `postNotificationAction`. Tags: Notifications Resources. Api endpoint to execute action on a notification Execute an action on a notification. **Note**: POST doesn’t take request parameters or a request body. _Available in: v66.0_ #### Parameters * `notificationId` (path, string, required) ID of the notification. * `actionKey` (path, string, required) Use the [Notification Types](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Notifications-Resources/operation/getNotificationTypes) resource to get the `{actionKey}` parameter. #### Request body Media type: `application/json`. Schema: `NotificationActionInput`. #### Responses * **200** _Action Result_ Notification action execution result. Media type: `application/json`. Schema: `ActionResult`. ### GET Experience Model Property Types `GET /connect/experience-model/property-types` Operation ID: `getPropertyTypes`. Tags: Experience Model Resources. Resource for the Property Type Collection. Get experience model property types. _Available in: v58.0_ #### Parameters * `designConfigTarget` (query, ExperienceModelTypeDesignConfigTargetEnum) Design configuration target. Value is `Default`. _Available in: v58.0_ * `fullyQualifiedNames` (query, array of string) Comma-separated list of fully qualified names of property types. _Available in: v58.0_ * `language` (query, string) Language or locale, such as `en` or `en_US`. _Available in: v58.0_ * `page` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v58.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25. _Available in: v58.0_ * `renditionConfigTarget` (query, ExperienceModelTypeRenditionConfigTargetEnum) Rendition configuration target. Value is `Default`. _Available in: v58.0_ #### Responses * **200** _Experience Model Property Type Collection_ Collection of property types. Media type: `application/json`. Schema: `ExperienceModelPropertyTypeCollection`. ### GET Experience Model Property Type `GET /connect/experience-model/property-types/{fullyQualifiedName}` Operation ID: `getPropertyType`. Tags: Experience Model Resources. Resource for the Property Type. Get an experience model property type. _Available in: v58.0_ #### Parameters * `fullyQualifiedName` (path, string, required) The Fully Qualified Name of a property type to be retrieved. * `designConfigTarget` (query, ExperienceModelTypeDesignConfigTargetEnum) Design configuration target. Value is `Default`. _Available in: v58.0_ * `includeSubSchemaDefinitions` (query, boolean) Specifies whether to include sub schema definitions (`true`) or not (`false`). _Available in: v58.0_ * `language` (query, string) Language or locale, such as `en` or `en_US`. _Available in: v58.0_ * `renditionConfigTarget` (query, ExperienceModelTypeRenditionConfigTargetEnum) Rendition configuration target. Value is `Default`. _Available in: v58.0_ #### Responses * **200** _Experience Model Property Type Detail_ Property type detail. Media type: `application/json`. Schema: `ExperienceModelPropertyTypeDetail`. ### GET Network Data Category Tree `GET /connect/communities/{communityId}/data-category/network-data-category` Operation ID: `getNetworkDataCategories`. Tags: Network Data Category Resources. Save Update and Fetch all network data categories enabled in a given community organized by its tree Get the network data category tree in an Experience Cloud site. _Available in: v59.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. #### Responses * **200** _Network Data Category Tree_ Network data category tree. Media type: `application/json`. Schema: `NetworkDataCategoryTree`. ### PUT Network Data Category Tree `PUT /connect/communities/{communityId}/data-category/network-data-category` Operation ID: `updateNetworkDataCategories`. Tags: Network Data Category Resources. Save Update and Fetch all network data categories enabled in a given community organized by its tree Update the network data category tree in an Experience Cloud site. _Available in: v59.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. #### Request body Collection of data category groups. Media type: `application/json`. Schema: `DataCategoryGroupCollectionInput`. _Example: example\_1_ Payload 1 ``` { "dataCategoryGroups": [ { "categoryGroupName": "Geographic", "rootCategory": { "categoryName": "WorldWide", "childCategories": [ { "categoryName": "US", "childCategories": [ { "categoryName": "America", "childCategories": [ { "categoryName": "States", "childCategories": [ { "categoryName": "California" } ] } ] } ] } ] } } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `Empty`. ### PATCH Network Data Category `PATCH /connect/communities/{communityId}/network-data-category/{networkDataCategoryId}` Operation ID: `updateNetworkDataCategory`. Tags: Network Data Category Resources. Update network data category record enabled in a given community Update the network data category record in an Experience Cloud site. _Available in: v60.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `networkDataCategoryId` (path, string (Id), required) ID of the network data category. Pattern: ^(9cn)\\w\*. * `description` (query, string) Description of the network data category. Required if `label` isn’t specified _Available in: v60.0_ * `label` (query, string) Label of the network data category. Required if `description` isn’t specified _Available in: v60.0_ #### Responses * **200** _Network Data Category_ Category network. Media type: `application/json`. Schema: `NetworkDataCategory`. ### GET Network Data Category Catalog Items `GET /connect/communities/{communityId}/network-data-category/{networkDataCategoryId}/catalog-item` Operation ID: `getServiceCatalogItemsByCommunityId`. Tags: Network Data Category Resources. Given a network data category id return the list of catalog items Get catalog items for a network data category in an Experience Cloud site or org. _Available in: v59.0_ #### Alternate paths * `/connect/network-data-category/{networkDataCategoryId}/catalog-item` - Base Scope #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `networkDataCategoryId` (path, string (Id), required) ID of the network data category. Pattern: ^(9cn)\\w\*. * `pageNumber` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v59.0_ * `pageSize` (query, integer) Number of items per page. Valid values are from 1 through 25. If unspecified, the default number of items is 3. _Available in: v59.0_ * `sortOrder` (query, ConnectSortOrderEnum) Sort order of the results. Valid values are: * `Ascending` —Items are sorted in ascending alphabetical order (A–Z). * `Descending` —Items are sorted in descending alphabetical order (Z–A). If unspecified, results are returned in ascending order. _Available in: v59.0_ * `sortedBy` (query, string) Name of the field by which to sort results, such as `Label` or `LastModifiedDate`. If unspecified, results are sorted by `Label`. _Available in: v59.0_ #### Responses * **200** _Service Catalog Item Collection_ Collection of service catalog items. Media type: `application/json`. Schema: `ServiceCatalogItemCollection`. ### GET Network Data Category Child Category `GET /connect/communities/{communityId}/network-data-category/{networkDataCategoryId}/child-category` Operation ID: `getChildCategories`. Tags: Network Data Category Resources. Fetch children of a given network data category in a community Retrieve child categories of a network data category in an Experience Cloud site. _Available in: v60.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `networkDataCategoryId` (path, string (Id), required) ID of the network data category. Pattern: ^(9cn)\\w\*. * `language` (query, string) Language of the child categories to retrieve. Default is the user's org language. _Available in: v60.0_ * `pageNumber` (query, integer) Page number of the result to return. Default is the first page. _Available in: v60.0_ * `pageSize` (query, integer) Number of results to retrieve per page. The maximum is 25. Default is 3. _Available in: v60.0_ * `sortOrder` (query, ConnectSortOrderEnum) Sort order of the fields. This can be ascending or descending. 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. Default is `Descending`. _Available in: v60.0_ * `sortedBy` (query, string) The field name to sort child categories by. Default is the title. _Available in: v60.0_ #### Responses * **200** _Network Data Category Collection_ List of network data categories. Media type: `application/json`. Schema: `NetworkDataCategoryCollection`. ### GET Network Data Category Articles `GET /connect/communities/{communityId}/network-data-category/{networkDataCategoryId}/knowledge-article` Operation ID: `getArticlesForCategory`. Tags: Network Data Category Resources. Given a network data category id, return the list of articles Get articles for a network data category in an Experience Cloud site. _Available in: v59.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `networkDataCategoryId` (path, string (Id), required) ID of the network data category. Pattern: ^(9cn)\\w\*. * `language` (query, string) Language for the articles, limited to the knowledge languages that are enabled for the org. _Available in: v59.0_ * `pageNumber` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v59.0_ * `pageSize` (query, integer) Number of items per page. Valid values are from 1 through 25. If unspecified, the default number of items is 3. _Available in: v59.0_ * `sortOrder` (query, ConnectSortOrderEnum) Sort order of the results. Valid values are: * `Ascending` —Items are sorted in ascending alphabetical order (A–Z). * `Descending` —Items are sorted in descending alphabetical order (Z–A). If unspecified, results are returned in ascending order. _Available in: v59.0_ * `sortedBy` (query, string) Name of the field by which to sort results, such as `Label` or `LastModifiedDate`. If unspecified, results are sorted by `Label`. _Available in: v59.0_ #### Responses * **200** _Lightning Knowledge Article Version Collection_ Collection of knowledge articles in Lightning. Media type: `application/json`. Schema: `LightningKnowledgeArticleVersionCollection`. ### GET Network Data Category Parent Path `GET /connect/communities/{communityId}/network-data-category/{networkDataCategoryId}/parent-path` Operation ID: `getParentNetworkDataCategoryPath`. Tags: Network Data Category Resources. Fetch parent data category hierarchy given a network data category in a community Retrieve the hierarchy of the network data categories in an Experience Cloud site. This API returns the network data category path from the parent category to the specified category. _Available in: v60.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `networkDataCategoryId` (path, string (Id), required) ID of the network data category. Pattern: ^(9cn)\\w\*. * `language` (query, string) Language of the parent path to retrieve. Default is the user's org language. _Available in: v60.0_ #### Responses * **200** _Network Data Category Collection_ List of network data categories. Media type: `application/json`. Schema: `NetworkDataCategoryCollection`. ### GET Data Category Groups `GET /connect/data-category/category-group` Operation ID: `getCategoryGroups`. Tags: Network Data Category Resources. All active data category groups and their child categories Get active data category groups and their subcategories. _Available in: v59.0_ #### Responses * **200** _Data Category Group Collection_ Data category group collection. Media type: `application/json`. Schema: `DataCategoryGroupCollection`. ### PATCH Knowledge Article View Stat `PATCH /connect/knowledge/article/view-stat` Operation ID: `updateViewStat`. Tags: Knowledge Article View Stat Resources. Knowledge Article View Stat Endpoints Increase the view count of a knowledge article by one. #### Experience Cloud site path `/connect/communities/{communityId}/knowledge/article/view-stat` _Available in: v48.0_ #### Parameters * `articleOrVersionId` (query, string, required) ID of the knowledge article or knowledge article version to increase the view count by one. If you provide the ID of a knowledge article version, the parent article view count is increased. _Available in: v48.0_ #### Request body (required) Knowledge article view stat input. _Available in: v48.0_ Media type: `application/json`. Schema: `KnowledgeArticleViewStatInput`. _Example: example\_1_ Payload 1 ``` { "articleOrVersionId": "ka230000000PCiy" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `Empty`. ### GET Network Data Category Catalog Items (Base Scope) `GET /connect/network-data-category/{networkDataCategoryId}/catalog-item` Operation ID: `getServiceCatalogItems`. Tags: Network Data Category Resources. Given a network data category id return the list of catalog items _Available in: v59.0_ Alternate path for `Network Data Category Catalog Items`. Variant: Base Scope. Canonical documentation path: `/connect/communities/{communityId}/network-data-category/{networkDataCategoryId}/catalog-item`. #### Parameters * `networkDataCategoryId` (path, string (Id), required) ID of the network data category. Pattern: ^(9cn)\\w\*. * `pageNumber` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v59.0_ * `pageSize` (query, integer) Number of items per page. Valid values are from 1 through 25. If unspecified, the default number of items is 3. _Available in: v59.0_ * `sortOrder` (query, ConnectSortOrderEnum) Sort order of the results. Valid values are: * `Ascending` —Items are sorted in ascending alphabetical order (A–Z). * `Descending` —Items are sorted in descending alphabetical order (Z–A). If unspecified, results are returned in ascending order. _Available in: v59.0_ * `sortedBy` (query, string) Name of the field by which to sort results, such as `Label` or `LastModifiedDate`. If unspecified, results are sorted by `Label`. _Available in: v59.0_ #### Responses * **200** _Service Catalog Item Collection_ Collection of service catalog items. Media type: `application/json`. Schema: `ServiceCatalogItemCollection`. ### GET Top Viewed Articles for a Topic `GET /connect/topics/{topicId}/top-viewed-articles` Operation ID: `getTopViewedArticlesForTopic`. Tags: Topics Resources. Given a topic id, return the list of top viewed articles. Get the top viewed articles for a topic. #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/top-viewed-articles` _Available in: v41.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. * `maxResults` (query, integer) The maximum number of articles returned for each topic ID. Values can be from 1 to 25. The default value is 5. _Available in: v41.0_ #### Responses * **200** _Knowledge Article Version Collection_ A collection of knowledge article versions. Media type: `application/json`. Schema: `KnowledgeArticleVersionCollection`. ### GET Managed Topics `GET /connect/communities/{communityId}/managed-topics` Operation ID: `getManagedTopicCollection`. Tags: Managed Topics Resources. Managed topics for the community. Get all the managed topics for an Experience Cloud site. _Available in: v32.0_ **Note:** If you make a GET request without request parameters, you get only featured and navigational topics. To get content topics, make a GET request with the `managedTopicType` parameter set to Content, for example **Note:** To see all your managed topic hierarchies, make a GET request with the `depth` parameter set to 8 and the `managedTopicType` set to `Navigational` #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `depth` (query, integer) Specify an integer 1–8. If you specify 1, the `children` property of the Managed Topic response body is null. If you specify 2, the `children` property of the Managed Topic response body contains the direct children managed topics, if any, of the managed topic. If you specify 3–8, you get the direct children managed topics and their children managed topics if there are any. If depth isn’t specified, it defaults to 1. _Available in: v35.0_ * `managedTopicType` (query, ConnectManagedTopicTypeEnum) Type of managed topic. * `Content` —Topics that are associated with native content. * `Featured` —Topics that are featured, for example, on the Experience Cloud site home page, but don’t provide overall navigation. * `Navigational` —Topics that display in a navigational menu in the Experience Cloud site. A topic can be associated with all three managed topic types, so a topic can be a `Featured`, `Navigational`, and `Content` topic. If you specify `Content` and you want more than 50 topics to be returned, use the `page` and `pageSize` parameters. Required if specifying `recordIds` or `depth`. Required for `Content` topics _Available in: v32.0_ * `page` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. If you specify 2–8 for the `depth`, the `page` and `pageSize` properties apply only to the top-level managed topics and not to children managed topics. _Available in: v44.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 50. If you specify 2–8 for the `depth`, the `page` and `pageSize` properties apply only to the top-level managed topics and not to children managed topics. _Available in: v44.0_ * `recordIds` (query, string) List of up to 100 topic IDs associated with the managed topics. If you list more than 10 topic IDs, you can’t specify 2–8 for `depth`. _Available in: v38.0_ * `recordId` (query, string) ID of the topic associated with the managed topics. In version 38.0 and later, use `recordIds`. _Available in: v35.0–37.0_ #### Responses * **200** _Managed Topic Collection_ A collection of managed topics in an Experience Cloud site. Media type: `application/json`. Schema: `ManagedTopicCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` # If you make a GET request without request parameters, you get only featured # and navigational topics. To get content topics, make a GET request with the # managedTopicType parameter set to Content, for example: GET /connect/communities/communityId/managed-topics?&managedTopicType=Content ``` _Example: Example 2 · HTTP_ ``` # To see all your managed topic hierarchies, make a GET request with the depth # parameter set to 8 and the managedTopicType set to Navigational, for example: GET /connect/communities/communityId/managed-topics?depth=8&managedTopicType=Navigational ``` ### POST Managed Topics `POST /connect/communities/{communityId}/managed-topics` Operation ID: `postManagedTopicCollection`. Tags: Managed Topics Resources. Managed topics for the community. Create a managed topic and create managed topic hierarchies. Only community managers (users with the Create and Set Up Experiences or Manage Experiences permission) can create or reorder managed topics. _Available in: v32.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `managedTopicType` (query, ConnectManagedTopicTypeEnum, required) Type of managed topic. * `Content` —Topics that are associated with native content. * `Featured` —Topics that are featured, for example, on the Experience Cloud site home page, but don’t provide overall navigation. * `Navigational` —Topics that display in a navigational menu in the Experience Cloud site. A topic can be associated with all three managed topic types, so a topic can be a `Featured`, `Navigational`, and `Content` topic. You can create up to 25 `Featured` and 5,000 `Content` topics. You can create up to eight levels of `Navigational` managed topics with 25 top-level topics and 10 children topics per level for a maximum of 2,775 `Navigational` topics. To create a child managed topic, specify `Navigational` as the `managedTopicType` and specify a `parentId`. _Available in: v32.0_ * `name` (query, string) Name of the managed topic. Required for new topics. You must specify either `name` or `recordId`. You can’t specify both. _Available in: v32.0_ * `parentId` (query, string) ID of the parent managed topic. If you specify a `parentId`, also specify `Navigational` as the `managedTopicType`. You can create up to eight levels (parent, direct children, their children, etc.) of managed topics and up to 10 children managed topics per managed topic. _Available in: v35.0_ * `recordId` (query, string) ID of the record to become a managed topic. In version 32.0 and later, `recordId` must be a topic ID. Required if the `Name` property isn’t used. You must specify either `name` or `recordId`. You can’t specify both. Required for existing topics if the `Name` property isn’t used. You must specify either `name` or `recordId`. You can’t specify both. _Available in: v32.0_ #### Request body (required) A managed topic. _Available in: v32.0_ Media type: `application/json`. Schema: `ManagedTopicInput`. _Example: example\_1_ Payload 1 Using `recordId` ``` { "managedTopicType": "Navigational", "parentId": "0mtR000000001KLIAY", "recordId": "0TOD00000000cwk" } ``` _Example: example\_2_ Payload 2 Using `name` ``` { "name": "Child Topic", "managedTopicType": "Navigational", "parentId": "0mtR000000001KLIAY" } ``` #### Responses * **200** _Managed Topic_ Managed topic in an Experience Cloud site. Media type: `application/json`. Schema: `ManagedTopic`. ### PATCH Managed Topics `PATCH /connect/communities/{communityId}/managed-topics` Operation ID: `patchManagedTopicCollection`. Tags: Managed Topics Resources. Managed topics for the community. Reorder parent managed topics or children managed topics with the same parent. You can't reorder Content topics. _Available in: v32.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. #### Request body A collection of relative positions of managed topics. Media type: `application/json`. Schema: `ManagedTopicPositionCollectionInput`. _Example: example\_1_ Payload 1 ``` { "managedTopicPositions": [ { "managedTopicId": "0mtD0000000001aIAA", "position": "0" }, { "managedTopicId": "0mtD0000000002qIAA", "position": "2" } ] } ``` #### Responses * **200** _Managed Topic Collection_ A collection of managed topics in an Experience Cloud site. Media type: `application/json`. Schema: `ManagedTopicCollection`. ### GET Managed Topic `GET /connect/communities/{communityId}/managed-topics/{managedTopicId}` Operation ID: `getManagedTopic`. Tags: Managed Topics Resources. Individual managed topic in community. Get information about a managed topic in an Experience Cloud site. _Available in: v32.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `managedTopicId` (path, string (Id), required) ID of existing managed topic. Pattern: ^(0mt)\\w\*. * `depth` (query, integer) Specify an integer 1–8. If you specify 1, the `children` property of the Managed Topic response body is null. If you specify 2, the `children` property of the Managed Topic response body contains the direct children managed topics, if any, of the managed topic. If you specify 3–8, you get the direct children managed topics and their children managed topics if there are any. If depth isn’t specified, it defaults to 1. _Available in: v35.0_ #### Responses * **200** _Managed Topic_ Managed topic in an Experience Cloud site. Media type: `application/json`. Schema: `ManagedTopic`. ### DELETE Managed Topic `DELETE /connect/communities/{communityId}/managed-topics/{managedTopicId}` Operation ID: `deleteManagedTopic`. Tags: Managed Topics Resources. Individual managed topic in community. Delete a managed topic in an Experience Cloud site. Only community managers (users with the Create and Set Up Experiences or Manage Experiences permission) can delete managed topics. _Available in: v32.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `managedTopicId` (path, string (Id), required) ID of existing managed topic. Pattern: ^(0mt)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Topics on Records `GET /connect/records/{recordId}/topics` Operation ID: `getRecordTopics`. Tags: Topics on Records Resources. Work with the topics on a record. Get information about topics assigned to a record or feed item. #### Experience Cloud site path `/connect/communities/{communityId}/records/{recordId}/topics` _Available in: v30.0_ #### Parameters * `recordId` (path, string (Id), required) ID of the record. #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### PUT Topics on Records `PUT /connect/records/{recordId}/topics` Operation ID: `putRecordTopics`. Tags: Topics on Records Resources. Work with the topics on a record. Replace topics on a record or feed item. Optionally, suggest a list of topics to assign to a record or feed item to improve future topic suggestions. #### Experience Cloud site path `/connect/communities/{communityId}/records/{recordId}/topics` _Available in: v35.0_ #### Parameters * `recordId` (path, string (Id), required) ID of the record. #### Request body A list of topic names to replace currently assigned topics. Also a list of suggested topics to assign. Media type: `application/json`. Schema: `TopicNameCollectionInput`. _Example: example\_1_ Payload 1 ``` { "topicNames": [ "API", "Connect REST API", "ConnectApi" ] } ``` #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### POST Topics on Records `POST /connect/records/{recordId}/topics` Operation ID: `postRecordTopics`. Tags: Topics on Records Resources. Work with the topics on a record. Add topics on a record or feed item. Add existing topics to records or feed items. #### Experience Cloud site path `/connect/communities/{communityId}/records/{recordId}/topics` _Available in: v30.0_ #### Parameters * `recordId` (path, string (Id), required) ID of the record. * `topicId` (query, string) ID of an existing topic Required for existing topics if the `topicName` parameter isn’t used _Available in: v30.0_ * `topicName` (query, string) Name of a new or existing topic Required for new topics; required for existing topics if the `topicId` parameter isn’t used _Available in: v30.0_ #### Request body Represents a topic to assign to a feed item or record. Administrators must enable topics for objects before users can add topics to records of that object type. _Available in: v30.0_ Media type: `application/json`. Schema: `TopicAssignmentInput`. #### Responses * **200** _Topic_ Topic. Media type: `application/json`. Schema: `TopicSbi`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example passes the ID of an existing topic in the `topidId` parameter to # associate it with an opportunity record: POST /connect/records/006D000000CtYBc/topics?topicId=0TOD0000000090r ``` _Example: Example 2 · HTTP_ ``` # The following example assigns a topic to a record: { "topicId": "0TOD0000000090r" } ``` ### DELETE Topics on Records `DELETE /connect/records/{recordId}/topics` Operation ID: `deleteRecordTopics`. Tags: Topics on Records Resources. Work with the topics on a record. Remove topics on a record or feed item. #### Experience Cloud site path `/connect/communities/{communityId}/records/{recordId}/topics` _Available in: v30.0_ #### Parameters * `recordId` (path, string (Id), required) ID of the record. * `topicId` (query, string, required) ID of an existing topic _Available in: v30.0_ #### 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 List of Topics `GET /connect/topics` Operation ID: `getTopicCollection`. Tags: Topics Resources. Get or search for all topics in an organization. Get information about topics in the organization. In version 28.0, use `/chatter/topics` #### Experience Cloud site path `/connect/communities/{communityId}/topics` _Available in: v29.0_ #### Parameters * `exactMatch` (query, boolean) Use with the `q` parameter and specify `true` to find a topic by its exact, case-insensitive name. Specify `true` and use with the `q` parameter and the `fallBackToRenamedTopics` parameter set to `true` to find the most recent renamed topic match if there isn’t an exact match. Default value is `false` . _Available in: v28.0_ * `fallBackToRenamedTopics` (query, boolean) Use with the `q` parameter and the `exactMatch` parameter set to `true` . If an exact match isn’t found and `fallBackToRenamedTopics` is set to `true` , the most recent renamed topic match is returned. If there are multiple renamed topic matches, only the most recent is returned. If there are no renamed topic matches, an empty collection is returned. _Available in: v35.0_ * `page` (query, integer) An integer greater than 0 specifying a page of topics. The default value is zero. _Available in: v28.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: v28.0_ * `q` (query, string) A query string to filter the results. The string must contain at least two characters, not including wildcards. _Available in: v28.0_ * `sort` (query, ConnectTopicSortEnum) One of the following values: * `popularDesc` —Sorts topics by popularity with the most popular first. This value is the default. * `alphaAsc` —Sorts topics alphabetically. _Available in: v28.0_ #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example requests a list of topics sorted alphabetically: /connect/topics?sort=alphaAsc ``` ### POST List of Topics `POST /connect/topics` Operation ID: `postTopicCollection`. Tags: Topics Resources. Get or search for all topics in an organization. Create a topic. #### Experience Cloud site path `/connect/communities/{communityId}/topics` _Available in: v36.0_ #### Parameters * `description` (query, string) Text description of the topic _Available in: v36.0_ * `name` (query, string) Name of the topic _Available in: v36.0_ #### Request body Topic input. _Available in: v36.0_ Media type: `application/json`. Schema: `TopicInput`. _Example: example\_1_ Payload 1 ``` { "description": "World Wide Web Consortium (W3C) is the main international standards organization for the web.", "name": "W3C" } ``` #### Responses * **200** _Topic_ Topic. Media type: `application/json`. Schema: `TopicSbi`. ### POST Topic and Article Assignments `POST /connect/topics/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}/articles` Operation ID: `postArticleTopicAssignmentJob`. Tags: Topics Resources. Assign or Unassign topics to articles in data category. Assign topics to articles and unassign topics from articles in a data category. #### Experience Cloud site path `/connect/communities/{communityId}/topics/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}/articles` _Available in: v40.0_ #### Parameters * `dataCategory` (path, string, required) The data category used by articles. * `dataCategoryGroup` (path, string, required) The data category group used by articles. #### Request body An article and topic assignment job. Media type: `application/json`. Schema: `ArticleTopicAssignmentJobInput`. _Example: example\_1_ Payload 1 ``` { "operation": "AssignTopicsToArticle", "topicNames": [ "API", "Connect REST API", "ConnectApi" ] } ``` #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### GET Topic and Article Assignment Rules `GET /connect/topics/data-category-rules/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}` Operation ID: `getTopicDataCategoryRule`. Tags: Topics Resources. Work with the topics dataCategory rules. Get topic and article assignment rules by data category. #### Experience Cloud site path `/connect/communities/{communityId}/topics/data-category-rules/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}` _Available in: v40.0_ #### Parameters * `dataCategory` (path, string, required) The data category used by articles. * `dataCategoryGroup` (path, string, required) The data category group used by articles. #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### PUT Topic and Article Assignment Rules `PUT /connect/topics/data-category-rules/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}` Operation ID: `putTopicDataCategoryRule`. Tags: Topics Resources. Work with the topics dataCategory rules. Reassign topic and article assignment rules by data category. Reassignment deletes the existing rules and creates new rules. #### Experience Cloud site path `/connect/communities/{communityId}/topics/data-category-rules/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}` _Available in: v40.0_ #### Parameters * `dataCategory` (path, string, required) The data category used by articles. * `dataCategoryGroup` (path, string, required) The data category group used by articles. #### Request body A list of topic names to replace currently assigned topics. Also a list of suggested topics to assign. Media type: `application/json`. Schema: `TopicNameCollectionInput`. _Example: example\_1_ Payload 1 ``` { "topicNames": [ "API", "Connect REST API", "ConnectApi" ] } ``` #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### POST Topic and Article Assignment Rules `POST /connect/topics/data-category-rules/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}` Operation ID: `postTopicDataCategoryRule`. Tags: Topics Resources. Work with the topics dataCategory rules. Create topic and article assignment rules by data category. #### Experience Cloud site path `/connect/communities/{communityId}/topics/data-category-rules/data-category-groups/{dataCategoryGroup}/data-categories/{dataCategory}` _Available in: v40.0_ #### Parameters * `dataCategory` (path, string, required) The data category used by articles. * `dataCategoryGroup` (path, string, required) The data category group used by articles. #### Request body A list of topic names to replace currently assigned topics. Also a list of suggested topics to assign. Media type: `application/json`. Schema: `TopicNameCollectionInput`. _Example: example\_1_ Payload 1 ``` { "topicNames": [ "API", "Connect REST API", "ConnectApi" ] } ``` #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### GET Topics Suggestions `GET /connect/topics/suggestions` Operation ID: `getTopicSuggestion`. Tags: Topics Resources. Get a list of suggested topics for a given record. Get a list of topic suggestions for a string of text, feed item, or record. In version 28.0, use `/chatter/topics/suggestions` #### Experience Cloud site path `/connect/communities/{communityId}/topics/suggestions` _Available in: v29.0_ #### Parameters * `maxResults` (query, integer) Maximum number of topic suggestions that get returned. The default is 5. Value must be greater than 0 and less than or equal to 25. * `recordId` (query, string) 18-character ID of a feed item or record from which to extract topics. Administrators must enable topics for objects to see topic suggestions for records of that object type. Topics for objects is available in version 30.0. Required if the `text` parameter isn’t used * `text` (query, string) Text from which to extract topics. Required if the `recordId` parameter isn’t used #### Responses * **200** _Topic Suggestion Collection_ Topic suggestion collection. Media type: `application/json`. Schema: `TopicSuggestionCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example gets topic suggestions for the text “Working on the planning # meeting for our new initiative.” /connect/topics/suggestions?text=Working+on+the+planning+meeting+for+our+new+initiative. ``` ### GET Trending Topics `GET /connect/topics/trending` Operation ID: `getTrendingTopics`. Tags: Topics Resources. Get a page of trending topics. Get the top five trending topics for the org. The more frequently people add a specific topic to their posts and comments and comment on or like posts with the same topic over a short period of time, the more likely it is to become a trending topic. For example, if your coworkers are attending the upcoming Dreamforce conference and have started discussing it in Chatter, you may see a trending topic for Dreamforce. A trending topic is not solely based on popularity and usually relates to a one-time or infrequent event that has a spike in activity, such as a conference or a project deadline. **Note**: In API versions earlier than 28.0, topics began with a hashtag (#). In versions 24.0–28.0, use `/chatter/topics/trending` and `/connect/communities/{communityId}/chatter/topics/trending` #### Experience Cloud site path `/connect/communities/{communityId}/topics/trending` _Available in: v29.0_ #### Parameters * `maxResults` (query, integer) Maximum number of trending topics that get returned. The default is 5. Value must be greater than 0 and less than 100. #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` {"currentPageUrl" : "/services/data/v67.0/connect/topics/trending?maxResults=5", "nextPageUrl" : null, "topics" : [ { "createdDate": "2013-01-01T20:43:31.000Z", "id" : "0TOD0000000090qOAA", "description" : "Application Programming Interface", "talkingAbout" : 527, "name" : "API", "url": "/services/data/v67.0/connect/topics/0TOD0000000090qOAA" }, { "createdDate": "2012-11-14T05:24:23.000Z", "id" : "0TOD000000006RxOAI", "description" : "The cloud computing event of the year.", "talkingAbout" : 424, "name" : "Dreamforce", "url": "/services/data/v67.0/connect/topics/0TOD000000006RxOAI" }, { "createdDate": "2013-02-25T10:47:51.000Z", "id" : "0TOD0000000090rOAA", "description" : "All things related to mobile.", "talkingAbout" : 87, "name" : "Mobile", "url": "/services/data/v67.0/connect/topics/0TOD0000000090rOAA" } ]} ``` _Example: Example 2 · HTTP_ ``` {"topics" : [ { "name" : "#API" }, { "name" : "#Dreamforce" }, { "name" : "#Mobile" } ]} ``` ### GET Topic `GET /connect/topics/{topicId}` Operation ID: `getTopic`. Tags: Topics Resources. Returns information about the specified topic. Get information about a topic. In version 28.0, use `/chatter/topics/{topicId}` #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}` _Available in: v29.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. #### Responses * **200** _Topic_ Topic. Media type: `application/json`. Schema: `TopicSbi`. ### DELETE Topic `DELETE /connect/topics/{topicId}` Operation ID: `deleteTopic`. Tags: Topics Resources. Returns information about the specified topic. Delete a topic. Users with the Delete Topics or Modify All Data permission can merge and delete topics. In version 28.0, use `/chatter/topics/{topicId}` Topic deletion is asynchronous. If a topic is requested before the deletion completes, the response is [200: Successful](/docs/platform/connect-rest-api/guide/connect_error_responses) and the `isBeingDeleted` property of the Topic output is `true` in version 33.0 and later. If a topic is requested after the deletion completes, the response is [404: Not found](/docs/platform/connect-rest-api/guide/connect_error_responses). #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}` _Available in: v29.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\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 Topic `PATCH /connect/topics/{topicId}` Operation ID: `patchTopic`. Tags: Topics Resources. Returns information about the specified topic. Update a topic’s name or description. Merge topics. Users with the Edit Topics or Modify All Data permission can edit topic names and descriptions. Users with the Delete Topics or Modify All Data permission can merge and delete topics. In version 28.0, use `/chatter/topics/{topicId}` #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}` _Available in: v29.0_ #### Parameters * `topicId` (path, string (Id), required) ID of the topic. Pattern: ^(0TO)\\w\*. * `description` (query, string) Text description of the topic _Available in: v28.0_ * `idsToMerge` (query, array of string) List of up to five secondary topic IDs to merge with the primary topic If any of the secondary topics are navigational or featured topics, they lose their topic type, topic images, and children topics. Their feed items are reassigned to the primary topic. If you merge a topic with a content topic, the content associations are preserved. If you merge a topic with an inactive endorsee, the endorsement isn’t mapped to the primary topic. _Available in: v33.0_ * `name` (query, string) Name of the topic Use this property to change only the capitalization and spacing of the topic name. _Available in: v28.0_ #### Request body Topic input. _Available in: v28.0_ Media type: `application/json`. Schema: `TopicInput`. _Example: example\_1_ Payload 1 ``` { "description": "World Wide Web Consortium (W3C) is the main international standards organization for the web.", "name": "W3C" } ``` #### Responses * **200** _Topic_ Topic. Media type: `application/json`. Schema: `TopicSbi`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example uses request parameters to update the description of a topic: /connect/topics/0TOD000000006RxOAI?description=Edit+requests Content-Type: application/json { "description": "World Wide Web Consortium (W3C) is the main international standards organization for the web.", "name": "W3C" } ``` _Example: Example 2 · HTTP_ ``` # This example uses a JSON request body to make the same request: /connect/topics/0TOD000000006RxOAI { "description" : "Edit requests" } ``` ### GET Topic Files `GET /connect/topics/{topicId}/files` Operation ID: `getTopicFileCollection`. Tags: Topics Resources. Returns information about recent files tagged with a topic keyword. Returns information about the five files most recently posted to the specified topic. In version 28.0, use `/chatter/topics/{topicId}/files` #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/files` _Available in: v29.0_ #### Parameters * `topicId` (path, string (IdOrMe), required) ID of the topic. Pattern: ^(0TO)\\w\*|me. #### Responses * **200** _File Summary Page_ File summary page. Media type: `application/json`. Schema: `FileSummaryCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` # This GET request returns information about every file in the specified topic: /connect/topics/0TOD000000009Q2/files # The response is: { "currentPageUrl": null, "files": [{ "checksum": "a65b71bc6a31fa95dd0a9232c9f58c86", "contentSize": 100377, "contentUrl": null, "description": null, "downloadUrl": "/services/data/v67.0/connect/files/069D00000001E32IAE/content?versionNumber=1", "fileExtension": "png", "fileType": "Png", "flashRenditionStatus": "Na", "id": "069D00000001E32IAE", "isInMyFileSync": false, "mimeType": "image/png", "modifiedDate": "2012-07-17T21:47:27.000Z", "motif": { "color": "993333", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png" }, "mySubscription": { "id": "0E8D0000000T5JrKAK", "url": "/services/data/v67.0/chatter/subscriptions/0E8D0000000T5JrKAK" }, "name": "Recruitment Poster", "origin": "Chatter", "owner": { "companyName": "SeattleApps", "firstName": "Rene", "id": "005D0000001LFNnIAO", "isActive": true, "lastName": "Holmes", "motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile.png", "smallIconUrl": "/img/icon/profile.png" }, "mySubscription": null, "name": "Rene Holmes", "photo": { "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt", "largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F", "photoVersionId": "729D00000000BDV", "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T", "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_", "url": "/services/data/v67.0/chatter/users/005D0000001LL8OIAW/photo" }, "title": null, "type": "User", "url": "/services/data/v67.0/chatter/users/005D0000001LFNnIAO", "userType": "Internal" }, "parentFolder" : "null", "pdfRenditionStatus": "Na", "renditionUrl": "/services/data/v67.0/connect/files/069D00000001E32IAE/rendition", "thumb120By90RenditionStatus": "Success", "thumb240By180RenditionStatus": "Success", "thumb720By480RenditionStatus": "Success", "title": "Recruitment Poster", "type": "ContentDocument", "url": "/services/data/v67.0/connect/files/069D00000001E32IAE?versionNumber=1", "versionNumber": "1" }], "nextPageUrl": null, "previousPageUrl": null } ``` ### GET Related Topics `GET /connect/topics/{topicId}/related-topics` Operation ID: `getRelatedTopics`. Tags: Topics Resources. Returns information about topics that might be related through shared feed elements. Get up to five topics most closely related to a topic. Two topics that are assigned to the same feed item at least three times are related. In version 28.0, use `/chatter/topics/{topicId}/relatedtopics` #### Experience Cloud site path `/connect/communities/{communityId}/topics/{topicId}/related-topics` _Available in: v29.0_ #### Parameters * `topicId` (path, string (IdOrMe), required) ID of the topic. Pattern: ^(0TO)\\w\*|me. #### Responses * **200** _Topic Collection_ Topic collection. Media type: `application/json`. Schema: `TopicCollection`. ### GET OAuth Credentials by Consumer ID `GET /apps/oauth/credentials/{appIdentifier}/{oauthConsumerIdentifier}` Operation ID: `getAppOauthCredentials`. Tags: OAuth Credentials Resources. Resource for retrieving OAuth credentials for the given OAuth Consumer Get the OAuth key, secret, or both for a specific OAuth consumer by providing the consumer ID. OAuth consumer secrets must be kept secure. To access the secret for a consumer, include `secret` or `keyandsecret` as the value for the part parameter. _Available in: v60.0_ #### Parameters * `appIdentifier` (path, string (Id), required) Identifier of the app. Pattern: ^(0xI)\\w\*. * `oauthConsumerIdentifier` (path, string (Id), required) Identifier of the OAuth consumer. Pattern: ^(888)\\w\*. * `part` (query, string) Part of the credential to return. Values are `key` , `secret` , and `keyandsecret` . If this parameter is excluded from the request, then the key is provided in the response. The secret value is returned only when specified in this parameter. _Available in: v60.0_ #### Responses * **200** _App Oauth Credentials_ Represents the primary and staged credentials of a single OAuth consumer. Media type: `application/json`. Schema: `AppOauthCredentials`. ### GET OAuth Staged Credentials `GET /apps/oauth/credentials/{appIdentifier}/{oauthConsumerIdentifier}/staged` Operation ID: `getAppOauthStagedCredentialsCollection`. Tags: OAuth Credentials Resources. Resource for retrieving and creating staged credentials for the given app and OAuth consumer Get staged credentials for the given app and OAuth consumer. _Available in: v65.0_ The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. #### Parameters * `appIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. Pattern: ^(0xI)\\w\*. * `oauthConsumerIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. Pattern: ^(888)\\w\*. #### Responses * **200** _App Oauth Staged Credentials Collection_ List of OAuth consumer's staged credentials associated with the app. Media type: `application/json`. Schema: `AppOauthStagedCredentialsCollection`. ### POST OAuth Staged Credentials `POST /apps/oauth/credentials/{appIdentifier}/{oauthConsumerIdentifier}/staged` Operation ID: `postAppOauthStagedCredentialsCollection`. Tags: OAuth Credentials Resources. Resource for retrieving and creating staged credentials for the given app and OAuth consumer Create staged credentials for the given app and OAuth consumer. _Available in: v65.0_ The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. **Note**: POST doesn't take a request body and doesn't require request parameters. #### Parameters * `appIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. Pattern: ^(0xI)\\w\*. * `oauthConsumerIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. Pattern: ^(888)\\w\*. #### Responses * **200** _App Oauth Staged Credentials Collection_ List of OAuth consumer's staged credentials associated with the app. Media type: `application/json`. Schema: `AppOauthStagedCredentialsCollection`. ### GET OAuth Staged Credentials ID `GET /apps/oauth/credentials/{appIdentifier}/{oauthConsumerIdentifier}/staged/{stagedCredentialsIdentifier}` Operation ID: `getAppOauthStagedCredentials`. Tags: OAuth Credentials Resources. Resource for replacing OAuth consumer's primary credentials with staged credentials Add OAuth credentials as staged credentials, replace primary credentials with staged credentials, or delete staged credentials. _Available in: v65.0_ The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. #### Parameters * `appIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(0xI)\\w\*. * `oauthConsumerIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(888)\\w\*. * `stagedCredentialsIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(0ug)\\w\*. #### Responses * **200** _App Oauth Staged Credentials_ Information about an OAuth consumer's primary and staged credentials. Staged credentials are valid for 30 days unless they're deleted before then. Media type: `application/json`. Schema: `AppOauthStagedCredentials`. ### DELETE OAuth Staged Credentials ID `DELETE /apps/oauth/credentials/{appIdentifier}/{oauthConsumerIdentifier}/staged/{stagedCredentialsIdentifier}` Operation ID: `deleteAppOauthStagedCredentials`. Tags: OAuth Credentials Resources. Resource for replacing OAuth consumer's primary credentials with staged credentials Delete staged credentials. _Available in: v65.0_ The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. #### Parameters * `appIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(0xI)\\w\*. * `oauthConsumerIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(888)\\w\*. * `stagedCredentialsIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(0ug)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH OAuth Staged Credentials ID `PATCH /apps/oauth/credentials/{appIdentifier}/{oauthConsumerIdentifier}/staged/{stagedCredentialsIdentifier}` Operation ID: `patchAppOauthStagedCredentials`. Tags: OAuth Credentials Resources. Resource for replacing OAuth consumer's primary credentials with staged credentials Add OAuth credentials as staged credentials, replace primary credentials with staged credentials, or delete staged credentials. _Available in: v65.0_ The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. #### Parameters * `appIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(0xI)\\w\*. * `oauthConsumerIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(888)\\w\*. * `stagedCredentialsIdentifier` (path, string (Id), required) The `{externalClientAppIdentifier}` is the ID of the external client app, which can be retrieved from the [OAuth Usage](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Usage-Resources/operation/getAppOauthUsage) endpoint. The `{oauthConsumerIdentifier}` is the OAuth consumer ID, which can be retrieved by a call to the [OAuth Credentials by App ID](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthCredentialsCollection) endpoint. The `{stagedCredentialsIdentifier}` is the ID of the staged credentials, which can be retrieved by a call to the [OAuth Staged Credentials](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/OAuth-Credentials-Resources/operation/getAppOauthStagedCredentialsCollection) endpoint. Pattern: ^(0ug)\\w\*. #### Request body Request to rotate credentials with staged data. Media type: `application/json`. Schema: `StagedCredentialsInput`. _Example: example\_1_ Payload 1 ``` { "command": "rotate" } ``` #### Responses * **200** _App Oauth Staged Credentials_ Information about an OAuth consumer's primary and staged credentials. Staged credentials are valid for 30 days unless they're deleted before then. Media type: `application/json`. Schema: `AppOauthStagedCredentials`. ### GET OAuth Credentials by App ID `GET /apps/oauth/credentials/{externalClientAppIdentifier}` Operation ID: `getAppOauthCredentialsCollection`. Tags: OAuth Credentials Resources. Resource for retrieving OAuth credentials for the given app Get OAuth credentials for all OAuth consumers associated with a given app by providing the app ID. _Available in: v60.0_ #### Parameters * `externalClientAppIdentifier` (path, string, required) Identifier of the external client app. #### Responses * **200** _App OAuth Credentials Collection_ List of OAuth consumers associated with the external client app. Media type: `application/json`. Schema: `AppOauthCredentialsCollection`. ### GET OAuth Usage `GET /apps/oauth/usage` Operation ID: `getAppOauthUsage`. Tags: OAuth Usage Resources. Resource for fetching OAuth usage for the given app Get a list of external client apps that have OAuth usage data. _Available in: v59.0_ #### Parameters * `page` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. If you enter a page number that comes after the last page of items, an empty array is returned. _Available in: v59.0_ * `pageSize` (query, integer) Number of usage entries per page. Defaults to 100. _Available in: v59.0_ #### Responses * **200** _App OAuth Usage Collection_ OAuth usage information for a list of apps. Media type: `application/json`. Schema: `AppOauthUsageCollection`. ### DELETE OAuth Refresh Token `DELETE /apps/oauth/usage/tokens/{tokenIdentifier}` Operation ID: `deleteAppOauthUsageTokens`. Tags: OAuth Usage Resources. Resource for deleting the given refresh token Delete a refresh token by token identifier. The token identifier is included in the revocation URL field in the App OAuth Usage Token. _Available in: v59.0_ #### Parameters * `tokenIdentifier` (path, string, required) Identifier of the token. #### Responses * **204** _Successful Delete_ Success ### DELETE Refresh Token by App `DELETE /apps/oauth/usage/{appIdentifier}/tokens` Operation ID: `deleteAppOauthUsageAppTokens`. Tags: OAuth Usage Resources. Resource for deleting the refresh tokens of the given app Delete the refresh tokens of a given app. _Available in: v59.0_ #### Parameters * `appIdentifier` (path, string, required) Identifier of the app. #### Responses * **204** _Successful Delete_ Success ### GET OAuth Users by App ID `GET /apps/oauth/usage/{appIdentifier}/users` Operation ID: `getAppOauthUsageUsers`. Tags: OAuth Usage Resources. Resource for fetching a list of OAuth users for the given app Get a list of OAuth users for a given app. _Available in: v59.0_ #### Parameters * `appIdentifier` (path, string, required) Identifier of the app. * `page` (query, integer) Page number for the usage information. Defaults to 0. _Available in: v59.0_ * `pageSize` (query, integer) Number of usage entries per page. Defaults to 100. _Available in: v59.0_ #### Responses * **200** _App OAuth Usage User Collection_ List of OAuth app users. Media type: `application/json`. Schema: `AppOauthUsageUserCollection`. ### GET Refresh Token by User and App `GET /apps/oauth/usage/{externalClientAppIdentifier}/{userIdentifier}/tokens` Operation ID: `getAppOauthUsageUserTokens`. Tags: OAuth Usage Resources. Resource for the refresh tokens of the given user and app Get the refresh tokens of the given user and app. _Available in: v59.0_ #### Parameters * `userIdentifier` (path, string, required) Identifier of the user. * `externalClientAppIdentifier` (path, string, required) Identifier of the external client app. #### Responses * **200** _App OAuth Usage Token Collection_ A collection of tokens. Media type: `application/json`. Schema: `AppOauthUsageTokenCollection`. ### DELETE Refresh Token by User and App `DELETE /apps/oauth/usage/{externalClientAppIdentifier}/{userIdentifier}/tokens` Operation ID: `deleteAppOauthUsageUserTokens`. Tags: OAuth Usage Resources. Resource for the refresh tokens of the given user and app Delete the refresh tokens of the given user and app. _Available in: v59.0_ #### Parameters * `userIdentifier` (path, string, required) Identifier of the user. * `externalClientAppIdentifier` (path, string, required) Identifier of the external client app. #### Responses * **204** _Successful Delete_ Success ### GET Environment Hub My Domain Validation `GET /connect/environment-hub/my-domain-validation/{myDomainName}` Operation ID: `getMyDomainValidation`. Tags: Environment Hub Resources. Validates that the specified My Domain value is valid and unique. Validates that the specified My Domain name is available, valid, and unique. Your My Domain name determines the URLs used when you enable single sign-on or connect existing organizations to Environment Hub. _Available in: v36.0_ #### Parameters * `orgEdition` (query, string) The edition of the org to validate. Possible values are: * `Personal Edition` * `Contact Manager Edition` * `Team Edition` (for Group Edition) * `Professional Edition` * `Enterprise Edition` * `Unlimited Edition` * `Developer Edition` _Available in: v36.0_ * `templateId` (query, string) * `myDomainName` (path, string, required) The subdomain to use for My Domain. #### Responses * **200** _Environment Hub My Domain Validation_ Results from an attempt to validate a My Domain value. Media type: `application/json`. Schema: `EnvironmentHubMyDomainValidation`. ### GET Environment Hub OAuth URL Generator `GET /connect/environment-hub/oauth-url-generator/{username}` Operation ID: `getOAuthUrlGenerator`. Tags: Environment Hub Resources. Generates the URL used to initiate the OAuth connect org workflow. Generates the URL used to initiate the OAuth workflow that connects an org to the Environment Hub. _Available in: v36.0_ #### Parameters * `username` (path, string, required) The admin username for the org being connected to the Environment Hub. #### Responses * **200** _Environment Hub OAuth URL_ An OAuth URL that initiates the workflow to connect an org to an Environment Hub. Media type: `application/json`. Schema: `EnvironmentHubOAuthUrl`. ### GET Environment Hub Sign-up Member Validation `GET /connect/environment-hub/signup-member-validation/{username}` Operation ID: `getSignupMemberValidation`. Tags: Environment Hub Resources. Validates the input parameters used to initiate an org sign-up in the Environment Hub. Validates the input parameters used to initiate an org sign-up in the Environment Hub. _Available in: v36.0_ **Note:** You must specify at least one parameter when you make your request. You must specify at least one parameter when you make your request. #### Parameters * `username` (path, string, required) The admin username for the org being connected to the Environment Hub. * `edition` (query, string) The edition to validate. _Available in: v36.0_ * `templateId` (query, string) The template ID to validate. _Available in: v36.0_ #### Responses * **200** _Environment Hub Sign-up Member Validation_ The results from validation of the input parameters used to create an Environment Hub member org. Media type: `application/json`. Schema: `EnvironmentHubSignupMemberValidation`. ### POST Environment Hub SSO User Mapping Generator `POST /connect/environment-hub/sso-user-mappings/{hubMemberId}` Operation ID: `postSsoUserMapping`. Tags: Environment Hub Resources. Creates a SsoUserMapping for an Environment Hub user Creates an SSO mapping between an Environment Hub user and a user in a hub member org. An SSO user mapping lets the Environment Hub user log in as the mapped user in the member org without having to re-authenticate. User mappings can be many-to-one but not one-to-many. In other words, you can associate multiple users in the hub org with the same user in a member org. _Available in: v36.0_ #### Parameters * `hubMemberId` (path, string, required) ID of the hub member. * `hubUserId` (query, string, required) The ID of a user in an Environment Hub organization. _Available in: v36.0_ * `memberUsername` (query, string, required) The username of a user in an Environment Hub member organization. _Available in: v36.0_ #### Request body (required) Creates an SSO mapping between a user in an Environment Hub org and a user in an Environment Hub member org. _Available in: v36.0_ Media type: `application/json`. Schema: `SsoUserMappingInput`. #### Responses * **200** _Environment Hub SSO User Mapping Validation_ Results from validating a potential SSO user mapping between a user in an Environment Hub and a user in a hub member org. Media type: `application/json`. Schema: `SsoUserMapping`. #### Code samples _Example: Example 1 · HTTP_ ``` {   "hubUserId":"005B0000000F6SNIA0",   "memberUsername":"jeanSmith" } ``` ### GET Credential `GET /named-credentials/credential` Operation ID: `getCredential`. Tags: Named Credentials Resources. Resource to interact with Credential Get a credential. _Available in: v56.0_ #### Parameters * `externalCredential` (query, string, required) Fully qualified developer name of the external credential. _Available in: v56.0_ * `principalName` (query, string) Name of the external credential named principal. Required if `principalType` is `NamedPrincipal` _Available in: v56.0_ * `principalType` (query, CredentialPrincipalType, required) Type of credential principal. _Available in: v56.0_ #### Responses * **200** _Credential_ Credential. Media type: `application/json`. Schema: `Credential`. ### PUT Credential `PUT /named-credentials/credential` Operation ID: `putCredential`. Tags: Named Credentials Resources. Resource to interact with Credential Replace a credential. _Available in: v56.0_ #### Request body Credential input. Media type: `application/json`. Schema: `CredentialInput`. #### Responses * **200** _Credential_ Credential. Media type: `application/json`. Schema: `Credential`. #### Code samples _Example: Example 1 · HTTP_ ``` { externalCredential: "ecNameAws", authenticationProtocol: "AwsSv4", principalName: "principalA", principalType: "NamedPrincipal", credentials: { awsAccessKeyId: { value: "00000000000", encrypted: false }, awsSecretAccessKey: { value: "aws-secret-value", encrypted: true }, awsRoleArn: { value: "arn:partition:service:region:account-id:resource-id", encrypted: false } } } ``` _Example: Example 2 · HTTP_ ``` # In this example, assume the credential has two values: apiKey and apiSecret. # When this request body is used with PUT, apiKey is updated and apiSecret is # deleted. { authenticationProtocol: String : "Custom", externalCredential: String : "medicalIntegrationExternalCredential", principalName: String : "customerSupportGroup", principalType: String : "NamedPrincipal", // Map credentials: { apiKey: { value: String : "00000000", encrypted: Boolean : false } } } ``` _Example: Example 3 · HTTP_ ``` # PATCH is supported only for custom credentials. Only the credentials included # in the request body are updated. In this example, assume the credential has # two values: apiKey and apiSecret. When this request body is used with PATCH, # apiKey is updated and apiSecret remains the same. { authenticationProtocol: String : "Custom", externalCredential: String : "medicalIntegrationExternalCredential", principalName: String : "customerSupportGroup", principalType: String : "NamedPrincipal", // Map credentials: { apiKey: { value: String : "00000000", encrypted: Boolean : false } } } ``` ### POST Credential `POST /named-credentials/credential` Operation ID: `postCredential`. Tags: Named Credentials Resources. Resource to interact with Credential Create or refresh a credential. _Available in: v56.0_ #### Parameters * `action` (query, CreateCredentialAction) Action to take when creating the credential. Use this request parameter to refresh an OAuth or AWS Roles Anywhere credential. _Available in: v58.0_ #### Request body Credential input. _Available in: v58.0_ Media type: `application/json`. Schema: `CredentialInput`. #### Responses * **200** _Credential_ Credential. Media type: `application/json`. Schema: `Credential`. #### Code samples _Example: Example 1 · HTTP_ ``` { externalCredential: "ecNameAws", authenticationProtocol: "AwsSv4", principalName: "principalA", principalType: "NamedPrincipal", credentials: { awsAccessKeyId: { value: "00000000000", encrypted: false }, awsSecretAccessKey: { value: "aws-secret-value", encrypted: true }, awsRoleArn: { value: "arn:partition:service:region:account-id:resource-id", encrypted: false } } } ``` _Example: Example 2 · HTTP_ ``` # In this example, assume the credential has two values: apiKey and apiSecret. # When this request body is used with PUT, apiKey is updated and apiSecret is # deleted. { authenticationProtocol: String : "Custom", externalCredential: String : "medicalIntegrationExternalCredential", principalName: String : "customerSupportGroup", principalType: String : "NamedPrincipal", // Map credentials: { apiKey: { value: String : "00000000", encrypted: Boolean : false } } } ``` _Example: Example 3 · HTTP_ ``` # PATCH is supported only for custom credentials. Only the credentials included # in the request body are updated. In this example, assume the credential has # two values: apiKey and apiSecret. When this request body is used with PATCH, # apiKey is updated and apiSecret remains the same. { authenticationProtocol: String : "Custom", externalCredential: String : "medicalIntegrationExternalCredential", principalName: String : "customerSupportGroup", principalType: String : "NamedPrincipal", // Map credentials: { apiKey: { value: String : "00000000", encrypted: Boolean : false } } } ``` ### DELETE Credential `DELETE /named-credentials/credential` Operation ID: `deleteCredential`. Tags: Named Credentials Resources. Resource to interact with Credential Delete a credential. _Available in: v56.0_ #### Parameters * `authenticationParameters` (query, array of string) List of authentication parameters only for custom protocols, for example `myApiKey,myApiSecret`. If unspecified, all credentials are deleted. _Available in: v59.0_ * `externalCredential` (query, string, required) Fully qualified developer name of the external credential. _Available in: v56.0_ * `principalName` (query, string) Name of the external credential named principal. Required if `principalType` is `NamedPrincipal` _Available in: v56.0_ * `principalType` (query, CredentialPrincipalType, required) Type of credential principal. _Available in: v56.0_ #### Responses * **204** _Successful Delete_ Success ### PATCH Credential `PATCH /named-credentials/credential` Operation ID: `patchCredential`. Tags: Named Credentials Resources. Resource to interact with Credential Update a Credential. _Available in: v56.0_ **Note:** PATCH is supported in version 59.0 and later only for custom protocols. #### Request body Credential input. Media type: `application/json`. Schema: `CredentialInput`. #### Responses * **200** _Credential_ Credential. Media type: `application/json`. Schema: `Credential`. #### Code samples _Example: Example 1 · HTTP_ ``` { externalCredential: "ecNameAws", authenticationProtocol: "AwsSv4", principalName: "principalA", principalType: "NamedPrincipal", credentials: { awsAccessKeyId: { value: "00000000000", encrypted: false }, awsSecretAccessKey: { value: "aws-secret-value", encrypted: true }, awsRoleArn: { value: "arn:partition:service:region:account-id:resource-id", encrypted: false } } } ``` _Example: Example 2 · HTTP_ ``` # In this example, assume the credential has two values: apiKey and apiSecret. # When this request body is used with PUT, apiKey is updated and apiSecret is # deleted. { authenticationProtocol: String : "Custom", externalCredential: String : "medicalIntegrationExternalCredential", principalName: String : "customerSupportGroup", principalType: String : "NamedPrincipal", // Map credentials: { apiKey: { value: String : "00000000", encrypted: Boolean : false } } } ``` _Example: Example 3 · HTTP_ ``` # PATCH is supported only for custom credentials. Only the credentials included # in the request body are updated. In this example, assume the credential has # two values: apiKey and apiSecret. When this request body is used with PATCH, # apiKey is updated and apiSecret remains the same. { authenticationProtocol: String : "Custom", externalCredential: String : "medicalIntegrationExternalCredential", principalName: String : "customerSupportGroup", principalType: String : "NamedPrincipal", // Map credentials: { apiKey: { value: String : "00000000", encrypted: Boolean : false } } } ``` ### POST External Credential OAuth URL `POST /named-credentials/credential/auth-url/o-auth` Operation ID: `postOAuthCredentialAuthUrl`. Tags: Named Credentials Resources. Resource to get the OAuth authentication url for a User External Credential Get the URL for the OAuth token flow for an external credential. _Available in: v56.0_ **Note:** POST methods typically create an item, but for this resource POST is used to retrieve information. #### Request body OAuth authentication flow input. Media type: `application/json`. Schema: `OAuthCredentialAuthUrlInput`. _Example: example\_1_ Payload 1 ``` { "externalCredential": "salesforceOAuthExternalCredential", "principalName": "defaultNamedPrincipal", "principalType": "NamedPrincipal", "returnUrl": "lightning/setup/SetupOneHome/home" } ``` #### Responses * **200** _OAuth Credential Auth URL_ OAuth authentication URL for a credential. Media type: `application/json`. Schema: `OAuthCredentialAuthUrl`. ### GET External Auth Identity Provider Credentials `GET /named-credentials/external-auth-identity-provider-credentials/{fullName}` Operation ID: `getExternalAuthIdentityProviderCredentials`. Tags: Named Credentials Resources. Resource to view and manage External Auth Identity Provider Credentials Get external auth identity provider credentials. _Available in: v62.0_ #### Parameters * `fullName` (path, string, required) Fully qualified name of the resource. #### Responses * **200** _External Auth Identity Provider Credentials_ List of an external auth identity provider's credentials. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderCredentials`. ### PUT External Auth Identity Provider Credentials `PUT /named-credentials/external-auth-identity-provider-credentials/{fullName}` Operation ID: `putExternalAuthIdentityProviderCredentials`. Tags: Named Credentials Resources. Resource to view and manage External Auth Identity Provider Credentials Create and update external auth identity provider credentials. _Available in: v62.0_ #### Parameters * `fullName` (path, string, required) Fully qualified name of the resource. #### Request body External auth identity provider credentials input. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderCredentialsInput`. _Example: example\_1_ Payload 1 Creating (POST) or replacing (PUT) an external auth identity provider's credentials ``` { "credentials": [ { "credentialName": "clientId", "credentialValue": "SampleClientID" }, { "credentialName": "clientSecret", "credentialValue": "SampleClientSecret" } ] } ``` #### Responses * **200** _External Auth Identity Provider Credentials_ List of an external auth identity provider's credentials. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderCredentials`. ### POST External Auth Identity Provider Credentials `POST /named-credentials/external-auth-identity-provider-credentials/{fullName}` Operation ID: `postExternalAuthIdentityProviderCredentials`. Tags: Named Credentials Resources. Resource to view and manage External Auth Identity Provider Credentials Create external auth identity provider credentials. _Available in: v62.0_ #### Parameters * `fullName` (path, string, required) Fully qualified name of the resource. #### Request body External auth identity provider credentials input. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderCredentialsInput`. _Example example\_1: same as PUT /named-credentials/external-auth-identity-provider-credentials/{fullName} request._ Payload 1 Creating (POST) or replacing (PUT) an external auth identity provider's credentials _Example: example\_1_ Payload 1 Creating (POST) or replacing (PUT) an external auth identity provider's credentials #### Responses * **200** _External Auth Identity Provider Credentials_ List of an external auth identity provider's credentials. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderCredentials`. ### GET External Auth Identity Providers `GET /named-credentials/external-auth-identity-providers` Operation ID: `getExternalAuthIdentityProviderList`. Tags: Named Credentials Resources. Resource for External Auth Identity Provider creation and all records retrieval Get a list of external auth identity providers in the org. _Available in: v62.0_ #### Responses * **200** _External Auth Identity Provider List_ List of external auth identity providers. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderList`. ### POST External Auth Identity Providers `POST /named-credentials/external-auth-identity-providers` Operation ID: `postExternalAuthIdentityProviderList`. Tags: Named Credentials Resources. Resource for External Auth Identity Provider creation and all records retrieval Create an external auth identity provider. _Available in: v62.0_ #### Request body External auth identity provider input. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderInput`. _Example: example\_1_ Payload 1 ``` { "label": "ExternalIdp2", "fullName": "ExternalIdp2", "description": "OAuth Browser flow for connected app", "authenticationProtocol": "OAuth", "authenticationFlow": "AuthorizationCode", "clientAuthentication": "ClientSecretPost", "authorizeUrl": "https://identityprovider.com/services/oauth2/authorize", "tokenUrl": "https://identityprovider.com/services/oauth2/token", "userInfoUrl": "https://identityprovider.com/services/userinfo", "parameters": [ { "parameterName": "PkceEnabled", "parameterType": "IdentityProviderOptions", "parameterValue": "true" }, { "parameterName": "ExampleName", "parameterType": "AuthorizeRequestQueryParameter", "parameterValue": "ExampleValue", "sequenceNumber": 1 } ] } ``` #### Responses * **200** _External Auth Identity Provider_ External auth identity provider. Media type: `application/json`. Schema: `ExternalAuthIdentityProvider`. ### GET External Auth Identity Provider `GET /named-credentials/external-auth-identity-providers/{fullName}` Operation ID: `getExternalAuthIdentityProvider`. Tags: Named Credentials Resources. Resource to to view and manage an External Auth Identity Provider Get an external auth identity provider. _Available in: v62.0_ #### Parameters * `fullName` (path, string, required) Fully qualified name of the resource. #### Responses * **200** _External Auth Identity Provider_ External auth identity provider. Media type: `application/json`. Schema: `ExternalAuthIdentityProvider`. ### PUT External Auth Identity Provider `PUT /named-credentials/external-auth-identity-providers/{fullName}` Operation ID: `putExternalAuthIdentityProvider`. Tags: Named Credentials Resources. Resource to to view and manage an External Auth Identity Provider Update an external auth identity provider. _Available in: v62.0_ #### Parameters * `fullName` (path, string, required) Fully qualified name of the resource. #### Request body External auth identity provider input. Media type: `application/json`. Schema: `ExternalAuthIdentityProviderInput`. _Example example\_1: same as POST /named-credentials/external-auth-identity-providers request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _External Auth Identity Provider_ External auth identity provider. Media type: `application/json`. Schema: `ExternalAuthIdentityProvider`. ### DELETE External Auth Identity Provider `DELETE /named-credentials/external-auth-identity-providers/{fullName}` Operation ID: `deleteExternalAuthIdentityProvider`. Tags: Named Credentials Resources. Resource to to view and manage an External Auth Identity Provider Delete an external auth identity provider. _Available in: v62.0_ #### Parameters * `fullName` (path, string, required) Fully qualified name of the resource. #### Responses * **204** _Successful Delete_ Success ### GET External Credentials `GET /named-credentials/external-credentials` Operation ID: `getExternalCredentialList`. Tags: Named Credentials Resources. Resource to retrieve a list of external credentials the user can authenticate to Get external credentials that the user can authenticate to. _Available in: v56.0_ #### Responses * **200** _External Credential List_ List of external credentials. Media type: `application/json`. Schema: `ExternalCredentialList`. ### POST External Credentials `POST /named-credentials/external-credentials` Operation ID: `postExternalCredentialList`. Tags: Named Credentials Resources. Resource to retrieve a list of external credentials the user can authenticate to Create an external credential. _Available in: v58.0_ #### Request body Input used to create or update an external credential. Media type: `application/json`. Schema: `ExternalCredentialInput`. _Example: example\_1_ Payload 1 Creating an external credential (POST) ``` { "developerName": "SampleAws", "masterLabel": "SampleAwsLabel", "authenticationProtocol": "AwsSv4", "authenticationProtocolVariant": "AwsSv4_STS", "parameters": [ { "parameterName": "AwsService", "parameterType": "AuthParameter", "parameterValue": "dynamodb" }, { "parameterName": "AwsRegion", "parameterType": "AuthParameter", "parameterValue": "us-west-2" }, { "parameterName": "AwsAccountId", "parameterType": "AuthParameter", "parameterValue": "sampleAccountId" }, { "parameterName": "AwsStsExternalId", "parameterType": "AuthProviderUrlQueryParameter", "parameterValue": "sampleExternalId" }, { "parameterName": "AwsStsDuration", "parameterType": "AuthProviderUrlQueryParameter", "parameterValue": "1000" } ], "principals": [ { "principalName": "SamplePrincipal", "principalType": "NamedPrincipal", "sequenceNumber": 1 } ], "customHeaders": [ { "headerName": "SampleHeader", "headerValue": "SampleHeaderValue", "sequenceNumber": 1 } ] } ``` _Example: example\_2_ Payload 2 Updating an external credential (PUT) ``` { "developerName": "SampleOAuth", "masterLabel": "SampleOAuthLabel", "authenticationProtocol": "OAuth", "authenticationProtocolVariant": "JwtBearer", "parameters": [ { "id": "0puxxxxxxxxxxxxxxx", "parameterName": "SigningCertificate", "parameterType": "SigningCertificate", "parameterValue": "SampleCertificate" }, { "parameterName": "AuthProviderUrl", "parameterType": "AuthProviderUrl", "parameterValue": "www.identityprovider.com" }, { "parameterDescription": "Expiration Time", "parameterName": "exp", "parameterType": "JwtBodyClaim", "parameterValue": "{!Text(FLOOR((NOW() - DATETIMEVALUE( \"1970-01-01 00:00:00\" )) * 86400 + 120))}" }, { "parameterName": "Scope", "parameterType": "AuthParameter", "parameterValue": "SampleScope" } ], "principals": [ { "principalName": "SamplePerUserPrincipal", "principalType": "PerUserPrincipal", "sequenceNumber": 1, "parameters": [ { "parameterName": "Scope", "parameterType": "AuthParameter", "parameterValue": "SamplePrincipalGroupScope" } ] } ], "customHeaders": [ { "headerName": "SampleHeader", "headerValue": "SampleHeaderValue", "sequenceNumber": 1 } ] } ``` #### Responses * **200** _External Credential_ External credential, including the named credentials and principals associated with it and the type and status of each principal. Media type: `application/json`. Schema: `ExternalCredential`. ### GET External Credential `GET /named-credentials/external-credentials/{developerName}` Operation ID: `getExternalCredential`. Tags: Named Credentials Resources. Resource to retrieve information for a single external credential which includes the named credentials and principals associated with it and the type and authentication status of each principal Get an external credential, including the named credentials and principals associated with it and the type and status of each principal. _Available in: v56.0_ #### Parameters * `developerName` (path, string, required) Developer name of the resource. #### Responses * **200** _External Credential_ External credential, including the named credentials and principals associated with it and the type and status of each principal. Media type: `application/json`. Schema: `ExternalCredential`. ### PUT External Credential `PUT /named-credentials/external-credentials/{developerName}` Operation ID: `putExternalCredential`. Tags: Named Credentials Resources. Resource to retrieve information for a single external credential which includes the named credentials and principals associated with it and the type and authentication status of each principal Update an external credential. _Available in: v58.0_ #### Parameters * `developerName` (path, string, required) Developer name of the resource. #### Request body Input used to create or update an external credential. Media type: `application/json`. Schema: `ExternalCredentialInput`. _Example example\_1: same as POST /named-credentials/external-credentials request._ Payload 1 Creating an external credential (POST) _Example example\_2: same as POST /named-credentials/external-credentials request._ Payload 2 Updating an external credential (PUT) _Example: example\_1_ Payload 1 Creating an external credential (POST) _Example: example\_2_ Payload 2 Updating an external credential (PUT) #### Responses * **200** _External Credential_ External credential, including the named credentials and principals associated with it and the type and status of each principal. Media type: `application/json`. Schema: `ExternalCredential`. ### DELETE External Credential `DELETE /named-credentials/external-credentials/{developerName}` Operation ID: `deleteExternalCredential`. Tags: Named Credentials Resources. Resource to retrieve information for a single external credential which includes the named credentials and principals associated with it and the type and authentication status of each principal Delete an external credential. _Available in: v58.0_ #### Parameters * `developerName` (path, string, required) Developer name of the resource. #### Responses * **204** _Successful Delete_ Success ### GET Named Credentials `GET /named-credentials/named-credential-setup` Operation ID: `getNamedCredentialList`. Tags: Named Credentials Resources. Resource to retrieve a list of named credentials in the org Get a list of named credentials in the org. _Available in: v58.0_ #### Responses * **200** _Named Credential List_ List of named credentials. Media type: `application/json`. Schema: `NamedCredentialList`. ### POST Named Credentials `POST /named-credentials/named-credential-setup` Operation ID: `postNamedCredentialList`. Tags: Named Credentials Resources. Resource to retrieve a list of named credentials in the org Create a named credential. _Available in: v58.0_ #### Request body Input used to create or update a named credential. Media type: `application/json`. Schema: `NamedCredentialInput`. _Example: example\_1_ Payload 1 ``` { "developerName": "SamplePrivate", "masterLabel": "SamplePrivateLabel", "type": "PrivateEndpoint", "calloutUrl": "https://www.salesforce.com", "externalCredentials": [ { "developerName": "SampleAws" } ], "networkConnection": { "developerName": "SampleOutboundConnection" }, "customHeaders": [ { "headerName": "SampleHeader", "headerValue": "SampleValue", "sequenceNumber": 1 }, { "headerName": "SampleHeader2", "headerValue": "SampleValue2", "sequenceNumber": 2 } ], "calloutOptions": { "allowMergeFieldsInBody": false, "allowMergeFieldsInHeader": true, "generateAuthorizationHeader": true }, "parameters": [ { "parameterDescription": "This is a description", "parameterName": "NamespaceOne", "parameterType": "AllowedManagedPackageNamespaces", "parameterValue": "namespace1" }, { "parameterName": "NamespaceTwo", "parameterType": "AllowedManagedPackageNamespaces", "parameterValue": "namespace2" }, { "parameterName": "ClientCertificate", "parameterType": "ClientCertificate", "parameterValue": "SampleCertificate" } ] } ``` #### Responses * **200** _Named Credential_ Named credential associated with an external credential. Media type: `application/json`. Schema: `NamedCredential`. ### GET Named Credential `GET /named-credentials/named-credential-setup/{developerName}` Operation ID: `getNamedCredential`. Tags: Named Credentials Resources. Resource to interact with Named Credential Get a named credential. _Available in: v58.0_ #### Parameters * `developerName` (path, string, required) Developer name of the resource. #### Responses * **200** _Named Credential_ Named credential associated with an external credential. Media type: `application/json`. Schema: `NamedCredential`. ### PUT Named Credential `PUT /named-credentials/named-credential-setup/{developerName}` Operation ID: `putNamedCredential`. Tags: Named Credentials Resources. Resource to interact with Named Credential Update a named credential. _Available in: v58.0_ #### Parameters * `developerName` (path, string, required) Developer name of the resource. #### Request body Input used to create or update a named credential. Media type: `application/json`. Schema: `NamedCredentialInput`. _Example example\_1: same as POST /named-credentials/named-credential-setup request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Named Credential_ Named credential associated with an external credential. Media type: `application/json`. Schema: `NamedCredential`. ### DELETE Named Credential `DELETE /named-credentials/named-credential-setup/{developerName}` Operation ID: `deleteNamedCredential`. Tags: Named Credentials Resources. Resource to interact with Named Credential Delete a named credential. _Available in: v58.0_ #### Parameters * `developerName` (path, string, required) Developer name of the resource. #### 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 Network Connection Topologies, Inbound `GET /network-connection/inbound/connection-types/{connectionType}/topologies` Operation ID: `getInboundNetworkConnectionTopologies`. Tags: Private Connect Resources. Resource to get the inbound network connection region topologies Get the inbound network connection topologies for a connection type. _Available in: v49.0_ #### Parameters * `connectionType` (path, ExternalConnectionType, required) In version 49.0 and later, `AwsPrivateLink` is the only supported `{connectionType}`. * `regions` (query, array of string) Comma-separated list of regions. If unspecified, returns all the regions. For a list of supported regions, see [Considerations for Private Connect with AWS](https://help.salesforce.com/s/articleView?id=xcloud.private_connect_considerations.htm&type=5) in Salesforce Help. _Available in: v58.0_ * `scope` (query, ExternalConnectionTopologiesScope) Scope of the topologies. Values are: * `All` —List of regions with additional information, such as status and service name. * `Region` —List of regions. If a value isn’t specified, the default value is `All`. _Available in: v50.0_ #### Responses * **200** _Inbound Network Connection Topologies_ Inbound network connection topologies. Media type: `application/json`. Schema: `InboundNetworkConnectionTopologies`. #### Code samples _Example: Example 1 · HTTP_ ``` GET https://MyDomainName.my.salesforce.com/services/data/v67.0/network-connection/inbound/connection-types/AwsPrivateLink/topologies?regions=us-east-1,us-west-2&scope=ALL ``` ### POST Network Connection, Inbound `POST /network-connection/inbound/connections/{developerName}` Operation ID: `postInboundNetworkConnection`. Tags: Private Connect Resources. Resource to perform actions on the inbound network connection Provision, sync, or tear down the inbound network connection. _Available in: v49.0_ In version 49.0–50.0, the response is empty. In version 51.0 and later, the response body is Network Connection. #### Parameters * `developerName` (path, string, required) Developer name of the resource. * `action` (query, ExternalConnectionAction, required) Action to take on the network connection. _Available in: v49.0_ #### Responses * **200** _Network Connection_ External network connection. Media type: `application/json`. Schema: `NetworkConnection`. ### GET Network Connection Topologies, Outbound `GET /network-connection/outbound/connection-types/{connectionType}/topologies` Operation ID: `getOutboundNetworkConnectionTopologies`. Tags: Private Connect Resources. Resource to get the outbound network connection topologies Get the outbound network connection topologies for a connection type. _Available in: v49.0_ #### Parameters * `connectionType` (path, ExternalConnectionType, required) In version 49.0 and later, `AwsPrivateLink` is the only supported `{connectionType}`. * `regions` (query, array of string) Comma-separated list of regions. If unspecified, returns all the regions. For a list of supported regions, see [Considerations for Private Connect with AWS](https://help.salesforce.com/s/articleView?id=xcloud.private_connect_considerations.htm&type=5) in Salesforce Help. _Available in: v58.0_ * `scope` (query, ExternalConnectionTopologiesScope) Scope of the topologies. Values are: * `All` —List of regions with additional information, such as status and IAM role. * `Region` —List of regions. If a value isn’t specified, the default value is `All`. _Available in: v50.0_ #### Responses * **200** _Outbound Network Connection Topologies_ Outbound network connection topologies. Media type: `application/json`. Schema: `OutboundNetworkConnectionTopologies`. #### Code samples _Example: Example 1 · HTTP_ ``` GET https://MyDomainName.my.salesforce.com/services/data/v67.0/network-connection/outbound/connection-types/AwsPrivateLink/topologies?regions=us-east-1,us-west-2&scope=ALL ``` ### POST Network Connection, Outbound `POST /network-connection/outbound/connections/{developerName}` Operation ID: `postOutboundNetworkConnection`. Tags: Private Connect Resources. Resource to perform actions on the outbound network connection Provision, sync, or tear down the outbound network connection. _Available in: v49.0_ In version 49.0–50.0, the response is empty. In version 51.0 and later, the response body is Network Connection. #### Parameters * `developerName` (path, string, required) Developer name of the resource. * `action` (query, ExternalConnectionAction, required) Action to take on the network connection. _Available in: v49.0_ #### Responses * **200** _Network Connection_ External network connection. Media type: `application/json`. Schema: `NetworkConnection`. ### GET Duplicate Directory `GET /dedupe` Operation ID: `getDuplicateRootDirectory`. Tags: Duplicate Resources. Describes the URLs to the sub-resources available under /dedupe. Get a directory of the duplicate resources. _Available in: v42.0_ #### Responses * **200** _Duplicate Directory_ Duplicate directory. Media type: `application/json`. Schema: `DuplicateDirectory`. ### GET Duplicate Job Definitions `GET /dedupe/job-definitions` Operation ID: `getJobDefinitions`. Tags: Duplicate Resources. Resource for getting a collection of Job Definitions Get duplicate job definitions. _Available in: v42.0_ #### Responses * **200** _Duplicate Job Definition Collection_ A collection of job definitions. Media type: `application/json`. Schema: `DuplicateJobDefinitionCollection`. ### GET Duplicate Job Definition `GET /dedupe/job-definitions/{jobDefinitionId}` Operation ID: `getJobDefinition`. Tags: Duplicate Resources. Resource for Duplicate Job Definition Get a duplicate job definition. _Available in: v42.0_ #### Parameters * `jobDefinitionId` (path, string (Id), required) ID of the job definition. Pattern: ^(0PO)\\w\*. #### Responses * **200** _Duplicate Job Definition_ A duplicate job definition. Media type: `application/json`. Schema: `DuplicateJobDefinition`. ### GET Duplicate Jobs `GET /dedupe/jobs` Operation ID: `getJobs`. Tags: Duplicate Resources. Resource for creating a Job (i.e., running a Job) or returnning a collection of jobs Get duplicate jobs. _Available in: v42.0_ #### Responses * **200** _Duplicate Job Collection_ A collection of duplicate jobs. Media type: `application/json`. Schema: `DuplicateJobCollection`. ### POST Duplicate Jobs `POST /dedupe/jobs` Operation ID: `createJob`. Tags: Duplicate Resources. Resource for creating a Job (i.e., running a Job) or returnning a collection of jobs Run a job. _Available in: v42.0_ #### Request body Create a duplicate job. Media type: `application/json`. Schema: `DuplicateJobInput`. _Example: example\_1_ Payload 1 ``` { "duplicateJobDefId": "0POB0000004GUDXIA4" } ``` #### Responses * **200** _Duplicate Job_ A duplicate job. Media type: `application/json`. Schema: `DuplicateJob`. ### GET Duplicate Job `GET /dedupe/jobs/{jobId}` Operation ID: `getJob`. Tags: Duplicate Resources. Resource for Duplicate Job Get the status of a duplicate job. _Available in: v42.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(0PB)\\w\*. #### Responses * **200** _Duplicate Job_ A duplicate job. Media type: `application/json`. Schema: `DuplicateJob`. ### PATCH Duplicate Job `PATCH /dedupe/jobs/{jobId}` Operation ID: `updateJob`. Tags: Duplicate Resources. Resource for Duplicate Job Update the status of a duplicate job. _Available in: v42.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(0PB)\\w\*. #### Request body Update the duplicate job status. Media type: `application/json`. Schema: `DuplicateJobStatusInput`. _Example: example\_1_ Payload 1 ``` { "status": "Canceled" } ``` #### Responses * **200** _Duplicate Job_ A duplicate job. Media type: `application/json`. Schema: `DuplicateJob`. ### DELETE Duplicate Job Results `DELETE /dedupe/jobs/{jobId}/results` Operation ID: `deleteJobResults`. Tags: Duplicate Resources. Resource for deleting Duplicate Job results Delete duplicate job results. _Available in: v42.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(0PB)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Custom Domains `GET /connect/custom-domain/domains` Operation ID: `getCustomDomainCollection`. Tags: Custom Domain Resources. Resource for getting domains in the org and onboarding new domains Get a list of the custom domains for the org. A custom domain is a domain that you own, such as `https://www.example.com`, that serves content from your Experience Cloud sites or Salesforce Sites. _Available in: v60.0_ #### Responses * **200** _Custom Domain Collection_ List of custom domains for the org. A custom domain is a domain that you own, such as `https://www.example.com`, that serves content from your Experience Cloud sites or Salesforce Sites. Media type: `application/json`. Schema: `CustomDomainCollection`. ### GET Custom URLs for a Site or Store `GET /connect/custom-domain/domains/sites/{storeOrSiteId}/custom-urls` Operation ID: `getCustomDomainCustomUrlBySiteCollection`. Tags: Custom Domain Resources. Resource for getting Custom Urls associated with a site Get a list of custom URLs for a custom domain associated with a site or store. _Available in: v63.0_ #### Parameters * `storeOrSiteId` (path, string (Id), required) ID of the store or Experience Cloud site. Pattern: ^(0ZE|0DM)\\w\*. #### Responses * **200** _Custom Domain Custom URL Collection_ List of custom URLs for a custom domain. A custom URL consists of a domain, a custom path prefix, and a unique site path. For a domain to serve content from a site, at least one custom URL is required. Media type: `application/json`. Schema: `CustomDomainCustomUrlDetailCollection`. ### GET Domain Detail `GET /connect/custom-domain/domains/{domainId}` Operation ID: `getCustomDomain`. Tags: Custom Domain Resources. Resource for getting a single domain Get information about a custom domain. A custom domain is a domain that you own, such as `https://www.example.com`, that serves content from your Experience Cloud sites or Salesforce Sites. _Available in: v60.0_ #### Parameters * `domainId` (path, string (Id), required) ID of the custom domain. Pattern: ^(0I4)\\w\*. #### Responses * **200** _Custom Domain Detail_ Detailed description of a custom domain. Media type: `application/json`. Schema: `CustomDomainDetail`. ### GET Custom URLs for a Domain `GET /connect/custom-domain/domains/{domainId}/custom-urls` Operation ID: `getCustomDomainCustomUrlDetailCollection`. Tags: Custom Domain Resources. Resource for getting Custom Urls on a domain Get a list of custom URLs for a custom domain. For a domain to serve site content, at least one custom URL is required. _Available in: v62.0_ #### Parameters * `domainId` (path, string (Id), required) ID of the custom domain. Pattern: ^(0I4)\\w\*. #### Responses * **200** _Custom Domain Custom URL Collection_ List of custom URLs for a custom domain. A custom URL consists of a domain, a custom path prefix, and a unique site path. For a domain to serve content from a site, at least one custom URL is required. Media type: `application/json`. Schema: `CustomDomainCustomUrlDetailCollection`. ### GET Custom URL Detail `GET /connect/custom-domain/domains/{domainId}/custom-urls/{customUrlId}` Operation ID: `getCustomDomainCustomUrlDetail`. Tags: Custom Domain Resources. Resource for getting a specific customURl on a domain Get information about a custom URL. _Available in: v62.0_ #### Parameters * `customUrlId` (path, string (Id), required) ID of the custom URL. Pattern: ^(0Jf)\\w\*. * `domainId` (path, string (Id), required) ID of the custom domain. Pattern: ^(0I4)\\w\*. #### Responses * **200** _Custom URL Detail_ Detailed description of a custom URL. Media type: `application/json`. Schema: `CustomDomainCustomUrlDetail`. ### GET Custom Domain Pending Configuration `GET /connect/custom-domain/domains/{domainId}/pending-configuration` Operation ID: `getCustomDomainPendingConfiguration`. Tags: Custom Domain Resources. Resource for getting current domain status Get the pending configuration for a custom domain. _Available in: v66.0_ #### Parameters * `domainId` (path, string (Id), required) ID of the custom domain. Pattern: ^(0I4)\\w\*. #### Responses * **200** _Custom Domain Pending Configuration Detail_ Detailed description of the pending configuration for a custom domain. Media type: `application/json`. Schema: `CustomDomainPendingConfigurationOutput`. ### GET Custom Domain ID `GET /connect/custom-domain/domains/{domainName}/domainId` Operation ID: `getCustomDomainId`. Tags: Custom Domain Resources. Resource for getting domain Id attached to a domain name Get the ID for the custom domain associated with a domain name. _Available in: v63.0_ #### Parameters * `domainName` (path, string, required) Name of the domain. #### Responses * **200** _Custom Domain ID_ ID of the custom domain. Media type: `application/json`. Schema: `CustomDomainId`. ### GET Custom Domain Expected CDN CNAME `GET /connect/custom-domain/domains/{domainName}/expected-cdn-validation-cname` Operation ID: `getCustomDomainExpectedCdnValidationCName`. Tags: Custom Domain Resources. Resource for getting the CDN validation CName for domain ownership verification Get values for the canonical name (CNAME) record that’s required for custom domains that use the Salesforce CDN. _Available in: v63.0_ #### Parameters * `domainName` (path, string, required) Name of the domain. #### Responses * **200** _Custom Domain CNAME for the Salesforce CDN_ The canonical name (CNAME) that’s required for custom domains that use the Saleforce CDN. Media type: `application/json`. Schema: `CustomDomainExpectedCdnCName`. ### GET Custom Domain Expected CNAME `GET /connect/custom-domain/domains/{domainName}/expected-cname` Operation ID: `getCustomDomainExpectedCName`. Tags: Custom Domain Resources. Resource for getting the CName for domain ownership verification Get values for the canonical name (CNAME) record that’s used to verify ownership of a custom domain. _Available in: v63.0_ #### Parameters * `domainName` (path, string, required) Name of the domain. #### Responses * **200** _Custom Domain CNAME for Domain Verification_ The canonical name (CNAME) record that’s used to verify ownership of a custom domain. Media type: `application/json`. Schema: `CustomDomainExpectedCName`. ### GET Next Best Action, Reactions `GET /connect/recommendation-strategies/reactions` Operation ID: `getRecommendationReactions`. Tags: Next Best Action Resources. Record user reaction generated from previously presented recommendation Get and record user reactions to recommendations. _Available in: v45.0_ **Note:** Users with the Manage Next Best Action Recommendations or Modify All Data permission can get recommendation reactions. #### Parameters * `contextRecordId` (query, string) Use the ID of a context record to filter the results. _Available in: v45.0_ * `createdById` (query, string) Use the ID of the user who is indirectly reacting to the recommendation to filter the results. _Available in: v45.0_ * `onBehalfOfId` (query, string) Use the ID of the user or record that created the recommendation reaction to filter the results. _Available in: v45.0_ * `page` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v45.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25. _Available in: v45.0_ * `targetId` (query, string) Use the ID of the target to filter the results. _Available in: v45.0_ #### Responses * **200** _Recommendation Reaction Collection_ A list of recommendation reactions. Media type: `application/json`. Schema: `RecommendationReactionCollection`. ### POST Next Best Action, Reactions `POST /connect/recommendation-strategies/reactions` Operation ID: `setRecommendationReaction`. Tags: Next Best Action Resources. Record user reaction generated from previously presented recommendation Get and record user reactions to recommendations. _Available in: v45.0_ #### Request body A reaction to a recommendation produced by a recommendation strategy. Media type: `application/json`. Schema: `RecommendationReactionInput`. _Example: example\_1_ Payload 1 ``` { "contextRecordId": "500xx000000Ylnv", "onBehalfOfId": "001xx000003DGQW", "reactionType": "Accepted", "strategyName": "AcmeSupport", "targetActionName": "UpgradeService", "targetId": "0prxx00000000M7AAI" } ``` #### Responses * **200** _Recommendation Reaction_ Reaction to a recommendation produced by a recommendation strategy. Media type: `application/json`. Schema: `RecommendationReaction`. ### GET Next Best Action, Reaction `GET /connect/recommendation-strategies/reactions/{reactionId}` Operation ID: `getRecommendationReaction`. Tags: Next Best Action Resources. Expose recommendation reactions Get a recommendation reaction. _Available in: v45.0_ **Note:** Users with the Manage Next Best Action Recommendations or Modify All Data permission can get and delete recommendation reactions. #### Parameters * `reactionId` (path, string (Id), required) ID of the recommendation reaction or other sObject that caused the user to react. Pattern: ^(0ps)\\w\*. #### Responses * **200** _Recommendation Reaction_ Reaction to a recommendation produced by a recommendation strategy. Media type: `application/json`. Schema: `RecommendationReaction`. ### DELETE Next Best Action, Reaction `DELETE /connect/recommendation-strategies/reactions/{reactionId}` Operation ID: `deleteRecommendationReaction`. Tags: Next Best Action Resources. Expose recommendation reactions Delete a recommendation reaction. _Available in: v45.0_ **Note:** Users with the Manage Next Best Action Recommendations or Modify All Data permission can get and delete recommendation reactions. #### Parameters * `reactionId` (path, string (Id), required) ID of the recommendation reaction or other sObject that caused the user to react. Pattern: ^(0ps)\\w\*. #### Responses * **204** _Successful Delete_ Success ### POST Next Best Action, Strategy Recommendations `POST /connect/recommendation-strategies/{strategyName}/recommendations` Operation ID: `executeStrategy`. Tags: Next Best Action Resources. Provides execution endpoint for a named Recommendation Strategy Execute a strategy. _Available in: v45.0_ #### Parameters * `strategyName` (path, string, required) Name of the strategy. * `contextRecordId` (query, string) ID of the context record. For example, if the next best action is on a case detail page, the ID of the case. _Available in: v45.0_ * `debugTrace` (query, boolean) Specifies whether to return trace and debug information in the response (`true`) or not (`false`). If unspecified, the default is `false`. _Available in: v45.0_ * `maxResults` (query, integer) Maximum number of results. Valid values are from 1 to 25. The default is 3. _Available in: v45.0_ #### Request body A recommendation strategy. _Available in: v45.0_ Media type: `application/json`. Schema: `NBAStrategyInput`. _Example: example\_1_ Payload 1 ``` { "strategyContext": { "key1": "val1", "key2": "val2" }, "contextRecordId": "a0lB0000001G2nFIAS", "maxResults": 5 } ``` #### Responses * **200** _Next Best Action Recommendations_ Recommendations returned by a recommendation strategy. Media type: `application/json`. Schema: `NBARecommendations`. ### GET Next Best Action, Recommendation `GET /connect/recommendations/{recommendationId}` Operation ID: `getRecommendation`. Tags: Next Best Action Resources. Read Recommendation by Id Get a recommendation. _Available in: v45.0_ #### Parameters * `recommendationId` (path, string (Id), required) ID of the recommendation. Pattern: ^(0pr)\\w\*. #### Responses * **200** _Recommendation Object_ A Next Best Action recommendation object. Media type: `application/json`. Schema: `Recommendation`. ### POST Surveys Responses Using Invitation ID `POST /connect/surveys/{surveyId}/invitation/{surveyInvitationId}/survey-response` Operation ID: `startSurveyResponseBySurveyInvitationId`. Tags: Surveys Resources. This call is responsible to submit survey responses Initialize the process of submitting survey responses and return the details of the first page of the survey by making a POST request. **Note**: Salesforce Feedback Management (SFM) Business API performance can be impacted if a POST request exceeds 5,400 calls per minute and if a PATCH request exceeds 2,700 calls per minute at the org level. For more rate limit information, see [Connect REST API Limits](/docs/platform/connect-rest-api/guide/intro_rate_limits). _Available in: v56.0_ **Note**: The HTTP header request format only accepts `Content-Type: application/json`. #### Special Access Rules The Feedback Management - Starter and Feedback Management - Growth licenses are required to use this resource. #### Parameters * `surveyId` (path, string (Id), required) Unique ID used to represent a Survey. * `surveyInvitationId` (path, string (Id), required) Unique ID used to represent Survey Invitation. #### Request body Input representation of the details of the survey recipient and their engagement context, and the language, related records, and invitation settings of the survey. Media type: `application/json`. Schema: `SurveyDescriptionInput`. _Example: example\_1_ Payload 1 ``` { "languageCode": "", "relatedRecordIds": [ "500xx000000bo3dAAA" ], "recipientEngagementContext": { "test_key1": "test_value1", "test_key2": "test_value1" } } ``` #### Responses * **200** _Survey Description Output_ Output representation of the response to the Start Survey request. Media type: `application/json`. Schema: `SurveyDescriptionOutput`. _Example: example\_1_ Payload 1 ``` { "languageCode": "en", "invitationId": "0Kixx0000004MWaCAM", "flowInterviewState": "state1", "status": "Success", "isPartiallyCmplSurveyLoaded": false, "surveyDetail": { "label": "Survey01", "name": "Survey01", "surveyPage": { "label": "Page 1", "name": "p_d84afb73_3a30_4a3f_aae7_b0478b3bb4ed", "surveyQuestions": [ { "name": "q_856a997e_be2c_4ea3_b70d_7f6fb9cfbf4f", "label": "Good so Far !", "questionType": "ShortText", "responseDataType": "STRING", "isResponseRequired": false } ] } }, "navigationActions": [ "Next" ], "responseId": "0Myxx0000004CYqCAM", "errors": [], "warnings": [] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/invitation/0Kixx0000004EsOCAU/survey-response Content-Type: application/json { "languageCode": "", "relatedRecordIds": [ "500xx000000bo3dAAA" ], "recipientEngagementContext": { "test_key1": "test_value1", "test_key2": "test_value1" } } ``` ### PATCH Surveys Responses Using Invitation ID `PATCH /connect/surveys/{surveyId}/invitation/{surveyInvitationId}/survey-response` Operation ID: `submitSurveyResponseBySurveyInvitationId`. Tags: Surveys Resources. This call is responsible to submit survey responses Submit the survey responses using the PATCH request. **Note**: Salesforce Feedback Management (SFM) Business API performance can be impacted if a POST request exceeds 5,400 calls per minute and if a PATCH request exceeds 2,700 calls per minute at the org level. For more rate limit information, see [Connect REST API Limits](/docs/platform/connect-rest-api/guide/intro_rate_limits). _Available in: v56.0_ **Note**: The HTTP header request format only accepts `Content-Type: application/json`. #### Special Access Rules The Feedback Management - Starter and Feedback Management - Growth licenses are required to use this resource. #### Parameters * `surveyId` (path, string (Id), required) Unique ID used to represent a Survey. * `surveyInvitationId` (path, string (Id), required) Unique ID used to represent Survey Invitation. #### Request body Input representation of the details of a survey response. Media type: `application/json`. Schema: `SurveyResponseInput`. _Example: example\_1_ Payload 1 Here’s an example for multiple questions. ``` { "invitationId": "0Kixx0000004DbMCAU", "languageCode": "en", "flowInterviewState": "ewqJgw", "navigationAction": "Next", "surveyPageResponses": { "name": "p_ff794819_c0f0_4e0d_b357_29ca1694cfc4", "questionResponses": [ { "name": "q_d217f330_05a6_4e2b_859b_1f1ef210bf84", "questionType": "NPS", "responseValue": 5 }, { "name": "q_ab781617_3665_4a41_b4ff_f236d73ecb30", "questionType": "FreeText", "responseValue": "Free Text Question Response" }, { "name": "q_b1cdfe4c_9c7d_4c2f_ad9d_1915d301d780", "questionType": "ShortText", "responseValue": "Short Text Question Response" }, { "name": "q_f84a6a3c_683c_4ed5_864e_5b486baed308", "questionType": "Boolean", "responses": [ { "name": "choice1" } ] }, { "name": "q_113419b1_5d29_4bb9_8b10_e3fe324ae040", "questionType": "MultiChoice", "responses": [ { "name": "c_9775c2e5_9086_44a8_a5c9_89fdc886c99a" }, { "name": "c_0f1f63cc_608a_4560_9d29_72b203f195f2" } ] }, { "name": "q_1d8690a9_ae95_4e7c_86be_b8057205facc", "questionType": "RadioButton", "responses": [ { "name": "c_4867edc8_e9a6_4e86_9fea_b80758e90caf" } ] }, { "name": "q_8946f212_25ff_43a8_a507_d267637eee1f", "questionType": "Rating", "responses": [ { "name": "c_f51c509a_9643_4a05_89f1_42464de618a6" } ] } ] } } ``` _Example: example\_2_ Payload 2 Here’s an example for a single question. ``` { "invitationId": "0Kixx0000004EdsCAE", "languageCode": "en", "navigationAction": "Next", "surveyPageResponses": { "questionResponses": [ { "name": "q_3e501184_bb93_4a9c_a66b_6f2d81c92316", "questionType": "FreeText", "responseValue": "Answer for text question" } ] }, "flowInterviewState": "eg" } ``` #### Responses * **200** _Survey Response Output_ Output representation of the response to the Submit Survey request. The response includes the status of the survey response API and the Thank You page details in the survey. Media type: `application/json`. Schema: `SurveyResponseOutput`. _Example: example\_1_ Payload 1 ``` { "languageCode": "en", "invitationId": "0Kixx0000004MWaCAM", "flowInterviewState": "state1", "status": "Success", "surveyPage": { "label": "Page 1", "name": "p_d84afb73_3a30_4a3f_aae7_b0478b3bb4ed", "surveyQuestions": [ { "name": "q_856a997e_be2c_4ea3_b70d_7f6fb9cfbf4f", "label": "Good so Far !", "questionType": "ShortText", "responseDataType": "STRING", "isResponseRequired": false } ] }, "navigationActions": [ "Next", "Back" ], "responseId": "0Myxx0000004CYqCAM", "errors": [] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/invitation/0Kixx0000004EsOCAU/survey-response Content-Type: application/json { "invitationId": "0Kixx0000004DbMCAU", "languageCode": "en", "flowInterviewState": "ewqJgw", "navigationAction": "Next", "surveyPageResponses": { "name": "p_ff794819_c0f0_4e0d_b357_29ca1694cfc4", "questionResponses": [ { "name": "q_d217f330_05a6_4e2b_859b_1f1ef210bf84", "questionType": "NPS", "responseValue": 5 }, { "name": "q_ab781617_3665_4a41_b4ff_f236d73ecb30", "questionType": "FreeText", "responseValue": "Free Text Question Response" }, { "name": "q_b1cdfe4c_9c7d_4c2f_ad9d_1915d301d780", "questionType": "ShortText", "responseValue": "Short Text Question Response" }, { "name": "q_f84a6a3c_683c_4ed5_864e_5b486baed308", "questionType": "Boolean", "responses": [ { "name": "choice1" } ] }, { "name": "q_113419b1_5d29_4bb9_8b10_e3fe324ae040", "questionType": "MultiChoice", "responses": [ { "name": "c_9775c2e5_9086_44a8_a5c9_89fdc886c99a" }, { "name": "c_0f1f63cc_608a_4560_9d29_72b203f195f2" } ] }, { "name": "q_1d8690a9_ae95_4e7c_86be_b8057205facc", "questionType": "RadioButton", "responses": [ { "name": "c_4867edc8_e9a6_4e86_9fea_b80758e90caf" } ] }, { "name": "q_8946f212_25ff_43a8_a507_d267637eee1f", "questionType": "Rating", "responses": [ { "name": "c_f51c509a_9643_4a05_89f1_42464de618a6" } ] } ] } } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/invitation/0Kixx0000004EsOCAU/survey-response Content-Type: application/json { "invitationId": "0Kixx0000004EdsCAE", "languageCode": "en", "navigationAction": "Next", "surveyPageResponses": { "questionResponses": [ { "name": "q_3e501184_bb93_4a9c_a66b_6f2d81c92316", "questionType": "FreeText", "responseValue": "Answer for text question" } ] }, "flowInterviewState": "eg" } ``` ### POST Salesforce Surveys Invitation Emails `POST /connect/surveys/{surveyId}/survey-invitation-emails` Operation ID: `sendSurveyInvitationEmail`. Tags: Surveys Resources. This call is responsible for generating and distributing survey invitations to emails. Email survey invitations to up to 300 participants. You can email leads, contacts, or users in your org. Either a link to launch the survey or a question can be embedded in the email invitations. _Available in: v50.0_ #### Parameters * `surveyId` (path, string (Id), required) Unique ID used to represent a Survey. #### Request body Survey email. Media type: `application/json`. Schema: `SurveyEmailInput`. _Example: example\_1_ Payload 1 ``` { "recipients": [ "003x0000003j8CEAAY" ], "collectAnonymousResponse": false, "allowParticipantsAccessTheirResponse": false, "allowGuestUserResponse": true, "isPersonalInvitation": true, "emailTemplateId": "00Xx0000000LwAuEAK", "surveyQuestionIds": [ "0Kux000000003yBCAQ" ], "invitationExpirationDate": "2020-07-31T21:32:54", "fromEmailAddress": "abeeram@salesforce.com", "invitationOwner": "0054V00000FZTjJ", "shareInvitationsWith": [ "0054V00000FZTjJ" ], "associateRecordsWithRecipients": [ { "recipientId": "003x0000003j8CEAAY", "associateRecordIds": [ "001x0000004EWIZAA4" ] } ], "recipientEngagementContexts": [ { "recipientId": "003x0000003j8CEAAY", "recipientEngagementContext": { "TestKey": "TestValue" } } ] } ``` #### Responses * **200** _Survey Email_ Survey invitation email response. Media type: `application/json`. Schema: `SurveyEmail`. ### POST Survey Responses Using Invitation Configurations `POST /connect/surveys/{surveyId}/survey-response` Operation ID: `startSurveyResponse`. Tags: Surveys Resources. This call is responsible to submit survey responses Create responses using the invitation configuration details and initiate the process of submitting the survey responses by making a POST request. **Note**: Salesforce Feedback Management (SFM) Business API performance can be impacted if a POST request exceeds 5,400 calls per minute and if a PATCH request exceeds 2,700 calls per minute at the org level. For more rate limit information, see [Connect REST API Limits](/docs/platform/connect-rest-api/guide/intro_rate_limits). _Available in: v56.0_ **Note**: The HTTP header request format only accepts `Content-Type: application/json`. #### Special Access Rules The Feedback Management - Starter and Feedback Management - Growth licenses are required to use this resource. #### Parameters * `surveyId` (path, string (Id), required) Unique ID used to represent a Survey. #### Request body Input representation of the details of the survey recipient and their engagement context, and the language, related records, and invitation settings of the survey. Media type: `application/json`. Schema: `SurveyDescriptionInput`. _Example: example\_1_ Payload 1 ``` { "languageCode": "", "relatedRecordIds": [ "500xx000000bo3dAAA" ], "recipientEngagementContext": { "test_key1": "test_value1", "test_key2": "test_value1" }, "invitationSettings": { "recipientId": "005xx000001X7ibAAC", "allowGuestUserResponse": false, "allowParticipantsAccessTheirResponse": false, "collectAnonymousResponse": false, "invitationExpirationDate": "2022-07-31T21:32:54", "communityId": "", "invitationOwner": "" } } ``` #### Responses * **200** _Survey Description Output_ Output representation of the response to the Start Survey request. Media type: `application/json`. Schema: `SurveyDescriptionOutput`. _Example example\_1: same as POST /connect/surveys/{surveyId}/invitation/{surveyInvitationId}/survey-response 200 response._ Payload 1 _Example: example\_1_ Payload 1 #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/survey-response Content-Type: application/json { "languageCode": "", "relatedRecordIds": [ "500xx000000bo3dAAA" ], "recipientEngagementContext": { "test_key1": "test_value1", "test_key2": "test_value1" }, "invitationSettings": { "recipientId": "005xx000001X7ibAAC", "allowGuestUserResponse": false, "allowParticipantsAccessTheirResponse": false, "collectAnonymousResponse": false, "invitationExpirationDate": "2022-07-31T21:32:54", "communityId": "", "invitationOwner": "" } } ``` ### PATCH Survey Responses Using Invitation Configurations `PATCH /connect/surveys/{surveyId}/survey-response` Operation ID: `submitSurveyResponse`. Tags: Surveys Resources. This call is responsible to submit survey responses Submit the survey responses using the PATCH request. **Note**: Salesforce Feedback Management (SFM) Business API performance can be impacted if a POST request exceeds 5,400 calls per minute and if a PATCH request exceeds 2,700 calls per minute at the org level. For more rate limit information, see [Connect REST API Limits](/docs/platform/connect-rest-api/guide/intro_rate_limits). _Available in: v56.0_ **Note**: The HTTP header request format only accepts `Content-Type: application/json`. #### Special Access Rules The Feedback Management - Starter and Feedback Management - Growth licenses are required to use this resource. #### Parameters * `surveyId` (path, string (Id), required) Unique ID used to represent a Survey. #### Request body Input representation of the details of a survey response. Media type: `application/json`. Schema: `SurveyResponseInput`. _Example example\_1: same as PATCH /connect/surveys/{surveyId}/invitation/{surveyInvitationId}/survey-response request._ Payload 1 Here’s an example for multiple questions. _Example example\_2: same as PATCH /connect/surveys/{surveyId}/invitation/{surveyInvitationId}/survey-response request._ Payload 2 Here’s an example for a single question. _Example: example\_1_ Payload 1 Here’s an example for multiple questions. _Example: example\_2_ Payload 2 Here’s an example for a single question. #### Responses * **200** _Survey Response Output_ Output representation of the response to the Submit Survey request. The response includes the status of the survey response API and the Thank You page details in the survey. Media type: `application/json`. Schema: `SurveyResponseOutput`. _Example example\_1: same as PATCH /connect/surveys/{surveyId}/invitation/{surveyInvitationId}/survey-response 200 response._ Payload 1 _Example: example\_1_ Payload 1 #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/survey-response Content-Type: application/json { "invitationId": "0Kixx0000004DbMCAU", "languageCode": "en", "flowInterviewState": "ewqJgw", "navigationAction": "Next", "surveyPageResponses": { "name": "p_ff794819_c0f0_4e0d_b357_29ca1694cfc4", "questionResponses": [ { "name": "q_d217f330_05a6_4e2b_859b_1f1ef210bf84", "questionType": "NPS", "responseValue": 5 }, { "name": "q_ab781617_3665_4a41_b4ff_f236d73ecb30", "questionType": "FreeText", "responseValue": "Free Text Question Response" }, { "name": "q_b1cdfe4c_9c7d_4c2f_ad9d_1915d301d780", "questionType": "ShortText", "responseValue": "Short Text Question Response" }, { "name": "q_f84a6a3c_683c_4ed5_864e_5b486baed308", "questionType": "Boolean", "responses": [ { "name": "choice1" } ] }, { "name": "q_113419b1_5d29_4bb9_8b10_e3fe324ae040", "questionType": "MultiChoice", "responses": [ { "name": "c_9775c2e5_9086_44a8_a5c9_89fdc886c99a" }, { "name": "c_0f1f63cc_608a_4560_9d29_72b203f195f2" } ] }, { "name": "q_1d8690a9_ae95_4e7c_86be_b8057205facc", "questionType": "RadioButton", "responses": [ { "name": "c_4867edc8_e9a6_4e86_9fea_b80758e90caf" } ] }, { "name": "q_8946f212_25ff_43a8_a507_d267637eee1f", "questionType": "Rating", "responses": [ { "name": "c_f51c509a_9643_4a05_89f1_42464de618a6" } ] } ] } } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/survey-response Content-Type: application/json { "invitationId": "0Kixx0000004EdsCAE", "languageCode": "en", "navigationAction": "Next", "surveyPageResponses": { "questionResponses": [ { "name": "q_3e501184_bb93_4a9c_a66b_6f2d81c92316", "questionType": "FreeText", "responseValue": "Answer for text question" } ] }, "flowInterviewState": "eg" } ``` ### GET Connect `GET /connect` Operation ID: `getConnectRootDirectory`. Tags: Connect Resources. Describes the URLs to the sub-resources available under /connect. A directory of the org and Experience Cloud site resources available to the context user. _Available in: v24.0_ #### Responses * **200** _Connect Directory_ Connect directory. Media type: `application/json`. Schema: `ConnectDirectory`. ### POST Batch `POST /connect/batch` Operation ID: `postGenericBatch`. Tags: Batch Resources. Create a request body with a batch of up to 25 requests and send them to the server in a single request. The response bodies and HTTP statuses for every request in the batch are returned within a single response body. Use this resource to minimize the number of round-trips between the client and the server. For example, in a mobile app, when a user taps on the like button, the response body includes information about the like, but it doesn’t include the total number of likes on the feed item. To like the feed item, POST a request to /chatter/feed-items/feedItemId/likes. To get the like total, GET the feed item information from /chatter/feed-items/feedItemId. Add both requests to a Batch Input request body and send them both in a single POST request to /connect/batch.The requests in a batch are called sub-requests. Sub-requests are independent and information can’t be passed between them. Sub-requests execute serially in their order in the request body. When a sub-request executes successfully, it commits its data. Commits are reflected in the output of later sub-requests (as in the previous example which liked a feed-item then got the total number of likes). If haltOnError is true and a sub-request returns an HTTP status code in the 400 or 500 range, subsequent sub-requests are not executed. A halted batch request returns an HTTP 412 status code and a BATCH\_PROCESSING\_HALTED error message. To upload binary files, specify the name of the binary part in the richInput of the request body. Create a request body with a batch of up to 25 subrequests and send them to the server in a single request to improve your application’s performance. The response bodies and HTTP statuses for each subrequest in the batch are returned within a single response body. Each subrequest counts against rate limits. Use this resource to minimize the number of round-trips between the client and the server. For example, in a mobile app, when a user taps the button to like a feed item, the response body includes information about the like, but it doesn’t include the total number of likes on the feed item. To like the feed item, POST a request to `/chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`. To get the like total, GET the feed item information from `/chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`. Add both requests to a Generic Batch Collection Input request body and send them both in a single POST request to `/connect/batch`. The requests in a batch are called subrequests. All subrequests are executed in the context of the same user. Subrequests are independent and information can’t be passed between them. Subrequests execute serially in their order in the request body. When a subrequest executes successfully, it commits its data. Commits are reflected in the output of later subrequests (as in the previous example which liked a feed item then got the total number of likes). If a subrequest fails, commits made by previous subrequests are not rolled back. _Available in: v28.0_ #### Request body Generic batch collection input. Media type: `application/json`. Schema: `object`. * `batchRequests` (_array of GenericBatchRequestInput_) Collection of Batch Request Input request bodies containing the subrequest URLs to execute. _Available in: v28.0_ * `haltOnError` (_boolean_) Controls whether Salesforce stops processing subrequests if a subrequest fails. The default value is `false` . If the value is `false` and a subrequest in the batch does not complete, Salesforce attempts to execute subsequent subrequests in the batch. If the value is `true` and a subrequest in the batch doesn’t complete due to an HTTP response in the 400 or 500 range, Salesforce halts execution. It doesn’t attempt to execute subsequent subrequests in the batch. It returns an HTTP 412 status code and a `BATCH_PROCESSING_HALTED` error message for each subsequent subrequest indicating that a previous request was unsuccessful. The top-level request to `/connect/batch` returns HTTP 200, and the `hasErrors` property in the response is set to `true`. Before subrequests are executed, Salesforce verifies that the entire request, including subrequests, is formed properly. If it isn't, Salesforce returns an HTTP 400 Bad Request and doesn't execute subrequests, regardless of the value of `haltOnError`. Examples of a bad request are a subrequest using the wrong method or having an error in its URL. _Available in: v28.0_ _Example: example\_1_ Payload 1 ``` { "batchRequests": [ { "method": "Get", "url": "/v/chatter/feeds/news/me" }, { "method": "Get", "url": "/v/chatter/feeds/user-profile/me" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `Batch`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example is a POST request made to # `https://{instance_name}/services/data/v67.0/connect/batch` that includes the # following request body containing two subrequests: { "batchRequests": [ { "method": "Get", "url": "/v/chatter/feeds/user-profile/me" }, { "method": "Get", "url": "/v/chatter/feeds/news/me" } ] } ``` ### GET Batch Motifs `GET /connect/motifs/batch/{idOrPrefixList}` Operation ID: `getMotifBatch`. Tags: Motifs Resources. Returns URLs for sets of small, medium, and large motif icons for a set of objectsor object types. Returns a set of small, medium, and large motif icons for the specified records. Can also contain the base color for each specified record. #### Experience Cloud site path `/connect/communities/{communityId}/motifs/batch/{idOrPrefixList}` _Available in: v27.0_ #### Parameters * `idOrPrefixList` (path, array of string (IdOrPrefix), required) Specify a comma-separated list of IDs and key prefixes for `idOrPrefixList`. You can mix IDs and key prefixes in the same request. #### Responses * **200** _Batch Results_ Batch results. Media type: `application/json`. Schema: `Batch`. #### Code samples _Example: Example 1 · HTTP_ ``` # Request for motifs for a user and a file: # `/connect/motifs/batch/005D0000001LLO1,069D00000001FHF` # # Response: {"results": [ { "result": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png" }, "statusCode": 200 }, { "result": { "color": "993333", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png" }, "statusCode": 200 } ]} ``` ### GET Motifs `GET /connect/motifs/{idOrPrefix}` Operation ID: `getMotif`. Tags: Motifs Resources. Returns URLs for sets of small, medium, and large motif icons. Records have different sets of motif icons depending on the record type. Returns a set of small, medium, and large motif icons for the specified record. Can also return the base color for the specified record. #### Experience Cloud site path `/connect/communities/{communityId}/motifs/{idOrPrefix}` _Available in: v27.0_ #### Parameters * `idOrPrefix` (path, string (IdOrPrefix), required) Specify either an ID or key prefix for `idOrPrefix`. #### Responses * **200** _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`. Media type: `application/json`. Schema: `Motif`. #### Code samples _Example: Example 1 · HTTP_ ``` # Request for user motifs: `/connect/motifs/005D0000001LLO1` # # Response: { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png" } ``` ### GET Organization `GET /connect/organization` Operation ID: `getSettings`. Tags: Connect Resources. Information about the current user’s organization, features, and user settings. Information about the context user’s org and settings. _Available in: v24.0_ #### Responses * **200** _Organization_ An org. Media type: `application/json`. Schema: `Organization`. ### GET List of Zones `GET /connect/communities/{communityId}/zones` Operation ID: `getZoneCollectionZones`. Tags: ⚠️ Deprecated. **Deprecated**. Returns information about the zones that are available to the context user. A list of Chatter Answers zones in the organization. Get information about zones available to the context user. **Note**: With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see [End of Support for Chatter Answers in Spring ’18](https://help.salesforce.com/apex/HTViewSolution?urlname=Chatter-Answers-to-Retire-in-Spring-18). _Available in: v29.0_ #### Alternate paths * `/connect/communities/{communityId}/zones/` - Community Scope #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v29.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 250. The default value is 25. _Available in: v29.0_ #### Responses * **200** _Zone Page_ A page of Chatter Answers zones. Media type: `application/json`. Schema: `ZoneCollection`. ### GET Quick Text `GET /connect/quicktextbody` Operation ID: `getQuickTextBody`. Tags: Quick Text Resources. get quick text body Get the body of a quick text. _Available in: v50.0_ #### Parameters * `channel` (query, string) Where the message body was created. Values are: * `Email` * `Event` * `Generic` * `Internal` * `Knowledge` * `Live Agent` * `Messaging` * `Phone` * `Portal` * `Social` * `Task` _Available in: v50.0_ * `launchSource` (query, string) How the user started the quick text. Values are: * `Floater` * `Keyboard shortcut` * `Macro` * `Toolbar` _Available in: v50.0_ * `quickTextContext` (query, ConnectQuickTextContextEnum) Context of the quick text. _Available in: v50.0_ * `quickTextId` (query, string, required) ID of the quick text. _Available in: v50.0_ * `quickTextMessage` (query, string) Content of the original text template before quick text is merged into it. _Available in: v50.0_ * `whatId` (query, string, required) ID of a nonhuman object, such as an account or case. _Available in: v50.0_ * `whoId` (query, string, required) ID of a human object, such as a lead or contact. _Available in: v50.0_ #### Responses * **200** _Quick Text Preview Body_ Body of a preview quick text. Media type: `application/json`. Schema: `QuickTextBody`. ### GET Zone Information `GET /connect/zones/{zoneId}` Operation ID: `getZone`. Tags: ⚠️ Deprecated. **Deprecated**. Return a zone Information about the specified Chatter Answers zone. **Note**: With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see [End of Support for Chatter Answers in Spring ’18](https://help.salesforce.com/apex/HTViewSolution?urlname=Chatter-Answers-to-Retire-in-Spring-18). #### Experience Cloud site path `/connect/communities/{communityId}/zones/{zoneId}` _Available in: v29.0_ #### Parameters * `zoneId` (path, string (Id), required) The ID of a zone. Pattern: ^(09a)\\w\*. #### Responses * **200** _Zone_ A Chatter Answers zone. Media type: `application/json`. Schema: `Zone`. ### GET Zone Search Results `GET /connect/zones/{zoneId}/search-results` Operation ID: `getZoneSearch`. Tags: ⚠️ Deprecated. **Deprecated**. Return zone search results Search results from a search in a Chatter Answers zone. **Note**: With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see [End of Support for Chatter Answers in Spring ’18](https://help.salesforce.com/apex/HTViewSolution?urlname=Chatter-Answers-to-Retire-in-Spring-18). #### Experience Cloud site path `/connect/communities/{communityId}/zones/{zoneId}/search-results` _Available in: v29.0_ #### Parameters * `zoneId` (path, string (Id), required) The ID of a zone. Pattern: ^(09a)\\w\*. * `filter` (query, ConnectZoneSearchResultTypeEnum) A filter for the search results. One of these values: * `Article` —Search results contain only articles. * `Question` —Search results contain only questions. _Available in: v29.0_ * `language` (query, string) The language of the articles or questions. The value must be a Salesforce supported locale code. In an `` , the default value is the language of the page. Otherwise, the default value is the user's locale. _Available in: v36.0_ * `page` (query, integer) The page of items to return. The default value is 0, which returns the first page. _Available in: v29.0_ * `pageSize` (query, integer) The number of items per page. Valid values are from 1 through 100. The default value is 20. _Available in: v29.0_ * `q` (query, string) Required and can’t be `null`. 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: v29.0_ #### Responses * **200** _Zone Search Result_ The result of a search within a Chatter Answers zone. Media type: `application/json`. Schema: `ZoneSearchResultCollection`. ### GET Bot Version Activation `GET /connect/bot-versions/{botVersionId}/activation` Operation ID: `getBotVersionActivation`. Tags: Bot Version Activation Resources. The Bot Activation resource defines operations around activation of a Bot Version Get the activation information of a bot version. _Available in: v50.0_ #### Parameters * `botVersionId` (path, string (Id), required) ID of the bot version. Pattern: ^(0X9)\\w\*. #### Responses * **200** _Bot Version Activation Info_ Success or failure information of the bot version activation. Media type: `application/json`. Schema: `BotVersionActivationInfo`. ### POST Bot Version Activation `POST /connect/bot-versions/{botVersionId}/activation` Operation ID: `postBotVersionActivation`. Tags: Bot Version Activation Resources. The Bot Activation resource defines operations around activation of a Bot Version Change the activation information of a bot version. _Available in: v50.0_ #### Parameters * `botVersionId` (path, string (Id), required) ID of the bot version. Pattern: ^(0X9)\\w\*. * `status` (query, BotVersionActivationStatus) Activation status of the bot version. Activation status must be specified in the `status` request parameter or the Bot Version Activation Input request body. _Available in: v50.0_ #### Request body Activation information for the bot version. _Available in: v50.0_ Media type: `application/json`. Schema: `BotVersionActivationInput`. #### Responses * **200** _Bot Version Activation Info_ Success or failure information of the bot version activation. Media type: `application/json`. Schema: `BotVersionActivationInfo`. ### GET Conversation Application Definition `GET /connect/conversation-application` Operation ID: `getConversationApplicationDefinition`. Tags: Conversation Application Definition Resources. This resource defines operations around Conversation Application Definition Get information about an integration’s conversation application definition and the associated bot. _Available in: v54.0_ #### Parameters * `integrationName` (query, string, required) Name of the conversation application. _Available in: v54.0_ #### Responses * **200** _Conversation Application Definition Detail_ Information about conversation application definition. Media type: `application/json`. Schema: `ConversationApplicationDefinitionDetailRespresentation`. ### POST Bot Utterance Intent Prediction `POST /connect/bots/utterance-prediction/intent` Operation ID: `postUtterancePrediction`. Tags: Bot Utterance Intent Prediction Resources. Predict the associated intent of utterances for a bot. Predict the intent of utterances for a bot. _Available in: v66.0_ #### Request body Collection of utterance and associated intent information for a bot. Media type: `application/json`. Schema: `BotUtteranceCollectionPredictionInput`. _Example: example\_1_ Payload 1 ``` { "botId": "1M1SG00000000Ax", "botVersionId": "0X9SG0000005ABd0AM", "utterancesToIntents": [ { "utterance": "Do not give up?", "intent": "bot-profile_update" }, { "utterance": "How do I change my account information?", "intent": "bot-profile_update" }, { "utterance": "Can you tell me the status of my order?", "intent": "bot-order_details" }, { "utterance": "I want to track my order.", "intent": "bot-order_details" }, { "utterance": "Can you tell me the movie schedule?", "intent": "bot-movie_schedule" }, { "utterance": "What are the showtimes for today?", "intent": "bot-movie_schedule" } ] } ``` #### Responses * **200** _Bot Utterance Collection Prediction Output_ Intent predictions for a bot. Media type: `application/json`. Schema: `BotUtteranceCollectionPredictionOutput`. ### POST Bot Utterance Intent Prediction from a Set `POST /connect/bots/utterance-prediction/intentFromSet` Operation ID: `postUtterancePredictionFromSet`. Tags: Bot Utterance Intent Prediction Resources. Predict the associated intent of utterances for a bot using the bot’s existing intent set and utterances. Predict the intent of utterances for a bot using the bot’s existing intent set and utterances. _Available in: v66.0_ #### Request body Bot data. Media type: `application/json`. Schema: `BotUtteranceCollectionPredictionFromSetInput`. _Example: example\_1_ Payload 1 ``` { "botId": "1M1SG00000000Ax", "botVersionId": "1M1SG00000000By" } ``` #### Responses * **200** _Bot Utterance Collection Prediction Output_ Intent predictions for a bot. Media type: `application/json`. Schema: `BotUtteranceCollectionPredictionOutput`. ### POST Application for Program `POST /connect/eu-program/applications` Operation ID: `postProgramApplication`. Tags: Application for Program Resources. Used to create an application for a Program Create an application for a program. _Available in: v58.0_ #### Request body (required) Input representation of an application to a program. _Available in: v58.0_ Media type: `application/json`. Schema: `ProgramApplicationInput`. _Example: example\_1_ Payload 1 ``` { "programId": "11Wxx0000004GkaEAE", "accountId": "001xx000003GlBHAA0", "description": "Individual Application created for Program EV Charger Rebate", "applicationItems": { "records": [ { "programProductId": "11mxx0000004PROAA2" } ] }, "files": { "records": [ { "contentDocumentId": "069xx0000004DWWAA2" } ] } } ``` #### Responses * **200** _Program Application Output_ Output representation of an application request to a Program. Media type: `application/json`. Schema: `ProgramApplicationOutput`. _Example: example\_1_ Payload 1 ``` { "success": true, "message": "Your application has been submittted successfully", "applicationId": "IA-0000000456" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/connect/eu-program/applications Content-Type: application/json { "programId": "11Wxx0000004GkaEAE", "accountId": "001xx000003GlBHAA0", "description": "Individual Application created for Program EV Charger Rebate", "applicationItems": { "records": [ { "programProductId": "11mxx0000004PROAA2" } ] }, "files": { "records": [ { "contentDocumentId": "069xx0000004DWWAA2" } ] } } ``` ### POST Generate Asset `POST /asset-management/assets/actions/generate` Operation ID: `generateAsset`. Tags: Customer Asset Lifecycle Management Resources. Resource for Customer Asset Lifecycle Management Generate Service Create a lifecycle-managed asset. _Available in: v50.0_ #### Limits * Asset: 1 per call * Asset state period: 10 per call * Asset action: 1 per call * Asset action source: 10 per asset action #### Request body Asset generation input for Customer Asset Lifecycle Management. Represents the creation of a lifecycle-managed asset. Media type: `application/json`. Schema: `CalmGenerateInput`. _Example: example\_1_ Payload 1 ``` { "accountId": "001B000001KDI7BIAX", "assetName": "MDM Subscription", "productId": "01tB0000000q2FFIAY", "currencyIsoCode": "USD", "assetStatePeriods": [ { "startDate": "2020-01-01T09:00:00+08:00", "endDate": "2020-12-31T08:59:59+08:00", "quantity": 10, "mrr": 100, "amount": 1200 } ], "assetAction": { "category": "Initial Sale", "actionDate": "2019-09-05T16:00:00+08:00", "quantityChange": 10, "mrrChange": 100, "amount": 1200 }, "assetActionSources": [ { "transactionDate": "2019-09-05T16:00:00+08:00", "startDate": "2020-01-01T09:00:00+08:00", "endDate": "2020-12-31T08:59:59+08:00", "quantity": 10, "productAmount": 1200, "referenceEntityItem": "1WLB00000003geJOAQ" } ] } ``` #### Responses * **200** _Asset Result Output_ Connect REST API output representation for lifecycle-managed assets. Media type: `application/json`. Schema: `CalmOutput`. ### POST Cancel Asset `POST /asset-management/assets/{assetId}/actions/cancel` Operation ID: `cancelAsset`. Tags: Customer Asset Lifecycle Management Resources. Resource for Customer Asset Lifecycle Management Cancel Service Cancel a lifecycle-managed asset. _Available in: v50.0_ #### Limits * Asset action creation: 1 per call * Asset action source creation: 10 per asset action * Asset state period deletion: 4 per call #### Parameters * `assetId` (path, string (Id), required) ID of the asset. Pattern: ^(02i)\\w\*. #### Request body Cancellation input consumed by Customer Asset Lifecycle Management. Represents a cancellation action made against a lifecycle-managed asset. Media type: `application/json`. Schema: `CalmCancelInput`. _Example: example\_1_ Payload 1 ``` { "assetStatePeriod": { "startDate": "2020-10-01T09:00:00+08:00", "endDate": "2020-11-30T08:59:59+08:00", "quantity": 25, "mrr": 250, "amount": 500 }, "assetAction": { "category": "Cancellations", "actionDate": "2020-12-01T09:00:00+08:00", "quantityChange": -25, "mrrChange": -250, "amount": -250 }, "assetActionSources": [ { "transactionDate": "2020-10-01T09:00:00+08:00", "startDate": "2020-10-01T09:00:00+08:00", "endDate": "2020-12-31T08:59:59+08:00", "quantity": -25, "productAmount": -250, "referenceEntityItem": "1WLB00000003geJOAQ" } ] } ``` #### Responses * **200** _Asset Result Output_ Connect REST API output representation for lifecycle-managed assets. Media type: `application/json`. Schema: `CalmOutput`. ### POST Change Asset `POST /asset-management/assets/{assetId}/actions/change` Operation ID: `changeAsset`. Tags: Customer Asset Lifecycle Management Resources. Resource for Customer Asset Lifecycle Management Change Service Amend or renew a lifecycle-managed asset. _Available in: v50.0_ #### Change Asset * Asset state period: 10 per call * Asset action creation: 1 per call * Asset action source creation: 10 per asset action * Asset state period deletion: 4 per call #### Parameters * `assetId` (path, string (Id), required) ID of the asset. Pattern: ^(02i)\\w\*. #### Request body Change input consumed by Customer Asset Lifecycle Management. Represents a change action made against a lifecycle-managed asset. Media type: `application/json`. Schema: `CalmChangeInput`. _Example: example\_1_ Payload 1 ``` { "assetStatePeriods": [ { "startDate": "2020-07-01T09:00:00+08:00", "endDate": "2020-09-30T08:59:59+08:00", "quantity": 20, "mrr": 200, "amount": 600 }, { "startDate": "2020-10-01T09:00:00+08:00", "endDate": "2020-12-31T08:59:59+08:00", "quantity": 25, "mrr": 250, "amount": 750 } ], "assetAction": { "category": "Upsells", "actionDate": "2020-10-01T14:00:00+08:00", "quantityChange": 5, "mrrChange": 50, "amount": 150 }, "assetActionSources": [ { "transactionDate": "2020-10-01T14:00:00+08:00", "startDate": "2020-10-01T09:00:00+08:00", "endDate": "2020-12-31T08:59:59+08:00", "quantity": 5, "productAmount": 150, "referenceEntityItem": "1WLB00000003geJOAQ" } ] } ``` #### Responses * **200** _Asset Result Output_ Connect REST API output representation for lifecycle-managed assets. Media type: `application/json`. Schema: `CalmOutput`. ### GET Call Coaching `GET /callcoaching/{callCoachingMediaProviderId}` Operation ID: `getConnectorsCallCoachingStatus`. Tags: Call Coaching Resources. Resource for getting current state of call coaching for a given callCoachingMediaProviderId Get the status of Einstein Conversation Insights. _Available in: v49.0_ #### Parameters * `callCoachingMediaProviderId` (path, string (Id), required) ID of the call coaching media provider. Pattern: ^(0hn)\\w\*. #### Responses * **200** _Connectors Call Coaching Status_ Current status of Einstein Conversation Insights for a partner. Media type: `application/json`. Schema: `ConnectorsCallCoachingStatus`. ### POST Voice Calls `POST /voicecalls` Operation ID: `postConnectorsVoiceCall`. Tags: Call Coaching Resources. Resource for posting metadata about a new VoiceCall and VoiceCallRecording Post metadata about new voice calls and recordings. _Available in: v49.0_ #### Request body List of voice calls and recording properties. Media type: `application/json`. Schema: `ConnectorsCallInputList`. _Example: example\_1_ Payload 1 ``` { "calls": [ { "toPhoneNumber": "+16315122409", "fromPhoneNumber": "+15105024190", "userId": "005R0000000XTJD", "startDateTime": "2019-11-06T19:41:56.000Z", "endDateTime": "2019-11-06T19:41:56.000Z", "callType": "Outbound", "recordingDuration": "300", "externalId": "CAXXXXXYYYYY1", "recordingFormat": "mp3", "activityId": "00Txxxxxxxxxxxx", "recordId": "001xxxxxxxxxxxx", "mediaProviderId": "0hnxxxxxxxxxxxx", "vendorType": "Twilio" }, { "toPhoneNumber": "+16315122409", "fromPhoneNumber": "+15105024190", "userId": "005R0000000XTJD", "startDateTime": "2020-11-06T19:41:56.000Z", "endDateTime": "2020-11-06T19:41:56.000Z", "callType": "Inbound", "recordingDuration": "30", "externalId": "CAXXXXXYYYYY2", "recordingFormat": "mp3", "activityId": "00Txxxxxxxxxxxx", "recordId": "001xxxxxxxxxxxx", "mediaProviderId": "0hnxxxxxxxxxxxx", "vendorType": "AmazonConnect" } ] } ``` #### Responses * **200** _Connectors Voice Call List Result_ List results of posting a voice call. Media type: `application/json`. Schema: `ConnectorsVoiceCallListResult`. ### POST Voice Call Audio Upload `POST /voicecalls/{voiceCallId}/audio_upload` Operation ID: `postConnectorsVoiceCallAudioUpload`. Tags: Call Coaching Resources. Resource for uploading an audio recording of a VoiceCall Upload an audio recording of a voice call. To upload an audio binary file that resides locally, send it in a multipart/form-data request with the `audioFileData` header parameter in the binary upload body part of the request. To upload an audio file that resides on a third-party vendor’s system, use the `recordingURL` and `name` request parameters for the URL and named credential, respectively. 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). _Available in: v49.0_ #### Parameters * `voiceCallId` (path, string (Id), required) ID of the voice call. Pattern: ^(0LQ)\\w\*. * `name` (query, string) Named credential used to authenticate to the third-party vendor’s system. _Available in: v57.0_ * `recordingURL` (query, string) URL of the signed link where the audio file resides. _Available in: v57.0_ #### Request body _Available in: v57.0_ Media type: `application/octet-stream`. Schema: `string (binary)`. Type: `string (binary)`. #### Responses * **200** Success Media type: `application/json`. Schema: `Empty`. ### GET Datacloud Company Information `GET /connect/datacloud/companies/{companyId}` Operation ID: `getDatacloudCompany`. Tags: ⚠️ Deprecated. **Deprecated**. Return the fields of Company Entity Get company information. _Available in: v32.0_ #### Parameters * `companyId` (path, string, required) ID of the company. #### Responses * **200** _Datacloud Company_ The Data.com company record. If you own a company record, you see all the fields. If you don’t own the company record, some fields are hidden by asterisks (\*\*\*). Media type: `application/json`. Schema: `DatacloudCompany`. ### POST Datacloud Contact Import `POST /connect/datacloud/contact-imports` Operation ID: `postDatacloudContactImport`. Tags: ⚠️ Deprecated. **Deprecated**. Import the contact ids specified and return a response Import records as contacts or leads. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). _Available in: v36.0_ #### Request body Input representation of the criteria for importing records as contacts or leads. Media type: `application/json`. Schema: `DatacloudContactImportInput`. _Example: example\_1_ Payload 1 To add the records as contacts, include a parentAccountId. ``` { "datacloudContactIds": [ 10344600, 42701050, 45995423 ], "parentAccountId": "09KR00000004C9rMAE" } ``` _Example: example\_2_ Payload 2 Without a parentAccountId, the records are added as leads. ``` { "datacloudContactIds": [ 10344600, 42701050, 45995423 ] } ``` #### Responses * **200** _Datacloud Import_ Represents the Data.com contact import response. Media type: `application/json`. Schema: `DatacloudImport`. ### GET Datacloud Contact Information `GET /connect/datacloud/contacts/{contactId}` Operation ID: `getDatacloudContact`. Tags: ⚠️ Deprecated. **Deprecated**. Return the fields of Contact Entity Get the contact information for the specified contact. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). _Available in: v32.0_ #### Parameters * `contactId` (path, string, required) ID of the contact. #### Responses * **200** _Datacloud Contact_ Information about Data.com contacts. If you own a contact, you see all the fields. If you don’t own the contact record, some fields are hidden by asterisks (\*\*\*). Media type: `application/json`. Schema: `DatacloudContact`. ### POST Datacloud Orders `POST /connect/datacloud/orders` Operation ID: `postDatacloudOrgOrder`. Tags: ⚠️ Deprecated. **Deprecated**. Return the Order information. The order information provides orderId, count of purchases made for that Id, Date of the order, Url for the orderID and ContactUrl or CompanyUrl based on the entity that are purchased with this order Purchase the contacts or companies for the listed IDs. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). _Available in: v32.0_ #### Request body A list of Data.com identification numbers that are used to purchase contacts or companies by a specific user type. Media type: `application/json`. Schema: `DatacloudOrderInput`. _Example: example\_1_ Payload 1 ``` { "companyIds": [ "23456", "24548" ], "userType": "Monthly" } ``` #### Responses * **200** _Datacloud Order_ Information about the Data.com records that you purchased and details of the purchase. Media type: `application/json`. Schema: `DatacloudOrder`. ### GET Datacloud OrderId Information `GET /connect/datacloud/orders/{orderId}` Operation ID: `getDatacloudOrder`. Tags: ⚠️ Deprecated. **Deprecated**. Return the Order information. The order information provides orderId, count of purchases made for that Id, Date of the order, Url for the order and url for the list of entitie that are purchased with this order Get information for an order. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). Order information includes the `orderId`, the number of purchased records for the `orderId`, the URL for the order information, and the URL for a list of the purchased records. _Available in: v32.0_ #### Parameters * `orderId` (path, string (Id), required) ID of an order. Pattern: ^(09F)\\w\*. #### Responses * **200** _Datacloud Order_ Information about the Data.com records that you purchased and details of the purchase. Media type: `application/json`. Schema: `DatacloudOrder`. ### GET Datacloud Company Order Information `GET /connect/datacloud/orders/{orderId}/companies` Operation ID: `getDatacloudCompanyCollection`. Tags: ⚠️ Deprecated. **Deprecated**. Return all the companies purchased in a given order Get all the order information about all companies. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). Order information includes the `{orderId}`, the number of purchased records for the order, information for the purchased companies, and the URLs for next and previous pages. _Available in: v32.0_ The `{orderId}` must be for purchased companies. A request for a contact `{orderId}` fails. #### Parameters * `orderId` (path, string (Id), required) The `{orderId}` must be for purchased companies. A request for a contact `{orderId}` fails. Pattern: ^(09F)\\w\*. * `page` (query, integer) Number of the page that you want returned. _Available in: v32.0_ * `pageSize` (query, integer) The number of companies that you want returned on each page. The default page size is 25. _Available in: v32.0_ #### Responses * **200** _Datacloud Company Collection_ Purchase details for all companies that were purchased for a specific order. Media type: `application/json`. Schema: `DatacloudCompanyCollection`. ### GET Datacloud Contact Order Information `GET /connect/datacloud/orders/{orderId}/contacts` Operation ID: `getDatacloudContactCollection`. Tags: ⚠️ Deprecated. **Deprecated**. Return all the contacts purchased in a given order Get all the order information for a specific order for contacts. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). Order information includes the `orderId`, the number of purchased records for the `orderId`, the URL for the order information, and details for the purchased contacts. _Available in: v32.0_ The `{orderId}` must be for purchased contacts. A request with an `{orderId}` for purchased companies fails. #### Parameters * `orderId` (path, string (Id), required) The `{orderId}` must be for purchased contacts. A request with an `{orderId}` for purchased companies fails. Pattern: ^(09F)\\w\*. * `page` (query, integer) The number of the page that you want returned. _Available in: v32.0_ * `pageSize` (query, integer) The number of contacts you want returned on each page. The default page size is 25. _Available in: v32.0_ #### Responses * **200** _Datacloud Contact Collection_ Purchase details for all contacts that were purchased for a specific order. Media type: `application/json`. Schema: `DatacloudContactCollection`. ### GET Datacloud Usage `GET /connect/datacloud/usage/{userId}` Operation ID: `getDatacloudPurchaseUsage`. Tags: ⚠️ Deprecated. **Deprecated**. Return the usage information of the User. The usage information provides monthly credits used and available for an user as well as list pool credits used and available for the org. Get usage information for a Monthly user or a Listpool user. **Note**: When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1). _Available in: v32.0_ #### Parameters * `userId` (path, string (Id), required) ID of the user. Pattern: ^(005)\\w\*. #### Responses * **200** _Datacloud Purchase Usage_ Information about the Data.com purchase usage for an organization. Shows the credits that are used and available for Monthly and Listpool users. Media type: `application/json`. Schema: `DatacloudPurchaseUsage`. ### GET External Email Services `GET /authenticated-email-service` Operation ID: `getUserOauthInfo`. Tags: External Email Services Resources. Resource to access the ExternalEmailService API Get information about the external email services available to the context user. _Available in: v37.0_ #### Parameters * `landingPage` (query, string, required) The landing page that the user starts on when they are finished with the OAuth authorization process. _Available in: v37.0_ #### Responses * **200** _OAuth User_ Information about a user’s OAuth status. Media type: `application/json`. Schema: `UserOauthInfo`. ### GET Email Merge Field Services `GET /email-merge-fields` Operation ID: `getEmailMergeField`. Tags: Email Merge Field Services Resources. Resource to access the Merge Fields See a list of merge fields for a specific object. A merge field is a field you can put in an email template, mail merge template, custom link, or formula to incorporate values from a record. _Available in: v39.0_ #### Parameters * `objectApiNames` (query, string, required) The API names for the objects being referenced. _Available in: v39.0_ #### Responses * **200** _Email Merge Field_ The map for objects and their merge fields. Media type: `application/json`. Schema: `EmailMergeField`. ### GET Clean Rule Data Services `GET /clean/data-services` Operation ID: `getDataService`. Tags: Clean Resources. Resource for getting CleanDataService records Get the data services associated with an organization’s active data integration rules. _Available in: v37.0_ #### Responses * **200** _Clean Rule Data Service Collection_ Data services associated with all active data integration rules in an organization. Media type: `application/json`. Schema: `CleanDataServiceOutputCollection`. ### GET Clean Rule Data Service Metrics `GET /clean/data-services/{dataServiceId}/metrics` Operation ID: `getMetric`. Tags: Clean Resources. Resource for getting clean Metric Records Get metrics for the data services associated with an organization’s active data integration rules. _Available in: v37.0_ #### Parameters * `dataServiceId` (path, string (Id), required) ID of the data service. Pattern: ^(07S)\\w\*. #### Responses * **200** _Clean Rule Data Service Metrics Collection_ Metrics for data services associated with all active data integration rules in an organization. Media type: `application/json`. Schema: `CleanMetricOutputCollection`. ### GET Clean Rule Statuses `GET /clean/{recordId}/rules/statuses` Operation ID: `getXCleanStatusCollection`. Tags: Clean Resources. Get clean status of entity Get the statuses of active data integration rules for a record. _Available in: v37.0_ #### Parameters * `recordId` (path, string (Id), required) ID of the record. #### Responses * **200** _Clean Rule Status Collection_ Statuses of all active data integration rules for a record. Media type: `application/json`. Schema: `CleanStatusOutputCollection`. ### GET Data Integration Licensed Objects `GET /data-integration/licensed-objects` Operation ID: `getDataIntegrationCreditObjects`. Tags: Data Integration Resources. Resource for getting External Object Names for Credit Details Get external object names of active packages for credit details. _Available in: v42.0_ #### Responses * **200** _Data Integration Credit Objects_ External object names of active packages. Media type: `application/json`. Schema: `DataIntegrationCreditObjects`. ### GET Data Integration Licensed Objects Contract Credit `GET /data-integration/licensed-objects/{externalObjectName}/contracts/current` Operation ID: `getDataIntegrationCredit`. Tags: Data Integration Resources. Resource for getting Credit Details for a Contract Get credit details for a contract. _Available in: v42.0_ #### Parameters * `externalObjectName` (path, string, required) To get `externalObjectName`, use `/data-integration/licensed-objects`. #### Responses * **200** _Data Integration Credit_ Contract credit information. Media type: `application/json`. Schema: `DataIntegrationCredit`. ### GET Content Taxonomy, Get Terms `GET /connect/content-taxonomy/terms` Operation ID: `getTerms`. Tags: Content Taxonomy Resources. Resource for getting multiple content taxonomy terms and their descendants. Get terms and child terms for a content taxonomy. _Available in: v63.0_ #### Parameters * `depth` (query, integer, required) Number of levels of the tree to retrieve. If you specify `0` , you get the details for the specified initial terms or the root terms only. _Available in: v63.0_ * `includeMetadata` (query, boolean) Specifies whether to include metadata, such as created date, last modified date, and description, in the results ( `true` ) or not ( `false` ). If unspecified, defaults to ( `false` ). _Available in: v63.0_ * `includePaths` (query, boolean) Specifies whether to include paths in the results ( `true` ) or not ( `false` ). If unspecified, defaults to `false` . _Available in: v63.0_ * `initialTerms` (query, array of string) List of IDs of terms to get, with child terms to the specified depth. If unspecified, defaults to the root terms. _Available in: v63.0_ * `taxonomyId` (query, string, required) ID of the content taxonomy. _Available in: v63.0_ #### Responses * **200** _Content Taxonomy Term Collection_ Collection of content taxonomy terms. Media type: `application/json`. Schema: `ContentTaxonomyTermCollection`. ### GET Content Taxonomy, Search Terms `GET /connect/content-taxonomy/terms/search` Operation ID: `searchTerms`. Tags: Content Taxonomy Resources. Resource for searching content taxonomy terms for the given query text. Search content taxonomy terms for specified query text. _Available in: v63.0_ #### Parameters * `includeMetadata` (query, boolean) Specifies whether to include metadata, such as created date, last modified date, and description, in the results ( `true` ) or not ( `false` ). If unspecified, defaults to ( `false` ). _Available in: v63.0_ * `page` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v63.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25. _Available in: v63.0_ * `queryText` (query, string, required) Word or phrase to find in the content taxonomy term labels. Only “starts with” search is supported. _Available in: v63.0_ * `taxonomyIds` (query, array of string, required) List of IDs of the content taxonomies to search for the query text. _Available in: v63.0_ #### Responses * **200** _Content Taxonomy Term Collection_ Collection of content taxonomy terms. Media type: `application/json`. Schema: `ContentTaxonomyTermCollection`. ### POST Content Taxonomy, Create a Term `POST /connect/content-taxonomy/{taxonomyId}/terms` Operation ID: `createTerm`. Tags: Content Taxonomy Resources. Resource for creating a term within a content taxonomy. Create a term within a content taxonomy. _Available in: v63.0_ #### Parameters * `taxonomyId` (path, string (Id), required) ID of the taxonomy. Pattern: ^(15b)\\w\*. #### Request body Create or update a term within a content taxonomy. Media type: `application/json`. Schema: `ContentTaxonomyTermInput`. _Example: example\_1_ Payload 1 ``` { "label": "Fruit", "description": "The seed-bearing part of a flowering plant.", "parentTermId": "" } ``` #### Responses * **200** _Content Taxonomy Term_ Content taxonomy term. Media type: `application/json`. Schema: `ContentTaxonomyTerm`. ### GET Content Taxonomy, Term `GET /connect/content-taxonomy/{taxonomyId}/terms/{termId}` Operation ID: `getTerm`. Tags: Content Taxonomy Resources. Resource for fetching, updating and deleting a term within a content taxonomy. Get a term within a content taxonomy. _Available in: v63.0_ #### Parameters * `taxonomyId` (path, string (Id), required) ID of the taxonomy. Pattern: ^(15b)\\w\*. * `termId` (path, string (Id), required) ID of the term. Pattern: ^(15d)\\w\*. #### Responses * **200** _Content Taxonomy Term_ Content taxonomy term. Media type: `application/json`. Schema: `ContentTaxonomyTerm`. ### DELETE Content Taxonomy, Term `DELETE /connect/content-taxonomy/{taxonomyId}/terms/{termId}` Operation ID: `deleteTerm`. Tags: Content Taxonomy Resources. Resource for fetching, updating and deleting a term within a content taxonomy. Delete a term within a content taxonomy. _Available in: v63.0_ #### Parameters * `taxonomyId` (path, string (Id), required) ID of the taxonomy. Pattern: ^(15b)\\w\*. * `termId` (path, string (Id), required) ID of the term. Pattern: ^(15d)\\w\*. * `deleteChildren` (query, boolean, required) Specifies whether to delete the child terms of the term ( `true` ) or not ( `false` ). _Available in: v63.0_ * `newParentTerm` (query, string) ID of the term that becomes the parent term if `deleteChildren` is `false` . If unspecified and `deleteChildren` is `false` , the child terms become root terms. _Available in: v63.0_ #### 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 Content Taxonomy, Term `PATCH /connect/content-taxonomy/{taxonomyId}/terms/{termId}` Operation ID: `updateTerm`. Tags: Content Taxonomy Resources. Resource for fetching, updating and deleting a term within a content taxonomy. Update a term within a content taxonomy. _Available in: v63.0_ #### Parameters * `taxonomyId` (path, string (Id), required) ID of the taxonomy. Pattern: ^(15b)\\w\*. * `termId` (path, string (Id), required) ID of the term. Pattern: ^(15d)\\w\*. #### Request body Create or update a term within a content taxonomy. Media type: `application/json`. Schema: `ContentTaxonomyTermInput`. _Example: example\_1_ Payload 1 ``` { "label": "Fruit", "description": "The seed-bearing part of a flowering plant.", "parentTermId": "" } ``` #### Responses * **200** _Content Taxonomy Term_ Content taxonomy term. Media type: `application/json`. Schema: `ContentTaxonomyTerm`. ### POST Lightning Model Types `POST /connect/lightning-model/types` Operation ID: `postLightningModelTypes`. Tags: Type System Resources. Resource for lightning model types. Get detailed information about each Lightning type and Apex class type. _Available in: v64.0_ #### Request body Input for lightning model types. Media type: `application/json`. Schema: `LightningModelTypesInput`. #### Responses * **200** _Lightning Model Types Collection_ Collection of lightning model types. Media type: `application/json`. Schema: `LightningModelTypesCollection`. ### GET Lightning Types `GET /connect/lightning-types` Operation ID: `getLightningTypes`. Tags: Type System Resources. Resource for the Lightning Type Collection. Get basic information, such as identifiers, title, and description about each Lightning type. _Available in: v64.0_ #### Parameters * `category` (query, LightningModelTypeCategoryEnum) Filter lightning types by their underlying schema category. Valid values: 'apex' (for @apexClassType types), 'object' (for lightning\_\_objectType). If not specified, returns all types. * `editorConfigTarget` (query, LightningModelTypesEditorConfigEnum) Editor configuration targets for lightning types. In version 64.0 and later, `LightningDesktopGenAi` is the only valid value. _Available in: v64.0_ * `excludeStandardTypes` (query, boolean) Exclude standard schema types from the response. * `fullyQualifiedNames` (query, array of string) List of fully qualified names of types to return. _Available in: v64.0_ * `language` (query, string) Language or locale code, such as `es` or `en_US` , to retrieve the title and description of a type. If unspecified, the logged-in user’s language is used. The fallback language is English in case translations don’t exist. _Available in: v64.0_ * `page` (query, integer) Number of the page to return. If unspecified or if you specify 0, the first page is returned. _Available in: v64.0_ * `pageSize` (query, integer) Number of items on a page. Valid values are from 1 to 250. If unspecified, defaults to 25. _Available in: v64.0_ * `rendererConfigTarget` (query, LightningModelTypesRendererConfigEnum) Renderer configuration targets for lightning types. In version 64.0 and later, `LightningDesktopGenAi` is the only valid value. _Available in: v64.0_ #### Responses * **200** _Lightning Type Collection_ Collection of lightning types. Media type: `application/json`. Schema: `LightningTypeCollection`. ### GET Lightning Type `GET /connect/lightning-types/{fullyQualifiedName}` Operation ID: `getLightningType`. Tags: Type System Resources. Resource for the Lightning Type. Get detailed information, such as JSON schema definition, editor configuration, and renderer configuration about each Lightning type. _Available in: v64.0_ #### Parameters * `fullyQualifiedName` (path, string, required) The Fully Qualified Name of a lightning type to be retrieved. * `applyDefaults` (query, boolean) applyDefaults * `editorConfigTarget` (query, LightningModelTypesEditorConfigEnum) Editor configuration targets for the lightning type. In version 64.0 and later, `LightningDesktopGenAi` is the only valid value. _Available in: v64.0_ * `expandConfigs` (query, boolean) Specifies whether the API returns the expanded configuration ( `true` ) or the originally saved configuration ( `false` ). If unspecified, defaults to `true` . Specifying `true` returns the full configuration by expanding the referred standard, custom, and Apex types in the schema, editor, and renderer. Specifying `false` returns only the user-supplied configuration, without any system-generated expansions or properties. _Available in: v65.0_ * `includeSubSchemaDefinitions` (query, boolean) Specifies whether to include sub-schema definitions ( `true` ) or not ( `false` ). _Available in: v64.0_ * `language` (query, string) Language or locale code, such as `es` or `en_US` , to retrieve the title and description of a type. If unspecified, the logged-in user’s language is used. The fallback language is English in case translations don’t exist. _Available in: v64.0_ * `rendererConfigTarget` (query, LightningModelTypesRendererConfigEnum) Renderer configuration targets for the lightning type. In version 64.0 and later, `LightningDesktopGenAi` is the only valid value. _Available in: v64.0_ #### Responses * **200** _Lightning Type Detail_ Detailed information about a lightning type. Media type: `application/json`. Schema: `LightningTypeDetail`. ### GET Search Objects Answer `GET /connect/search/sobjects/answer` Operation ID: `getSearchAnswer`. Tags: Search Resources. Search Answer Resource Search objects using a natural language query and return an answer. **Note**: To use this resource, enable search answers in your Salesforce org from Einstein Search settings. This resource doesn't support the search customizations configured in Search Manager. _Available in: v63.0_ #### Parameters * `displayFields` (query, array of string) * `q` (query, string, required) Natural language query to search for in the org. _Available in: v63.0_ #### Responses * **200** _Search Answer_ Results of searching objects using a natural language query. Media type: `application/json`. Schema: `SearchAnswer`. #### Code samples _Example: Example 1 · HTTP_ ``` GET /services/data/v67.0/connect/search/sobjects/answer?q=how to sign documents with docusign &htmlEncode=false ``` ### GET Search Objects Results `GET /connect/search/sobjects/result-groups` Operation ID: `getGroupedSearchResults`. Tags: Search Resources. Search Keyword Resource Search objects using keywords and return result groups. _Available in: v63.0_ #### Parameters * `configurationName` (query, string) Name of the search configuration to apply. Look up search configuration names from Search Manager. _Available in: v63.0_ * `highlights` (query, boolean) Specifies whether search generates a text highlight ( `true` ) or not ( `false` ). The default value is `false` . _Available in: v63.0_ * `q` (query, string, required) Query term to search on. The query term must be two or more characters. _Available in: v63.0_ #### Responses * **200** _Search Result Groups_ Results of searching objects using keywords. Media type: `application/json`. Schema: `SearchResultGroups`. #### Code samples _Example: Example 1 · HTTP_ ``` GET /services/data/v67.0/connect/search/sobjects/result-groups?q=issue ``` ### GET Search Object Answer `GET /connect/search/sobjects/{objectApiName}/answer` Operation ID: `getSearchAnswerAnswer`. Tags: Search Resources. Search Answer Resource Search an object using a natural language query and return an answer. **Note**: To use this resource, enable search answers in your Salesforce org from Einstein Search settings. This resource doesn't support the search customizations configured in Search Manager. _Available in: v63.0_ #### Parameters * `objectApiName` (path, string, required) API name of the object. * `displayFields` (query, array of string) List of fields to display and return in the search answer. The default is the citation field. _Available in: v63.0_ * `q` (query, string, required) Natural language query to search for in the org. _Available in: v63.0_ #### Responses * **200** _Search Answer_ Results of searching objects using a natural language query. Media type: `application/json`. Schema: `SearchAnswer`. #### Code samples _Example: Example 1 · HTTP_ ``` GET /services/data/v67.0/connect/search/sobjects/Knowledge__kav/answer?q=how to sign documents with docusign &htmlEncode=false ``` ### POST Search Object Results `POST /connect/search/sobjects/{objectApiName}/results` Operation ID: `postScopedSearchResults`. Tags: Search Resources. Search Keyword Resource on a single object Search an object using keywords and return results. _Available in: v63.0_ #### Parameters * `objectApiName` (path, string, required) API name of the object. #### Request body Search request input for searching an object. Media type: `application/json`. Schema: `SearchRequest`. _Example: example\_1_ Payload 1 ``` { "q": "overview", "orderBy": [ { "field": "LastModifiedDate" } ], "dataCategories": [ { "groupName": "Renewals", "operator": "Below", "categories": [ "Deal_Progression_Stage" ] } ], "filters": [ { "field": "Language", "operator": "EqOp", "values": [ "en_US" ] } ] } ``` #### Responses * **200** _Scoped Search Results_ Keyword search results for an object. Media type: `application/json`. Schema: `ScopedSearchResults`. #### Code samples _Example: Example 1 · HTTP_ ``` POST /services/data/v67.0/connect/search/sobjects/Knowledge__kav/results Content-Type: application/json { "q": "overview", "orderBy": [ { "field": "LastModifiedDate" } ], "dataCategories": [ { "groupName": "Renewals", "operator": "Below", "categories": [ "Deal_Progression_Stage" ] } ], "filters": [ { "field": "Language", "operator": "EqOp", "values": [ "en_US" ] } ] } ``` ### POST Field Service Recordset Filter Criteria `POST /connect/field-service/recordset-filter-criteria/evaluate` Operation ID: `postRecordsetFilterCriteria`. Tags: Field Service Recordset Filter Criteria Resources. validate object as recordset-filter-criteria member Filter records on recordset filter criteria. _Available in: v53.0_ #### Request body A set of recordset filter criteria applied to records, such as service appointment records. Media type: `application/json`. Schema: `RecordsetFilterCriteriaInput`. _Example: example\_1_ Payload 1 ``` { "filteredObjectName": "ServiceAppointment", "criteriaIds": [ "0hrxx00000006obAAA" ], "recordIds": [ "08pxx0000004Ge4AAE", "08pxx0000004GcSAAU" ] } ``` #### Responses * **200** _Recordset Filter Criteria Collection_ List of record IDs of the filtered object. Media type: `application/json`. Schema: `RecordsetFilterCriteriaCollection`. ### POST Optimization Files `POST /connect/field-service/scheduling-operations/fetchOptimizationFiles` Operation ID: `postFetchFiles`. Tags: Optimization Files Resources. Fetch Optimization Request Files for Enhanced Scheduling and Optimization Fetch the files generated for an optimization request in Enhanced Scheduling and Optimization. This resource requires Field Service to be enabled for the org and requires the context user to have Field Service enabled. _Available in: v66.0_ #### Request body Fetch the files generated for an optimization request in Enhanced Scheduling and Optimization. Media type: `application/json`. Schema: `FetchFilesInput`. _Example: example\_1_ Payload 1 ``` { "optimizationRequestId": "0XxXX0000000001AAA" } ``` #### Responses * **200** _Fetch Files Output_ Output representation for a fetch optimization files operation. Contains a map of the files created in the org for the specified optimization request. Media type: `application/json`. Schema: `FetchFiles`. ### GET Field Service Shifts from Pattern `GET /connect/field-service/shift-patterns/{shiftPatternId}/shifts` Operation ID: `getShiftsFromPattern`. Tags: Field Service Shifts from Pattern Resources. Shifts from Pattern Endpoints Preview shifts created from a pattern. _Available in: v51.0_ #### Parameters * `shiftPatternId` (path, string (Id), required) ID of the shift pattern. Pattern: ^(1w1)\\w\*. * `shiftsFromPatternInput` (query, ShiftsFromPatternInput) #### Responses * **200** _Shifts from Pattern_ Shifts created from a pattern. Media type: `application/json`. Schema: `ShiftsFromPattern`. ### POST Field Service Shifts from Pattern `POST /connect/field-service/shift-patterns/{shiftPatternId}/shifts` Operation ID: `postShiftsFromPattern`. Tags: Field Service Shifts from Pattern Resources. Shifts from Pattern Endpoints Create up to 2,000 shifts from a pattern. _Available in: v51.0_ #### Parameters * `shiftPatternId` (path, string (Id), required) ID of the shift pattern. Pattern: ^(1w1)\\w\*. #### Request body Shifts from a pattern. Media type: `application/json`. Schema: `ShiftsFromPatternInput`. #### Responses * **200** _Shifts from Pattern_ Shifts created from a pattern. Media type: `application/json`. Schema: `ShiftsFromPattern`. #### Code samples _Example: Example 1 · HTTP_ ``` { "schedulingStartDate": "2020-11-01" "schedulingEndDate": "2020-12-01" } ``` ### GET Activity Reminders `GET /connect/reminders/activities` Operation ID: `getActivityRemindersCollection`. Tags: Activity Reminders Resources. Upcoming Activity Reminders Get a list of upcoming activity reminders in Salesforce Classic. _Available in: v39.0_ #### Parameters * `maxRecordCount` (query, integer) The number of returned reminders. The maximum allowed is 2,000. The default is 100. _Available in: v39.0_ * `numberOfDays` (query, integer) Returns reminders due for the next number of days in the future. The default is seven, and the maximum is 365. _Available in: v39.0_ * `type` (query, ConnectActivityTypeEnum) Type of activity. The default is `All`. _Available in: v39.0_ #### Responses * **200** _Activity Reminders Resources_ Get a list of upcoming activity reminders in Salesforce Classic. #### Resource ``` /connect/reminders/activities ``` #### Available version 39.0 #### HTTP methods GET #### Request parameters for GET Parameter Name Type Description Required or Optional Available Version `maxRecordCount` Integer The number of returned reminders. The maximum allowed is 2,000. The default is 100. Optional 39.0 `numberOfDays` Integer Returns reminders due for the next number of days in the future. The default is seven, and the maximum is 365. Optional 39.0 `type` String Type of activity. Valid values are: * `All` * `Event` * `Task` The default is `All`. Optional 39.0 #### Response body for GET [Activity Reminders Resources](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Activity-Reminders-Resources/operation/getActivityRemindersCollection) #### Activity Reminders Get a list of upcoming activity reminders in Salesforce Classic. Resource ``` /connect/reminders/activities ``` Available version 39.0 HTTP methods GET Request parameters for GET Parameter Name Type Description Required or Optional Available Version `maxRecordCount` Integer The number of returned reminders. The maximum allowed is 2,000. The default is 100. Optional 39.0 `numberOfDays` Integer Returns reminders due for the next number of days in the future. The default is seven, and the maximum is 365. Optional 39.0 `type` String Type of activity. Valid values are: * `All` * `Event` * `Task` The default is `All`. Optional 39.0 Response body for GET [Activity Reminders Resources](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Activity-Reminders-Resources/operation/getActivityRemindersCollection) Media type: `application/json`. Schema: `ActivityRemindersCollection`. ### GET Activity Reminder `GET /connect/reminders/{activityId}` Operation ID: `getActivityReminder`. Tags: Activity Reminders Resources. Activity Reminder Get information about an activity reminder in Salesforce Classic. _Available in: v39.0_ #### Parameters * `activityId` (path, string (Id), required) ID of the activity. Pattern: ^(00T|00U)\\w\*. #### Responses * **200** _Activity Reminder_ An activity reminder in Salesforce Classic. Media type: `application/json`. Schema: `ActivityReminder`. ### PUT Activity Reminder `PUT /connect/reminders/{activityId}` Operation ID: `putActivityReminder`. Tags: Activity Reminders Resources. Activity Reminder Update an activity reminder in Salesforce Classic. _Available in: v39.0_ #### Parameters * `activityId` (path, string (Id), required) ID of the activity. Pattern: ^(00T|00U)\\w\*. * `reminderDateTime` (query, string) The date and time that the activity reminder displays in ISO 8601 format. _Available in: v39.0_ #### Request body Activity reminder details in Salesforce Classic. _Available in: v39.0_ Media type: `application/json`. Schema: `ActivityReminderInput`. _Example: example\_1_ Payload 1 ``` { "reminderDateTime": "2016-11-22T16:00:00.000Z", "isReminderDisplayed": false } ``` #### Responses * **200** _Activity Reminder_ An activity reminder in Salesforce Classic. Media type: `application/json`. Schema: `ActivityReminder`. ### DELETE Activity Reminder `DELETE /connect/reminders/{activityId}` Operation ID: `deleteActivityReminder`. Tags: Activity Reminders Resources. Activity Reminder Delete an activity reminder in Salesforce Classic. _Available in: v39.0_ #### Parameters * `activityId` (path, string (Id), required) ID of the activity. Pattern: ^(00T|00U)\\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 Activity Reminder `PATCH /connect/reminders/{activityId}` Operation ID: `patchActivityReminder`. Tags: Activity Reminders Resources. Activity Reminder Update an activity reminder in Salesforce Classic. _Available in: v39.0_ #### Parameters * `activityId` (path, string (Id), required) ID of the activity. Pattern: ^(00T|00U)\\w\*. * `isReminderDisplayed` (query, boolean, required) Indicates whether the activity reminder has been displayed. _Available in: v39.0_ * `reminderDateTime` (query, string) The date and time that the activity reminder displays in ISO 8601 format. _Available in: v39.0_ #### Request body (required) Activity reminder details in Salesforce Classic. _Available in: v39.0_ Media type: `application/json`. Schema: `ActivityReminderInput`. _Example: example\_1_ Payload 1 ``` { "reminderDateTime": "2016-11-22T16:00:00.000Z", "isReminderDisplayed": false } ``` #### Responses * **200** _Activity Reminder_ An activity reminder in Salesforce Classic. Media type: `application/json`. Schema: `ActivityReminder`. ### POST Available Territory Slots `POST /connect/scheduling/available-territory-slots` Operation ID: `postGetAllAppointmentSlots`. Tags: Salesforce Scheduler Resources. Resource to get all appointment slots Get consolidated availability of each service resource within specified territories. _Available in: v49.0_ #### Request body Media type: `application/json`. Schema: `GetAllAppointmentSlotsInput`. #### Responses * **200** _Available Territory Slots Output_ Available territory slots result. Media type: `application/json`. Schema: `GetAllAppointmentSlotsOutput`. ### GET Engagement Channel Types `GET /connect/scheduling/engagement-channel-types` Operation ID: `getGetEngagementChannelType`. Tags: Salesforce Scheduler Resources. Resource to get engagement channel type Retrieve a list of the engagement channel types from your Salesforce org. The API returns only the channel types that are active and whose usage type is set to Salesforce Scheduler. _Available in: v56.0_ **Note**: You can either specify `workTypeGroupIds` or `workTypeIds` in the request to filter the engagement channel type results. #### Parameters * `workTypeGroupIds` (query, array of string (Id)) List of the work type group IDs. The API returns the list of engagement channel type records that are associated with the specified work type group IDs. For example, suppose that you have three engagement channel types: EC1, EC2, and EC3. If you pass work type group IDs WTG1 that is associated with EC1 and EC2 and WTG2 that is associated with EC2, the API returns the list of engagement channel types where: * EC1 is with WTG1 only * EC2 is with both WTG1 and WTG2 Because EC3 is not associated with any of the specified work type group IDs, the API doesn’t return the engagement channel type EC3. _Available in: v56.0_ * `workTypeIds` (query, array of string (Id)) List of the work type IDs. The API returns the engagement channel type records that are associated with the specified work type IDs. For example, suppose that you have three engagement channel types: EC1, EC2, and EC3. If you pass work type IDs WT1 that is associated with EC1 and EC3 and WT2 that is associated with EC3, the API returns the list of engagement channel types where: * EC1 is with WT1 only * EC3 is with both WT1 and WT2 Because EC2 is not associated with any of the specified work type IDs, the API doesn’t return the engagement channel type EC2. _Available in: v56.0_ #### Responses * **200** _Engagement Channel Type Output_ Output representation of the list of the engagement channel types. Media type: `application/json`. Schema: `GetEngagementChannelTypeOutput`. _Example: example\_1_ Payload 1 ``` { "result": { "engagementChannelTypes": [ { "id": "0eFRM0000004CBs2AM", "name": "Inperson-2", "workTypeGroupIds": [ "0VSRM0000000BgX4AU" ], "workTypeIds": [] }, { "contactPointType": "InPerson", "id": "0eFRM00000000BL2AY", "name": "A Channel", "workTypeGroupIds": [ "0VSRM0000000BgX4AU" ], "workTypeIds": [] }, { "contactPointType": "InPerson", "id": "0eFRM00000000Bk2AI", "name": "Test", "workTypeGroupIds": [ "0VSRM0000000BgX4AU" ], "workTypeIds": [] } ] } } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect​​​/scheduling/engagement-channel-types https://yourInstance.salesforce.com/services/data/v67.0/connect​​​/scheduling/engagement-channel-types?workTypeGroupIds=0VSRM0000000BgX4AU https://yourInstance.salesforce.com/services/data/v67.0/connect​​​/scheduling/engagement-channel-types?workTypeIds=08q2w000000XmniAAC,08q2w000000XmniAAS ``` ### POST Group Appointments `POST /connect/scheduling/group-appointments` Operation ID: `postGetGroupAppointments`. Tags: Salesforce Scheduler Resources. Resource to get group appointments Get a list of group appointments along with the remaining attendee limit. _Available in: v61.0_ #### Request body Input representation of the criteria to filter and retrieve group appointments. Media type: `application/json`. Schema: `GetGroupAppointmentsInput`. _Example: example\_1_ Payload 1 ``` { "startTime": "2024-01-23T00:00:00.000Z", "endTime": "2024-02-28T00:00:00.000Z", "filterByWorkTypes": [ "08qRM00000003fkYAA" ], "filterByResources": [ "0HnB0000000TO8gKAK" ], "filterByTerritories": [ "0HhRM00000003OZ0AY" ], "filterByParentRecords": [ "001B000000qAUAWIA4" ], "filterByEngagementChannelTypes": [ "0eFRM00000000Bv2AI" ], "extendedFieldsToQuery": [ "subject", "description" ] } ``` #### Responses * **200** _Group Appointments_ Output representation of the response that contains the retrieved group appointments. Media type: `application/json`. Schema: `GetGroupAppointmentsOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/group-appointments Content-Type: application/json { "startTime": "2024-01-23T00:00:00.000Z", "endTime": "2024-02-28T00:00:00.000Z", "filterByWorkTypes": [ "08qRM00000003fkYAA" ], "filterByResources": [ "0HnB0000000TO8gKAK" ], "filterByTerritories": [ "0HhRM00000003OZ0AY" ], "filterByParentRecords": [ "001B000000qAUAWIA4" ], "filterByEngagementChannelTypes": [ "0eFRM00000000Bv2AI" ], "extendedFieldsToQuery": [ "subject", "description" ] } ``` ### POST Service Appointments `POST /connect/scheduling/service-appointments` Operation ID: `postServiceAppointment`. Tags: Salesforce Scheduler Resources. Resource to create Service Appointment, Assigned Resources, and Lead Create, assign resources, and generate leads, including group appointments with multiple participants. **Note**: When these parameters aren't specified, the API doesn't check for the availability of time slots. To ensure that duplicate service appointments aren't created, specify these parameters. * WorkTypeId * ServiceTerritoryId * SchedStartTime * SchedEndTime * AssignedResources _Available in: v48.0_ #### Considerations for using engagement channel types with the service-appointments resource * **Schedule Appointments Using Engagement Channels** must be enabled in Salesforce Scheduler Settings in your Salesforce org. * When you create or modify appointments, shifts must be defined in the scheduling policy. For more information on setting up shifts in the scheduling policy, see [Define Shift Rules in Scheduling Policy](https://help.salesforce.com/s/articleView?id=platform.ls_use_shifts_to_determine_time_slots.htm&type=5). Engagement channel types are not supported with operating hours rules in the scheduling policy. * When you use engagement channels and shifts to create or modify a service appointment, Salesforce Scheduler must consider the default value for the Appointment Type (if not specified). However, Salesforce Scheduler only considers the engagement channel and Appointment Type is ignored. #### Request body Input representation for creating a service appointment. You can create service appointments, assign resources, and generate leads with either `parentRecordId` or `lead` but not both. Media type: `application/json`. Schema: `CreateServiceAppointmentInput`. _Example: example\_1_ Payload 1 ``` { "serviceAppointment": { "parentRecordId": "0012w000004oZXgAAM", "workTypeId": "08q2w000000XmniAAC", "serviceTerritoryId": "0Hh2w000000XmoXCAS", "engagementChannelTypeId": "0eFRM00000000Bv2AI", "schedStartTime": "2020-02-26T15:00:00.000Z", "schedEndTime": "2020-02-26T16:00:00.000Z", "street": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "USA", "appointmentType": "In Person", "appointmentMode": "Group", "attendeeLimit": "20", "extendedFields": [ { "name": "Email", "value": "rachel.adams@salesforce.com" }, { "name": "Phone", "value": "111111111" }, { "name": "Description", "value": "Test Description" } ] }, "assignedResources": [ { "serviceResourceId": "0Hn2w000000gDWDCA2", "isRequiredResource": true, "isPrimaryResource": true, "extendedFields": [] }, { "serviceResourceId": "0Hn2w000000gCqnCAE", "isRequiredResource": true, "isPrimaryResource": false, "extendedFields": [] } ] } ``` _Example: example\_2_ Payload 2 Unauthenticated user ``` { "serviceAppointment": { "workTypeId": "08q2w000000XmniAAC", "serviceTerritoryId": "0Hh2w000000XmoXCAS", "engagementChannelTypeId": "0eFRM00000000Bv2AI", "schedStartTime": "2020-02-26T15:00:00.000Z", "schedEndTime": "2020-02-26T16:00:00.000Z", "street": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "USA", "appointmentType": "In Person", "appointmentMode": "Group", "attendeeLimit": "20", "extendedFields": [] }, "assignedResources": [ { "serviceResourceId": "0Hn2w000000gDWDCA2", "isRequiredResource": true, "isPrimaryResource": true, "extendedFields": [] } ], "lead": { "firstName": "Rachel", "lastName": "Adams", "phone": "012-345-6789", "email": "rachel.adams@salesforce.com", "company": "Salesforce", "extendedFields": [] } } ``` #### Responses * **200** _Service Appointment Output_ Output of the service appointment POST method. Media type: `application/json`. Schema: `ServiceAppointmentOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/service-appointments Content-Type: application/json { "serviceAppointment": { "parentRecordId": "0012w000004oZXgAAM", "workTypeId": "08q2w000000XmniAAC", "serviceTerritoryId": "0Hh2w000000XmoXCAS", "engagementChannelTypeId": "0eFRM00000000Bv2AI", "schedStartTime": "2020-02-26T15:00:00.000Z", "schedEndTime": "2020-02-26T16:00:00.000Z", "street": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "USA", "appointmentType": "In Person", "appointmentMode": "Group", "attendeeLimit": "20", "extendedFields": [ { "name": "Email", "value": "rachel.adams@salesforce.com" }, { "name": "Phone", "value": "111111111" }, { "name": "Description", "value": "Test Description" } ] }, "assignedResources": [ { "serviceResourceId": "0Hn2w000000gDWDCA2", "isRequiredResource": true, "isPrimaryResource": true, "extendedFields": [] }, { "serviceResourceId": "0Hn2w000000gCqnCAE", "isRequiredResource": true, "isPrimaryResource": false, "extendedFields": [] } ] } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/service-appointments Content-Type: application/json { "serviceAppointment": { "workTypeId": "08q2w000000XmniAAC", "serviceTerritoryId": "0Hh2w000000XmoXCAS", "engagementChannelTypeId": "0eFRM00000000Bv2AI", "schedStartTime": "2020-02-26T15:00:00.000Z", "schedEndTime": "2020-02-26T16:00:00.000Z", "street": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "USA", "appointmentType": "In Person", "appointmentMode": "Group", "attendeeLimit": "20", "extendedFields": [] }, "assignedResources": [ { "serviceResourceId": "0Hn2w000000gDWDCA2", "isRequiredResource": true, "isPrimaryResource": true, "extendedFields": [] } ], "lead": { "firstName": "Rachel", "lastName": "Adams", "phone": "012-345-6789", "email": "rachel.adams@salesforce.com", "company": "Salesforce", "extendedFields": [] } } ``` ### PATCH Service Appointments `PATCH /connect/scheduling/service-appointments` Operation ID: `patchServiceAppointment`. Tags: Salesforce Scheduler Resources. Resource to create Service Appointment, Assigned Resources, and Lead Update service appointment records. **Note**: When these parameters aren't specified, the API doesn't check for the availability of time slots. To ensure that duplicate service appointments aren't created, specify these parameters. * WorkTypeId * ServiceTerritoryId * SchedStartTime * SchedEndTime * AssignedResources _Available in: v51.0_ #### Considerations for using engagement channel types with the service-appointments resource * **Schedule Appointments Using Engagement Channels** must be enabled in Salesforce Scheduler Settings in your Salesforce org. * When you create or modify appointments, shifts must be defined in the scheduling policy. For more information on setting up shifts in the scheduling policy, see [Define Shift Rules in Scheduling Policy](https://help.salesforce.com/s/articleView?id=platform.ls_use_shifts_to_determine_time_slots.htm&type=5). Engagement channel types are not supported with operating hours rules in the scheduling policy. * When you use engagement channels and shifts to create or modify a service appointment, Salesforce Scheduler must consider the default value for the Appointment Type (if not specified). However, Salesforce Scheduler only considers the engagement channel and Appointment Type is ignored. #### Request body Input representation for updating a service appointment. Use to update the scheduled times, assigned resource(s), service territory or even work type for existing appointments. Media type: `application/json`. Schema: `UpdateServiceAppointmentInput`. #### Responses * **200** _Service Appointment Output_ Output of the service appointment POST method. Media type: `application/json`. Schema: `ServiceAppointmentOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "serviceAppointmentId": "08pxx0000004C92AAE", "serviceAppointment": { "workTypeId": "08pxx0000004C92AAE", "serviceTerritoryId": "0Hh2xx0000004CAeCAM", "engagementChannelTypeId": "0eFRM0000004CC22AM", "schedStartTime": "2020-09-15T16:00:00+0000", "schedEndTime": "2020-09-15T17:00:00+0000", "street": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "USA", "appointmentType": "In Person", "appointmentMode": "Group", "attendeeLimit": "20", "extendedFields": [ { "name": "Email", "value": "rachel.adams@salesforce.com" }, { "name": "Phone", "value": "111111111" }, { "name": "Description", "value": "Test Description" } ], "assignedResources": [ { "serviceResourceId": "0Hnxx0000004CAeCAM", "isRequiredResource": true, "isPrimaryResource": false, "extendedFields": [] }, ] } ``` _Example: Example 2 · HTTP_ ``` { "serviceAppointmentId": "08pxx0000004C92AAE", "serviceAppointment": { "schedStartTime": "2020-09-15T16:00:00+0000", "schedEndTime": "2020-09-15T17:00:00+0000", } ``` _Example: Example 3 · HTTP_ ``` { "serviceAppointmentId": "08pxx0000004C92AAE", "serviceAppointment": { "workTypeId": "08qxx0000004C92AAE", } ``` _Example: Example 4 · HTTP_ ``` { "serviceAppointmentId": "08pxx0000004C92AAE", "serviceAppointment": { "serviceTerritoryId": "0Hhxx0000004CAeCAM" } ``` _Example: Example 5 · HTTP_ ``` { "serviceAppointmentId": "08pxx0000004C92AAE", "engagementChannelTypeId": "0eFRM0000004CC22AM" } ``` ### GET Service Territories `GET /connect/scheduling/service-territories` Operation ID: `getGetServiceTerritories`. Tags: Salesforce Scheduler Resources. Resource to get service territories Get service territories for a `workTypeId` or `workTypeGroupId`. Filter and sort the service territories using the `radius`, `latitude`, `longitude`, `sortBy`, and `sortOrder` properties. _Available in: v48.0_ #### Parameters * `filterByTerritoryIds` (query, array of string) Comma-separated list of service territory IDs to filter the API response. _Available in: v57.0_ * `latitude` (query, number (double)) Latitude of the service territory area. _Available in: v48.0_ * `limit` (query, integer) Limit of the service territories returned. For example, specify limit=1 to have only one service territory in the service territories list. The default value is 40. _Available in: v48.0_ * `longitude` (query, number (double)) Longitude of the service territory area. _Available in: v48.0_ * `offset` (query, integer) Offset for the service territories returned. The default value is 0. _Available in: v48.0_ * `radius` (query, integer) Radius around the latitude and longitude values to get service territories. Default value is 5 when latitude and longitude values are provided, otherwise there is no default value. _Available in: v48.0_ * `radiusUnit` (query, string) Unit for the radius value. Possible values are `mi` for miles and `km` for kilometer. Default value is `mi` when latitude and longitude values are provided, otherwise there is no default value. _Available in: v48.0_ * `schedulingPolicyId` (query, string) ID of the `AppointmentSchedulingPolicy` object. If no scheduling policy is passed in the request body, the default configurations are used. All Scheduling Policy Configurations are considered when using this API. _Available in: v48.0_ * `serviceResourceIds` (query, array of string) Comma-separated list of service territory technician or asset IDs to filter the API response. _Available in: v48.0_ * `sortBy` (query, array of string) Criteria to sort the service territories list. Possible case-insensitive values are `distance` and `name` . The default value is `distance` when latitude and longitude values are provided, otherwise `name` . _Available in: v48.0_ * `sortOrder` (query, array of string) Sorting order of the service territory list. Possible case-insensitive values are `asc` for ascending and `desc` for descending. The default value is `asc` . _Available in: v48.0_ * `workTypeGroupId` (query, string) ID of the work type group containing the work types that are being performed. Required if `workTypeId` isn’t given _Available in: v48.0_ * `workTypeId` (query, string) ID of the type of work to be performed. Required if `workTypeGroupId` isn’t given _Available in: v48.0_ #### Responses * **200** _Service Territories Output_ Output for the service territories GET method. Media type: `application/json`. Schema: `GetServiceTerritoriesOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/connect/scheduling/service-territories?workTypeGroupId=0VSRM000000009Z4AQ&latitude=37.79332&longitude=-122.392761&radius=50&radiusUnit=km&sortBy=Distance&sortOrder=asc ``` _Example: Example 2 · HTTP_ ``` { "result": { "serviceTerritories": [ { "city": "San Francisco", "country": "United States", "id": "0HhRM00000002U50AI", "latitude": 37.79332, "longitude": -122.392761, "name": "Chase 1 Mission", "operatingHoursId": "0OHRM00000002Ps4AI", "postalCode": "94105", "state": "CA", "street": "1 Mission Street" }, { "city": "San Francisco", "country": "United States", "id": "0HhRM00000002Tq0AI", "latitude": 37.793872, "longitude": -122.394865, "name": "Chase 1 Market", "operatingHoursId": "0OHRM00000002Ps4AI", "postalCode": "94105", "state": "CA", "street": "1 Market Street" } ] } } ``` ### POST Waitlist Check Ins `POST /connect/scheduling/waitlist-checkin` Operation ID: `postWaitlistCheckIn`. Tags: Salesforce Scheduler Resources. Waitlist Checkin Resource Check in or register a participant to a waitlist who arrives at the service territory for a drop-in appointment. _Available in: v59.0_ #### Request body Input representation of the participant’s waitlist check in request. Media type: `application/json`. Schema: `WaitlistCheckInInput`. _Example: example\_1_ Payload 1 ``` { "lead": { "firstName": "Tom", "lastName": "Scott", "phone": "012-345-6789", "email": "tom.scott@phoenix.com", "company": "Phoenix", "extendedFields": [] }, "participantId": "00Q5h00000JdQWzEAN", "waitlistId": "0D3B0000000S2SeNOP", "workTypeId": "08q5h000000UuEcAAK", "workTypeGroupId": "0VSRM0000004MBk4AM", "serviceResourceId": "0Hn0000000S2SeNOP", "description": "Registration for a drop-in appointment.", "extendedFields": [ { "name": "Source__c", "value": "Email" } ] } ``` #### Responses * **200** _Waitlist Check In_ Output representation of the waitlist check in request. Media type: `application/json`. Schema: `WaitlistCheckInOutput`. _Example: example\_1_ Payload 1 ``` { "result": { "participantId": "00Q5h00000JdQWzEAN", "serviceAppointmentId": "08pxx0000004CYqAAM", "waitlistParticipantId": "12oxx0000004FGiAAM" } } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/waitlist-checkin Content-Type: application/json { "lead": { "firstName": "Tom", "lastName": "Scott", "phone": "012-345-6789", "email": "tom.scott@phoenix.com", "company": "Phoenix", "extendedFields": [] }, "participantId": "00Q5h00000JdQWzEAN", "waitlistId": "0D3B0000000S2SeNOP", "workTypeId": "08q5h000000UuEcAAK", "workTypeGroupId": "0VSRM0000004MBk4AM", "serviceResourceId": "0Hn0000000S2SeNOP", "description": "Registration for a drop-in appointment.", "extendedFields": [ { "name": "Source__c", "value": "Email" } ] } ``` ### PATCH Waitlist Participants `PATCH /connect/scheduling/waitlist/participants` Operation ID: `patchWaitlistParticipant`. Tags: Salesforce Scheduler Resources. Move a waitlist participant to the first position or last position in a waitlist. Move a participant to a specific position in a waitlist, to the top of the waitlist, or to the bottom of the waitlist. _Available in: v62.0_ #### Request body Input representation to move a waitlist participant to a specific position in a waitlist. Media type: `application/json`. Schema: `UpdateWaitlistParticipantInput`. _Example: example\_1_ Payload 1 ``` { "waitlistParticipantId": "12oRM0000004FGiYAM", "targetPosition": 3 } ``` #### Responses * **200** _Waitlist Participants Update_ Output representation of a waitlist participant move response. Media type: `application/json`. Schema: `WaitlistParticipantOutput`. _Example: example\_1_ Payload 1 ``` { "message": "Participant successfully moved to first in the Main Lobby waitlist.", "status": "success", "waitlistParticipantId": "12oRM0000004FGiYAM" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/waitlist/participants Content-Type: application/json { "waitlistParticipantId": "12oRM0000004FGiYAM", "targetPosition": 3 } ``` ### GET Waitlists `GET /connect/scheduling/waitlists` Operation ID: `getWaitlist`. Tags: Salesforce Scheduler Resources. Waitlist Resource Get waitlist details with the list of participants. A waitlist is a queue that includes participants without a scheduled appointment. _Available in: v59.0_ #### Parameters * `isActive` (query, boolean) Indicates whether to fetch the active waitlists ( `true` ) or inactive waitlists ( `false` ). Used when the `serviceTerritoryId` parameter is specified. _Available in: v59.0_ * `maxLimit` (query, integer) Batch size of the waitlist participant records to fetch for each waitlist ID or service territory ID. The default value is 50. _Available in: v59.0_ * `offset` (query, integer) Number of waitlist participant records to skip from the response, in ascending order as per the created date. The default value is 0. The maximum offset value is 2000. _Available in: v59.0_ * `participantFields` (query, array of string) Comma-separated list of fields to fetch from the waitlist participant object. _Available in: v59.0_ * `requestId` (query, string) For internal use only. _Available in: v59.0_ * `serviceTerritoryId` (query, string) ID of the service territory to fetch the details of the waitlists. Required if the `waitlistIds` parameter isn’t specified. _Available in: v59.0_ * `waitlistIds` (query, array of string (Id)) Comma-separated list of the waitlist IDs to filter the result. Required if the `serviceTerritoryId` parameter isn’t specified. _Available in: v59.0_ #### Responses * **200** _Waitlist Result_ Output representation of the waitlist result. Media type: `application/json`. Schema: `WaitlistOutput`. _Example: example\_1_ Payload 1 ``` { "result": { "waitlists": [ { "description": "None", "isActive": true, "name": "Queue_1", "serviceResources": [ { "id": "0Hnxx0000004C92CAE", "name": "Admin" }, { "id": "0Hnxx0000004CFVCA2", "name": "Standard User 2 Technician" } ], "waitlistAnalytics": { "currentParticipant": 1, "totalWaitingTime": 40, "avgWaitingTime": 20, "avgParticipants": 24 }, "waitlistId": "11wxx0000005GTHAA2", "waitlistParticipants": [ { "participant": { "id": "001xx000003GZUZAA4", "name": "Global Media" }, "participantIdentifier": "WP-0020", "serviceAppointmentId": "08pxx0000004CYqAAM", "serviceResource": { "id": "0Hnxx0000004C92CAE", "name": "Admin" }, "waitlistParticipantId": "12oxx0000004FGiAAM", "workTypeGroup": { "id": "0VSxx0000004CoyGAE", "name": "General Banking WTG" }, "createdDate": "2023-05-02T12:23:34", "extendedFields": [ { "name": "Source__c", "value": "Email" } ] } ], "workTypeGroups": [ { "id": "0VSxx0000004CoyGAE", "name": "General Banking WTG" } ] } ] } } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/waitlists?waitlistIds=0010000XKJSMEDD ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/waitlists?waitlistIds=0010000XKJSMEDD,0010000XKJSMEDD ``` _Example: Example 3 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/waitlists?serviceTerritoryId=0010000XKJSMEDD&isActive=true ``` _Example: Example 4 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/waitlists?waitlistIds=0010000XKJSMEDD&participantFields=Source__c ``` ### GET Forecasting Manager Parents by User Role or Territory ID `GET /connect/forecasting/ancestors/{forecastingTypeId}` Operation ID: `getForecastingAncestors`. Tags: Forecasts Resources. Gets a list of managers parent to the manager of the userRoleId or territoryId. Get a list of managers or territories between the context user and a specified user or territory in the forecast hierarchy. _Available in: v44.0_ In version 36.0–43.0, use Forecasting Manager Ancestors Query Get the manager at the top of the forecast hierarchy. and Forecasting Manager Ancestors, Specific User Get a list of managers between the context user and a specified user. . #### Parameters * `forecastingTypeId` (path, string (Id), required) ID of the forecast type associated with the hierarchy. Determines which hierarchy to check: user role or territory. Pattern: ^(0Db)\\w\*. * `territory2Id` (query, string, required) The unique identifier of the territory attached to this profile. _Available in: v44.0_ * `userRoleId` (query, string, required) The unique identifier of the forecasting user’s role attached to this profile. _Available in: v44.0_ #### Responses * **200** _Forecasting Ancestors_ A list of forecast managers or territories. Media type: `application/json`. Schema: `ForecastingAncestors`. ### GET Forecasting Jump-To-User-Or-Territory `GET /connect/forecasting/jump-to-user/{forecastingTypeId}` Operation ID: `getForecastingJumpTo`. Tags: Forecasts Resources. Returns a list of forecasting Users or Territories that represent the list of users or territory that can be jumped to Get a list of users and territories whose forecasts the context user has access to view. _Available in: v44.0_ In versions 36.0–43.0, use Forecasting Jump-To-User For Salesforce Forecasting, returns a list of users whose forecasts the context user has access to view. The method compares a search string to available users’ first and last names. This functionality is analogous to using Jump To on the Forecasts page. . #### Parameters * `forecastingTypeId` (path, string (Id), required) ID of the forecast type associated with the hierarchy. Determines which hierarchy to check: user role or territory. Pattern: ^(0Db)\\w\*. * `nameStartsWith` (query, string, required) The first few letters of the user’s or territory’s name. The system compares the string and returns entries that match any of the following. * The first name and last name of all users that the context user has access to * The names of all territories that the context user has access to Typing one or two letters returns a list of users only. Typing three or more letters returns a list of users and territories. For best results, start typing a territory name, and then select a user’s name from the results. _Available in: v44.0_ #### Responses * **200** _Forecasting User Collection_ A collection of forecasting users whose forecasts the context user can view. Media type: `application/json`. Schema: `ForecastingUserCollection`. ### GET Forecasting My Forecasts List `GET /connect/forecasting/my-forecasts-list/{forecastingTypeId}` Operation ID: `getForecastingMyForecasts`. Tags: Forecasts Resources. Returns the appropriate list of forecasts for the drop down for a given user Get the appropriate list of forecasts for a given user’s dropdown menu on the forecasts page. _Available in: v44.0_ #### Usage For the default case, only `forecastingTypeId` is passed in as a parameter. The appropriate lists are populated in MyForecastsCollection based on the `forecastingTypeId` that is passed in. For example, if a context user who does not have the View All Forecasts permission and does not have any forecasts shared with them passes in a territory-based `forecastingTypeId`, the `forecastManagerList` and `representativeList` are populated but the `viewAllForecastsList` and `sharedList` are not. #### Parameters * `forecastingTypeId` (path, string (Id), required) ID of the forecast type associated with the hierarchy. Determines which hierarchy to check: user role or territory. Pattern: ^(0Db)\\w\*. #### Responses * **200** _Forecasting My Forecasts Collection_ A collection of forecasting users or territories listed in the dropdown menu or in search results on the forecasts page. Media type: `application/json`. Schema: `MyForecastsCollection`. ### GET Forecasting User Access by Forecasting Type `GET /connect/forecasting/user-access/{userId}/{forecastingTypeId}` Operation ID: `getForecastingUserAccess`. Tags: Forecasts Resources. Returns an access representation that defines the context users access to the userToAccess Get information about the context user’s access to the user to which you need access. _Available in: v43.0_ In version 36.0–42.0, use Forecasting User Access . #### Parameters * `forecastingTypeId` (path, string (Id), required) ID of the forecast type associated with the hierarchy. Determines which hierarchy to check: user role or territory. Pattern: ^(0Db)\\w\*. * `userId` (path, string (Id), required) ID of the user. Pattern: ^(005)\\w\*. * `territory2Id` (query, string (Id)) ID of the territory that we’re trying to determine whether a user can access. _Available in: v43.0_ * `user` (query, string (Id)) ID of the user for which we’re trying to retrieve access. _Available in: v43.0_ #### Responses * **200** _Forecasting User Access Collection_ A collection of forecast user access representations. Media type: `application/json`. Schema: `ForecastingUserAccessCollection`. ### POST Translation Export `POST /connect/i18n/translation/export` Operation ID: `createExportJob`. Tags: Translation Workbench Resources (Beta). Creates an asynchronous translation export job Create an asynchronous Translation Workbench export job. _Available in: v67.0_ #### Request body Translation Workbench export request with filters and format options. Media type: `application/json`. Schema: `TwbExportRequestInput`. _Example: example\_1_ Payload 1 ``` { "filters": { "languages": [ "es", "fr" ], "exportType": "Metadata", "contentFilter": "SourceAndTranslations", "statusFilter": "AllRecords", "timeRangeFilter": { "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-31T23:59:59Z" }, "setupComponentsFilter": [ "ActionLinkGroupTemplateItem", "CustomFieldDefinition" ] }, "format": "Xliff" } ``` #### Responses * **200** _Translation Workbench Export Job_ Translation Workbench export job creation response. Media type: `application/json`. Schema: `TwbExportJobOutput`. ### GET Translation Export Job Status `GET /connect/i18n/translation/export/{jobId}/status` Operation ID: `getExportJobStatus`. Tags: Translation Workbench Resources (Beta). Returns the current status of a translation export job Get the status of a Translation Workbench export job. _Available in: v67.0_ #### Parameters * `jobId` (path, string, required) ID of the job. #### Responses * **200** _Translation Workbench Export Job Status_ Translation Workbench export job status. Media type: `application/json`. Schema: `TwbExportJobStatusOutput`. ### POST Translation Import `POST /connect/i18n/translation/import` Operation ID: `createImportJob`. Tags: Translation Workbench Resources (Beta). Creates an asynchronous translation import job Create an asynchronous Translation Workbench import job. _Available in: v67.0_ **Note:** Upload a binary file to create an asynchronous translation workbench import job. To upload a binary file, send it in a multipart/form-data request with the `file` header parameter in the binary upload body part of the request. For information about how to create the multiplart/form-data request, see [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input). #### Parameters * `parameters` (query, string) JSON string with import parameters. _Available in: v67.0_ #### Request body (required) _Available in: v67.0_ Media type: `application/octet-stream`. Schema: `string (binary)`. Type: `string (binary)`. #### Responses * **200** _Translation Workbench Import Job_ Translation Workbench import job creation response. Media type: `application/json`. Schema: `TwbImportJobOutput`. ### GET Translation Import Job Status `GET /connect/i18n/translation/import/{jobId}/status` Operation ID: `getImportJobStatus`. Tags: Translation Workbench Resources (Beta). Returns the current status of a translation import job Get the status of a Translation Workbench import job. _Available in: v67.0_ #### Parameters * `jobId` (path, string, required) ID of the job. #### Responses * **200** _Translation Workbench Import Job Status_ Translation Workbench import job status. Media type: `application/json`. Schema: `TwbImportJobStatusOutput`. ### GET Pardot Business Unit Context `GET /connect/pardot/business-unit-context` Operation ID: `getBusinessUnitContext`. Tags: Pardot Business Unit Context Resources. Information about the set of Pardot business units the context user has access to Get the Pardot business units the context user has access to. _Available in: v55.0_ #### Parameters * `isCurrent` (query, boolean) Specifies whether to return only the business unit that’s selected as the context user's current business unit context in the business unit switcher of the Pardot Lightning app (`true`) or to return only the business units that aren’t selected as the context user's current business unit context (`false`). If unspecified, all the business units the user has access to, including current and non-current business units, are returned. _Available in: v55.0_ #### Responses * **200** _Pardot Business Unit Context Output_ Pardot business unit context. Media type: `application/json`. Schema: `PardotBusinessUnitContextOutput`. ### GET Briefcase Priming Records `GET /connect/briefcase/priming-records` Operation ID: `getPrimingRecords`. Tags: Briefcase Priming Records Resources. Priming records endpoint. Get a list of records related to an offline briefcase. A client app only gets records from briefcases that are assigned to it. To ensure a reasonable response time, the priming API limits the single request processing time and the number of records returned in a single response. Briefcase rules are processed sequentially. When either the processing time or limit is reached, the processing stops, and a response is returned to the client that includes the records for the rules processed. If the non-null `relayToken` in the response indicates that not all the rules were processed, then the client must continue making requests until the `relayToken` returns a null value. _Available in: v54.0_ #### Parameters * `changedAfterTimestamp` (query, string) ISO 8601 date string. When present, filters the data for priming by records that were created or modified after the specified time. This parameter applies only to top-level briefcase rules, and not to related rules. You can include either `changedAfterTimestamp` or `relayToken` in a request, but not both. _Available in: v55.0_ * `relayToken` (query, string) When present, identifies the relay point to start processing from. You can include either `changedAfterTimestamp` or `relayToken` in a request, but not both. _Available in: v54.0_ #### Responses * **200** _Priming Record Collection_ Collection of records for offline priming. Media type: `application/json`. Schema: `PrimingRecordCollection`. ### GET List Share Recipients `GET /connect/list-share-recipients` Operation ID: `getListShareRecipients`. Tags: List Share Resources. Returns data about potential shares for a list. Get data on all groups, and all potential groups, a list view is shared with. _Available in: v44.0_ #### Parameters * `listViewId` (query, string) To find out which groups a specific list view can be shared with, use this parameter. When provided, entities that are already shared with the provided list view are removed from the output. To return all the possible groups to share a new a new list view with, omit this parameter. _Available in: v44.0_ * `q` (query, string) Filters results to groups or roles whose name contains the search term. _Available in: v44.0_ * `shareType` (query, ListShareType) Filters results to the type of group a list view is shared with. Values are: * `ChannelProgramGroup` —Shared with a channel program. * `Regular` —Shared with a group. * `Role` —Shared with a role. * `RoleAndSubordinates` —Shared with a role and all subordinates types. * `RoleAndSubordinatesInternal` —Shared with a role and subordinates that aren’t partners. * `Territory` —Shared with a territory. * `TerritoryAndSubordinates` —Shared with a territory and its subordinates. _Available in: v44.0_ #### Responses * **200** _List Share Collection_ Current and potential shares associated with a list. Media type: `application/json`. Schema: `ListShareCollection`. ### GET List Shares `GET /connect/list-shares/{listViewId}` Operation ID: `getListShares`. Tags: List Share Resources. Returns share data for list. Get share data for a list view. _Available in: v44.0_ #### Parameters * `listViewId` (path, string (Id), required) ID of the list view. Pattern: ^(00B)\\w\*. #### Responses * **200** _List Current Share Collection_ Current shares associated with a list. Media type: `application/json`. Schema: `ListCurrentShareCollection`. ### PUT List Shares `PUT /connect/list-shares/{listViewId}` Operation ID: `updateListShares`. Tags: List Share Resources. Returns share data for list. Replace all shares associated with a list view. _Available in: v44.0_ #### Parameters * `listViewId` (path, string (Id), required) ID of the list view. Pattern: ^(00B)\\w\*. #### Request body Shares to associate with a list. Media type: `application/json`. Schema: `ListCurrentShareCollectionInput`. _Example: example\_1_ Payload 1 ``` { "currentListShares": [ "00GD00000000izfKAA", "00GD00000000izfKAA", "00GD00000000izfKAA" ] } ``` #### Responses * **200** _List Current Share Collection_ Current shares associated with a list. Media type: `application/json`. Schema: `ListCurrentShareCollection`. ### DELETE List Shares `DELETE /connect/list-shares/{listViewId}` Operation ID: `deleteListShare`. Tags: List Share Resources. Returns share data for list. Delete all shares associated with a list view. _Available in: v44.0_ #### Parameters * `listViewId` (path, string (Id), required) ID of the list view. Pattern: ^(00B)\\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. ### GET Flow Approval Processes `GET /connect/interaction/flow-approval-process/status` Operation ID: `getFlowApprovalProcess`. Tags: Flow Approval Processes Resources. Get the status and available actions for flow approval processes. Get the status and available actions for flow approval processes. _Available in: v66.0_ #### Parameters * `processNames` (query, array of string, required) List of flow approval process names. _Available in: v66.0_ * `relatedRecordId` (query, string, required) ID of the related record associated with the approval submission. _Available in: v66.0_ #### Responses * **200** _Flow Approval Process Collection_ The results of requesting a flow approval status. Media type: `application/json`. Schema: `FlowApprovalProcessCollection`. ### GET Orchestration Instance Detail `GET /connect/interaction/orchestration/instance/detail` Operation ID: `getFlowOrchestrationInstance`. Tags: Orchestration Resources. Retrieves run, stage and step runtime data of an orchestration instance Get orchestration instance details. _Available in: v63.0_ #### Parameters * `instanceId` (query, string, required) The ID of orchestration instance to get details for. _Available in: v63.0_ #### Responses * **200** _Orchestration Instance_ Orchestration instance. Media type: `application/json`. Schema: `FlowOrchestrationInstance`. ### GET Orchestration Instances `GET /connect/interaction/orchestration/instances` Operation ID: `getFlowOrchestrationInstanceCollection`. Tags: Orchestration Resources. Retrieves a collection of Orchestration instances Get orchestration instances. _Available in: v54.0_ #### Parameters * `relatedOrchestrationId` (query, string) The ID of an orchestration configured as context for orchestration interactive steps. Required if `relatedRecordId` isn’t specified _Available in: v66.0_ * `relatedRecordId` (query, string) The ID of a record configured as a context record for orchestration interactive steps. Required if `relatedOrchestrationId` isn’t specified _Available in: v54.0_ #### Responses * **200** _Orchestration Instance Collection_ Collection of orchestration instances. Media type: `application/json`. Schema: `FlowOrchestrationInstanceCollection`. ### GET Navigation Menu Items `GET /connect/communities/{communityId}/navigation-menu/navigation-menu-items` Operation ID: `getCommunityNavigationMenu`. Tags: Navigation Menu Items Resources. Navigation Menu Items Collection Resource Get navigation menu items for an Experience Cloud site. Supported navigation menu item types are: * `DataSourceDriven` —Menu items dynamically added from a data source. * `Event` —Event, such as logging in, logging out, or switching accounts. * `ExternalLink` —URL outside of your site. * `GlobalAction` —Lets users create records that aren’t related to other records. * `InternalLink` —Relative URL inside your site. * `MenuLabel` —Menu label. * `Modal` —Modal, such as Account Switcher. * `NavigationalTopic` —Dropdown list with links to the navigational topics in your site. * `SalesforceObject` —Objects such as accounts, cases, contacts, and custom objects. * `SystemLink` —System link, such as a link to Builder, Workspaces, or Setup. _Available in: v47.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `addHomeMenuItem` (query, boolean) Specifies whether to add the Home menu item (`true`) or not (`false`). _Available in: v47.0_ * `catalogVersionId` (query, string (Id)) Pattern: ^(1zs)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v54.0_ * `includeImageUrl` (query, boolean) Specifies whether to include the image URL with the menu item (`true`) or not (`false`). _Available in: v47.0_ * `language` (query, string) * `menuItemTypesToSkip` (query, array of string) List of menu item types to filter out of the results. Values are: * `DataSourceDriven` —Menu items dynamically added from a data source. * `Event` —Event, such as logging in, logging out, or switching accounts. * `ExternalLink` —URL outside of your site. * `GlobalAction` —Lets users create records that aren’t related to other records. * `InternalLink` —Relative URL inside your site. * `MenuLabel` —Menu label. * `Modal` —Modal, such as Account Switcher. * `NavigationalTopic` —Dropdown list with links to the navigational topics in your site. * `SalesforceObject` —Objects such as accounts, cases, contacts, and custom objects. * `SystemLink` —System link, such as a link to Builder, Workspaces, or Setup. _Available in: v47.0_ * `navigationLinkSetDeveloperName` (query, string) Developer name of the navigation link set. Provide either `navigationLinkSetIdDeveloperName` or `navigationLinkSetId` . _Available in: v49.0_ * `navigationLinkSetId` (query, string) ID of the navigation link set. _Available in: v47.0_ * `publishStatus` (query, ConnectPublishStatusEnum) Publish status of the navigation menu item. _Available in: v47.0_ #### Responses * **200** _Navigation Menu Item Collection_ Collection of navigation menu items. Media type: `application/json`. Schema: `NavigationMenuItemCollection`. ### POST Push Notifications `POST /connect/notifications/push` Operation ID: `postPushNotification`. Tags: Push Notifications Resources. Send push notification to the list of users Send a mobile push notification to client apps on users’ devices. This resource is only accessible when the session is established with a client app that is developed in the same org or installed in the same package as the recipient’s client app. _Available in: v31.0_ #### Parameters * `appName` (query, string, required) The API name of the client app that the push notification is sent to. _Available in: v31.0_ * `namespace` (query, string) The namespace of the client app that the push notification is sent to. Required if the namespace is set _Available in: v31.0_ * `payload` (query, string, required) The push notification payload in JSON format. _Available in: v31.0_ * `userIds` (query, array of string, required) The push notification recipient user ids. _Available in: v31.0_ #### Request body (required) A push notification. _Available in: v31.0_ Media type: `application/json`. Schema: `PushNotificationInput`. _Example: example\_1_ Payload 1 ``` { "appName": "TestApp", "namespace": "abc", "userIds": [ "005x00000013dPK", "005x00000013dPL" ], "payload": "{'aps':{'alert':'test', 'badge':0, 'sound':'default'}}" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `Empty`. ### GET Quip Related Records `GET /connect/quip/related-records/{quipDocumentId}` Operation ID: `getQuipRelatedRecords`. Tags: Quip Related Records Resources. Quip Related Records endpoint Get records related to a Quip document. _Available in: v49.0_ #### Parameters * `quipDocumentId` (path, string, required) ID of the Quip document. #### Responses * **200** _Quip Related Records_ List of records related to a Quip document. Media type: `application/json`. Schema: `QuipRelatedRecords`. ### GET Messaging Channels `GET /connect/livemessage/channels` Operation ID: `getLiveMessageChannels`. Tags: Messaging Channels Resources. LiveMessage API to manage MessageChannels. You can get Messaging channels using the GET method. If a channel doesn't already have an ID, you can add and register it by taking the data from the GET method and passing it to the POST method. _Available in: v44.0_ #### Parameters * `authProviderId` (query, string) ID of the authentication provider record that the user created during authentication. If this value is not provided, the request only queries the org and doesn't query any external sources. If this value is provided, it must have a valid, unexpired token. _Available in: v44.0_ * `cursor` (query, string) Paged cursor position. The response to a GET can be paged. If it is paged, we provide a cursor in the response. Passing that cursor as an argument to the next GET request provides the next page. If the cursor is missing from the response, there are no additional pages. If the cursor is not passed as an argument, the first page is returned. _Available in: v44.0_ * `limit` (query, integer) Maximum number of channels to return in the response to the GET request. If provided, the response is paged. If not provided, the response contains all channels, which can take some time if you have many channels. _Available in: v44.0_ * `messageType` (query, MessageTypeEnum) Type of channel. Values are: * `Facebook` —A Facebook message. * `Line` —A LINE message. * `Text` —A text message. Required if the `authProviderId` is given _Available in: v44.0_ #### Responses * **200** _Messaging Channels_ List of messaging channels. Media type: `application/json`. Schema: `LiveMessageChannels`. ### POST Messaging Channels `POST /connect/livemessage/channels` Operation ID: `postLiveMessageChannels`. Tags: Messaging Channels Resources. LiveMessage API to manage MessageChannels. If a channel doesn't already have an ID, you can add and register it by taking the data from the GET method and passing it to the POST method. _Available in: v44.0_ #### Parameters * `authProviderId` (query, string, required) ID of the authentication provider record that the user created during authentication. _Available in: v44.0_ #### Request body (required) Data required to create a Messaging channel. _Available in: v44.0_ Media type: `application/json`. Schema: `LiveMessageChannelInput`. _Example: example\_1_ Payload 1 ``` { "messageType": "Facebook", "messagingPlatformKey": "234420552541404", "externalAccountId": "394847389739" } ``` #### Responses * **200** _Messaging Channel_ Messaging channel. Media type: `application/json`. Schema: `LiveMessageChannel`. ### GET Einstein Article Recommendations Runtime Metrics `GET /connect/article-recommendations/metrics/runtime/{channelType}` Operation ID: `getArticleRecommendationsRuntimeMetrics`. Tags: Einstein Recommendation Resources. Endpoint for service einstein metrics. Get Einstein Article Recommendations runtime metrics for the case channel type. _Available in: v52.0_ #### Parameters * `channelType` (path, ArticleRecommendationsChannelTypeEnum, required) The channel type. #### Responses * **200** _Article Recommendations Runtime Metrics_ Article recommendations runtime metrics. Media type: `application/json`. Schema: `ArticleRecommendationsRuntimeMetrics`. ### GET Einstein Reply Recommendations Runtime Metrics `GET /connect/reply-recommendations/metrics/runtime/{channelType}` Operation ID: `getEinsteinSupportReplyRecommendationsMetrics`. Tags: Einstein Recommendation Resources. Endpoint for reply recommendations metrics. Get Einstein Reply Recommendations runtime metrics for the chat channel type. _Available in: v52.0_ #### Parameters * `channelType` (path, ReplyRecommendationsChannelTypeEnum, required) The channel type. #### Responses * **200** _Reply Recommendations Metrics_ Reply recommendations metrics. Media type: `application/json`. Schema: `ReplyRecommendationsMetrics`. ### POST Voice Root Email Address, Accept Update `POST /connect/voice/root-email-address-update/accept` Operation ID: `postRootEmailAddressResetAccept`. Tags: Voice Resources. Connect API For Root Email Address Reset Accept Resource Accept the email address change for the AWS root user that's associated with the Voice account. This resource applies to the Service Cloud Voice with Amazon Connect partner telephony model. _Available in: v64.0_ #### Request body Accept the email address change for the AWS root user that's associated with the Voice account. This request applies to the Service Cloud Voice with Amazon Connect partner telephony model. Media type: `application/json`. Schema: `RootEmailAddressResetAcceptInput`. _Example: example\_1_ Payload 1 ``` { "emailAddress": "awsrootuser@mycompany.com", "otp": "340146" } ``` #### Responses * **200** _Voice Root Email Address Update Status_ AWS root user email address update. Media type: `application/json`. Schema: `RootEmailAddressResetAPIResponse`. ### POST Voice Root Email Address, Start Update `POST /connect/voice/root-email-address-update/start` Operation ID: `postRootEmailAddressResetStart`. Tags: Voice Resources. Connect API for Root Email Address Reset Accept Resource. Start the process to change the email address of the AWS root user that's associated with the Voice account. This resource applies to the Service Cloud Voice with Amazon Connect partner telephony model. Start the email address update process by sending an email message to the AWS root user. The message includes a one-time password (OTP), which the email recipient uses to accept the email address change. Email notifications are also sent to all admins of the Salesforce org. _Available in: v64.0_ #### Request body Start the process to change the email address of the AWS root user that's associated with the Voice account. This request applies to the Service Cloud Voice with Amazon Connect partner telephony model. Media type: `application/json`. Schema: `RootEmailAddressResetStartInput`. _Example: example\_1_ Payload 1 ``` { "emailAddress": "awsrootuser@mycompany.com" } ``` #### Responses * **200** _Voice Root Email Address Update Status_ AWS root user email address update. Media type: `application/json`. Schema: `RootEmailAddressResetAPIResponse`. ### PUT Share Captured Activity `PUT /salesforce-inbox/shared-activities/{activityId}` Operation ID: `putActivitySharing`. Tags: Share Captured Activity Resources. Resource for sharing activities (i.e. emails or events) Share an email or event that was captured by Automated Activity Capture, which is a feature of Sales Cloud Einstein and Inbox. You can share with no one, everyone, or selected groups. _Available in: v39.0_ #### Parameters * `activityId` (path, string, required) Unique ID used to represent an activity (i.e. email or event). #### Request body Defines who a captured email or event is shared with. Media type: `application/json`. Schema: `ActivitySharingInput`. _Example: example\_1_ Payload 1 ``` { "groupsToShareWith": [ "0F9B00000004EVAKA2", "0F9B00000005YGHKA2", "0F9B00000008RTUKA2" ], "sharingType": "MyGroups" } ``` #### Responses * **200** _Share Captured Activity Result_ Represents the results of sharing a captured email or event. Media type: `application/json`. Schema: `ActivitySharingResult`. ### GET Conversation Entries `GET /connect/conversation/{conversationIdentifier}/entries` Operation ID: `getConversationEntries`. Tags: Conversations Resources. Resource for fetching Conversation Entries for a given Conversation Get conversation entries. **Note**: The Conversation Entries resource is designed to retrieve individual conversations or small batches of transcripts, not for bulk data export or large-scale data analysis. This API has a different hourly rate limit than standard Salesforce APIs and bulk usage will likely cause you to hit that limit quickly. Each API call marks the conversation as active, counting against [your org’s concurrent active session limit](https://help.salesforce.com/s/articleView?id=service.livemessage_limitations.htm&type=5). Exceeding this limit can result in errors or dropped messages. For better options to export or analyze conversation data, see [Accessing Messaging and Voice Conversation Data](https://help.salesforce.com/s/articleView?id=service.conversation_transcript_access.htm&type=5&language=en_US). The conversation entry (transcript) for a voice call isn’t available until after the voice call record is created. An error occurs if you try to fetch the transcript before the record is created. _Available in: v51.0_ #### Parameters * `conversationIdentifier` (path, string, required) Identifier for the conversation. * `endTimestamp` (query, integer (int64)) End timestamp, in milliseconds, for the conversation. For example, 1600788018. _Available in: v51.0_ * `queryDirection` (query, ConversationEntryQueryDirection) Direction of the query. If unspecified, the default is `FromEnd` . _Available in: v51.0_ * `recordLimit` (query, integer) Maximum number of entries to return. Valid values are from 1 to 1000. If unspecified, the default is 25. _Available in: v51.0_ * `startTimestamp` (query, integer (int64)) Start timestamp, in milliseconds, for the conversation. If unspecified, the default is 0. _Available in: v51.0_ #### Responses * **200** _Conversation Entries_ List of entries in the conversation. Media type: `application/json`. Schema: `ConversationEntries`. ### PATCH Conversation Entries `PATCH /connect/conversation/{conversationIdentifier}/entries` Operation ID: `patchConversationEntries`. Tags: Conversations Resources. Resource for fetching Conversation Entries for a given Conversation Update conversation entries. **Note**: The Conversation Entries resource is designed to retrieve individual conversations or small batches of transcripts, not for bulk data export or large-scale data analysis. This API has a different hourly rate limit than standard Salesforce APIs and bulk usage will likely cause you to hit that limit quickly. Each API call marks the conversation as active, counting against [your org’s concurrent active session limit](https://help.salesforce.com/s/articleView?id=service.livemessage_limitations.htm&type=5). Exceeding this limit can result in errors or dropped messages. For better options to export or analyze conversation data, see [Accessing Messaging and Voice Conversation Data](https://help.salesforce.com/s/articleView?id=service.conversation_transcript_access.htm&type=5&language=en_US). _Available in: v51.0_ #### Parameters * `conversationIdentifier` (path, string, required) Identifier for the conversation. #### Request body List of conversation entry updates. Media type: `application/json`. Schema: `ConversationEntriesUpdateInput`. _Example: example\_1_ Payload 1 ``` { "conversationEntriesUpdates": [ { "identifier": "36b0f4d9-7c14-43dc-bb9e-7713a4930df0", "messageText": "The credit card I used was xxxx-xxxx-xxxx-4321." }, { "identifier": "46b0f5d9-7c14-43dc-bb9e-b713a4930df1", "messageText": "My ssn is: XXXXX." } ] } ``` #### Responses * **200** _Conversation Entries Update_ List of conversation entry update results. Media type: `application/json`. Schema: `ConversationEntriesUpdate`. ### GET Conversations, Bulk Upload and Statuses `GET /connect/conversations/upload` Operation ID: `getConversationBulkUpload`. Tags: Conversations Resources. Resource for bulk upload of Conversations Get the statuses of the uploads. _Available in: v51.0_ **Note:** Use GET to get the statuses of bulk conversation uploads. #### Parameters * `uploadIds` (query, array of string, required) Comma-separated list of up to 100 upload IDs. _Available in: v51.0_ #### Responses * **200** _Conversation Bulk Upload Statuses_ Collection of statuses for the bulk upload of conversations. Media type: `application/json`. Schema: `ConversationBulkUploadStatuses`. ### POST Conversations, Bulk Upload and Statuses `POST /connect/conversations/upload` Operation ID: `postConversationBulkUpload`. Tags: Conversations Resources. Resource for bulk upload of Conversations Upload bulk conversations. _Available in: v51.0_ **Note:** Use POST to bulk upload conversations up to 512 MB. **Note:** To upload a binary file, you must send it in a multipart/form-data request. 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:** For a detailed example of bulk conversation upload, see [Upload and Update Transcripts with Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.voice_developer_guide.meta/voice_developer_guide/voice_connect_overview.htm). #### Request body Media type: `application/octet-stream`. Schema: `string (binary)`. Type: `string (binary)`. #### Responses * **200** _Conversation Bulk Uploads_ List of conversation bulk upload results. Media type: `application/json`. Schema: `ConversationBulkUploads`. ### POST Estimated Wait Time `POST /connect/scheduling/estimated-wait-time` Operation ID: `getEstimatedWaitTime`. Tags: Salesforce Scheduler Resources. Resource used to get the estimated wait time for a customer waiting for service that belongs to a specified work type group. Get the estimated wait time for a customer waiting for service that belongs to a specified work type group. _Available in: v65.0_ #### Request body Input representation of the request for the estimated wait time of a waitlist or waitlist participant. Media type: `application/json`. Schema: `EstimatedWaitTimeInput`. _Example: example\_1_ Payload 1 With waitlist ID ``` { "waitlistId": "11wfi700000262vAAA" } ``` _Example: example\_2_ Payload 2 With waitlist participant ID ``` { "waitlistParticipantId": "12oxx0000004FGiAAM" } ``` #### Responses * **200** _Estimated Wait Time_ Output representation of the estimated wait time for a waitlist or waitlist participant. Media type: `application/json`. Schema: `EstimatedWaitTimeOutput`. _Example: example\_1_ Payload 1 ``` { "waitlistId": "11wfi700000262vAAA", "waitlistParticipantEstimatedWaitTime": "", "waitlistParticipantId": "", "workTypeGroups": [ { "workTypeGroupEstimatedWaitTime": "Unavailable", "workTypeGroupId": "0VSfi70000008yTGAQ" } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/estimated-wait-time Content-Type: application/json { "waitlistId": "11wfi700000262vAAA" } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/estimated-wait-time Content-Type: application/json { "waitlistParticipantId": "12oxx0000004FGiAAM" } ``` ### POST Cancel Appointments `POST /connect/unified-scheduling/actions/cancel` Operation ID: `cancel`. Tags: Workforce Scheduling Resources. API resource to cancel an appointment Cancel one or more service appointments. _Available in: v66.0_ #### Request body Input representation for canceling one or more service appointments. Media type: `application/json`. Schema: `CancelAppointmentCollectionInput`. _Example: example\_1_ Payload 1 ``` { "appointments": [ { "serviceAppointmentId": "08pJS00000K09UPYAZ", "status": "Canceled", "cancellationReason": "Customer requested cancellation" } ] } ``` #### Responses * **200** _Cancel Appointment Collection Output_ Output representation for the cancel operation. Media type: `application/json`. Schema: `CancelAppointmentCollectionOutput`. _Example: example\_1_ Payload 1 ``` { "result": [ { "appointmentId": "08pJS00000K09UPYAZ", "errors": [] } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/unified-scheduling/actions/cancel Content-Type: application/json { "appointments": [ { "serviceAppointmentId": "08pJS00000K09UPYAZ", "status": "Canceled", "cancellationReason": "Customer requested cancellation" } ] } ``` ### POST Appointment Candidates `POST /connect/unified-scheduling/actions/get-appointment-candidates` Operation ID: `getAppointmentCandidates`. Tags: Workforce Scheduling Resources. API resource to get appointment candidates Get the available time slots and candidate resources for a specified work type and territories. _Available in: v66.0_ #### Request body Input representation for requesting available appointment time slots or candidate resources. Media type: `application/json`. Schema: `GetAppointmentCandidatesSlotsInput`. _Example: example\_1_ Payload 1 ``` { "appointments": [ { "schedulingMethod": "OnSite", "coreDetails": { "startTime": "2026-05-13T00:00:00Z", "endTime": "2026-06-10T00:00:00Z", "workConfiguration": { "workTypeId": "08qJS000000256rYAA" }, "locationConstraints": { "addressIds": [ "0HhJS0000000NB70AM" ] } }, "auxiliaryDetails": { "engagementChannelTypeId": [ "0eFJS000000001d2AA" ] }, "assignedResources": [ { "isRequiredResource": true, "serviceResourceId": "0HnJS0000003n2d0AA" } ] } ] } ``` #### Responses * **200** _Get Appointment Candidates Output_ Output representation for the get-appointment-candidates operation. Media type: `application/json`. Schema: `GetAppointmentCandidatesOutput`. _Example: example\_1_ Payload 1 ``` { "result": [ { "candidates": [ { "startTime": "2026-05-13T12:00:00.000Z", "endTime": "2026-05-13T13:00:00.000Z", "resourceId": "0HnJS0000003n2d0AA", "territoryId": "0HhJS0000000NB70AM", "engagementChannelTypeIds": [] } ] } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/unified-scheduling/actions/get-appointment-candidates Content-Type: application/json { "appointments": [ { "schedulingMethod": "OnSite", "coreDetails": { "startTime": "2026-05-13T00:00:00Z", "endTime": "2026-06-10T00:00:00Z", "workConfiguration": { "workTypeId": "08qJS000000256rYAA" }, "locationConstraints": { "addressIds": [ "0HhJS0000000NB70AM" ] } }, "auxiliaryDetails": { "engagementChannelTypeId": [ "0eFJS000000001d2AA" ] }, "assignedResources": [ { "isRequiredResource": true, "serviceResourceId": "0HnJS0000003n2d0AA" } ] } ] } ``` ### POST Appointment Slots `POST /connect/unified-scheduling/actions/get-appointment-slots` Operation ID: `getAppointmentSlots`. Tags: Workforce Scheduling Resources. API resource to get appointment slots Gets the available time slots for a specified service resource. _Available in: v66.0_ #### Request body Input representation for requesting available appointment time slots or candidate resources. Media type: `application/json`. Schema: `GetAppointmentCandidatesSlotsInput`. _Example example\_1: same as POST /connect/unified-scheduling/actions/get-appointment-candidates request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Get Appointment Slots Output_ Output representation for the get-appointment-slots operation. Media type: `application/json`. Schema: `GetAppointmentSlotsOutput`. _Example: example\_1_ Payload 1 ``` { "result": [ { "slots": [ { "startTime": "2026-05-13T12:00:00.000Z", "endTime": "2026-05-13T13:00:00.000Z", "territoryId": "0HhJS0000000NB70AM", "remainingAppointments": 1, "engagementChannelTypeIds": [] } ] } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/unified-scheduling/actions/get-appointment-slots Content-Type: application/json { "appointments": [ { "schedulingMethod": "OnSite", "coreDetails": { "startTime": "2026-05-13T00:00:00Z", "endTime": "2026-06-10T00:00:00Z", "workConfiguration": { "workTypeId": "08qJS000000256rYAA" }, "locationConstraints": { "addressIds": [ "0HhJS0000000NB70AM" ] } }, "auxiliaryDetails": { "engagementChannelTypeId": [ "0eFJS000000001d2AA" ] }, "assignedResources": [ { "isRequiredResource": true, "serviceResourceId": "0HnJS0000003n2d0AA" } ] } ] } ``` ### POST Reschedule Appointments `POST /connect/unified-scheduling/actions/reschedule` Operation ID: `reschedule`. Tags: Workforce Scheduling Resources. API resource to reschedule one or more appointments Reschedule one or more service appointments to new times. _Available in: v66.0_ #### Request body Input representation for rescheduling one or more service appointments. Media type: `application/json`. Schema: `RescheduleAppointmentCollectionInput`. _Example: example\_1_ Payload 1 ``` { "rescheduleAppointments": [ { "schedulingMethod": "OnSite", "appointmentId": "08pJS00000K09SnYAJ", "startTime": "2026-05-14T14:00:00.000Z", "endTime": "2026-05-14T15:00:00.000Z" } ] } ``` #### Responses * **200** _Appointment Collection Output_ Output representation for the schedule and reschedule operations. Media type: `application/json`. Schema: `AppointmentCollectionOutput`. _Example: example\_1_ Payload 1 ``` { "appointments": [ { "operation": "CreateOperation", "schedulingStatus": "Success", "schedulingType": "Requested", "serviceAppointment": { "serviceAppointmentId": "08pJS00000K09SnYAJ", "resourceIds": [ "03rJS00000Mk8u1YAB" ] }, "errors": [] } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/unified-scheduling/actions/reschedule Content-Type: application/json { "rescheduleAppointments": [ { "schedulingMethod": "OnSite", "appointmentId": "08pJS00000K09SnYAJ", "startTime": "2026-05-14T14:00:00.000Z", "endTime": "2026-05-14T15:00:00.000Z" } ] } ``` ### POST Schedule Appointments `POST /connect/unified-scheduling/actions/schedule` Operation ID: `schedule`. Tags: Workforce Scheduling Resources. API resource to schedule one or more appointments Schedule one or more service appointments. _Available in: v66.0_ #### Request body Input representation for scheduling one or more service appointments. Media type: `application/json`. Schema: `ScheduleAppointmentCollectionInput`. _Example: example\_1_ Payload 1 ``` { "appointments": [ { "schedulingMethod": "OnSite", "coreDetails": { "startTime": "2026-05-14T12:00:00.000Z", "endTime": "2026-05-14T13:00:00.000Z", "status": "Scheduled", "subject": "Office visit", "workConfiguration": { "workTypeId": "08qJS000000256rYAA" }, "locationConstraints": { "id": "0HhJS0000000NB70AM" } }, "serviceAppointmentParent": { "id": "001JS000000eZrzYAE" }, "auxiliaryDetails": { "engagementChannelTypeId": "0eFJS000000001d2AA" }, "assignedResources": [ { "isRequiredResource": true, "isPrimaryResource": false, "serviceResourceId": "0HnJS0000003n2d0AA" } ] } ] } ``` #### Responses * **200** _Appointment Collection Output_ Output representation for the schedule and reschedule operations. Media type: `application/json`. Schema: `AppointmentCollectionOutput`. _Example example\_1: same as POST /connect/unified-scheduling/actions/reschedule 200 response._ Payload 1 _Example: example\_1_ Payload 1 #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/connect/unified-scheduling/actions/schedule Content-Type: application/json { "appointments": [ { "schedulingMethod": "OnSite", "coreDetails": { "startTime": "2026-05-14T12:00:00.000Z", "endTime": "2026-05-14T13:00:00.000Z", "status": "Scheduled", "subject": "Office visit", "workConfiguration": { "workTypeId": "08qJS000000256rYAA" }, "locationConstraints": { "id": "0HhJS0000000NB70AM" } }, "serviceAppointmentParent": { "id": "001JS000000eZrzYAE" }, "auxiliaryDetails": { "engagementChannelTypeId": "0eFJS000000001d2AA" }, "assignedResources": [ { "isRequiredResource": true, "isPrimaryResource": false, "serviceResourceId": "0HnJS0000003n2d0AA" } ] } ] } ``` ### POST Run a Privacy Policy `POST /privacycenter/datamanagement/job` Operation ID: `submitPolicyRunRequest`. Tags: Privacy Center Resources. Resource for creating Privacy Policy jobs. Submit a run request for a data management privacy policy. Specify the privacy policy to run with the `policyId` query parameter. _Available in: v67.0_ #### Parameters * `policyId` (query, string (Id)) Id of the Privacy Policy to run. Pattern: ^(8so)\\w\*. #### Responses * **200** Success Media type: `application/json`. Schema: `PrivacyPolicyRunRequestOutput`. ### POST Audit Consent Status `POST /globalconsent/consentstatus/audit` Operation ID: `auditConsentStatus`. Tags: Global Consent Manager Resources. The api resource for auditing consent status with flexible field return. Audit consent status for multiple data subjects with option to return all fields _Available in: v68.0_ #### Request body Media type: `application/json`. Schema: `ConsentStatusInput`. #### Responses * **200** Success Media type: `application/json`. Schema: `ConsentStatusOutput`. ### POST Read Consent Status `POST /globalconsent/consentstatus/read` Operation ID: `readConsentStatus`. Tags: Global Consent Manager Resources. The api resource for reading consent status. Read consent status for multiple data subjects _Available in: v68.0_ #### Request body Media type: `application/json`. Schema: `ConsentStatusInput`. #### Responses * **200** Success Media type: `application/json`. Schema: `ConsentStatusOutput`. ### POST Write Consent Status `POST /globalconsent/consentstatus/write` Operation ID: `writeConsentStatus`. Tags: Global Consent Manager Resources. The api resource for writing consent status. Write consent status for multiple data subjects _Available in: v68.0_ #### Request body Media type: `application/json`. Schema: `ConsentStatusWriteInput`. #### Responses * **200** Success Media type: `application/json`. Schema: `ConsentStatusWriteOutput`. ### POST Start a Global Consent Store Export Job `POST /globalconsent/export/jobs` Operation ID: `startConsentExportJob`. Tags: Global Consent Manager Resources. The api resource for starting Global Consent Store export jobs. Start a Global Consent Store data export job for the calling org and return its job id. The export destination is read server-side from the org's saved export configuration; it is never accepted from the request. Idempotent on clientRequestId: a repeated request with the same clientRequestId returns the existing job rather than starting a new one. This is the programmatic entry point behind enabling export on the Consent Export Settings setup page. The org/tenant is derived server-side from the authenticated context. _Available in: v68.0_ #### Request body Media type: `application/json`. Schema: `ConsentExportJobStartInput`. #### Responses * **200** Success Media type: `application/json`. Schema: `ConsentExportJobOutput`. ### GET Get a Global Consent Store Export Job `GET /globalconsent/export/jobs/{jobId}` Operation ID: `getConsentExportJob`. Tags: Global Consent Manager Resources. The api resource for reading and updating a Global Consent Store export job by id. Read an export job by its Salesforce id. Returns the coarse status (mapped from the platform GridforceJobState), plus the raw gridforceState and gridforceJobId for diagnostics. Feeds the "Status" section of the Consent Export Settings setup page. The org/tenant is derived server-side from the authenticated context. _Available in: v68.0_ #### Parameters * `jobId` (path, string, required) The Salesforce id of the export job. #### Responses * **200** Success Media type: `application/json`. Schema: `ConsentExportJobOutput`. ### POST Decode a Preference Center Token `POST /privacycenter/prefcenter/v1/decodetoken` Operation ID: `decodeToken`. Tags: Privacy Center Resources. API resource for decoding a Preference Center token Decodes an encrypted Preference Center token into its record ID and metadata _Available in: v68.0_ #### Request body Media type: `application/json`. Schema: `DecodeTokenInput`. #### Responses * **200** Success Media type: `application/json`. Schema: `DecodeTokenOutput`. ### POST Submit a Right to Be Forgotten Request `POST /privacycenter/rtbf/v1/job` Operation ID: `submitRtbfRunRequest`. Tags: Privacy Center Resources. API resource for executing a Right to Be Forgotten request Executes a Right to Be Forgotten request immediately _Available in: v68.0_ #### Request body Media type: `application/json`. Schema: `RtbfRunRequestInput`. #### Responses * **200** Success Media type: `application/json`. Schema: `RtbfRunRequestOutput`. ### POST Microbatching `POST /connect/communities/{communityId}/microbatching` Operation ID: `postMicrobatchingIngestion`. Tags: Microbatching Resources. Microbatching record ingestion Ingest microbatching records. _Available in: v55.0_ #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. #### Request body Media type: `application/json`. Schema: `MicrobatchingIngestionInput`. _Example: example\_1_ Payload 1 ``` { "requestBody": { "Description": "Lead for xyz", "LastName": "Inc", "Status": "New" }, "processType": "LEAD_MS", "groupBy": "sampleGroupByValue" } ``` #### Responses * **200** _Microbatching Ingestion Output_ Microbatching ingestion response. Media type: `application/json`. Schema: `MicrobatchingIngestionOutput`. ### GET Microbatching Errors `GET /connect/communities/{communityId}/microbatching/errors` Operation ID: `getMicrobatchingErrorRecordInfoCollection`. Tags: Microbatching Resources. Fetch collection of microbatching error recordInfo rows. Get microbatching errors. _Available in: v54.0_ #### Alternate paths * `/connect/microbatching/errors` (version 54.0 only) - Base Scope #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `earliestDate` (query, string) ISO 8601 date string for the oldest date from which to get records. The results include errors that occurred on the oldest date. _Available in: v54.0_ * `errorCategory` (query, ConnectMicrobatchingErrorCategoryEnum) Category of the errors. Values are: * `AdminActionable` — Errors caused by conditions that can be fixed by site admins. * `AutoRetry` — Errors that are automatically reprocessed with the Microbatching Errors Resubmission resource. * `InvalidSetup` — Errors caused by invalid setup. Errors of this category can’t be reprocessed with the Microbatching Errors Resubmission resource. * `NonRetryable` — Errors that can’t be reprocessed with the Microbatching Errors Resubmission resource. * `Unknown` — Errors caused by conditions that can’t be fixed by site admins or users. * `UserActionable` — Errors caused by conditions that can be fixed by users. If unspecified, all error categories are returned. _Available in: v54.0_ * `errorCode` (query, string) Error code associated with the failed record. _Available in: v54.0_ * `includeRequestBody` (query, boolean) Specifies whether to include the JSON request body in the response ( `true` ) or not ( `false` ). Only users with the Manage Experiences user permission can include the request body in the response. If unspecified, the default value is `false`. _Available in: v54.0_ * `latestDate` (query, string) ISO 8601 date string for the most recent date from which to get records. The results include errors that occurred on the most recent date. _Available in: v54.0_ * `pageSize` (query, integer) Specifies the number of records per page. Valid values are from 1 through 100. If unspecified, the default is 100. _Available in: v54.0_ * `pageToken` (query, string) Token specifying the page of records. Page tokens are returned as part of the response, such as `currentPageToken` or `nextPageToken`. If unspecified, the first page is returned. _Available in: v54.0_ * `processType` (query, string, required) Logical name of the flow in the microbatching framework. Values are: * `LEAD_MS` * `SELF_REGISTRATION` _Available in: v54.0_ * `sortOrder` (query, ConnectMicrobatchingErrorsSortOrderEnum) * `status` (query, string) Status of failed records. Values are: * `Error` — Records in failed state. * `Reprocessing` — Records that are reprocessing. _Available in: v54.0_ #### Responses * **200** _Microbatching Error Record Info Collection_ Collection of microbatching error records. Media type: `application/json`. Schema: `MicrobatchingErrorRecordInfoCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` /connect/communities/0DBD20000004CZsOAM/microbatching/errors?processType=SELF_REGISTRATION ``` _Example: Example 2 · HTTP_ ``` connect/communities/0DBD20000004CZsOAM/microbatching/errors?processType=SELF_REGISTRATION&earliestDate=2023-10-02T00:14:15.375Z ``` ### DELETE Microbatching Errors `DELETE /connect/communities/{communityId}/microbatching/errors` Operation ID: `deleteMicrobatchingErrorRecordInfoCollection`. Tags: Microbatching Resources. Fetch collection of microbatching error recordInfo rows. Delete microbatching errors. _Available in: v54.0_ #### Alternate paths * `/connect/microbatching/errors` (version 54.0 only) - Base Scope #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `earliestDate` (query, string) ISO 8601 date string for the oldest date from which to get records. The results include errors that occurred on the oldest date. _Available in: v54.0_ * `errorCategory` (query, ConnectMicrobatchingErrorCategoryEnum) Category of the errors. Values are: * `AdminActionable` — Errors caused by conditions that can be fixed by site admins. * `AutoRetry` — Errors that are automatically reprocessed with the Microbatching Errors Resubmission resource. * `InvalidSetup` — Errors caused by invalid setup. Errors of this category can’t be reprocessed with the Microbatching Errors Resubmission resource. * `NonRetryable` — Errors that can’t be reprocessed with the Microbatching Errors Resubmission resource. * `Unknown` — Errors caused by conditions that can’t be fixed by site admins or users. * `UserActionable` — Errors caused by conditions that can be fixed by users. If unspecified, all error categories are deleted. _Available in: v54.0_ * `errorCode` (query, string) Error code associated with the failed record. _Available in: v54.0_ * `latestDate` (query, string) ISO 8601 date string for the most recent date from which to get records. The results include errors that occurred on the most recent date. _Available in: v54.0_ * `pageSize` (query, integer) Specifies the maximum number of records to delete in a single DELETE request. Valid values are from 1 through 100. If unspecified, the default is 100. If there is more than one page of records to delete, continue making DELETE requests until all the pages of records are deleted. _Available in: v54.0_ * `processType` (query, string, required) Logical name of the flow in the microbatching framework. Values are: * `LEAD_MS` * `SELF_REGISTRATION` _Available in: v54.0_ * `status` (query, string) Status of failed records. Values are: * `Error` — Records in failed state. * `Reprocessing` — Records that are reprocessing. _Available in: v54.0_ #### Responses * **204** _Successful Delete_ Success ### POST Microbatching Errors Resubmission `POST /connect/communities/{communityId}/microbatching/errors/resubmission` Operation ID: `postMicrobatchingErrorResubmission`. Tags: Microbatching Resources. Submit a collection of microbatching error records for reprocessing Resubmit microbatching error records. **Note**: `InvalidSetup` and `NonRetryable` categories of errors aren’t supported by this API. If you resubmit errors of those categories, they aren’t reprocessed. _Available in: v54.0_ `/connect/microbatching/errors/resubmission` (version 54.0 only) #### Alternate paths * `/connect/microbatching/errors/resubmission` - Base Scope #### Parameters * `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site. * `earliestDate` (query, string) ISO 8601 date string for the oldest date from which to resubmit records. The results include errors that occurred on the oldest date. _Available in: v54.0_ * `errorCode` (query, string) Error code associated with the failed record. _Available in: v54.0_ * `keyPrefix` (query, string) Object keyPrefix that a specified `processType` is tied to in the microbatching framework. _Available in: v54.0_ * `latestDate` (query, string) ISO 8601 date string for the most recent date from which to resubmit records. The results include errors that occurred on the most recent date. _Available in: v54.0_ * `pageSize` (query, integer) Specifies the maximum number of records to resubmit. Valid values are from 1 through 1500. If unspecified, the default is 1500. _Available in: v54.0_ * `pageToken` (query, string) Page token specifying the last submission. The response returns the `nextPageToken`. If unspecified, the first page is returned. _Available in: v54.0_ * `processType` (query, string, required) Logical name of the flow in the microbatching framework. Values are: * `LEAD_MS` * `SELF_REGISTRATION` _Available in: v54.0_ #### Responses * **200** _Microbatching Error Resubmission_ Microbatching error resubmission. Media type: `application/json`. Schema: `MicrobatchingErrorResubmission`. ### GET Employee Banner Photo `GET /connect/employee-profiles/{employeeId}/banner-photo` Operation ID: `getEmployeeBannerPicture`. Tags: Employee Profiles Resources. Use this resource to access the banner photo for the specified employee, 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 an employee banner photo. To use an image from the Files page as the employee banner photo, pass the file ID in the request body or the request parameters. To upload a binary file as the employee 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). _Available in: v51.0_ #### Parameters * `employeeId` (path, string (Id), required) ID of the employee. Pattern: ^(0id)\\w\*. #### Responses * **200** _Banner Photo_ A banner photo. Media type: `application/json`. Schema: `BannerPhoto`. ### POST Employee Banner Photo `POST /connect/employee-profiles/{employeeId}/banner-photo` Operation ID: `postEmployeeBannerPicture`. Tags: Employee Profiles Resources. Use this resource to access the banner photo for the specified employee, 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. Upload and crop. To use an image from the Files page as the employee banner photo, pass the file ID in the request body or the request parameters. To upload a binary file as the employee 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). _Available in: v51.0_ **Note**: Photos are processed asynchronously and may not be visible right away. #### Parameters * `employeeId` (path, string (Id), required) ID of the employee. Pattern: ^(0id)\\w\*. * `cropHeight` (query, integer) Height of the crop rectangle in pixels. _Available in: v51.0_ * `cropWidth` (query, integer) Width of the crop rectangle in pixels. _Available in: v51.0_ * `cropX` (query, integer) X position of the crop rectangle from the left edge of the image in pixels. Top left is position (0,0). _Available in: v51.0_ * `cropY` (query, integer) Y position of the crop rectangle from the top edge of the image in pixels. Top left is position (0,0). _Available in: v51.0_ * `fileId` (query, 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. Required to use an existing file _Available in: v51.0_ * `versionNumber` (query, integer) Version number of an existing file. If not provided, the latest version is used. _Available in: v51.0_ #### Request body A banner photo. _Available in: v51.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 Employee Banner Photo `DELETE /connect/employee-profiles/{employeeId}/banner-photo` Operation ID: `deleteEmployeeBannerPicture`. Tags: Employee Profiles Resources. Use this resource to access the banner photo for the specified employee, 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 an employee banner photo. To use an image from the Files page as the employee banner photo, pass the file ID in the request body or the request parameters. To upload a binary file as the employee 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). _Available in: v51.0_ #### Parameters * `employeeId` (path, string (Id), required) ID of the employee. Pattern: ^(0id)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Employee Photo `GET /connect/employee-profiles/{employeeId}/photo` Operation ID: `getEmployeeProfilePicture`. Tags: Employee Profiles Resources. Get the URL of a employee photo and post a employee 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 employee profile photos in a feed, cache the employee 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 an employee photo. _Available in: v51.0_ #### Parameters * `employeeId` (path, string (Id), required) ID of the employee. Pattern: ^(0id)\\w\*. #### Responses * **200** _Photo_ Photo. Media type: `application/json`. Schema: `Photo`. ### POST Employee Photo `POST /connect/employee-profiles/{employeeId}/photo` Operation ID: `postEmployeeProfilePicture`. Tags: Employee Profiles Resources. Get the URL of a employee photo and post a employee 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 employee profile photos in a feed, cache the employee 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. Upload and crop an employee photo. _Available in: v51.0_ **Note**: Photos are processed asynchronously and may not be visible right away. #### Parameters * `employeeId` (path, string (Id), required) ID of the employee. Pattern: ^(0id)\\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: v51.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: v51.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: v51.0_ * `fileId` (query, string) ID of an existing file. The file must be an image and be smaller than 2 GB. Required to choose an existing file. _Available in: v51.0_ * `versionNumber` (query, integer) Version number of an existing file. If not provided, the latest version is used. _Available in: v51.0_ #### Request body Describes a photo input. _Available in: v51.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 Employee Photo `DELETE /connect/employee-profiles/{employeeId}/photo` Operation ID: `deleteEmployeeProfilePicture`. Tags: Employee Profiles Resources. Get the URL of a employee photo and post a employee 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 employee profile photos in a feed, cache the employee 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 an employee photo. _Available in: v51.0_ #### Parameters * `employeeId` (path, string (Id), required) ID of the employee. Pattern: ^(0id)\\w\*. #### Responses * **204** _Successful Delete_ Success ## Schemas ### ActionLinkGroupDefinitionInput The definition of an action link group. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group. Information in the action link definition can be sensitive to a third party (for example, OAuth bearer token headers). For this reason, only requests made via the client app that created the action link definition can read, modify, or delete the definition. In addition, the user making the request must have created the definition or have View All Data permission. * `actionLinks` (_array of ActionLinkDefinitionInput_) The action links in the 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. Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value. _Available in: v33.0_ * `category` (_object_) ConnectPlatformActionGroupCategoryEnum Indicates the priority and relative locations of action links in an associated feed item. 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. You can create up to three action links in a `Primary` group and up to four in an `Overflow` group. Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value. _Available in: v33.0_ Includes all fields of `ConnectPlatformActionGroupCategoryEnum`. * `executionsAllowed` (_object_) ConnectActionLinkExecutionsAllowedEnum Defines the number of times an action link can be executed. Values are: * `Once` —An action link can be executed only one time across all users. * `OncePerUser` —An action link can be executed only one time for each user. * `Unlimited` —An action link can be executed an unlimited number of times by each user. If the action link’s `actionType` is `Api` or `ApiAsync`, you can’t use this value. Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value. _Available in: v33.0_ Includes all fields of `ConnectActionLinkExecutionsAllowedEnum`. * `expirationDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, that represents the date and time this action link group is removed from associated feed items and can no longer be executed. The `expirationDate` must be within one year of the creation date. If the action link group definition includes an OAuth token, it is a good idea to set the expiration date of the action link group to the same value as the expiration date of the OAuth token so that users can’t execute the action link and get an OAuth error. To set a date when instantiating from a template, see Set the Action Link Group Expiration Time in [Design Action Link Templates](https://help.salesforce.com/s/articleView?id=platform.action_link_group_template_design.htm&type=5). Required to instantiate this action link group without a template. Optional to instantiate from a template. _Available in: v33.0_ * `templateBindings` (_array of ActionLinkTemplateBindingInput_) A collection of key-value pairs to fill in binding variable values or a custom user alias from an action link template. To instantiate this action link group from an action link template that uses binding variables, you must provide values for all the variables. See Define Binding Variables in [Design Action Link Templates](https://help.salesforce.com/s/articleView?id=platform.action_link_group_template_design.htm&type=5). To instantiate without a template, don’t specify a value. Required to instantiate this action link group from a template that uses binding variables. _Available in: v33.0_ * `templateId` (_string_) The ID of the action link group template from which to instantiate this action link group. To instantiate without a template, don’t specify a value. Required to instantiate this action link group from a template. _Available in: v33.0_ ### ActionLinkGroupDefinition The definition of an action link group. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group. * `actionLinks` (_array of ActionLinkDefinition_) A collection of action link definitions that make up the action link 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_ * `category` (_object_) ConnectPlatformActionGroupCategoryEnum Indicates the priority and location of the action links. 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`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v33.0_ _Filter group: Small_ * `executionsAllowed` (_object_) ConnectActionLinkExecutionsAllowedEnum Defines the number of times an action link can be executed. Values are: * `Once` —An action link can be executed only one time across all users. * `OncePerUser` —An action link can be executed only one time for each user. * `Unlimited` —An action link can be executed an unlimited number of times by each user. If the action link’s `actionType` is `Api` or `ApiAsync`, you can’t use this value. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `ConnectActionLinkExecutionsAllowedEnum`. * `expirationDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, that represents the date and time this action group expires and can no longer be executed. If the value is `null`, there isn’t an expiration date. _Available in: v33.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the action link group definition _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_ * `templateId` (_string (Id)_) The ID of the action link group template from which to instantiate this action link group, or `null` if this group isn’t associated with a template. _Available in: v33.0_ _Filter group: Medium_ * `url` (_string (url)_) Connect REST API URL for this action link group definition. _Available in: v33.0_ _Filter group: Small_ ### 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_ ### 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}`](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Action-Links-Resources/operation/getActionLink) 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 `Reference`. * `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}`](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Action-Links-Resources/operation/getActionLink) 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_ Allowed values: `Api`, `ApiAsync`, `Download`, `Ui`. * `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_ ### 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}`](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Action-Links-Resources/operation/getActionLink) resource. _Available in: v33.0_ _Filter group: Small_ Type: `string`. Allowed values: `FailedStatus`, `NewStatus`, `PendingStatus`, `SuccessfulStatus`. ### ActionLinkInput The desired execution status of an action link. * `status` (_object_, required) ConnectPlatformActionStatusEnum The current status of the 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. _Available in: v33.0_ Includes all fields of `ConnectPlatformActionStatusEnum`. ### ActionLinkDiagnostic Any diagnostic information that is returned from the REST endpoint when an action link has been executed. Diagnostic information is given only for users who can access the action link. * `diagnosticInfo` (_string_) Any diagnostic information that is returned from the REST endpoint when an action link has been executed. Diagnostic information is given only for users who can access the action link. _Available in: v33.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL for this action link diagnostic. _Available in: v33.0_ _Filter group: Small_ ### NotificationCollection Collection of notifications. * `notifications` (_array of Notification_) Collection of notifications. _Available in: v49.0_ _Filter group: Small_ ### NotificationCollectionInput Collection of notifications to update. * `before` (_string (date-time)_) Notifications occurring before this ISO 8601 formatted date string to mark as read, unread, seen, or unseen. If unspecified, the default is the current date and time. _Available in: v49.0_ * `notificationIds` (_array of string_) List of up to 50 notification IDs to mark as read, unread, seen, or unseen. This property can’t be used with the `before` property. _Available in: v49.0_ * `read` (_boolean_) Marks notifications as read (`true`) or unread (`false`). If notifications are marked as read, they are also marked as seen. If you set `read` to `true` and `seen` to `false`, you get an error. Required if `seen` isn’t specified _Available in: v49.0_ * `seen` (_boolean_) Marks notifications as seen (`true`) or unseen (`false`). Required if `read` isn’t specified _Available in: v49.0_ ### NotificationAppSettingsCollection Notification app settings. * `notificationAppSettings` (_array of NotificationAppSettings_) Collection of notification app settings. _Available in: v47.0_ _Filter group: Small_ ### NotificationApplicationSettingsInput Notification app setting. **Note**: Starting in API version 64.0, the Notification App Setting Input request body supports external client apps, in addition to connected apps. Mobile, push notification, and notification plugins for external client apps (beta) are available in API version 64.0. * `applicationId` (_string_) ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session. _Available in: v47.0_ * `enabled` (_boolean_) Specifies whether to enable delivery of the notification type for the connected app or external client app (`true`) or not (`false`). _Available in: v47.0_ * `notificationTypeOrId` (_string_) Notification Type or Id of the custom notification type. * `pushEnabled` (_boolean_) Enable/disable push in the connected application. ### NotificationAppSettings Notification app setting. * `applicationDevName` (_string_) Developer name of the client app. _Available in: v47.0_ _Filter group: Medium_ * `applicationId` (_string_) ID of the client app. _Available in: v47.0_ _Filter group: Small_ * `applicationName` (_string_) Name of the client app. _Available in: v47.0_ _Filter group: Small_ * `applicationNamespace` (_string_) Namespace of the client app if it’s installed with a managed package. _Available in: v47.0_ _Filter group: Medium_ * `enabled` (_boolean_) Specifies whether the notification type is enabled for the client app (`true`) or not (`false`). If `true` , notifications of this type are displayed in the tray. _Available in: v47.0_ _Filter group: Small_ * `notificationLabel` (_string_) Display label of the notification. _Available in: v47.0_ _Filter group: Small_ * `notificationTypeName` (_string_) API name of the custom notification type. _Available in: v47.0_ _Filter group: Medium_ * `notificationTypeNamespace` (_string_) Namespace of the custom notification type if it’s installed with a managed package. _Available in: v47.0_ _Filter group: Medium_ * `notificationTypeOrId` (_string_) Notification type or ID of the custom notification type. _Available in: v47.0_ _Filter group: Small_ * `pushEnabled` (_boolean_) Specifies whether push is enabled for the notification type in the client app (`true`) or not (`false`). _Available in: v47.0_ _Filter group: Small_ ### NotificationSettingsCollection Notification settings. * `notificationSettings` (_array of NotificationSettings_) Collection of notification settings. _Available in: v47.0_ _Filter group: Small_ ### NotificationSettings Notification setting. * `advancedEmailEnabled` (_boolean_) Reserved for future use. _Available in: v67.0_ _Filter group: Small_ * `advancedSlackEnabled` (_boolean_) Reserved for future use. _Available in: v67.0_ _Filter group: Small_ * `advancedTeamsEnabled` (_boolean_) Reserved for future use. _Available in: v67.0_ _Filter group: Small_ * `desktopEnabled` (_boolean_) Specifies whether desktop delivery is enabled for the notification type (`true`) or not (`false`). _Available in: v47.0_ _Filter group: Small_ * `emailEnabled` (_boolean_) Specifies whether email delivery is enabled for the notification type (`true`) or not (`false`). _Available in: v47.0_ _Filter group: Small_ * `mobileEnabled` (_boolean_) Specifies whether mobile delivery is enabled for the notification type (`true`) or not (`false`). _Available in: v47.0_ _Filter group: Small_ * `multiChannelSlackEnabled` (_boolean_) Multi Channel Delivery with Slack Enabled. * `notificationLabel` (_string_) Display label of the notification. _Available in: v47.0_ _Filter group: Small_ * `notificationTypeName` (_string_) API name of the custom notification type. _Available in: v47.0_ _Filter group: Medium_ * `notificationTypeNamespace` (_string_) Namespace of the custom notification type if it’s installed with a managed package. _Available in: v47.0_ _Filter group: Medium_ * `notificationTypeOrId` (_string_) Notification type or ID of the custom notification type. _Available in: v47.0_ _Filter group: Small_ * `slackEnabled` (_boolean_) Reserved for future use. _Available in: v52.0_ _Filter group: Small_ ### NotificationSettingInput Notification setting input. * `desktopEnabled` (_boolean_) Specifies whether to enable desktop delivery for the notification type (`true`) or not (`false`). If not specified, the setting doesn’t change. _Available in: v47.0_ * `emailEnabled` (_boolean_) Specifies whether to enable email delivery for the notification type (`true`) or not (`false`). If not specified, the setting doesn’t change. _Available in: v47.0_ * `mobileEnabled` (_boolean_) Specifies whether to enable mobile delivery for the notification type (`true`) or not (`false`). If not specified, the setting doesn’t change. _Available in: v47.0_ * `slackEnabled` (_boolean_) Reserved for future use. _Available in: v52.0_ ### NotificationStatus Status of notifications for the context user. * `lastActivity` (_string (date-time)_) Date and time of latest activity date for any notifications or, if none, the current date and time. _Available in: v49.0_ _Filter group: Small_ * `oldestUnread` (_string (date-time)_) Date and time of oldest unread notification or, if none, the current date and time. _Available in: v49.0_ _Filter group: Small_ * `oldestUnseen` (_string (date-time)_) Date and time of oldest unseen notification or, if none, the current date and time. _Available in: v49.0_ _Filter group: Small_ * `unreadCount` (_integer_) Count of unread notifications. _Available in: v49.0_ _Filter group: Small_ * `unseenCount` (_integer_) Count of unseen notifications. _Available in: v49.0_ _Filter group: Small_ ### NotificationTypeCollection Collection of notification types. * `notificationTypes` (_array of NotificationType_) Collection of notification types. _Available in: v66.0_ _Filter group: Small_ ### Notification Notification. * `actionGroup` (_object_) NotificationActionGroup Action group for the notification. _Available in: v67.0_ _Filter group: Small_ Includes all fields of `NotificationActionGroup`. * `additionalData` (_string_) Reserved for future use. _Available in: v49.0_ _Filter group: Small_ * `communityId` (_string_) ID of the Experience Cloud site for the notification. _Available in: v49.0_ _Filter group: Small_ * `communityName` (_string_) Name of the Experience Cloud site for the notification. _Available in: v49.0_ _Filter group: Small_ * `count` (_integer_) Total number of events for the notification. For custom notifications that are exposed to third-party developers, the value is `1` . _Available in: v49.0_ _Filter group: Small_ * `id` (_string_) ID of the notification. _Available in: v49.0_ _Filter group: Small_ * `image` (_string_) URL to the image associated with the notification. _Available in: v49.0_ _Filter group: Medium_ * `lastModified` (_string (date-time)_) Date and time when the notification was last modified. _Available in: v49.0_ _Filter group: Small_ * `messageBody` (_string_) Body of the message for the notification. _Available in: v49.0_ _Filter group: Small_ * `messageTitle` (_string_) Title of the message for the notification. _Available in: v49.0_ _Filter group: Small_ * `mostRecentActivityDate` (_string (date-time)_) Date and time of the most recent activity for the notification. _Available in: v49.0_ _Filter group: Small_ * `organizationId` (_string_) ID of the notification recipient’s org. _Available in: v49.0_ _Filter group: Small_ * `read` (_boolean_) Specifies whether the notification is marked read (`true`) or unread (`false`). _Available in: v49.0_ _Filter group: Small_ * `recipientId` (_string_) ID of the recipient of the notification. _Available in: v49.0_ _Filter group: Small_ * `seen` (_boolean_) Specifies whether the notification is marked seen (`true`) or unseen (`false`). _Available in: v49.0_ _Filter group: Small_ * `target` (_string_) ID of the record associated with the notification. _Available in: v49.0_ _Filter group: Medium_ * `targetPageRef` (_string_) Page reference for notification target. _Available in: v50.0_ _Filter group: Medium_ * `type` (_string_) Type of notification. For custom notifications, this is the custom notification type ID. _Available in: v49.0_ _Filter group: Small_ * `url` (_string_) URL to the notification. _Available in: v49.0_ _Filter group: Small_ ### NotificationInput Notification to update. * `read` (_boolean_) Marks a notification as read (`true`) or unread (`false`). If a notification is marked as read, it is also marked as seen. If you set `read` to `true` and `seen` to `false`, you get an error. Required if `seen` isn’t specified _Available in: v49.0_ * `seen` (_boolean_) Marks a notification as seen (`true`) or unseen (`false`). Required if `read` isn’t specified _Available in: v49.0_ ### NotificationActionInput Optional JSON body for the action. May contain any keys. * `actionPayload` (_object_) Optional payload data for the notification action. Can contain any JSON object structure. Additional properties: `object`. ### ActionResult Notification action execution result. * `message` (_string_) Notification action execution result message. _Available in: v66.0_ _Filter group: Small_ ### ExperienceModelTypeDesignConfigTargetEnum The design configuration targets for Experience Model Types. Type: `string`. Allowed values: `BrandCenterEditor`, `ContentTemplate`, `Default`, `DynamicVariant`, `EasyEmail`, `Email`, `EmailTemplate`, `EnhancedMessaging`, `EnhancedWebChat`, `ExperienceBuilder`, `Form`, `LandingPage`, `LandingPageTemplate`, `LightningCanvas`, `LightningCommunity`, `LightningDesktopCopilot`, `LightningDesktopDesign`, `LightningExperience`, `LightningMiawCopilot`, `LightningMobileCopilot`, `LightningSetupChat`, `MiawCopilot`, `PreviewAndTest`, `PromptBuilder`, `QuickSettings`, `ScEverywhere`, `SlackCopilot`, `WebHtml`. ### ExperienceModelTypeRenditionConfigTargetEnum The rendition configuration targets for Experience Model Types. Type: `string`. Allowed values: `AdaptiveCards`, `AgenticApps`, `Default`, `Detail`, `Email`, `EnhancedMessaging`, `EnhancedWebChat`, `LightningCanvas`, `LightningDesktopCopilot`, `LightningDesktopDesign`, `LightningMiawCopilot`, `LightningMobileCopilot`, `LightningSetupChat`, `MiawCopilot`, `Mweb`, `ScEverywhere`, `SlackCopilot`, `Summary`, `TemplatePreview`, `WebHtml`. ### ExperienceModelPropertyTypeCollection Collection of property types. * `count` (_integer_) Number of types returned. _Available in: v58.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the page of types. _Available in: v58.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) URL to the next page of types. _Available in: v58.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of types. _Available in: v58.0_ _Filter group: Medium_ * `propertyTypes` (_array of ExperienceModelPropertyTypeSummary_) List of property types ordered alphabetically by title. _Available in: v58.0_ _Filter group: Small_ ### ExperienceModelPropertyTypeDetail Property type detail. * `description` (_string_) Description of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ * `designConfig` (_object_) Design configuration for the specified target. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `developerName` (_string_) Developer name, or apiName, of the type. _Available in: v58.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the type, returned only for database-based (custom) types. _Available in: v58.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fullyQualifiedName. _Available in: v58.0_ _Filter group: Small_ * `renditionConfig` (_object_) Rendition configuration for the specified target. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `schema` (_object_) JSON schema definition, or schema.json, of the type. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `title` (_string_) The title of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ ### NetworkDataCategoryTree Network data category tree. * `communityId` (_string (Id)_) ID of the Experience Cloud site. _Available in: v59.0_ _Filter group: Small_ * `dataCategoryGroups` (_array of NetworkDataCategoryGroup_) List of category groups. _Available in: v59.0_ _Filter group: Small_ ### DataCategoryGroupCollectionInput Collection of data category groups. * `dataCategoryGroups` (_array of DataCategoryGroupInput_, required) Collection of data category groups. _Available in: v59.0_ ### Empty A response with no properties. ### NetworkDataCategory Category network. * `categoryName` (_string_) Name of the category network. _Available in: v59.0_ _Filter group: Small_ * `childCategories` (_array of NetworkDataCategory_) Subcategories of the category network. _This property is recursive: each item has the same structure as `NetworkDataCategory`._ _Available in: v59.0_ _Filter group: Medium_ * `description` (_string_) Description of the category network. _Available in: v59.0_ _Filter group: Medium_ * `id` (_string (Id)_) ID of the category network. _Available in: v59.0_ _Filter group: Small_ * `imageUrl` (_string (url)_) Image URL of the category network. _Available in: v59.0_ _Filter group: Small_ * `label` (_string_) Label of the category network. _Available in: v59.0_ _Filter group: Small_ * `relativeUrl` (_string_) Relative URL of the network data category. _Available in: v60.0_ _Filter group: Small_ ### 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`. ### ServiceCatalogItemCollection Collection of service catalog items. * `baseUrl` (_string_) Lightning Web Runtime (LWR) Base URL for the Service Catalog Item Definition Detail page. _Available in: v60.0_ _Filter group: Small_ * `items` (_array of ServiceCatalogItem_) List of service catalog items. _Available in: v59.0_ _Filter group: Small_ ### NetworkDataCategoryCollection List of network data categories. * `baseUrl` (_string_) Lightning Web Runtime (LWR) base URL for the Network Data Category Detail page. _Available in: v60.0_ _Filter group: Small_ * `networkDataCategories` (_array of NetworkDataCategory_) List of network data categories. _Available in: v60.0_ _Filter group: Small_ ### LightningKnowledgeArticleVersionCollection Collection of knowledge articles in Lightning. * `baseUrl` (_string_) Lightning Web Runtime (LWR) base URL for the Knowledge Article Detail page. _Available in: v60.0_ _Filter group: Small_ * `items` (_array of LightningKnowledgeArticleVersion_) List of knowledge articles. _Available in: v59.0_ _Filter group: Small_ ### DataCategoryGroupCollection Data category group collection. * `dataCategoryGroups` (_array of DataCategoryGroup_) List of data category groups. _Available in: v59.0_ _Filter group: Small_ ### KnowledgeArticleViewStatInput Knowledge article view stat input. * `articleOrVersionId` (_string_, required) ID of the knowledge article or knowledge article version to increase the view count by one. If you provide the ID of a knowledge article version, the parent article view count is increased. _Available in: v48.0_ ### KnowledgeArticleVersionCollection A collection of knowledge article versions. * `items` (_array of KnowledgeArticleVersion_) A collection of knowledge article versions. _Available in: v36.0_ _Filter group: Small_ ### ConnectManagedTopicTypeEnum Type of managed topic. * `Content` —Topics that are associated with native content. * `Featured` —Topics that are featured, for example, on the Experience Cloud site home page, but don’t provide overall navigation. * `Navigational` —Topics that display in a navigational menu in the Experience Cloud site. A topic can be associated with all three managed topic types, so a topic can be a `Featured`, `Navigational`, and `Content` topic. You can create up to 25 `Featured` and 5,000 `Content` topics. You can create up to eight levels of `Navigational` managed topics with 25 top-level topics and 10 children topics per level for a maximum of 2,775 `Navigational` topics. To create a child managed topic, specify `Navigational` as the `managedTopicType` and specify a `parentId`. _Available in: v32.0_ Type: `string`. Allowed values: `Content`, `Featured`, `Navigational`. ### ManagedTopicCollection A collection of managed topics in an Experience Cloud site. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v32.0_ _Filter group: Medium_ * `managedTopics` (_array of ManagedTopic_) Collection of managed topics. _Available in: v32.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: v44.0_ _Filter group: Medium_ ### ManagedTopicInput A managed topic. * `managedTopicType` (_object_, required) ConnectManagedTopicTypeEnum Type of managed topic. * `Content` —Topics that are associated with native content. * `Featured` —Topics that are featured, for example, on the Experience Cloud site home page, but don’t provide overall navigation. * `Navigational` —Topics that display in a navigational menu in the Experience Cloud site. A topic can be associated with all three managed topic types, so a topic can be a `Featured`, `Navigational`, and `Content` topic. You can create up to 25 `Featured` and 5,000 `Content` topics. You can create up to eight levels of `Navigational` managed topics with 25 top-level topics and 10 children topics per level for a maximum of 2,775 `Navigational` topics. To create a child managed topic, specify `Navigational` as the `managedTopicType` and specify a `parentId`. _Available in: v32.0_ Includes all fields of `ConnectManagedTopicTypeEnum`. * `name` (_string_) Name of the managed topic. Required for new topics. You must specify either `name` or `recordId`. You can’t specify both. _Available in: v32.0_ * `parentId` (_string_) ID of the parent managed topic. If you specify a `parentId`, also specify `Navigational` as the `managedTopicType`. You can create up to eight levels (parent, direct children, their children, etc.) of managed topics and up to 10 children managed topics per managed topic. _Available in: v35.0_ * `recordId` (_string_) ID of the record to become a managed topic. In version 32.0 and later, `recordId` must be a topic ID. Required for existing topics if the `Name` property isn’t used. You must specify either `name` or `recordId`. You can’t specify both. _Available in: v32.0_ ### ManagedTopic Managed topic in an Experience Cloud site. * `children` (_array of ManagedTopic_) Children managed topics of the managed topic; `null` if the `depth` request parameter isn’t specified or is 1. _This property is recursive: each item has the same structure as `ManagedTopic`._ _Available in: v35.0_ _Filter group: Medium_ * `id` (_string (Id)_) ID of managed topic. _Available in: v32.0_ _Filter group: Small_ * `managedTopicType` (_object_) ConnectManagedTopicTypeEnum Type of managed topic. * `Content` —Topics that are associated with native content. * `Featured` —Topics that are featured, for example, on the Experience Cloud site home page, but don’t provide overall navigation. * `Navigational` —Topics that display in a navigational menu in the Experience Cloud site. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectManagedTopicTypeEnum`. * `parent` (_object_) Reference Parent managed topic of the managed topic. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `Reference`. * `topic` (_object_) Topic Information about the topic. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `TopicSbi`. * `url` (_string (url)_) Connect REST API URL to the managed topic. _Available in: v32.0_ _Filter group: Small_ ### ManagedTopicPositionCollectionInput A collection of relative positions of managed topics. * `managedTopicPositions` (_array of ManagedTopicPositionInput_, required) Collection of managed topic position request bodies. This collection can include `Featured` and `Navigational` managed topics and doesn’t have to include all managed topics. If you don’t include all managed topics in `managedTopicPositions`, the managed topics are reordered by respecting the positions indicated in `managedTopicPositions`. Any managed topics that aren’t included in `managedTopicPositions` are pushed down to the next available position. For example, if you have these managed topics in these positions: * ManagedTopicA, 0 * ManagedTopicB, 1 * ManagedTopicC, 2 * ManagedTopicD, 3 * ManagedTopicE, 4 And you reorder managed topics by including this information in the request body: * ManagedTopicD, 0 * ManagedTopicE, 2 The result is: * ManagedTopicD, 0 * ManagedTopicA, 1 * ManagedTopicE, 2 * ManagedTopicB, 3 * ManagedTopicC, 4 _Available in: v32.0_ ### 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 TopicSbi_) Collection of topics _Available in: v24.0_ _Filter group: Small_ ### TopicNameCollectionInput A list of topic names to replace currently assigned topics. Also a list of suggested topics to assign. * `topicNames` (_array of string_, required) A list of up to 10 topic names for a feed item or 100 topic names for a record. _Available in: v35.0_ * `topicSuggestions` (_array of string_) A list of suggested topics to assign to a record or feed item to improve future topic suggestions. _Available in: v37.0_ ### TopicAssignmentInput Represents a topic to assign to a feed item or record. Administrators must enable topics for objects before users can add topics to records of that object type. * `topicId` (_string_) ID of an existing topic. Required for existing topics if the `topicName` property isn’t used. _Available in: v30.0_ * `topicName` (_string_) Name of a new or existing topic. Required for new topics; required for existing topics if the `topicId` property isn’t used. _Available in: v30.0_ ### TopicSbi Topic. * `createdDate` (_string_) 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_) 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](/docs/platform/connect-rest-api/guide/connect_error_responses#status-codes-and-error-responses). _Available in: v33.0_ _Filter group: Small_ * `name` (_string_) Name of the topic _Available in: v24.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 to the topic detail page _Available in: v29.0_ _Filter group: Small_ ### ConnectTopicSortEnum Indicates how lists of topics should be sorted. Type: `string`. Allowed values: `AlphaAsc`, `PopularDesc`. ### TopicInput Topic input. * `description` (_string_) Text description of the topic _Available in: v28.0_ * `idsToMerge` (_array of string_) List of up to five secondary topic IDs to merge with the primary topic If any of the secondary topics are navigational or featured topics, they lose their topic type, topic images, and children topics. Their feed items are reassigned to the primary topic. If you merge a topic with a content topic, the content associations are preserved. If you merge a topic with an inactive endorsee, the endorsement isn’t mapped to the primary topic. _Available in: v33.0_ * `name` (_string_) Name of the topic Use this property to change only the capitalization and spacing of the topic name. _Available in: v28.0_ ### ArticleTopicAssignmentJobInput An article and topic assignment job. * `operation` (_object_, required) ConnectArticleTopicJobTypeEnum Type of operation to perform on articles and topics. Values are: * `AssignTopicsToArticle` —Assign topics to articles in a data category. * `UnassignTopicsFromArticle` —Unassign topics from articles in a data category. _Available in: v40.0_ Includes all fields of `ConnectArticleTopicJobTypeEnum`. * `topicNames` (_object_, required) TopicNameCollectionInput List of topic names to assign to or unassign from articles. _Available in: v40.0_ Includes all fields of `TopicNameCollectionInput`. ### TopicSuggestionCollection Topic suggestion collection. * `topicSuggestions` (_array of TopicSuggestion_) Collection of topic suggestion response bodies _Available in: v28.0_ _Filter group: Small_ ### FileSummaryCollection Description of a collection of file summary information. * `currentPageUrl` (_string (url)_) URL to the current page of files. _Available in: v24.0_ _Filter group: Medium_ * `files` (_array of FileSummarySbi_) Collection of one or more files. _Available in: v24.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of files. _Available in: v24.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of files. _Available in: v24.0_ _Filter group: Medium_ ### AppOauthCredentials Represents the primary and staged credentials of a single OAuth consumer. * `id` (_string (Id)_) The OAuth consumer's identifier _Available in: v60.0_ _Filter group: Small_ * `key` (_string_) The OAuth consumer's key _Available in: v60.0_ _Filter group: Small_ * `name` (_string_) The application's name _Available in: v60.0_ _Filter group: Small_ * `secret` (_string_) The OAuth consumer's secret _Available in: v60.0_ _Filter group: Small_ * `stagedCredentialsUrl` (_string (url)_) The URL for the staged credentials of the OAuth consumer _Available in: v65.0_ _Filter group: Small_ * `url` (_string (url)_) The URL for the primary credentials of the OAuth consumer _Available in: v60.0_ _Filter group: Small_ ### AppOauthStagedCredentialsCollection List of OAuth consumer's staged credentials associated with the app. * `stagedCredentials` (_array of AppOauthStagedCredentials_) Collection of OAuth Consumers' staged credentials. _Available in: v65.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the current collection of staged credentials. _Available in: v65.0_ _Filter group: Small_ ### AppOauthStagedCredentials Information about an OAuth consumer's primary and staged credentials. Staged credentials are valid for 30 days unless they're deleted before then. * `createdBy` (_string_) User who created the OAuth consumer's staged credentials. _Available in: v65.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the OAuth consumer's staged credentials were created. _Available in: v65.0_ _Filter group: Small_ * `expirationDate` (_string (date-time)_) Expiration date of the OAuth consumer's staged credentials. _Available in: v65.0_ _Filter group: Small_ * `id` (_string (Id)_) OAuth consumer's staged credentials' identifier. _Available in: v65.0_ _Filter group: Small_ * `key` (_string_) OAuth consumer's staged credentials' key. _Available in: v65.0_ _Filter group: Small_ * `primaryCredUrl` (_string (url)_) The URL for the primary credentials of the OAuth consumer * `secret` (_string_) OAuth consumer's staged credentials' secret. _Available in: v65.0_ _Filter group: Small_ * `state` (_object_) OauthStagedCredentialStateEnum Current state of the OAuth consumer's staged credentials. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `OauthStagedCredentialStateEnum`. * `url` (_string (url)_) URL for the primary credentials of the OAuth consumer. _Available in: v65.0_ _Filter group: Small_ * `stagedCredentialsUrl` (_string_) URL for the staged credentials of the OAuth consumer. _Available in: v65.0_ _Filter group: Small_ ### StagedCredentialsInput Request to rotate credentials with staged data. * `command` (_object_, required) OauthStagedCredentialsCommandEnum Staged credentials command. The only available command is `rotate` . _Available in: v65.0_ Includes all fields of `OauthStagedCredentialsCommandEnum`. ### AppOauthCredentialsCollection List of OAuth consumers associated with the external client app. * `consumers` (_array of AppOauthCredentials_) Collection of OAuth consumers' credentials. _Available in: v60.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current collection of assets _Available in: v60.0_ _Filter group: Small_ ### AppOauthUsageCollection OAuth usage information for a list of apps. * `apps` (_array of AppOauthUsage_) Collection of OAuth apps. _Available in: v59.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to get the collection. _Available in: v59.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to get the next page of the collection. _Available in: v59.0_ _Filter group: Small_ ### AppOauthUsageUserCollection List of OAuth app users. * `currentPageUrl` (_string (url)_) URL identifying the current page. _Available in: v59.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL identifying the next page of the collection. This URL is returned with every page, even the last page of items. If you enter nextPageUrl that comes with the last page of items, an empty array is returned. _Available in: v59.0_ _Filter group: Small_ * `users` (_array of AppOauthUsageUser_) Collection of OAuth users. _Available in: v59.0_ _Filter group: Small_ ### AppOauthUsageTokenCollection A collection of tokens. * `currentPageUrl` (_string (url)_) URL to get the collection. _Available in: v59.0_ _Filter group: Small_ * `tokens` (_array of AppOauthUsageToken_) Collection of OAuth tokens. _Available in: v59.0_ _Filter group: Small_ ### EnvironmentHubMyDomainValidation Results from an attempt to validate a My Domain value. * `domainPrefix` (_string_) The domain prefix that was used for validation. This takes into account if the resulting org would be a DE org. * `validationError` (_object_) MyDomainValidationStatus A validation error for a proposed domain. One of these values: * `Duplicate` —The proposed domain is already in use. * `Invalid` —The proposed domain is not a valid CNAME. * `Valid` —The proposed domain is valid. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `MyDomainValidationStatus`. ### EnvironmentHubOAuthUrl An OAuth URL that initiates the workflow to connect an org to an Environment Hub. * `oauthUrl` (_string_) The generated URL. _Available in: v36.0_ _Filter group: Small_ ### EnvironmentHubSignupMemberValidation The results from validation of the input parameters used to create an Environment Hub member org. * `errorMessage` (_string_) If the parameters were invalid, this property contains the error string. _Available in: v36.0_ _Filter group: Small_ * `orgEdition` (_string_) If the parameters were valid, this property contains the edition of the member org. _Available in: v36.0_ _Filter group: Small_ * `trialMaxLengthDays` (_integer_) If the parameters were valid, this property contains the trial length of the member org. _Available in: v36.0_ _Filter group: Small_ ### SsoUserMappingInput Create a SsoUserMapping for an Environmet Hub member org * `hubUserId` (_string_, required) The ID of a user in an Environment Hub organization. _Available in: v36.0_ * `memberUsername` (_string_, required) The username of a user in an Environment Hub member organization. _Available in: v36.0_ ### SsoUserMapping Results from validating a potential SSO user mapping between a user in an Environment Hub and a user in a hub member org. * `errorFieldNames` (_array of string_) If the parameters were invalid, this property contains the names of fields with errors. _Available in: v36.0_ _Filter group: Small_ * `errorMessage` (_string_) If the parameters were invalid, this property contains the error string. _Available in: v36.0_ _Filter group: Small_ * `hubUserId` (_string_) The ID of a user in an Environment Hub organization. _Available in: v36.0_ _Filter group: Small_ * `memberUsername` (_string_) The username of a user in an Environment Hub member organization. _Available in: v36.0_ _Filter group: Small_ * `userMappingId` (_string_) The ID of the new SSO user mapping. _Available in: v36.0_ _Filter group: Small_ ### CredentialPrincipalType Type of credential principal. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `AwsStsPrincipal`, `NamedPrincipal`, `PerUserPrincipal`. ### Credential Credential. * `authenticationProtocol` (_object_) CredentialAuthenticationProtocol Authentication protocol of the external credential. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationProtocol`. * `authenticationProtocolVariant` (_object_) CredentialAuthenticationProtocolVariant Authentication protocol variant of the external credential. Values are: * `AwsSv4_STS` —AWS Signature Version 4 with Security Token Service. * `ClientCredentialsClientSecret` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body. * `ClientCredentialsClientSecretBasic` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication. * `ClientCredentialsJwtAssertion` —OAuth 2.0 Client Credentials JSON Web Token assertion. * `JwtBearer` —OAuth 2.0 JSON Web Token bearer flow. * `NoAuthentication` —No authentication. * `RolesAnywhere` —AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationProtocolVariant`. * `authenticationStatus` (_object_) CredentialAuthenticationStatus Status of the credential authentication. Values are: * `Configured` —Credential has all required credentials for at least one principal. * `NotConfigured` —Credential isn’t configured. * `Unknown` —Credential status can’t be determined because the authentication protocol is custom. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationStatus`. * `credentials` (_object_) Map of protocol-specific credentials. _Available in: v56.0_ _Filter group: Small_ Additional properties: `CredentialValue`. * `externalCredential` (_string_) Fully qualified developer name of the external credential. _Available in: v56.0_ _Filter group: Small_ * `principalName` (_string_, nullable) Name of the external credential named principal. _Available in: v56.0_ _Filter group: Small_ * `principalType` (_object_) CredentialPrincipalType Type of credential principal. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialPrincipalType`. ### CredentialInput Credential input. * `authenticationProtocol` (_object_, required) CredentialAuthenticationProtocol Authentication protocol of the external credential. _Available in: v56.0_ Includes all fields of `CredentialAuthenticationProtocol`. * `authenticationProtocolVariant` (_object_) CredentialAuthenticationProtocolVariant Authentication protocol variant of the external credential. Values are: * `AwsSv4_STS` —AWS Signature Version 4 with Security Token Service. * `ClientCredentialsClientSecret` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body. * `ClientCredentialsClientSecretBasic` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication. * `ClientCredentialsJwtAssertion` —OAuth 2.0 Client Credentials JSON Web Token assertion. * `JwtBearer` —OAuth 2.0 JSON Web Token bearer flow. * `NoAuthentication` —No authentication. * `RolesAnywhere` —AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere. If specified, the authentication protocol variant must match the actual protocol variant of the external credential. _Available in: v57.0_ Includes all fields of `CredentialAuthenticationProtocolVariant`. * `credentials` (_object_, required) Map of protocol-specific credentials. Authentication protocols have credential allowlists and encryption rules. * `AwsSv4` — `awsAccessKeyId` (not encrypted), `awsSecretAccessKey` (encrypted), `awsRoleArn` (not encrypted) * `Custom` —Any credential name is valid (user sets encryption rules) _Available in: v56.0_ Additional properties: `CredentialValueInput`. * `externalCredential` (_string_, required) Fully qualified developer name of the external credential. _Available in: v56.0_ * `principalName` (_string_) Name of the external credential named principal. Required if `principalType` is `NamedPrincipal` _Available in: v56.0_ * `principalType` (_object_, required) CredentialPrincipalType Type of credential principal. _Available in: v56.0_ Includes all fields of `CredentialPrincipalType`. ### CreateCredentialAction Action to take when creating the credential. Type: `string`. Allowed values: `Refresh`. ### OAuthCredentialAuthUrlInput OAuth authentication flow input. * `externalCredential` (_string_, required) Fully qualified developer name of the external credential. _Available in: v56.0_ * `principalName` (_string_) Name of the external credential named principal. Required if `principalType` is `NamedPrincipal` _Available in: v56.0_ * `principalType` (_object_, required) CredentialPrincipalType Type of credential principal. _Available in: v56.0_ Includes all fields of `CredentialPrincipalType`. * `returnUrl` (_string_) Return URL to apply to the authentication URL. _Available in: v56.0_ ### OAuthCredentialAuthUrl OAuth authentication URL for a credential. * `authenticationUrl` (_string_) Authentication URL for the user external credential. Authentication URLs have encoded and escaped special characters. Before using the URL, undo the encoded and escaped characters. _Available in: v56.0_ _Filter group: Small_ * `externalCredential` (_string_) Fully qualified developer name of the external credential. _Available in: v56.0_ _Filter group: Small_ * `principalName` (_string_) Name of the external credential named principal. _Available in: v56.0_ _Filter group: Small_ * `principalType` (_object_) CredentialPrincipalType Type of credential principal. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialPrincipalType`. ### ExternalAuthIdentityProviderCredentials List of an external auth identity provider's credentials. * `credentials` (_array of ExternalAuthIdentityProviderCredential_) List of an external auth identity provider's credentials. _Available in: v62.0_ _Filter group: Medium_ ### ExternalAuthIdentityProviderCredentialsInput External auth identity provider credentials input. * `credentials` (_array of ExternalAuthIdentityProviderCredentialInput_, required) List of an external auth identity provider's credentials. _Available in: v62.0_ ### ExternalAuthIdentityProviderList List of external auth identity providers. * `externalAuthIdentityProviders` (_array of ExternalAuthIdentityProvider_) List of external auth identity providers. _Available in: v62.0_ _Filter group: Small_ ### ExternalAuthIdentityProviderInput External auth identity provider input. * `authenticationFlow` (_object_, required) IdentityProviderAuthFlow Authentication flow to get tokens to call protected APIs. _Available in: v62.0_ Includes all fields of `IdentityProviderAuthFlow`. * `authenticationProtocol` (_object_, required) IdentityProviderAuthProtocol Authentication protocol required to access the external system. _Available in: v62.0_ Includes all fields of `IdentityProviderAuthProtocol`. * `authorizeUrl` (_string_) Authorization endpoint URL for the external system. Required when the `authenticationProtocol` is `OAuth` and the `authenticationFlow` is `AuthorizationCode` . Otherwise, Optional. _Available in: v62.0_ * `clientAuthentication` (_object_) IdentityProviderClientAuth Client authentication method that describes how credentials are sent to the authorization server. Defaults to `ClientSecretBasic`. _Available in: v63.0_ Includes all fields of `IdentityProviderClientAuth`. * `description` (_string_) External auth identity provider description. _Available in: v62.0_ * `fullName` (_string_, required) Full name of the external auth identity provider. The full name can include a namespace prefix. _Available in: v62.0_ * `label` (_string_, required) External auth identity provider label. _Available in: v62.0_ * `parameters` (_array of ExternalAuthIdentityProviderParameterInput_) List of custom request parameters to customize and extend requests to the identity provider’s token endpoint. _Available in: v63.0_ * `standardExternalIdentityProvider` (_string_) Reference to a standard external auth identity provider. _Available in: v63.0_ * `tokenUrl` (_string_, required) Token endpoint URL to retrieve tokens from the external system. Required for all OAuth 2.0 authentication flows. _Available in: v62.0_ * `userInfoUrl` (_string_) User info URL to retrieve user profile information from the external system. Applicable only when the `authenticationProtocol` is `OAuth`. _Available in: v62.0_ ### ExternalAuthIdentityProvider External auth identity provider. * `authenticationFlow` (_object_) IdentityProviderAuthFlow Authentication flow to get tokens to call protected APIs. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `IdentityProviderAuthFlow`. * `authenticationProtocol` (_object_) IdentityProviderAuthProtocol Authentication protocol required to access the external system. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `IdentityProviderAuthProtocol`. * `authorizeUrl` (_string_) Authorization endpoint URL for the external system. _Available in: v62.0_ _Filter group: Small_ * `callbackUrl` (_string_) For the Authorization Code authentication flow, the callback URL that's used by the external system after authorization. _Available in: v62.0_ _Filter group: Small_ * `clientAuthentication` (_object_) IdentityProviderClientAuth Client authentication method that describes how credentials are sent to the authorization server. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `IdentityProviderClientAuth`. * `createdByNamespace` (_string_) Namespace of the package that created the external auth identity provider. _Available in: v62.0_ _Filter group: Small_ * `credentials` (_array of ExternalAuthIdentityProviderCredential_) List of the external auth identity provider credentials. _Available in: v62.0_ _Filter group: Medium_ * `description` (_string_) Description of the external auth identity provider. _Available in: v62.0_ _Filter group: Small_ * `fullName` (_string_) Full name of the external auth identity provider. The full name can include a namespace prefix. _Available in: v62.0_ _Filter group: Small_ * `id` (_string_) External auth identity provider ID. _Available in: v62.0_ _Filter group: Small_ * `label` (_string_) External auth identity provider label. _Available in: v62.0_ _Filter group: Small_ * `parameters` (_array of ExternalAuthIdentityProviderParameter_) List of custom request parameters. _Available in: v63.0_ _Filter group: Medium_ * `standardExternalIdentityProvider` (_string_) Reference to a standard external auth identity provider. _Available in: v63.0_ _Filter group: Small_ * `tokenUrl` (_string_) Token endpoint URL to retrieve tokens from the external system. Required for all OAuth 2.0 authentication flows. _Available in: v62.0_ _Filter group: Small_ * `url` (_string_) Connect REST API URL for the external auth identity provider. _Available in: v62.0_ _Filter group: Small_ * `userInfoUrl` (_string_) User info URL to retrieve user profile information from the external system. _Available in: v62.0_ _Filter group: Small_ ### ExternalCredentialList List of external credentials. * `externalCredentials` (_array of ExternalCredential_) List of external credentials. _Available in: v56.0_ _Filter group: Medium_ ### ExternalCredentialInput Input used to create or update an external credential. * `authenticationProtocol` (_object_, required) CredentialAuthenticationProtocol Authentication protocol of the external credential. _Available in: v58.0_ Includes all fields of `CredentialAuthenticationProtocol`. * `authenticationProtocolVariant` (_object_) CredentialAuthenticationProtocolVariant Authentication protocol variant of the external credential. Values are: * `AwsSv4_STS` —AWS Signature Version 4 with Security Token Service. * `ClientCredentialsClientSecret` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body. * `ClientCredentialsClientSecretBasic` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication. * `ClientCredentialsJwtAssertion` —OAuth 2.0 Client Credentials JSON Web Token assertion. * `JwtBearer` —OAuth 2.0 JSON Web Token bearer flow. * `NoAuthentication` —No authentication. * `RolesAnywhere` —AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere. If specified, the authentication protocol variant must match the actual protocol variant of the external credential. _Available in: v58.0_ Includes all fields of `CredentialAuthenticationProtocolVariant`. * `customHeaders` (_array of CredentialCustomHeaderInput_) List of credential custom headers. _Available in: v58.0_ * `developerName` (_string_) Fully qualified developer name of the external credential. Required for POST. Optional for PUT _Available in: v58.0_ * `masterLabel` (_string_, required) External credential label. _Available in: v58.0_ * `parameters` (_array of ExternalCredentialParameterInput_) List of external credential parameters. depending on `authenticationProtocol` and `authenticationVariant` _Available in: v58.0_ * `principals` (_array of ExternalCredentialPrincipalInput_) List of principals the credential has. _Available in: v58.0_ ### ExternalCredential External credential, including the named credentials and principals associated with it and the type and status of each principal. If you don’t have the View Setup and Configuration permission, some properties are empty or show limited information. * `authenticationProtocol` (_object_) CredentialAuthenticationProtocol Authentication protocol of the external credential. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationProtocol`. * `authenticationProtocolVariant` (_object_) CredentialAuthenticationProtocolVariant Authentication protocol variant of the external credential. Values are: * `AwsSv4_STS` —AWS Signature Version 4 with Security Token Service. * `ClientCredentialsClientSecret` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body. * `ClientCredentialsClientSecretBasic` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication. * `ClientCredentialsJwtAssertion` —OAuth 2.0 Client Credentials JSON Web Token assertion. * `JwtBearer` —OAuth 2.0 JSON Web Token bearer flow. * `NoAuthentication` —No authentication. * `RolesAnywhere` —AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationProtocolVariant`. * `authenticationStatus` (_object_) CredentialAuthenticationStatus Status of the credential authentication. Values are: * `Configured` —Credential has all required credentials for at least one principal. * `NotConfigured` —Credential isn’t configured. * `Unknown` —Credential status can’t be determined because the authentication protocol is custom. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationStatus`. * `createdByNamespace` (_string_) Namespace of the package that created the external credential. _Available in: v59.0_ _Filter group: Small_ * `customHeaders` (_array of CredentialCustomHeader_) List of custom headers. _Available in: v57.0_ _Filter group: Medium_ * `developerName` (_string_) Fully qualified developer name of the external credential. _Available in: v56.0_ _Filter group: Small_ * `id` (_string_) External credential ID. _Available in: v58.0_ _Filter group: Small_ * `masterLabel` (_string_) External credential label. _Available in: v56.0_ _Filter group: Small_ * `parameters` (_array of ExternalCredentialParameter_) List of parameters of the external credential. _Available in: v57.0_ _Filter group: Medium_ * `principals` (_array of ExternalCredentialPrincipal_) List of principals the credential has. _Available in: v56.0_ _Filter group: Medium_ * `relatedNamedCredentials` (_array of NamedCredential_) List of named credentials associated to the external credential. _Available in: v56.0_ _Filter group: Medium_ * `url` (_string_) Connect REST API URL for the external credential. _Available in: v58.0_ _Filter group: Small_ ### NamedCredentialList List of named credentials. * `namedCredentials` (_array of NamedCredential_) List of named credentials. _Available in: v58.0_ _Filter group: Small_ ### NamedCredentialInput Input used to create or update a named credential. * `calloutOptions` (_object_, required) NamedCredentialCalloutOptionsInput Callout options. _Available in: v58.0_ Includes all fields of `NamedCredentialCalloutOptionsInput`. * `calloutUrl` (_string_, required) URL of the named credential in a callout. _Available in: v58.0_ * `customHeaders` (_array of CredentialCustomHeaderInput_) Custom HTTP headers. _Available in: v58.0_ * `description` (_string_) Description of the named credential. _Available in: v64.0_ * `developerName` (_string_) Named credential developer name. Required for POST. Optional for PUT _Available in: v58.0_ * `externalCredentials` (_array of ExternalCredentialInput_, required) External credentials used by the named credential. In version 58.0 and later, only one external credential is supported. _Available in: v58.0_ * `masterLabel` (_string_, required) Named credential label. _Available in: v58.0_ * `networkConnection` (_object_) NetworkConnectionInput PrivateConnect outbound network connection. depending on `type` _Available in: v58.0_ Includes all fields of `NetworkConnectionInput`. * `parameters` (_array of NamedCredentialParameterInput_) Named credential parameters. _Available in: v58.0_ * `type` (_object_, required) NamedCredentialType Type of named credential. _Available in: v58.0_ Includes all fields of `NamedCredentialType`. ### NamedCredential Named credential associated with an external credential. * `calloutOptions` (_object_) NamedCredentialCalloutOptions Callout options for the named credential. _Available in: v58.0_ _Filter group: Big_ Includes all fields of `NamedCredentialCalloutOptions`. * `calloutStatus` (_object_) CalloutStatus Indicates whether a named credential is enabled for callout. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `CalloutStatus`. * `calloutUrl` (_string_) URL of the named credential in a callout. _Available in: v58.0_ _Filter group: Small_ * `createdByNamespace` (_string_) Namespace of the package that created the named credential. _Available in: v59.0_ _Filter group: Small_ * `customHeaders` (_array of CredentialCustomHeader_) Custom HTTP headers for the named credential. _Available in: v58.0_ _Filter group: Big_ * `description` (_string_) Description of the named credential. _Available in: v64.0_ _Filter group: Small_ * `developerName` (_string_) Fully qualified developer name of the named credential. _Available in: v56.0_ _Filter group: Small_ * `externalCredentials` (_array of ExternalCredential_) External credentials used by the named credential. _Available in: v58.0_ _Filter group: Big_ * `id` (_string_) Named credential ID. _Available in: v58.0_ _Filter group: Small_ * `masterLabel` (_string_) Named credential label. _Available in: v56.0_ _Filter group: Small_ * `networkConnection` (_object_) NetworkConnection PrivateConnect outbound network connection for the named credential. _Available in: v58.0_ _Filter group: Big_ Includes all fields of `NetworkConnection`. * `parameters` (_array of NamedCredentialParameter_) Named credential parameters. _Available in: v58.0_ _Filter group: Big_ * `type` (_object_) NamedCredentialType Type of named credential. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `NamedCredentialType`. * `url` (_string_) Connect REST API URL of the named credential. _Available in: v58.0_ _Filter group: Small_ ### ExternalConnectionType Type of network connection. Value is `AwsPrivateLink`. _Available in: v51.0_ _Filter group: Small_ Type: `string`. Allowed values: `AwsPrivateLink`. ### ExternalConnectionTopologiesScope Enumerates the scope of the external connection topologies Type: `string`. Allowed values: `All`, `Region`. ### InboundNetworkConnectionTopologies Inbound network connection topologies. * `topologies` (_array of NetworkConnectionTopologies_) List of topologies required for making inbound calls. _Available in: v49.0_ _Filter group: Small_ ### ExternalConnectionAction Enumerates the external network connection action types Type: `string`. Allowed values: `Provision`, `Sync`, `TearDown`. ### NetworkConnection External network connection. * `connectionProperties` (_AwsInboundNetworkConnectionProperties | AwsOutboundNetworkConnectionProperties_) Property names and values of the network connection. _Available in: v51.0_ _Filter group: Small_ One of: `AwsInboundNetworkConnectionProperties`, `AwsOutboundNetworkConnectionProperties`. * `connectionType` (_object_) ExternalConnectionType Type of network connection. Value is `AwsPrivateLink`. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ExternalConnectionType`. * `description` (_string_) Description of the network connection. _Available in: v51.0_ _Filter group: Small_ * `developerName` (_string_) Name of the network connection. _Available in: v51.0_ _Filter group: Small_ * `id` (_string_) ID of the network connection. _Available in: v51.0_ _Filter group: Small_ * `isActive` (_boolean_) Specifies whether the network connection is active (`true`) or not (`false`). _Available in: v51.0_ _Filter group: Small_ * `masterLabel` (_string_) Label of the network connection. _Available in: v51.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix of the network connection. _Available in: v51.0_ _Filter group: Small_ * `status` (_object_) ExternalConnectionStatus Status of the network connection. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ExternalConnectionStatus`. * `url` (_string_) Connect API NetworkConnection resource path for this record. _Available in: v58.0_ _Filter group: Small_ ### OutboundNetworkConnectionTopologies Outbound network connection topologies. * `topologies` (_array of NetworkConnectionTopologies_) Topologies required for making outbound calls. _Available in: v49.0_ _Filter group: Small_ ### DuplicateDirectory Duplicate directory. * `job-definitions` (_string_) URL to the duplicate job definitions resource. _Available in: v42.0_ _Filter group: Small_ * `jobs` (_string_) URL to the duplicate jobs resource. _Available in: v42.0_ _Filter group: Small_ ### DuplicateJobDefinitionCollection A collection of job definitions. * `jobDefinitions` (_array of DuplicateJobDefinition_) Collection of duplicate job definitions. _Available in: v42.0_ _Filter group: Small_ ### DuplicateJobDefinition A duplicate job definition. * `createdById` (_string (Id)_) ID of the user who created the job definition. _Available in: v42.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the job definition was created in ISO 8601 format. _Available in: v42.0_ _Filter group: Small_ * `developerName` (_string_) Developer name of the job definition. _Available in: v42.0_ _Filter group: Small_ * `jobDefinitionId` (_string (Id)_) ID of the job definition. _Available in: v42.0_ _Filter group: Small_ * `lastModifiedById` (_string (Id)_) ID of the user who last modified the job definition. _Available in: v42.0_ _Filter group: Small_ * `lastModifiedDate` (_string (date-time)_) Date when the job definition was last modified. _Available in: v42.0_ _Filter group: Small_ * `masterLabel` (_string_) Label of the job definition. _Available in: v42.0_ _Filter group: Small_ * `matchingRuleIds` (_array of string (Id)_) IDs of matching rules used by the job definition. _Available in: v42.0_ _Filter group: Small_ * `sobjectSubtype` (_object_) SobjectSubtypeEnum Object subtype of the job definition. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `SobjectSubtypeEnum`. * `sobjectType` (_string_) Object type of the job definition. _Available in: v42.0_ _Filter group: Small_ ### DuplicateJobCollection A collection of duplicate jobs. * `jobs` (_array of DuplicateJob_) Collection of duplicate jobs. _Available in: v42.0_ _Filter group: Small_ ### DuplicateJobInput Create a duplicate job. * `duplicateJobDefId` (_string (Id)_, required) ID of the duplicate job definition. _Available in: v42.0_ ### DuplicateJob A duplicate job. * `createdById` (_string (Id)_) ID of the user who created the job. _Available in: v42.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the job was created in ISO 8601 format. _Available in: v42.0_ _Filter group: Small_ * `endDateTime` (_string (date-time)_) Date when the job ended in ISO 8601 format. _Available in: v42.0_ _Filter group: Small_ * `jobDefinitionId` (_string (Id)_) ID of the job definition. _Available in: v42.0_ _Filter group: Small_ * `jobId` (_string (Id)_) ID of the job. _Available in: v42.0_ _Filter group: Small_ * `lastModifiedById` (_string (Id)_) ID of the user who last modified the job. _Available in: v42.0_ _Filter group: Small_ * `lastModifiedDate` (_string (date-time)_) Date when the job was last modified in ISO 8601 format. _Available in: v42.0_ _Filter group: Small_ * `name` (_string_) Name of the job. _Available in: v42.0_ _Filter group: Small_ * `numDuplicateRecordItems` (_integer_) Number of duplicate records created by the job. _Available in: v42.0_ _Filter group: Small_ * `numDuplicateRecordSets` (_integer_) Number of duplicate record sets created by the job. _Available in: v42.0_ _Filter group: Small_ * `numRecordsScanned` (_integer_) Number of records scanned by the job. _Available in: v42.0_ _Filter group: Small_ * `resultListViewId` (_string (Id)_) ID of the result list view for the job. _Available in: v42.0_ _Filter group: Small_ * `startDateTime` (_string (date-time)_) Date when the job started in ISO 8601 format. _Available in: v42.0_ _Filter group: Small_ * `status` (_object_) ConnectDuplicateJobStatusEnum Status of the job. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `ConnectDuplicateJobStatusEnum`. ### DuplicateJobStatusInput Update the duplicate job status. * `status` (_object_, required) ConnectDuplicateJobStatusEnum Status of the duplicate job. `Canceled` is the only valid value. _Available in: v42.0_ Includes all fields of `ConnectDuplicateJobStatusEnum`. ### CustomDomainCollection List of custom domains for the org. A custom domain is a domain that you own, such as `https://www.example.com`, that serves content from your Experience Cloud sites or Salesforce Sites. * `domains` (_array of CustomDomain_) List of custom domains. If no custom domains exist in the org, an empty list is returned. _Available in: v60.0_ _Filter group: Small_ ### CustomDomainCustomUrlDetailCollection List of custom URLs for a custom domain. A custom URL consists of a domain, a custom path prefix, and a unique site path. For a domain to serve content from a site, at least one custom URL is required. * `customUrls` (_array of CustomDomainCustomUrlDetail_) List of custom URLs for a specific domain. If no custom domains exist for the domain, an empty list is returned. _Available in: v62.0_ _Filter group: Small_ ### CustomDomainDetail Detailed description of a custom domain. * `associationType` (_object_) CustomDomainAssociationTypeEnum Type of org that contains the Experience Cloud site or Salesforce Site content that the custom domain serves. Custom domains exist only in production orgs. * `Production` —The custom domain serves content from a site on the same org. * `Sandbox` —The custom domain serves content from a site on a sandbox. _Available in: v60.0_ _Filter group: Small_ Includes all fields of `CustomDomainAssociationTypeEnum`. * `cnameTarget` (_string_, nullable) Canonical name (CNAME) of the external host or server for the custom domain. If `configurationOption` is `ExternalHttps` , this field points to the CNAME of the external provider. _Available in: v60.0_ _Filter group: Small_ * `configurationOption` (_object_) CustomDomainConfigurationOptionEnum Custom domain configuration option. * `CdnPartner` —A Salesforce content delivery network (CDN) partner serves the domain. * `ExternalHttps` —A non-Salesforce service or host serves your custom domain. This option includes third-party CDNs and proxy solutions. * `NoHttps` —The custom domain uses a temporary non-HTTPS configuration for initial setup. * `SitesRuntime` —The custom domain is served on Salesforce servers with your HTTPS certificate. _Available in: v60.0_ _Filter group: Small_ Includes all fields of `CustomDomainConfigurationOptionEnum`. * `customUrls` (_array of CustomDomainCustomUrlDetail_) List of custom URLs for this domain. If no custom URLs exist for the domain, an empty list is returned. _Available in: v62.0_ _Filter group: Small_ * `domainName` (_string_) Domain name. For example, `www.example.com` _Available in: v60.0_ _Filter group: Small_ * `domainStatus` (_object_) CustomDomainStatusTypeEnum Custom domain status. Values are: * `AwaitingActivation` —The domain provisioning process is complete. To use the updated domain, activate the domain. * `AwaitingCustomURL` —The custom domain requires a custom URL to start provisioning. Only applies to custom domains with the SitesRuntime configurationOption. * `Completed` —The custom domain is active and in use. * `DomainNameValidated` — `domainName` ownership has been validaed by Salesforce. * `DomainNameValidationFailed` —Salesforce couldn’t validate the `domainName`. Update the CNAME in DNS and attempt to validate the domain again. * `DomainNameValidationPending` — `domainName` validation hasn’t started. * `Provisioning` —Salesforce is provisioning the custom domain. In other words, Salesforce is getting the domain ready for activation.— _Available in: v63.0_ _Filter group: Small_ Includes all fields of `CustomDomainStatusTypeEnum`. * `hstsPreloadEnabled` (_boolean_) Indicates whether Salesforce includes the `Strict-Transport-Security` HTTP header with the `preload` directive for the custom domain ( `true` ) or not ( `false` ). Only registrable domains are eligible for HTTP Strict Transport Security (HSTS) preloading. Also, to finish configuring HSTS preloading, add your custom domain to the third-party HSTS preload list. For more information, see [Enable HSTS Preloading on a Custom Domain](https://help.salesforce.com/s/articleView?id=products.domain_mgmt_hsts_preloading.htm&type=5) in Salesforce Help. _Available in: v60.0_ _Filter group: Small_ * `lastModifiedDate` (_string (date-time)_) Date when the custom domain was last modified. _Available in: v63.0_ _Filter group: Small_ * `sandboxId` (_string_, nullable) If `associationType` is `Sandbox` , org ID of the sandbox. If `associationType` is `Production`, this field is always null. _Available in: v60.0_ _Filter group: Small_ ### CustomDomainCustomUrlDetail Detailed description of a custom URL. * `customUrlId` (_string_) ID of the custom URL. _Available in: v62.0_ _Filter group: Small_ * `domainId` (_string_) ID of the custom domain. _Available in: v62.0_ _Filter group: Small_ * `domainName` (_string_) Domain Name _Available in: v62.0_ _Filter group: Small_ * `lastModified` (_string (date-time)_) Date when the custom URL was last modified. _Available in: v63.0_ _Filter group: Small_ * `path` (_string_) The path on the domain, starting with a slash ( `/` ). A slash (`/`) with no subsequent characters represents the root path, such as `https://www.example.com`. You can use the same path for more than one domain, but you can use each path only once within the same domain. _Available in: v62.0_ _Filter group: Small_ * `primarySiteUrl` (_boolean_) Indicates whether this custom URL is the preferred URL for authenticated pages and email ( `true` ) or not ( `false` ). This property applies only when the `siteType` is `Community` or `SalesforceSite`. Each site can have only one primary custom URL. For more information, see [Add a Custom URL](https://help.salesforce.com/s/articleView?id=products.custom_url_add.htm&type=5) in Salesforce Help. _Available in: v62.0_ _Filter group: Small_ * `siteId` (_string_) ID of the site that this custom URL serves. _Available in: v62.0_ _Filter group: Small_ * `siteName` (_string_) Name of the site that this custom URL serves. _Available in: v62.0_ _Filter group: Small_ * `siteType` (_object_) CustomDomainUrlSiteTypeEnum Type of site that this custom URL serves. * `Community` —An [Experience Cloud Site](/docs/platform/connect-rest-api/references/connect-rest-api-experience-cloud#tag/Experience-Cloud-Sites-Resources/operation/getCommunity). * `SalesforceSite` —A Salesforce Site. * `LegacySite` —A legacy site type, such as legacy Site.com sites. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `CustomDomainUrlSiteTypeEnum`. * `status` (_object_) CustomDomainCustomUrlStatusEnum Custom URL status. Values are: * `AwaitingPublish` —The custom URL is ready to be published from within Site.com Studio. This status applies only to custom URLs with a `siteType` of `LegacySite` when no sites of other types exist on the same domain. * `AwaitingUnpublish` —The custom URL was removed but is still published. To finish deleting the custom URL, click Unpublish in Site.com Studio. This status applies only to custom URLs with a `siteType` of `LegacySite`. * `InDevelopment` —The custom URL is ready to be published. This status applies only to custom URLs with a `siteType` of `LegacySite` when no sites of other types exist on the same domain. * `Offline` —The custom URL is associated with an inactive site. * `Preview` —The custom URL is active for an Experience Cloud site with a status of Preview. * `PublishFailed` —There was an unexpected issue with the background publishing operation for a site associated with the custom URL. This status is assigned to the custom URL after the background publishing operation is attempted every hour for two weeks without success. * `Published` —The custom URL is active and is associated with a site that is live. * `Publishing` —Salesforce is publishing the custom URL in the background. If this custom URL was previously published, the custom URL remains available throughout the publishing process. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `CustomDomainCustomUrlStatusEnum`. ### CustomDomainPendingConfigurationOutput Detailed description of the pending configuration for a custom domain. * `associatedType` (_object_) CustomDomainAssociationTypeEnum Type of org that contains the Experience Cloud site or Salesforce Site content that the custom domain serves. Custom domains exist only in production orgs. * `Production` —The custom domain serves content from a site on the same org. * `Sandbox` —The custom domain serves content from a site on a sandbox. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `CustomDomainAssociationTypeEnum`. * `cdnPartnerOptions` (_object_) CdnPartnerOptions If the `configurationOption` is `CdnPartner` , the content delivery network (CDN) partner for the pending configuration. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `CdnPartnerOptions`. * `configurationOption` (_object_) CustomDomainConfigurationOptionEnum The pending domain configuration option. * `CdnPartner` —A Salesforce content delivery network (CDN) partner serves the domain. * `ExternalHttps` —A non-Salesforce service or host serves your custom domain. This option includes third-party CDNs and proxy solutions. * `NoHttps` —The custom domain uses a temporary non-HTTPS configuration for initial setup. * `SitesRuntime` —The custom domain is served on Salesforce servers with your HTTPS certificate. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `CustomDomainConfigurationOptionEnum`. * `domainId` (_string_) ID of the custom domain. _Available in: v66.0_ _Filter group: Small_ * `domainName` (_string_) Domain name. For example, `www.example.com` _Available in: v66.0_ _Filter group: Small_ * `domainStatus` (_object_) CustomDomainStatusTypeEnum Custom domain status. Valid values for a custom domain with a pending configuration are: * `AwaitingActivation` —The domain provisioning process is complete. To use the updated domain, activate the domain. * `AwaitingCustomURL` —The custom domain requires a custom URL to start provisioning. Only applies to custom domains with the SitesRuntime configurationOption. * `DomainNameValidated` — `domainName` ownership has been validated by Salesforce. * `Provisioning` —Salesforce is provisioning the custom domain. In other words, Salesforce is getting the domain ready for activation. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `CustomDomainStatusTypeEnum`. ### CustomDomainId ID of the custom domain. * `domainId` (_string_) ID of the custom domain. _Available in: v63.0_ _Filter group: Small_ ### CustomDomainExpectedCdnCName The canonical name (CNAME) that’s required for custom domains that use the Saleforce CDN. * `alias` (_string_) Alias hostname to use in the name element of the additional CNAME record for this custom domain that uses the Salesforce CDN. _Available in: v63.0_ _Filter group: Small_ * `value` (_string_) String to use in the value element of the additional CNAME record for this custom domain that uses the Salesforce CDN. _Available in: v63.0_ _Filter group: Small_ ### CustomDomainExpectedCName The canonical name (CNAME) record that’s used to verify ownership of a custom domain. * `alias` (_string_) Alias hostname to use in the name element of the CNAME record for this custom domain. _Available in: v63.0_ _Filter group: Small_ * `value` (_string_) String to use in the value element of the CNAME record for this custom domain. _Available in: v63.0_ _Filter group: Small_ ### RecommendationReactionCollection A list of recommendation reactions. * `currentPageUrl` (_string (url)_) URL to the current page of reactions in the collection. _Available in: v45.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of reactions in the collection. _Available in: v45.0_ _Filter group: Small_ * `reactions` (_array of RecommendationReaction_) Collection of recommendation reactions. _Available in: v45.0_ _Filter group: Small_ ### RecommendationReactionInput A reaction to a recommendation produced by a recommendation strategy. * `aiModel` (_string_) Reserved for future use. _Available in: v47.0_ * `contextRecordId` (_string_) ID of the context record. For example, if the next best action is on a case detail page, the ID of the case. _Available in: v45.0_ * `executionId` (_string_) ID of the original recommendation strategy execution. _Available in: v45.0_ * `externalId` (_string_) External ID of the recommendation. This ID doesn’t need to be a Salesforce 18-character ID. For example, it can be a product number from an external system. _Available in: v46.0_ * `onBehalfOfId` (_string_) ID of the user or entity for which the reaction took place. _Available in: v45.0_ * `reactionType` (_object_, required) ConnectRecommendationReactionTypeEnum Type of reaction to a recommendation. _Available in: v45.0_ Includes all fields of `ConnectRecommendationReactionTypeEnum`. * `recommendationMode` (_object_) ConnectRecommendationModeEnum Reserved for future use. Mode of recommendation, if you’re using Einstein Intelligent Offers, an AppExchange package. * `Intelligent` —Recommendation came from Einstein Intelligent Offers. * `Learning` —Recommendation came from a randomized process in learning mode. _Available in: v46.0_ Includes all fields of `ConnectRecommendationModeEnum`. * `recommendationScore` (_number (double)_) Reserved for future use. _Available in: v46.0_ * `strategyName` (_string_, required) Name of the recommendation strategy. _Available in: v45.0_ * `targetActionId` (_string_) ID of the target action. _Available in: v45.0_ * `targetActionName` (_string_, required) Name of the target action. _Available in: v45.0_ * `targetId` (_string_, required) ID of the recommendation that is being reacted to. _Available in: v45.0_ ### RecommendationReaction Reaction to a recommendation produced by a recommendation strategy. * `aiModel` (_string_) Reserved for future use. _Available in: v47.0_ _Filter group: Small_ * `contextRecord` (_object_) Reference Reference to the context record. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `Reference`. * `createdBy` (_object_) Reference Reference to the reaction creator. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `Reference`. * `createdDate` (_string (date-time)_) Reaction creation date. Format is ISO 8601. _Available in: v45.0_ _Filter group: Small_ * `externalId` (_string_) External target ID of the recommendation reacted on. This ID doesn’t need to be a Salesforce 18-character ID. For example, it can be a product number from an external system. _Available in: v46.0_ _Filter group: Small_ * `id` (_string (Id)_) Reaction record ID. _Available in: v45.0_ _Filter group: Small_ * `onBehalfOf` (_object_) Reference Reference to the user or record that is indirectly reacting to the recommendation. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `Reference`. * `reactionType` (_object_) ConnectRecommendationReactionTypeEnum Type of reaction to a recommendation. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationReactionTypeEnum`. * `recommendationMode` (_object_) ConnectRecommendationModeEnum Reserved for future use. Mode of recommendation, if you’re using Einstein Intelligent Offers, an AppExchange package. * `Intelligent` —Recommendation came from Einstein Intelligent Offers. * `Learning` —Recommendation came from a randomized process in learning mode. _Available in: v46.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationModeEnum`. * `recommendationScore` (_number (double)_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ * `strategy` (_object_) RecordSnapshot Strategy that recommended the target record. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `RecordSnapshot`. * `targetAction` (_object_) RecordSnapshot Target action that is recommended. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `RecordSnapshot`. * `targetRecord` (_object_) Reference Reference to the target record. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `Reference`. * `url` (_string (url)_) URL to the recommendation reaction. _Available in: v45.0_ _Filter group: Small_ ### NBAStrategyInput Input strategyContext consumed by a recommendation strategy. * `contextRecordId` (_string_) ID of the context record. For example, if the next best action is on a case detail page, the ID of the case. _Available in: v45.0_ * `debugTrace` (_boolean_) Specifies whether to return trace and debug information in the response (`true`) or not (`false`). If unspecified, the default is `false`. _Available in: v45.0_ * `maxResults` (_integer_) Maximum number of results. Valid values are from 1 to 25. The default is 3. _Available in: v45.0_ * `strategyContext` (_object_) Variable and value mappings for the strategy. _Available in: v45.0_ Additional properties: `string`. ### NBARecommendations Recommendations returned by a recommendation strategy. * `executionId` (_string_) ID of the recommendation strategy execution. _Available in: v45.0_ _Filter group: Small_ * `onBehalfOfId` (_string_) ID of the user or entity for which the recommendation strategy was executed. _Available in: v45.0_ _Filter group: Small_ * `recommendations` (_array of NBARecommendation_) List of recommendations returned by a recommendation strategy. _Available in: v45.0_ _Filter group: Small_ * `trace` (_object_) StrategyTrace Trace information for the recommendation strategy execution, if requested. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `StrategyTrace`. * `debug` (_string_) Runtime debug information recorded during recommendation strategy execution. _Available in: v45.0_ _Filter group: Small_ * `errors` (_string_) Runtime errors that occurred during recommendation strategy execution. _Available in: v45.0_ _Filter group: Small_ ### Recommendation A Next Best Action recommendation object. * `acceptanceLabel` (_string_) Text indicating user acceptance of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `actionReference` (_string_) Reference to the action to perform, for example, launching a flow. _Available in: v45.0_ _Filter group: Small_ * `description` (_string_) Description of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `externalId` (_string_) External ID of the recommendation. This ID doesn’t need to be a Salesforce 18-character ID. For example, it can be a product number from an external system. _Available in: v46.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `image` (_object_) FileAsset Image to display. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `FileAsset`. * `name` (_string_) Name of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `rejectionLabel` (_string_) Text indicating user rejection of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the recommendation. _Available in: v45.0_ _Filter group: Small_ ### SurveyDescriptionInput Input representation of the details of the survey recipient and their engagement context, and the language, related records, and invitation settings of the survey. * `invitationSettings` (_object_, required) SurveyInvitationSettingsInput Invitation settings of the survey. The Invitation ID API doesn’t require the invitation configuration settings to be passed with the Survey Invitations. _Available in: v56.0_ Includes all fields of `SurveyInvitationSettingsInput`. * `languageCode` (_string_) Code of the language in which the survey is created. _Available in: v56.0_ * `recipientEngagementContext` (_object_) Engagement context settings for a recipient of the survey. _Available in: v56.0_ Additional properties: `string`. * `relatedRecordIds` (_array of string_) IDs of the records that are related to the survey. _Available in: v56.0_ * `shouldLoadPartiallyCmplSurvey` (_boolean_) Indicates whether to load partially completed surveys when a partially completed survey is selected ( `true` ), or to start a new survey ( `false` ). The default value is `false` . _Available in: v63.0_ * `staticMergeFields` (_object_) Map of static merge field values. _Available in: v56.0_ Additional properties: `string`. ### SurveyDescriptionOutput Output representation of the response to the Start Survey request. * `errors` (_array of string_) Error messages for a failed request. _Available in: v56.0_ _Filter group: Small_ * `flowInterviewState` (_string_) State of the flow interview. _Available in: v56.0_ _Filter group: Small_ * `invitationId` (_string_) ID of the survey invitation that's related to the request. _Available in: v56.0_ _Filter group: Small_ * `isPartiallyCmplSurveyLoaded` (_boolean_) Indicates whether a partially completed survey is loaded ( `true` ) or a new survey is started ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `languageCode` (_string_) Code of the language that the survey is created in. _Available in: v56.0_ _Filter group: Small_ * `navigationActions` (_array of SurveyNavigationActionEnum_) Available navigation actions on the survey page. Possible values are: * `Back` —Go to the previous survey page. * `Next` —Go to the next survey page. _Available in: v57.0_ _Filter group: Small_ * `responseId` (_string_) ID of the survey response. _Available in: v57.0_ _Filter group: Small_ * `status` (_object_) SurveyResponseApiStatusEnum Status of the API request. Possible values are: * `Failure` —Survey Response API isn’t successfully run. * `Success` —Survey Response API is successfully run. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `SurveyResponseApiStatusEnum`. * `surveyDetail` (_object_) SurveyDetailOutput All details of the page in the survey. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `SurveyDetailOutput`. * `warnings` (_array of string_) Warnings for a request. _Available in: v56.0_ _Filter group: Small_ ### SurveyResponseInput Input representation of the details of a survey response. * `flowInterviewState` (_string_, required) State of the flow interview. _Available in: v56.0_ * `invitationId` (_string_, required) ID of the survey invitation. _Available in: v56.0_ * `languageCode` (_string_) Code of the language that the survey is created in. _Available in: v56.0_ * `navigationAction` (_object_, required) SurveyNavigationActionEnum Available navigation actions on the survey page. Possible values are: * `Back` —Navigate to the previous survey page. * `Next` —Navigate to the next survey page. _Available in: v57.0_ Includes all fields of `SurveyNavigationActionEnum`. * `surveyPageResponses` (_object_, required) SurveyPageResponseInput Responses to the survey questions on a page. _Available in: v56.0_ Includes all fields of `SurveyPageResponseInput`. ### SurveyResponseOutput Output representation of the response to the Submit Survey request. The response includes the status of the survey response API and the Thank You page details in the survey. * `errors` (_array of string_) Error messages for a failed request. _Available in: v56.0_ _Filter group: Small_ * `flowInterviewState` (_string_) State of the flow interview. _Available in: v57.0_ _Filter group: Small_ * `invitationId` (_string_) ID of the survey invitation that's related to the request. _Available in: v57.0_ _Filter group: Small_ * `languageCode` (_string_) Code of the language that the survey is created in. _Available in: v56.0_ _Filter group: Small_ * `navigationActions` (_array of SurveyNavigationActionEnum_) Available navigation actions on the survey page. Possible values are: * `Back` —Go to the previous survey page. * `Next` —Go to the next survey page. _Available in: v57.0_ _Filter group: Small_ * `responseId` (_string_) ID of the survey response. _Available in: v57.0_ _Filter group: Small_ * `status` (_object_) SurveyResponseApiStatusEnum Status of the API request. Possible values are: * `Failure` —Survey Response API isn’t successfully run. * `Success` —Survey Response API is successfully run. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `SurveyResponseApiStatusEnum`. * `surveyPage` (_SurveyQuestionPageOutput | SurveyThankYouPageOutput_) Details of the question or the Thank You page. _Available in: v56.0_ _Filter group: Small_ One of: `SurveyQuestionPageOutput`, `SurveyThankYouPageOutput`. ### SurveyEmailInput Survey email. * `allowGuestUserResponse` (_boolean_, required) Specifies whether participants who don't have a Salesforce account can respond (`true`) or not (`false`). _Available in: v50.0_ * `allowParticipantsAccessTheirResponse` (_boolean_, required) Specifies whether participants can see their responses (`true`) or not (`false`). _Available in: v50.0_ * `associateRecordsWithRecipients` (_array of SurveyRecipientSurveySubjectsInput_) Maps each recipient with another record that must be associated with the recipient's survey invitation. _Available in: v50.0_ * `body` (_string_) Content of the email. Specify the email body in case you don't specify an email template. The email body must contain one of these merge fields: * To embed a link to launch the survey: \[\[SURVEY\_INVITATION\_URL\]\] * To embed a survey question: {{{SurveyQuestion.QuestionName}}} and {{{SurveyQuestion.QuestionHtmlContent}}} _Available in: v50.0_ * `collectAnonymousResponse` (_boolean_, required) Specifies whether participants can respond anonymously (`true`) or not (`false`). _Available in: v50.0_ * `communityId` (_string_) ID of the site that's used to open the survey for users outside your org. _Available in: v50.0_ * `emailTemplateId` (_string_) ID of the Lightning email template that's used to send the survey invitation. The template must contain the required merge fields that embed either the survey link or a question in the email. Only Lightning email templates are used to send survey invitations. _Available in: v50.0_ * `fromEmailAddress` (_string_, required) Email ID of the user or the org-wide email address associated with the user's profile. _Available in: v50.0_ * `invitationExpirationDate` (_string (date-time)_) Date on which the survey invitation expires. _Available in: v50.0_ * `invitationOwner` (_string_) ID of the owner of the survey invitation records. _Available in: v50.0_ * `isPersonalInvitation` (_boolean_, required) Specifies whether a unique invitation is created for each participant (`true`) or not (`false`). When a participant responds using a personal invitation, the response record is associated with the participant's Salesforce record. _Available in: v50.0_ * `recipientEngagementContexts` (_array of SurveyRecipientEngagementContextInput_) Maps each recipient with the context based on which the survey invitation is emailed. _Available in: v50.0_ * `recipients` (_array of string_, required) List of up to 300 IDs of leads, contacts, or users to whom the survey invitation is emailed. _Available in: v50.0_ * `sendEmailThroughUma` (_boolean_) Specifies whether to send the email through Marketing Cloud (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v65.0_ * `shareInvitationsWith` (_array of string_) IDs of the users with whom the survey invitation records must be shared. The invitation records are shared with Read access. _Available in: v50.0_ * `subject` (_string_) Subject of the email. Specify the subject in case you don't specify an email template. _Available in: v50.0_ * `surveyQuestionIds` (_array of string_) IDs of the questions that are embedded in the email. You can send an email invitation for questions of these types: Net Promoter Score (NPS), rating, and score. _Available in: v50.0_ ### SurveyEmail Survey invitation email response. * `errorCode` (_integer_) Error code for the failed call. _Available in: v50.0_ _Filter group: Small_ * `errorMessage` (_string_) Details explaining why the call failed. _Available in: v50.0_ _Filter group: Small_ * `status` (_object_) SurveyEmailStatusEnum Status of a survey invitation email. Values are: * `Failed` —The survey invitation email wasn't sent. * `Queued` —The survey invitation email is queued for sending. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `SurveyEmailStatusEnum`. ### ConnectDirectory Connect directory. * `communities` (_string_) URL to the Experience Cloud sites resource. _Available in: v26.0_ _Filter group: Small_ * `organization` (_string_) URL to the org resource. _Available in: v25.0_ _Filter group: Small_ ### GenericBatchRequestInput Describes a batch request input. * `binaryPartName` (_string_) The name of the binary part in the multipart request. When there are multiple binary parts uploaded in one batch request, this value is used to map a request to its binary part. To prevent name collisions, use a unique value for each binaryPartName property in a batch request. This property is optional. If this value exists, a binaryPartNameAlias value must also exist. * `binaryPartNameAlias` (_string_) The name parameter in the Content-Disposition header of the binary body part. Different resources expect different values. This property is optional. If this value exists, a binaryPartName value must also exist. * `method` (_ConnectRequestMethod_) * `richInput` (_object_) The input body for the request. The type depends on the request specified in the url property. This property is optional. * `url` (_string_) The Chatter API resource to request. This value is called a sub-request. The URL must start with a version number, for example, /v28.0/chatter/users/me. The version number must be less than or equal to the version of the request given to the /connect/batch request URL. The URL can include any query string parameters that the sub-request supports. The query string must be URL-encoded. You can append query string parameters to this URL. In addition, you can apply property filtering. You cannot apply headers at the sub-request level. ### 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 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` (_array of BatchResult_) Collection of batch result items _Available in: v23.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_ ### Organization An org. * `accessTimeout` (_integer_) Amount of time after which the system prompts users who have been inactive to log out or continue working. _Available in: v24.0_ _Filter group: Small_ * `features` (_object_) Features Information about features available in the org or site. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `Features`. * `maintenanceInfo` (_array of Maintenance_) Information about a list of upcoming scheduled maintenances for the org. _Available in: v34.0_ _Filter group: Medium_ * `name` (_string_) Org name. _Available in: v26.0_ _Filter group: Small_ * `orgId` (_string (Id)_) 18-character ID for the org. _Available in: v24.0_ _Filter group: Small_ * `userSettings` (_object_) UserSettings Information about the org permissions for the user. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `UserSettings`. ### ZoneCollection A page of Chatter Answers zones. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v29.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: v29.0_ _Filter group: Small_ * `zones` (_array of Zone_) Collection of one or more zones _Available in: v29.0_ _Filter group: Small_ ### ConnectQuickTextContextEnum Context of the quick text. Value is `Runtime`. _Available in: v50.0_ _Filter group: Small_ Type: `string`. Allowed values: `Preview`, `Runtime`. ### QuickTextBody Quick Text Body * `contextType` (_object_) ConnectQuickTextContextEnum Context of the quick text. Value is `Runtime`. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ConnectQuickTextContextEnum`. ### Zone A Chatter Answers zone. * `description` (_string_) The description of the zone. _Available in: v29.0_ _Filter group: Big_ * `id` (_string_) The zone ID. _Available in: v29.0_ _Filter group: Small_ * `isActive` (_boolean_) Indicates that the zone is active. _Available in: v29.0_ _Filter group: Small_ * `isChatterAnswers` (_boolean_) Indicates that the zone is available for Chatter Answers. _Available in: v29.0_ _Filter group: Small_ * `name` (_string_) Name of the zone. _Available in: v29.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API resource URL to the zone. _Available in: v30.0_ _Filter group: Small_ * `visibility` (_object_) ConnectZoneVisibilityTypeEnum Zone visibility type. One of these values: * `Community` —Available in an Experience Cloud site. * `Internal` —Available internally only. * `Portal` —Available in a portal. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectZoneVisibilityTypeEnum`. * `visibilityId` (_string_) If the zone is available in a site, this property contains the ID of the site. If the zone is available to all sites, this property contains the value `All` . _Available in: v29.0_ _Filter group: Small_ ### ConnectZoneSearchResultTypeEnum Type of the search result. One of these values: * `Article` —Search results contain only articles. * `Question` —Search results contain only questions. _Available in: v29.0_ _Filter group: Small_ Type: `string`. Allowed values: `Article`, `Question`. ### ZoneSearchResultCollection Container of zone search results with page URL and page token. * `currentPageToken` (_string_) Current page token. * `currentPageUrl` (_string (url)_) Current page URL. * `items` (_array of ZoneSearchResult_) List of search results. * `nextPageToken` (_string_) Token of next resource page. * `nextPageUrl` (_string (url)_) URL of next resource page. ### BotVersionActivationInfo Success or failure information of the bot version activation. * `isActivated` (_boolean_) Indicates whether the bot is active or not. _Available in: v51.0_ _Filter group: Small_ * `messages` (_array of string_) Failure messages. _Available in: v50.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the activation was successful or not. _Available in: v50.0_ _Filter group: Small_ ### BotVersionActivationStatus Activation status of the bot version. Activation status must be specified in the `status` request parameter or the Bot Version Activation Input request body. _Available in: v50.0_ Type: `string`. Allowed values: `Active`, `Inactive`. ### BotVersionActivationInput Activation information for the bot version. * `status` (_object_) BotVersionActivationStatus Activation status of the bot version. Activation status must be specified in the `status` request parameter or the Bot Version Activation Input request body. _Available in: v50.0_ Includes all fields of `BotVersionActivationStatus`. ### ConversationApplicationDefinitionDetailRespresentation Information about conversation application definition. * `botInfo` (_object_) BotInfo Basic information of the bot associated with this conversation application. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `BotInfo`. * `errorMessage` (_string_) Error message for the failed get operation. _Available in: v54.0_ _Filter group: Small_ * `integrationApplication` (_object_) ConversationApplicationIntegrationType Conversation application integration types. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConversationApplicationIntegrationType`. * `integrationName` (_string_) Name of the conversation application. _Available in: v54.0_ _Filter group: Small_ * `isSuccess` (_boolean_) Success indicator of the get operation. _Available in: v54.0_ _Filter group: Small_ * `runtimeUrl` (_string_) Base URL of the bot runtime API. _Available in: v54.0_ _Filter group: Small_ * `eTag` (_string_, read-only) An entity tag that you can compare between responses to determine changes and also use to take advantage of browser caching. _Available in: v54.0_ _Filter group: Small_ ### BotUtteranceCollectionPredictionInput Collection of utterance and associated intent information for a bot. * `botId` (_string_, required) ID of the bot. _Available in: v66.0_ * `botVersionId` (_string_, required) Version ID of the bot. _Available in: v66.0_ * `utterancesToIntents` (_array of UtterancePredictionInput_, required) Collection of utterance and intent information for the bot. _Available in: v66.0_ ### BotUtteranceCollectionPredictionOutput Intent predictions for a bot. * `botId` (_string_) ID of the bot. _Available in: v66.0_ _Filter group: Small_ * `botVersionId` (_string_) Version ID of the bot. _Available in: v66.0_ _Filter group: Small_ * `lastPredictionDate` (_string (date-time)_) Date when an utterance prediction request for the bot was last processed. _Available in: v66.0_ _Filter group: Small_ * `predictionResults` (_array of UtterancePredictionOutput_) List of intent prediction information for utterances. _Available in: v66.0_ _Filter group: Small_ * `predictionSummary` (_object_) UtterancePredictionSummaryOutput Summary of intent predictions for utterances. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `UtterancePredictionSummaryOutput`. ### BotUtteranceCollectionPredictionFromSetInput Bot data. * `botId` (_string_, required) ID of the bot. _Available in: v66.0_ * `botVersionId` (_string_, required) Bot version ID. _Available in: v66.0_ * `language` (_string_) Language of the bot. _Available in: v66.0_ ### ProgramApplicationInput Input representation of an application to a program. * `accountId` (_string_, required) A valid ID of an account. _Available in: v58.0_ * `appName` (_string_) Application name or namespace initiating the API request. * `applicationItems` (_array of ProgramApplicationItemInput_, required) A list of application line items associated with the program. _Available in: v58.0_ * `attributeCreationStrategy` (_AttributeCreationStrategyEnum_) * `description` (_string_) Description of the application. _Available in: v58.0_ * `files` (_array of ProgramApplicationFileInput_) A list of ContentDocument IDs. _Available in: v58.0_ * `isSubmittedByThirdParty` (_boolean_) Is submitted by third party * `locationId` (_string_) A valid ID of a Location * `programId` (_string_, required) A valid ID of a program. _Available in: v58.0_ * `submittedByAccountId` (_string_) A valid ID of an Submitted by Account ### ProgramApplicationOutput Output representation of an application request to a Program. * `applicationId` (_string_) Tracking number for an application. _Available in: v58.0_ _Filter group: Small_ * `message` (_string_) Response message. _Available in: v58.0_ _Filter group: Small_ * `success` (_boolean_) Indicates if the application is successfully created ( `true` ) or not ( `false` ). _Available in: v58.0_ _Filter group: Small_ ### CalmGenerateInput Asset generation input for Customer Asset Lifecycle Management. Represents the creation of a lifecycle-managed asset. * `accountId` (_string (Id)_, required) Asset’s parent account. _Available in: v50.0_ * `assetAction` (_object_, required) CalmAssetActionInput Asset action that creates the asset. _Available in: v50.0_ Includes all fields of `CalmAssetActionInput`. * `assetActionSources` (_array of CalmAssetActionSourceInput_) List of asset action sources. _Available in: v50.0_ * `assetName` (_string_, required) Name of the new asset. _Available in: v50.0_ * `assetStatePeriods` (_array of CalmAssetStatePeriodInput_, required) List of asset state periods affected by the generate asset call. _Available in: v50.0_ * `currencyIsoCode` (_string_, required) Three-letter ISO 4217 currency code associated with the lifecycle-managed asset record. _Available in: v50.0_ * `productId` (_string (Id)_, required) ID of the parent product for the asset. _Available in: v50.0_ ### CalmOutput Connect REST API output representation for lifecycle-managed assets. * `asset` (_object_) CalmAssetOutput ID of the asset on which the API was called. _Available in: v50.0_ _Filter group: Big_ Includes all fields of `CalmAssetOutput`. * `assetAction` (_object_) CalmAssetActionOutput ID of the asset action created as a result of the API call. _Available in: v50.0_ _Filter group: Big_ Includes all fields of `CalmAssetActionOutput`. * `assetActionSources` (_array of CalmAssetActionSourceOutput_) Asset action sources. _Available in: v50.0_ _Filter group: Big_ * `assetStatePeriods` (_array of CalmAssetStatePeriodOutput_) Asset state periods. _Available in: v50.0_ _Filter group: Big_ ### CalmCancelInput Cancellation input consumed by Customer Asset Lifecycle Management. Represents a cancellation action made against a lifecycle-managed asset. * `assetAction` (_object_, required) CalmAssetActionInput Asset action that caused the cancellation. _Available in: v50.0_ Includes all fields of `CalmAssetActionInput`. * `assetActionSources` (_array of CalmAssetActionSourceInput_) List of asset action sources. _Available in: v50.0_ * `assetStatePeriod` (_object_, required) CalmAssetStatePeriodInput Most recent asset state period for the canceled asset. _Available in: v50.0_ Includes all fields of `CalmAssetStatePeriodInput`. ### CalmChangeInput Change input consumed by Customer Asset Lifecycle Management. Represents a change action made against a lifecycle-managed asset. * `assetAction` (_object_, required) CalmAssetActionInput Action that caused a change to the asset. _Available in: v50.0_ Includes all fields of `CalmAssetActionInput`. * `assetActionSources` (_array of CalmAssetActionSourceInput_) List of asset action sources. _Available in: v50.0_ * `assetStatePeriods` (_array of CalmAssetStatePeriodInput_) List of asset state periods affected by the change asset call. _Available in: v50.0_ ### ConnectorsCallCoachingStatus Current status of Einstein Conversation Insights for a partner. * `enabled` (_boolean_) Specifies whether the Einstein Conversation Insights preference is enabled and connector for partner is enabled (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `users` (_array of ConnectorsCallCoachingUserInfo_) List of user information for every active Einstein Conversation Insights user. _Available in: v49.0_ _Filter group: Small_ ### ConnectorsCallInputList List of voice calls and recording properties. * `calls` (_array of ConnectorsCallInput_, required) List of up to 200 voice calls. _Available in: v49.0_ ### ConnectorsVoiceCallListResult List results of posting a voice call. * `calls` (_array of ConnectorsVoiceCallResult_) List of voice call results. _Available in: v49.0_ _Filter group: Small_ ### DatacloudCompany The Data.com company record. If you own a company record, you see all the fields. If you don’t own the company record, some fields are hidden by asterisks (\*\*\*). * `activeContacts` (_integer_) The number of active contacts that the company has. _Available in: v32.0_ _Filter group: Small_ * `address` (_object_) Address The address of the company. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Address`. * `annualRevenue` (_number (double)_) The amount of money that the company makes in one year. _Available in: v32.0_ _Filter group: Small_ * `companyId` (_string_) The unique numerical identifier for the company. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) The description of the company. _Available in: v32.0_ _Filter group: Small_ * `dunsNumber` (_string_) A randomly generated nine-digit number that’s assigned by Dun & Bradstreet (D&B) to identify unique business establishments. _Available in: v32.0_ _Filter group: Small_ * `industry` (_string_) A description for the area of focus in which the company does business. _Available in: v32.0_ _Filter group: Small_ * `isInactive` (_boolean_) Whether the company information is no longer accurate (true) or the company information is up to date (false). _Available in: v32.0_ _Filter group: Small_ * `isOwned` (_boolean_) Whether the company has been purchased by you or your organization (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `naicsCode` (_string_) North American Industry Classification System (NAICS) codes were created to provide details about a business’s service orientation. The code descriptions are focused on what a business does. _Available in: v32.0_ _Filter group: Small_ * `naicsDescription` (_string_) A description of the NAICS classification. _Available in: v32.0_ _Filter group: Small_ * `name` (_string_) The company’s name. _Available in: v32.0_ _Filter group: Small_ * `numberOfEmployees` (_integer_) The number of employees who are working for the company. _Available in: v32.0_ _Filter group: Small_ * `ownership` (_string_) The type of ownership of the company: * `Public` * `Private` * `Government` * `Other` _Available in: v32.0_ _Filter group: Small_ * `phoneNumbers` (_array of PhoneNumber_) A numerical string that contains a corporate phone number for the company. _Available in: v32.0_ _Filter group: Small_ * `sic` (_string_) Standard Industrial Codes (SIC) is a numbering convention that indicates what type of service a business provides. _Available in: v32.0_ _Filter group: Small_ * `sicDescription` (_string_) A description of the SIC classification. _Available in: v32.0_ _Filter group: Small_ * `site` (_string_) The type of location of the company, such as “Headquarters.” _Available in: v32.0_ _Filter group: Small_ * `tickerSymbol` (_string_) The symbol that uniquely identifies companies that are traded on public stock exchanges. _Available in: v32.0_ _Filter group: Small_ * `tradeStyle` (_string_) A legal name under which a company conducts business. _Available in: v32.0_ _Filter group: Small_ * `updatedDate` (_string (date-time)_) The date when the information was last updated for this company in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `website` (_string_) The URL to the company’s website. _Available in: v32.0_ _Filter group: Small_ * `yearStarted` (_string_) The year when the company was founded. _Available in: v32.0_ _Filter group: Small_ ### DatacloudContactImportInput Input representation of the criteria for importing records as contacts or leads. * `datacloudClientId` (_string_) Datacloud Client Id * `datacloudContactIds` (_array of string_, required) A list of the `contactIds` to import. There can be from 1 up to 200 `contactIds` in a comma-separated list. Requests with more than 200 contacts fail. _Available in: v36.0_ * `parentAccountId` (_string_) The `accountId` for the selected account that is in your organization. _Available in: v36.0_ ### DatacloudImport Represents the Data.com contact import response. * `duplicatesSkippedCount` (_integer_) The number of duplicate records blocked from being added. _Available in: v35.0_ _Filter group: Small_ * `errorCount` (_integer_) The number of errors generated for this response. _Available in: v35.0_ _Filter group: Small_ * `errorMessageDescriptionUrl` (_string_) The URL to the error message for this response. _Available in: v35.0_ _Filter group: Small_ * `importStatus` (_array of DatacloudImportStatus_) The status of this response. _Available in: v35.0_ _Filter group: Small_ * `orgAllowsDuplicates` (_boolean_) Indicates whether duplicate rules are turned on for the organization. True means that the organization accepts duplicate records, and false means the organization blocks duplicate records. _Available in: v35.0_ _Filter group: Small_ * `successCount` (_integer_) The number of contacts successfully added to the organization. _Available in: v35.0_ _Filter group: Small_ ### DatacloudContact Information about Data.com contacts. If you own a contact, you see all the fields. If you don’t own the contact record, some fields are hidden by asterisks (\*\*\*). * `address` (_object_) Address A postal address for the company where this contact works. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Address`. * `companyId` (_string_) The unique numerical identifier for the company at which the contact works. _Available in: v32.0_ _Filter group: Small_ * `companyName` (_string_) The name of the company at which the contact works. _Available in: v32.0_ _Filter group: Small_ * `contactId` (_string_) The unique numerical identifier for a contact. _Available in: v32.0_ _Filter group: Small_ * `department` (_string_) The name of the department to which the contact is assigned. _Available in: v32.0_ _Filter group: Small_ * `email` (_string_) An email address for this contact. _Available in: v32.0_ _Filter group: Small_ * `firstName` (_string_) The first name of a contact. _Available in: v32.0_ _Filter group: Small_ * `isInactive` (_boolean_) A `true` or `false` response. True means that the record is no longer active. False means that the contact is still valid and active. _Available in: v32.0_ _Filter group: Small_ * `isOwned` (_boolean_) Specifies whether your organization owns this contact. _Available in: v32.0_ _Filter group: Small_ * `lastName` (_string_) The last name of a contact. _Available in: v32.0_ _Filter group: Small_ * `level` (_string_) A human resource label designating a person’s level in the company. _Available in: v32.0_ _Filter group: Small_ * `phoneNumbers` (_array of PhoneNumber_) A numerical string that contains the direct-dial phone number for the contact. _Available in: v32.0_ _Filter group: Small_ * `title` (_string_) The job title for a contact. _Available in: v32.0_ _Filter group: Small_ * `updatedDate` (_string (date-time)_) The date when the information for this contact was updated in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ ### DatacloudOrderInput A list of Data.com identification numbers that are used to purchase contacts or companies by a specific user type. * `companyIds` (_array of string_) The list of companies to purchase. If `contactIds` are included with `companyIds`, your purchase fails. Required to purchase companies _Available in: v32.0_ * `contactIds` (_array of string_) The list of contacts to purchase. If `companyIds` are included with `contactIds`, your purchase fails. Required to purchase contacts _Available in: v32.0_ * `userType` (_object_) ConnectDatacloudUserTypeEnum The Data.com user type. * `Monthly` —A user type that’s assigned monthly point limits for purchasing Data.com records. Only the assigned user can use monthly points. Points expire at the end of the month. Monthly is the default setting for `DatacloudUserType`. * `Listpool` —A user type that allows users to draw from a pool of points to purchase Data.com records. _Available in: v32.0_ Includes all fields of `ConnectDatacloudUserTypeEnum`. ### DatacloudOrder Information about the Data.com records that you purchased and details of the purchase. * `entityUrl` (_string (url)_) A URL to a list of purchased records for a specific order. _Available in: v32.0_ _Filter group: Small_ * `id` (_string (Id)_) The `orderId` that identifies a specific order. _Available in: v32.0_ _Filter group: Small_ * `purchaseCount` (_integer_) The number of records that were purchased for this order. _Available in: v32.0_ _Filter group: Small_ * `purchaseDate` (_string (date-time)_) The date when records were purchased in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) A URL to the order information for a specific order. _Available in: v32.0_ _Filter group: Small_ ### DatacloudCompanyCollection Purchase details for all companies that were purchased for a specific order. * `companies` (_array of DatacloudCompany_) A list of all companies for a specific order. _Available in: v32.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) The URL to the current page of companies. _Available in: v32.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) The URL to the next page of companies. If there isn’t a next page, value is `null`. _Available in: v32.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) The URL to the previous page of companies. The value is `null` if there isn’t a previous page. _Available in: v32.0_ _Filter group: Medium_ * `total` (_integer_) Number of companies in the order. Users can set how many companies are displayed on a page. The default page size is 25. _Available in: v32.0_ _Filter group: Small_ ### DatacloudContactCollection Purchase details for all contacts that were purchased for a specific order. * `contacts` (_array of DatacloudContact_) A list of all the contacts for a specific `{orderId}`. _Available in: v32.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) The current page of contacts. _Available in: v32.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) The URL to the next page of contacts. If there’s only one page of contacts, the value is null. _Available in: v32.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) The URL to the previous page of contacts. The value is null when there’s only one page of contacts. _Available in: v32.0_ _Filter group: Medium_ * `total` (_integer_) Number of contacts that are associated with this order. The total number of contacts can be greater than the number of contacts that are displayed on a single page. _Available in: v32.0_ _Filter group: Small_ ### DatacloudPurchaseUsage Information about the Data.com purchase usage for an organization. Shows the credits that are used and available for Monthly and Listpool users. * `listpoolCreditsAvailable` (_integer_) Listpool credits that are available for all users in the Listpool group. _Available in: v32.0_ _Filter group: Small_ * `listpoolCreditsUsed` (_integer_) Listpool credits that were used by all the users in the Listpool group. _Available in: v32.0_ _Filter group: Small_ * `monthlyCreditsAvailable` (_integer_) Monthly credits that are assigned to a specific user. _Available in: v32.0_ _Filter group: Small_ * `monthlyCreditsUsed` (_integer_) Monthly credits that were used by a specific user. _Available in: v32.0_ _Filter group: Small_ ### UserOauthInfo Information about a user’s OAuth status. * `availableExternalEmailService` (_object_) OauthProviderInfo The available OAuth service provider. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `OauthProviderInfo`. * `isAuthenticated` (_boolean_) Specifies whether the user is authenticated (`true`) or not (`false`). _Available in: v37.0_ _Filter group: Small_ ### EmailMergeField The map for objects and their merge fields. * `entityToMergeFieldsMap` (_object_) Map for multiple objects and their merge field collections. _Available in: v39.0_ _Filter group: Small_ Additional properties: `EmailMergeFieldCollection`. ### CleanDataServiceOutputCollection Data services associated with all active data integration rules in an organization. * `dataServiceRecords` (_array of CleanDataServiceOutput_) Collection of data services associated with all active data integration rules in an organization. _Available in: v37.0_ _Filter group: Small_ ### CleanMetricOutputCollection Metrics for data services associated with all active data integration rules in an organization. * `cleanMetricRecords` (_array of CleanMetricOutput_) List of metrics for data services associated with all active data integration rules in an organization. _Available in: v37.0_ _Filter group: Small_ * `metricDate` (_string (date-time)_) Date when metrics were generated in ISO 8601 format. _Available in: v37.0_ _Filter group: Small_ * `metricUri` (_string (url)_) URL for the Clean Metric API. _Available in: v37.0_ _Filter group: Medium_ ### CleanStatusOutputCollection Statuses of all active data integration rules for a record. * `cleanStatusRecords` (_array of CleanStatusOutput_) Collection of update statuses for a record’s data integration rules. _Available in: v37.0_ _Filter group: Small_ * `entityId` (_string (Id)_) ID of the record. _Available in: v37.0_ _Filter group: Small_ * `statusUri` (_string (url)_) URI for the update status. _Available in: v37.0_ _Filter group: Medium_ ### DataIntegrationCreditObjects External object names of active packages. * `sourceObjectNames` (_array of string_) List of external object names of the active packages. _Available in: v42.0_ _Filter group: Small_ ### DataIntegrationCredit Contract credit information. * `endDate` (_string (date-time)_) End date of a contract in ISO 8601 format. _Available in: v42.0_ _Filter group: Small_ * `orgCreditsTotal` (_integer (int64)_) Total credits granted to an org for use during a contract period. _Available in: v42.0_ _Filter group: Small_ * `orgCreditsUsed` (_integer (int64)_) Of the total credits granted to an org, credits used during a contract period. _Available in: v42.0_ _Filter group: Small_ * `sourceObjectName` (_string_) External object name. _Available in: v42.0_ _Filter group: Small_ * `startDate` (_string (date-time)_) Start date of a contract in ISO 8601. _Available in: v42.0_ _Filter group: Small_ * `userCreditsTotal` (_integer (int64)_) The maximum number of records that a user can import. _Available in: v43.0_ _Filter group: Small_ * `userCreditsUsed` (_integer (int64)_) The number of credits for importing records that a user has used during a contract period. _Available in: v43.0_ _Filter group: Small_ ### ContentTaxonomyTermCollection Collection of content taxonomy terms. * `currentPageUrl` (_string (url)_) URL for the current page of taxonomy terms. _Available in: v63.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL for the next page of taxonomy terms. _Available in: v63.0_ _Filter group: Small_ * `terms` (_array of ContentTaxonomyTerm_) List of taxonomy terms in the page. _Available in: v63.0_ _Filter group: Small_ ### ContentTaxonomyTermInput Create or update a term within a content taxonomy. * `description` (_string_) Description of the term. Required when creating a term. Optional when updating a term _Available in: v63.0_ * `label` (_string_) Label of the term. Required when creating a term. Optional when updating a term _Available in: v63.0_ * `parentTermId` (_string_) ID of the parent term. If unspecified when creating a term, creates a root term. If unspecified when updating a term, no changes are made. _Available in: v63.0_ ### ContentTaxonomyTerm Content taxonomy term. * `childTerms` (_array of ContentTaxonomyTerm_) Child terms of the term. _This property is recursive: each item has the same structure as `ContentTaxonomyTerm`._ _Available in: v63.0_ _Filter group: Big_ * `createdBy` (_object_) ContentTaxonomyUserSummary User that created the term. _Available in: v63.0_ _Filter group: Medium_ Includes all fields of `ContentTaxonomyUserSummary`. * `createdDate` (_string (date-time)_, nullable) Date the term was created. _Available in: v63.0_ _Filter group: Medium_ * `description` (_string_, nullable) Description of the term. _Available in: v63.0_ _Filter group: Medium_ * `id` (_string (Id)_) ID of the term. _Available in: v63.0_ _Filter group: Small_ * `isLeafTerm` (_boolean_, nullable) Specifies whether the term has no child terms ( `true` ) or has child terms ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `label` (_string_) Label of the term. _Available in: v63.0_ _Filter group: Small_ * `lastModifiedBy` (_object_) ContentTaxonomyUserSummary User that last modified the term. _Available in: v63.0_ _Filter group: Medium_ Includes all fields of `ContentTaxonomyUserSummary`. * `lastModifiedDate` (_string (date-time)_, nullable) Date the term was last modified. _Available in: v63.0_ _Filter group: Medium_ * `parentTerms` (_array of ContentTaxonomyTerm_) Parent term(s) of the term. _This property is recursive: each item has the same structure as `ContentTaxonomyTerm`._ _Available in: v63.0_ _Filter group: Big_ * `pathsFromRoot` (_array of ContentTaxonomyPath_) Path(s) from a root term to the term. _Available in: v63.0_ _Filter group: Big_ ### LightningModelTypesInput Input for lightning model types. * `language` (_string_) Language or locale code, such as `es` or `en_US` , to retrieve the title and description of a type. If unspecified, the logged-in user’s language is used. The fallback language is English in case translations don’t exist. _Available in: v64.0_ * `typeConfigs` (_array of LightningModelTypesConfigInput_, required) List of lightning model types configurations. _Available in: v64.0_ ### LightningModelTypesCollection Collection of lightning model types. * `types` (_array of LightningModelTypes_) List of types ordered alphabetically by title. _Available in: v64.0_ _Filter group: Small_ ### LightningModelTypeCategoryEnum The type categories for Lightning Model Types schema classification. Type: `string`. Allowed values: `Apex`, `Object`. ### LightningModelTypesEditorConfigEnum Editor configuration target for lightning model type. Valid value is `LightningDesktopGenAi` . _Available in: v64.0_ Type: `string`. Allowed values: `Default`, `EnhancedMessaging`, `EnhancedWebChat`, `ExperienceBuilder`, `LightningDesktopDesign`, `LightningDesktopGenAi`, `LightningMiawCopilot`, `LightningMobileGenAi`, `MiawCopilot`, `PreviewAndTest`, `PromptBuilder`, `ScEveryWhere`, `SlackCopilot`. ### LightningModelTypesRendererConfigEnum Renderer configuration target for lightning model types. Valid value is `LightningDesktopGenAi` . _Available in: v64.0_ Type: `string`. Allowed values: `AdaptiveCards`, `AgenticApps`, `AppDev`, `ChatGptApp`, `Default`, `Detail`, `Email`, `EnhancedMessaging`, `EnhancedWebChat`, `LightningDesktopDesign`, `LightningDesktopGenAi`, `LightningMiawCopilot`, `LightningMobileGenAi`, `MessagingChannel`, `MiawCopilot`, `ScEveryWhere`, `Slack`, `SlackCopilot`, `Summary`, `TemplatePreview`. ### LightningTypeCollection Collection of lightning types. * `count` (_integer_) Number of types returned. _Available in: v64.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of types. _Available in: v64.0_ _Filter group: Medium_ * `lightningTypes` (_array of LightningTypeSummary_) List of types ordered alphabetically by title. _Available in: v64.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of types. _Available in: v64.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of types. _Available in: v64.0_ _Filter group: Medium_ ### LightningTypeDetail Detailed information about a lightning type. * `description` (_string_) Description of the type from the schema.json. _Available in: v64.0_ _Filter group: Small_ * `developerName` (_string_) Developer name, or API name, of the type. _Available in: v64.0_ _Filter group: Small_ * `editorConfig` (_object_) Editor configuration for the specified target. _Available in: v64.0_ _Filter group: Big_ Additional properties: `object`. * `id` (_string (Id)_) 18-character ID of the type. This is returned for the database-based (Custom) types only. _Available in: v64.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix that is associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fully qualified name. _Available in: v64.0_ _Filter group: Small_ * `rendererConfig` (_object_) Renderer configuration for the specified target. _Available in: v64.0_ _Filter group: Big_ Additional properties: `object`. * `schema` (_object_) The JSON schema definition (schema.json) of the type. _Available in: v64.0_ _Filter group: Big_ Additional properties: `object`. * `source` (_object_) LightningModelTypesSourceEnum Source of the Lightning type. Values are: * `Standard` —Standard type provided out-of-the-box by Salesforce. * `Custom` —Custom type created in the org. * `Managed` —Type that was installed from a managed package. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `LightningModelTypesSourceEnum`. * `title` (_string_) Title of the type from the schema.json. _Available in: v64.0_ _Filter group: Small_ ### SearchAnswer Results of searching objects using a natural language query. * `content` (_string_) AI generated response. _Available in: v63.0_ _Filter group: Small_ * `llmGenerationId` (_string_, nullable) LLM generation ID used to track any feedback on the conversation. _Available in: v63.0_ _Filter group: Small_ * `metadata` (_object_) All search related metadata associated with the objects found in the results. _Available in: v63.0_ _Filter group: Small_ Additional properties: `ObjectMetadata`. * `parameters` (_object_) Parameters Search query parameters. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `Parameters`. * `searchObjects` (_array of SearchObject_) Record results to build the answer. _Available in: v63.0_ _Filter group: Small_ ### SearchResultGroups Results of searching objects using keywords. * `metadata` (_object_) All related metadata associated with the objects found in the results. _Available in: v63.0_ _Filter group: Small_ Additional properties: `ObjectMetadata`. * `parameters` (_object_) Parameters Search query parameters. Some search results may not return all query parameters. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `Parameters`. * `queryInfo` (_object_) QueryInfo Search query execution information. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `QueryInfo`. * `resultGroups` (_array of SearchResultGroup_) Record results from a keyword search grouped by object. _Available in: v64.0_ _Filter group: Small_ * `searchObjects` (_array of SearchObject_) Record results for the keyword search grouped by object. In version 64.0 and later, use `resultGroups` for record results. _Available in: v63.0 only_ _Filter group: Small_ ### SearchRequest Search request input for searching an object. * `configurationName` (_string_) Name of the search configuration to apply. Look up search configuration names from Search Manager. _Available in: v63.0_ * `dataCategories` (_array of DataCategoryInput_) List of data categories to filter. _Available in: v63.0_ * `displayFields` (_array of string_) List of fields to display and return in the search results. By default, the fields displayed are defined by the search layout. _Available in: v63.0_ * `filters` (_array of FilterInput_) List of filters to apply. _Available in: v63.0_ * `highlights` (_boolean_) Specifies whether search generates a text highlight ( `true` ) or not ( `false` ). The default value is `false` . _Available in: v63.0_ * `offset` (_integer_) Search page offset position. Default value is `0` , which indicates displaying results from the beginning without skipping any entries. _Available in: v63.0_ * `orderBy` (_array of OrderByInput_) Ordering information. _Available in: v63.0_ * `pageSize` (_integer_) Number of results in a page. Valid values are from 1 through 1999. If unspecified the default value is `20` . _Available in: v63.0_ * `q` (_string_, required) Query term to search on. Query term must be two or more characters. _Available in: v63.0_ * `spellcheck` (_boolean_) Specifies whether search should apply spellcheck ( `true` ) or not ( `false` ). The default value is `true` . _Available in: v63.0_ ### ScopedSearchResults Keyword search results for an object. * `metadata` (_object_) ObjectMetadata All search metadata associated with the object. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ObjectMetadata`. * `objectQueryInfo` (_object_) ObjectQueryInfo Query execution information for the object. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ObjectQueryInfo`. * `parameters` (_object_) Parameters Query parameters. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `Parameters`. * `queryId` (_string_, nullable) Unique identifier assigned to a search query to enable tracking usage and analysis of user interactions with search results. _Available in: v65.0_ _Filter group: Small_ * `results` (_array of SearchResult_) Record results for the keyword search. _Available in: v64.0_ _Filter group: Small_ * `searchObject` (_object_) SearchObject Record results for the keyword search. _Available in: v63.0 only_ _Filter group: Small_ Includes all fields of `SearchObject`. ### RecordsetFilterCriteriaInput A set of recordset filter criteria applied to records, such as service appointment records. * `criteriaIds` (_array of string_, required) Recordset filter criteria IDs. _Available in: v53.0_ * `enforceSharing` (_boolean_) Determines whether record sharing checks are enforced (`true`) or not (`false`) during the execution of this call. _Available in: v53.0_ * `filteredObjectName` (_string_, required) Object that the filter is applied to. _Available in: v53.0_ * `recordIds` (_array of string_, required) List of record IDs of the filtered object. _Available in: v53.0_ ### RecordsetFilterCriteriaCollection List of record IDs of the filtered object. * `recordsetFilters` (_array of RecordsetFilterCriteria_) Collection of recordset filter criteria IDs and filtered record IDs. _Available in: v53.0_ _Filter group: Big_ ### FetchFilesInput Fetch the files generated for an optimization request in Enhanced Scheduling and Optimization. * `optimizationRequestId` (_string_, required) ID of the optimization request for which to retrieve the generated files. _Available in: v66.0_ ### FetchFiles Output representation for a fetch optimization files operation. Contains a map of the files created in the org for the specified optimization request. * `createdFiles` (_object_) Map of file names to their corresponding file creation details. Each key is the name of a file associated with the optimization request. Each value contains the Content Version ID and a success indicator. _Available in: v66.0_ _Filter group: Small_ Additional properties: `CreatedFile`. ### ShiftsFromPatternInput Shifts from a pattern. * `schedulingEndDate` (_string_) Scheduling end date in YYYY-MM-DD format. Provide `schedulingEndDate` or `schedulingOccurrences`. Don’t provide both. Required if `schedulingOccurrences` isn’t provided _Available in: v51.0_ * `schedulingOccurrences` (_integer_) Number of scheduling occurrences. Provide `schedulingEndDate` or `schedulingOccurrences`. Don’t provide both. Required if `schedulingEndDate` isn’t provided _Available in: v51.0_ * `schedulingStartDate` (_string_, required) Scheduling start date in YYYY-MM-DD format. _Available in: v51.0_ * `serviceResourceIdList` (_array of string_) List of service resource IDs to assign shifts to. _Available in: v53.0_ * `serviceTerritoryId` (_string_) ID of the service territory to assign shifts to. _Available in: v51.0_ * `shiftStatus` (_string_) Status of the shifts. Default values are: * `Confirmed` * `Published` * `Tentative` Additional status values can be created. _Available in: v52.0_ * `serviceResourceId` (_string_) ID of the service resource to assign shifts to. In version 53.0 and later, use `serviceResourceIdList`. _Available in: v51.0–52.0_ ### ShiftsFromPattern Shifts created from a pattern. * `count` (_integer_) Total count of created shifts. _Available in: v51.0_ _Filter group: Small_ * `error` (_object_) ShiftPatternError Error details for shifts from a pattern. _Available in: v53.0_ _Filter group: Small_ Includes all fields of `ShiftPatternError`. * `isSuccess` (_boolean_) Indicates if the request is successful (`true`) or not (`false`). _Available in: v53.0_ _Filter group: Small_ * `recordIds` (_array of string (Id)_) Collection of created shift IDs. _Available in: v51.0_ _Filter group: Big_ ### ConnectActivityTypeEnum Type of activity. Type: `string`. Allowed values: `All`, `Event`, `Task`. ### ActivityRemindersCollection A collection of activity reminders in Salesforce Classic. * `reminders` (_array of ActivityReminder_) List of upcoming activity reminders. _Available in: v39.0_ _Filter group: Small_ ### ActivityReminder An activity reminder in Salesforce Classic. * `entityId` (_string (Id)_) Activity (task or event) ID. _Available in: v39.0_ _Filter group: Small_ * `isReminderDisplayed` (_boolean_) Indicates if the reminder is displayed to the user. _Available in: v39.0_ _Filter group: Small_ * `message` (_string_) Activity subject. _Available in: v39.0_ _Filter group: Small_ * `platformActionGroups` (_array of PlatformActionGroupActivities_) List of action groups with action links available for the activity reminder. _Available in: v39.0_ _Filter group: Medium_ * `reminderDate` (_string (date-time)_) Reminder due date and time in ISO 8601 format. _Available in: v39.0_ _Filter group: Small_ ### ActivityReminderInput Activity reminder details in Salesforce Classic. * `isReminderDisplayed` (_boolean_, required) Indicates whether the activity reminder is displayed. _Available in: v39.0_ * `reminderDateTime` (_string (date-time)_) Date and time that the activity reminder displays in ISO 8601 format. _Available in: v39.0_ ### GetAllAppointmentSlotsInput Get All Appointment Slots input representation * `accountId` (_string_) ID of the associated account. _Available in: v49.0_ * `allowConcurrentScheduling` (_boolean_) Indicates whether concurrent appointments are allowed ( `true` ) or not allowed ( `false` ). The default value is `false` . _Available in: v49.0_ * `appointmentMode` (_string_) Appointment Mode * `correlationId` (_string_) ID to pass custom information to the `ServiceResourceScheduleHandler` Apex interface. For example, you can use the correlation ID to identify the app, website, or any other external system that calls this Apex interface implementation. If you don’t pass a custom value, a randomly generated identifier is passed. _Available in: v53.0_ * `endTime` (_string (date-time)_) Latest time that an appointment can end. The API only returns time slots up to 31 days from the `startTime`. _Available in: v49.0_ * `engagementChannelTypeIds` (_array of string_) The ID of the engagement channel type record. The resources and their associated time slots are filtered by the specified engagement channel type. This field supports only one engagement channel type ID. You can use engagement channel types with the `available-territory-slots` API only if: * **Schedule Appointments Using Engagement Channels** is enabled in Salesforce Scheduler Settings in your Salesforce org. * Shifts are defined in the scheduling policy. For more information on setting up shifts in the scheduling policy, see [Define Shift Rules in Scheduling Policy](https://help.salesforce.com/s/articleView?id=platform.ls_use_shifts_to_determine_time_slots.htm&type=5). Engagement channel types are not supported with operating hours rules in the scheduling policy. _Available in: v56.0_ * `filterByResources` (_array of string_) Comma-separated list of service resource IDs. API returns only eligible service resources that are both in the list and in the selected service territory. The resources are sorted by the order in which the resource IDs are passed. You can either pass `filterByResources` or `requiredResourceIds` in a request. _Available in: v51.0_ * `recordLimit` (_integer_) The maximum number of earliest available slots across the specified territories. The API outputs the specified number of sorted slots across service territories. _Available in: v63.0_ * `requiredResourceIds` (_array of string_) List of resource IDs that you want to get available time slots for. When you pass more than one resource ID, the API returns all the slots where any of the passed resources are available. For example, suppose that you have three qualified resources: A, B, and C. If you pass resource IDs A and B, the API returns all the slots where: * only A is available * only B is available * both A and B are available * both A and C are available * both B and C are available * A, B, and C are all available The API doesn’t return the slots where only C is available. If this field is empty, time slots for all qualified resources are returned. The API request doesn't show time slots for the resource specified in `requiredResourceIds` if it does not appear in the list of least utilized resources set for `resourceLimitAppointmentDistribution`. For example, if you specify a resource A in `requiredResourceIds` and `resourceLimitAppointmentDistribution` is set to 15, the request doesn’t show time slots for this resource, as A isn’t among the top 15 least utilized resources. _Available in: v49.0_ * `resourceLimitApptDistribution` (_integer_) Specify the maximum number of service resources that you want to show during appointment scheduling when appointment distribution is enabled. Default value is 10. The `filterByResources` field takes precedence over the `resourceLimitApptDistribution` field. _Available in: v53.0_ * `schedulingPolicyId` (_string_) ID of the AppointmentSchedulingPolicy object. If not provided, the default configurations are considered. _Available in: v49.0_ * `startTime` (_string (date-time)_) Earliest time that an appointment can start. Defaults to the current time of the request, if empty. You can also use a time from the past. _Available in: v49.0_ * `territoryIds` (_array of string_) List of IDs of service territories where the specified work is performed. _Available in: v49.0_ * `workType` (_object_) WorkTypeInput Type of work performed. Required if `workTypeGroupId` isn’t provided _Available in: v49.0_ Includes all fields of `WorkTypeInput`. * `workTypeGroupId` (_string_) ID of the work type group containing all work types performed. Required if `workType` isn’t provided _Available in: v49.0_ ### GetAllAppointmentSlotsOutput Available territory slots result. * `result` (_object_) GetAllAppointmentSlotsListResult All available time slots and resources available for that time slot across each territory. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `GetAllAppointmentSlotsListResult`. ### GetEngagementChannelTypeOutput Output representation of the list of the engagement channel types. * `result` (_object_) GetEngagementChannelTypeListResult List that contains the engagement channel types. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `GetEngagementChannelTypeListResult`. ### GetGroupAppointmentsInput Input representation of the criteria to filter and retrieve group appointments. * `endTime` (_string (date-time)_) Latest end time for the group appointments to be retrieved. _Available in: v61.0_ * `excludeAssociatedAppts` (_boolean_) Indicates whether the response excludes appointments where the current user is associated as an attendee or assigned resource ( `true` ) or not ( `false` ). _Available in: v61.0_ * `extendedFieldsToQuery` (_array of string_) List of the extended custom fields to fetch in the output. _Available in: v61.0_ * `filterByEngagementChannelTypes` (_array of string_) ID of the engagement channel type record. Group appointments are filtered based on the selected engagement channel type. _Available in: v61.0_ * `filterByParentRecords` (_array of string_) The ID of the associated parent record. _Available in: v61.0_ * `filterByResources` (_array of string_) List of the group appointments where all the given resources are present. _Available in: v61.0_ * `filterByTerritories` (_array of string_) List of IDs of the service territories where the requested work is performed. _Available in: v61.0_ * `filterByWorkTypeGroups` (_array of string_) IDs of the work type groups containing the work types that are being performed. _Available in: v61.0_ * `filterByWorkTypes` (_array of string_) List of IDs of the work types to be performed. _Available in: v61.0_ * `limit` (_integer_) Maximum number of records to be fetched. _Available in: v61.0_ * `offset` (_integer_) Number of records to be skipped. _Available in: v61.0_ * `startTime` (_string (date-time)_) The earliest start time for the group appointments to be retrieved. If not provided, it defaults to the current time of the request. _Available in: v61.0_ ### GetGroupAppointmentsOutput Output representation of the response that contains the retrieved group appointments. * `result` (_object_) GetGroupAppointmentsListResult List of result objects for the retrieved group appointments. _Available in: v61.0_ _Filter group: Small_ Includes all fields of `GetGroupAppointmentsListResult`. ### CreateServiceAppointmentInput Create Service Appointment input representation * `assignedResources` (_array of AssignedResourceInput_) Service resource who is assigned to a service appointment. When creating an appointment, you can use `extendedFields` to add values to any of the fields, including custom fields, in `assignedResources` as long as you have edit access to those fields. _Available in: v48.0_ * `lead` (_object_) LeadInput Prospect or lead. Required if `serviceAppointment` isn’t provided. Required to create a service appointment with unauthenticated guest users. _Available in: v48.0_ Includes all fields of `LeadInput`. * `schedulingPolicyId` (_string_) ID of the `AppointmentSchedulingPolicy` object. If no scheduling policy is passed in the request body, the default configurations are used. The only scheduling policy configuration that is used in determining time slots is the enforcement of account visiting hours. _Available in: v48.0_ * `serviceAppointment` (_object_) ServiceAppointmentInput Appointment to complete a service work for a customer. When creating an appointment, you can use `extendedFields` to add values to any of the fields, including custom fields, in `serviceAppointment` as long as you have edit access to those fields. Required if `lead` isn’t provided _Available in: v48.0_ Includes all fields of `ServiceAppointmentInput`. ### ServiceAppointmentOutput Output of the service appointment POST method. * `result` (_object_) ServiceAppointmentResult Result of the POST method. _Available in: v48.0_ _Filter group: Small_ Includes all fields of `ServiceAppointmentResult`. ### UpdateServiceAppointmentInput Input representation for updating a service appointment. Use to update the scheduled times, assigned resource(s), service territory or even work type for existing appointments. * `assignedResources` (_array of AssignedResourceInput_) Service resource who is assigned to a service appointment. When updating an appointment, pass the complete list of resources needed. If you don’t pass a resource that is assigned to a service appointment, the API deletes that assigned resource. For example, suppose that an existing service appointment has assigned resources: A and B and if you pass assigned resources: B and C. The API checks the resource availability of B and C for existing work type and service territory, and if both are available, the service appointment gets updated with: * Resource A—Deleted * Resource B—Updated * Resource C—Created However, if you don’t pass any of the assigned resources, the API assumes there is no change. When updating an appointment, you can use `extendedFields` to add values to any of the fields, including custom fields, in `assignedResources` as long as you have edit access to those fields. _Available in: v51.0_ * `lead` (_object_) LeadInput Prospect or lead. Required if `serviceAppointment` isn’t provided. Required to create a service appointment with unauthenticated guest users. _Available in: v48.0_ Includes all fields of `LeadInput`. * `schedulingPolicyId` (_string_) ID of the `AppointmentSchedulingPolicy` object. If no scheduling policy is passed in the request body, the default configurations are used. The only scheduling policy configuration that is used in determining time slots is the enforcement of account visiting hours. _Available in: v51.0_ * `serviceAppointment` (_object_, required) ServiceAppointmentInput Appointment to complete a service work for a customer. When creating an appointment, you can use `extendedFields` to add values to any of the fields, including custom fields, in `serviceAppointment` as long as you have edit access to those fields. Required if `lead` isn’t provided _Available in: v48.0_ Includes all fields of `ServiceAppointmentInput`. * `serviceAppointmentId` (_string_, required) ID of the service appointment that you want to update. _Available in: v51.0_ ### GetServiceTerritoriesOutput Output for the service territories GET method. * `result` (_object_) GetServiceTerritoriesListResult Result for the GET method. _Available in: v48.0_ _Filter group: Small_ Includes all fields of `GetServiceTerritoriesListResult`. ### WaitlistCheckInInput Input representation of the participant’s waitlist check in request. * `description` (_string_) Description of the participant. _Available in: v59.0_ * `extendedFields` (_array of ExtendedFieldInput_) Details of the extended custom fields. _Available in: v59.0_ * `lead` (_object_) LeadInput Details of the prospect or lead. Required if the `participantId` parameter isn’t specified. _Available in: v59.0_ Includes all fields of `LeadInput`. * `participantId` (_string_) ID of the participant with an appointment. The participant can be an account, a contact, or a lead. Required if the `lead` parameter isn’t specified. _Available in: v59.0_ * `serviceResourceId` (_string_) ID of the service resource. _Available in: v59.0_ * `waitlistId` (_string_, required) ID of the waitlist that the participant is checked in. _Available in: v59.0_ * `workTypeGroupId` (_string_) ID of the work type group. Required if the `workTypeId` parameter isn’t specified. _Available in: v59.0_ * `workTypeId` (_string_) ID of the work type that represents the topic for the appointment. Required if the `workTypeGroupId` parameter isn’t specified. _Available in: v59.0_ ### WaitlistCheckInOutput Output representation of the waitlist check in request. * `result` (_object_) WaitlistCheckInResult Result of the waitlist check in request. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `WaitlistCheckInResult`. ### UpdateWaitlistParticipantInput Input representation to move a waitlist participant to a specific position in a waitlist. * `targetPosition` (_integer_, required) Position in the waitlist to move the participant to. A value of `1` moves the participant to the top, and `-1` moves the participant to the bottom. In API version 65.0 and later, a positive integer `n` moves the participant to the nth position; if `n` exceeds the number of participants in the waitlist, the participant moves to the bottom. _Available in: v62.0_ * `waitlistParticipantId` (_string_, required) ID of the waitlist participant record to move. The participant's `Status` must be `Unassigned` . _Available in: v62.0_ ### WaitlistParticipantOutput Output representation of a waitlist participant move response. * `message` (_string_) Human-readable description of the result. Display this value to end users rather than branching on it. On success, the value matches one of these templates, depending on the value of `targetPosition` : `Participant successfully moved to first in the {WaitlistName} waitlist.` for `1` , or `Participant successfully moved to last in the {WaitlistName} waitlist.` for `-1` . In API version 65.0 and later, a positive integer other than `1` returns `Participant successfully repositioned in the {WaitlistName} waitlist.` _Available in: v62.0_ _Filter group: Small_ * `status` (_string_) Result of the request. The value is `success` on an HTTP 200 response. Use this property to branch programmatically. _Available in: v62.0_ _Filter group: Small_ * `waitlistParticipantId` (_string_) ID of the waitlist participant record that was moved. _Available in: v62.0_ _Filter group: Small_ ### WaitlistOutput Output representation of the waitlist result. * `result` (_object_) WaitlistListResult Details of the waitlist, including the list of participants and work type groups. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `WaitlistListResult`. ### ForecastingAncestors A list of forecast managers or territories. * `ancestors` (_array of ForecastingManager_) List of parent user nodes. _Available in: v44.0_ _Filter group: Small_ * `url` (_string (url)_) URL endpoint that was accessed. _Available in: v44.0_ _Filter group: Small_ * `userRoleId` (_string (Id)_) Unique identifier of the forecasting user’s role attached to this profile. _Available in: v44.0_ _Filter group: Small_ ### ForecastingUserCollection A collection of forecasting users whose forecasts the context user can view. * `jumpToUsers` (_array of ForecastingUser_) A collection of forecasting users that the context user can jump to. _Available in: v36.0_ _Filter group: Big_ * `url` (_string (url)_) The URL that generated the collection of users. _Available in: v36.0_ _Filter group: Small_ ### MyForecastsCollection A collection of forecasting users or territories listed in the dropdown menu or in search results on the forecasts page. * `forecastManagerList` (_array of MyForecasts_) For territory-based forecast types, a list of territories that the context user is a forecast manager of. For role-based forecast types, the context user, if the context user is a forecast manager in the role hierarchy. _Available in: v44.0_ _Filter group: Big_ * `representativeList` (_array of MyForecasts_) For territory-based forecast types, a list of territories that the context user is assigned to but that have no forecast manager. For role-based forecast types, the context user, if the context user is part of the role hierarchy and not a forecast manager. _Available in: v44.0_ _Filter group: Big_ * `sharedList` (_array of MyForecasts_) List of users that have shared their forecasts with the context user. `null` for territory-based forecast types. Sharing isn’t available for territory-based forecast types, so this property is `null` for territory-based forecast types. _Available in: v44.0_ _Filter group: Big_ * `url` (_string (url)_) URL endpoint that was accessed. _Available in: v44.0_ _Filter group: Small_ * `viewAllForecastsList` (_array of MyForecasts_) For territory-based forecast types, a list of territories and their respective forecast managers at the top level of the territory hierarchy. For role-based forecast types, a list of users at the top level of the role hierarchy. _Available in: v44.0_ _Filter group: Big_ ### ForecastingUserAccessCollection A collection of forecast user access representations. * `users` (_array of ForecastingUserAccess_) A list of accessible forecasting users. _Available in: v36.0_ _Filter group: Big_ ### TwbExportRequestInput Translation Workbench export request with filters and format options. * `filters` (_object_, required) TwbExportFiltersInput Filters specifying what content to export. _Available in: v67.0_ Includes all fields of `TwbExportFiltersInput`. * `format` (_object_, required) TwbExportFormatEnum Export file format. Values are: * `Stf` —Salesforce Translation Format * `Xliff` —XML Localization Interchange File Format _Available in: v67.0_ Includes all fields of `TwbExportFormatEnum`. ### TwbExportJobOutput Translation Workbench export job creation response. * `jobId` (_string_) Unique identifier for the export job, prefixed with `export_` . _Available in: v67.0_ _Filter group: Small_ * `message` (_string_) Human-readable status message. _Available in: v67.0_ _Filter group: Small_ * `status` (_object_) TwbJobStatusEnum Status of the export job. _Available in: v67.0_ _Filter group: Small_ Includes all fields of `TwbJobStatusEnum`. ### TwbExportJobStatusOutput Translation Workbench export job status. * `createdAt` (_string_) Timestamp in ISO 8601 format (UTC) for when the job was created. _Available in: v67.0_ _Filter group: Small_ * `downloadLinks` (_array of TwbDownloadLinkOutput_) List of download links for exported files. Available when status is `Completed` . _Available in: v67.0_ _Filter group: Small_ * `jobId` (_string_) Unique identifier for the export job, prefixed with `export_` . _Available in: v67.0_ _Filter group: Small_ * `message` (_string_) Human-readable status message. _Available in: v67.0_ _Filter group: Small_ * `status` (_object_) TwbJobStatusEnum Status of the export job. _Available in: v67.0_ _Filter group: Small_ Includes all fields of `TwbJobStatusEnum`. * `updatedAt` (_string_) Timestamp in ISO 8601 format (UTC) for when the job was last updated. _Available in: v67.0_ _Filter group: Small_ ### TwbImportJobOutput Translation Workbench import job creation response. * `jobId` (_string_) Unique identifier for the import job, prefixed with `import_` . _Available in: v67.0_ _Filter group: Small_ * `message` (_string_) Human-readable status message. _Available in: v67.0_ _Filter group: Small_ * `status` (_object_) TwbJobStatusEnum Status of the import job. _Available in: v67.0_ _Filter group: Small_ Includes all fields of `TwbJobStatusEnum`. ### TwbImportJobStatusOutput Translation Workbench import job status. * `createdAt` (_string_) Timestamp in ISO 8601 format (UTC) for when the job was created. _Available in: v67.0_ _Filter group: Small_ * `jobId` (_string_) Unique identifier for the import job, prefixed with `import_` . _Available in: v67.0_ _Filter group: Small_ * `message` (_string_) Human-readable status message. _Available in: v67.0_ _Filter group: Small_ * `reportLinks` (_array of TwbReportLinkOutput_) List of error or validation report links that are available when the job status is `Completed` or `Failed` . _Available in: v67.0_ _Filter group: Small_ * `status` (_object_) TwbJobStatusEnum Status of the import job. _Available in: v67.0_ _Filter group: Small_ Includes all fields of `TwbJobStatusEnum`. * `summary` (_object_) TwbImportSummaryOutput Import summary statistics that are available when the job status is `Completed` or `Failed` . _Available in: v67.0_ _Filter group: Small_ Includes all fields of `TwbImportSummaryOutput`. * `updatedAt` (_string_) Timestamp in ISO 8601 format (UTC) for when the job was last updated. _Available in: v67.0_ _Filter group: Small_ ### PardotBusinessUnitContextOutput Pardot business unit context. * `businessUnits` (_array of PardotBusinessUnitContextItem_) List of the Pardot business unit context items that the context user has access to. _Available in: v55.0_ _Filter group: Small_ * `isSuccess` (_boolean_) Indicates whether the requested resource was successfully provided. _Available in: v55.0_ _Filter group: Small_ * `totalBusinessUnits` (_integer_) Indicates the total number of Pardot business units that the context user has access to. _Available in: v55.0_ _Filter group: Small_ ### PrimingRecordCollection Collection of records for offline priming. * `primingRecords` (_object_) List of records that match the briefcase rules grouped by object type and by record type within an object. The top-level map key is object API name (Account or MyCustomObject\_\_c). The second-level map key is record type ID. _Available in: v54.0_ _Filter group: Small_ Additional properties: `PrimingRecord`. * `relayToken` (_string_) Returned only if processing was incomplete (results returned only for a subset of rules). _Available in: v54.0_ _Filter group: Small_ * `ruleErrors` (_array of PrimingRuleError_) List of rules with errors. _Available in: v54.0_ _Filter group: Small_ * `stats` (_object_) PrimingRecordsStats Summary of record counts for the priming request or relay. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `PrimingRecordsStats`. ### ListShareType Type of group a list view is shared with. Values are: * `ChannelProgramGroup` —Shared with a channel program. * `Regular` —Shared with a group. * `Role` —Shared with a role. * `RoleAndSubordinates` —Shared with a role and all subordinates types. * `RoleAndSubordinatesInternal` —Shared with a role and subordinates that aren’t partners. * `Territory` —Shared with a territory. * `TerritoryAndSubordinates` —Shared with a territory and its subordinates. _Available in: v44.0_ _Filter group: Small_ Type: `string`. Allowed values: `ChannelProgramGroup`, `Regular`, `Role`, `RoleAndSubordinates`, `RoleAndSubordinatesInternal`, `Territory`, `TerritoryAndSubordinates`. ### ListShareCollection Current and potential shares associated with a list. * `availableListShares` (_array of ListShareCategory_) Share categories that the list can be shared with. _Available in: v44.0_ _Filter group: Small_ * `currentListShares` (_array of ListShareCategory_) Share categories that the list is shared with. _Available in: v44.0_ _Filter group: Small_ ### ListCurrentShareCollection Current shares associated with a list. * `currentListShares` (_array of ListShareCategory_) List of share categories that the list is currently shared with. _Available in: v44.0_ _Filter group: Small_ ### ListCurrentShareCollectionInput Shares to associate with a list. * `currentListShares` (_array of string_, required) List of API names or 15-character IDs that identify the groups or roles with which to share the list. _Available in: v44.0_ ### FlowApprovalProcessCollection The results of requesting a flow approval status. * `flowApprovalProcesses` (_array of FlowApprovalProcess_) A list of flow approval process names. _Available in: v66.0_ _Filter group: Small_ * `relatedRecordId` (_string_) The ID of the related record associated with the approval submission. _Available in: v66.0_ _Filter group: Small_ ### FlowOrchestrationInstance Orchestration instance. * `flowDefinitionDeveloperName` (_string_, nullable) Developer name of the flow definition. _Available in: v54.0_ _Filter group: Small_ * `flowDefinitionId` (_string (Id)_, nullable) ID of the flow definition. _Available in: v54.0_ _Filter group: Small_ * `flowDefinitionName` (_string_, nullable) Name of the flow definition. _Available in: v54.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the orchestration instance. _Available in: v54.0_ _Filter group: Small_ * `interviewId` (_string (Id)_, nullable) ID of the interview to resume. _Available in: v54.0_ _Filter group: Small_ * `stageInstances` (_array of FlowOrchestrationStageInstance_) Orchestration stage instances. _Available in: v54.0_ _Filter group: Small_ * `status` (_object_) ConnectFlowOrchestrationStatusEnum Status of the orchestration instance. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectFlowOrchestrationStatusEnum`. ### FlowOrchestrationInstanceCollection Collection of orchestration instances. * `instances` (_array of FlowOrchestrationInstance_) Collection of orchestration instances. _Available in: v54.0_ _Filter group: Small_ ### ConnectPublishStatusEnum Specifies publish status Type: `string`. Allowed values: `Draft`, `Live`. ### NavigationMenuItemCollection Collection of navigation menu items. * `menuItems` (_array of NavigationMenuItem_) List of navigation menu items. _Available in: v47.0_ _Filter group: Small_ ### PushNotificationInput A push notification. * `appName` (_string_, required) The API name of the client app that the push notification is sent to. _Available in: v31.0_ * `namespace` (_string_) The namespace of the client app that the push notification is sent to. Required if the namespace is set _Available in: v31.0_ * `payload` (_string_, required) The push notification payload in JSON format. _Available in: v31.0_ * `userIds` (_array of string_, required) The push notification recipient user ids. _Available in: v31.0_ ### QuipRelatedRecords List of records related to a Quip document. * `quipContentDocumentLinks` (_array of QuipContentDocumentLink_) List of related content document links. _Available in: v49.0_ _Filter group: Small_ ### MessageTypeEnum Type of channel. Values are: * `Facebook` —A Facebook message. * `Line` —A LINE message. * `Text` —A text message. _Available in: v44.0_ _Filter group: Small_ Type: `string`. Allowed values: `Alexa`, `AppleBusinessChat`, `Facebook`, `GoogleChat`, `Line`, `MsCopilot`, `Text`, `WeChat`, `WhatsApp`. ### LiveMessageChannels List of messaging channels. * `channels` (_array of LiveMessageChannel_) Messaging channels. _Available in: v44.0_ _Filter group: Medium_ * `cursor` (_string_) Messaging page cursor. _Available in: v44.0_ _Filter group: Medium_ ### LiveMessageChannelInput Data required to create a Messaging channel. * `authDetails` (_object_) The AuthDetails for the channel. Additional properties: `string`. * `externalAccountId` (_string_) ID of an account of the external channel specified in `messageType`. _Available in: v57.0_ * `isoCountryCode` (_string_) The ISO country code * `messageType` (_object_, required) MessageTypeEnum Type of channel. Values are: * `Facebook` —A Facebook message. _Available in: v44.0_ Includes all fields of `MessageTypeEnum`. * `messagingChannelName` (_string_) The name of channel. * `messagingPlatformKey` (_string_, required) ID of the Messaging channel on the external service. This value can be found in the GET response. _Available in: v44.0_ * `platformType` (_PlatformTypeEnum_) * `smsProvider` (_string_) The SMS provider ### LiveMessageChannel Messaging channel. * `developerName` (_string_) Unique developer name of the channel. _Available in: v44.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the Messaging channel, if it is added to the org. _Available in: v44.0_ _Filter group: Small_ * `isActive` (_boolean_) Indicates whether the channel is currently active (`true`) or not (`false`). _Available in: v44.0_ _Filter group: Small_ * `masterLabel` (_string_) User friendly name of the channel. _Available in: v44.0_ _Filter group: Small_ * `messageType` (_object_) MessageTypeEnum Type of channel. Values are: * `Facebook` —A Facebook message. * `Line` —A LINE message. * `Text` —A text message. _Available in: v44.0_ _Filter group: Small_ Includes all fields of `MessageTypeEnum`. * `messagingPlatformKey` (_string_) ID of the Messaging channel on the external service (such as Facebook), if applicable. _Available in: v44.0_ _Filter group: Small_ ### ArticleRecommendationsChannelTypeEnum Specifies the type of article recommendations channel type Type: `string`. Allowed values: `Case`. ### ArticleRecommendationsRuntimeMetrics Article recommendations runtime metrics. * `articleRecommendationsRuntimeMetrics` (_array of ArticleRecommendationsRuntimeMetric_) Collection of article recommendations metrics. _Available in: v52.0_ _Filter group: Small_ ### ReplyRecommendationsChannelTypeEnum Supported Reply Recommendations channel type to retrieve runtime metrics Type: `string`. Allowed values: `Chat`. ### ReplyRecommendationsMetrics Reply recommendations metrics. * `replyRecommendationsMetrics` (_array of ReplyRecommendationsMetric_) Collection of reply recommendations metrics. _Available in: v52.0_ _Filter group: Small_ ### RootEmailAddressResetAcceptInput Input representation for Root Email Address Reset Accept * `emailAddress` (_string_, required) New email address for the AWS account root user. _Available in: v64.0_ * `otp` (_string_, required) Six-digit one-time password sent to the new email address of the AWS account root user. _Available in: v64.0_ ### RootEmailAddressResetAPIResponse AWS root user email address update. * `message` (_string_) If the request was to start the email address update process, this message contains instructions on how to accept and complete the email address change. If the request was to accept the email address change, this message along with the `status` code confirms whether the email address change was successful. _Available in: v64.0_ _Filter group: Small_ * `status` (_string_) API status code indicating whether the request succeeded or failed. _Available in: v64.0_ _Filter group: Small_ ### RootEmailAddressResetStartInput Input representation for Root Email Address Reset Start * `emailAddress` (_string_, required) New email address for the AWS account root user. _Available in: v64.0_ ### ActivitySharingInput The sharing information (i.e. sharing type, and groups to share with). * `groupsToShareWith` (_array of string_) List of IDs for the groups that you share the activity with. Valid only if `sharingType` is `MyGroups`. _Available in: v39.0_ * `sharingType` (_object_, required) ActivitySharingTypeEnum Type of sharing operation. * `Everyone` —The activity is shared with everyone. * `MyGroups` —The activity is shared only with a selection of the context user’s groups. * `OnlyMe` —The activity is private. _Available in: v39.0_ Includes all fields of `ActivitySharingTypeEnum`. ### ActivitySharingResult Represents the results of sharing a captured email or event. * `success` (_boolean_) Whether the share operation succeeded or not. _Available in: v39.0_ _Filter group: Small_ ### ConversationEntryQueryDirection Query Direction. Type: `string`. Allowed values: `FromEnd`, `FromStart`. ### ConversationEntries List of entries in the conversation. * `conversationEntries` (_array of ConversationEntry_) List of conversation entries. _Available in: v51.0_ _Filter group: Small_ ### ConversationEntriesUpdateInput List of conversation entry updates. * `conversationEntriesUpdates` (_array of ConversationEntryUpdateInput_, required) List of conversation entry updates. _Available in: v51.0_ ### ConversationEntriesUpdate List of conversation entry update results. * `conversationEntriesUpdateResults` (_array of ConversationEntryUpdate_) List of conversation entry update results. _Available in: v51.0_ _Filter group: Small_ ### ConversationBulkUploadStatuses Collection of statuses for the bulk upload of conversations. * `conversationBulkUploadStatuses` (_array of ConversationBulkUploadStatus_) List of statuses for the bulk upload of conversations. _Available in: v51.0_ _Filter group: Small_ ### ConversationBulkUploads List of conversation bulk upload results. * `conversationBulkUploadsResults` (_array of ConversationBulkUpload_) List of conversation bulk upload results. _Available in: v51.0_ _Filter group: Small_ ### EstimatedWaitTimeInput Input representation of the request for the estimated wait time of a waitlist or waitlist participant. * `waitlistId` (_string_) ID of the waitlist. Required if the `waitlistParticipantId` parameter isn't specified. _Available in: v65.0_ * `waitlistParticipantId` (_string_) ID of the waitlist participant. Required if the `waitlistId` parameter isn't specified. _Available in: v65.0_ ### EstimatedWaitTimeOutput Output representation of the estimated wait time for a waitlist or waitlist participant. * `waitlistId` (_string_) ID of the waitlist. _Available in: v65.0_ _Filter group: Small_ * `waitlistParticipantEstimatedWaitTime` (_string_) Estimated wait time for the waitlist participant. Empty when the request specifies only `waitlistId` . _Available in: v65.0_ _Filter group: Small_ * `waitlistParticipantId` (_string_) ID of the waitlist participant. Empty when the request specifies only `waitlistId` . _Available in: v65.0_ _Filter group: Small_ * `workTypeGroups` (_array of WorkTypeGroupEstWaitTimeInfo_) Estimated wait times for the work type groups associated with the waitlist. _Available in: v65.0_ _Filter group: Small_ ### CancelAppointmentCollectionInput Input representation for canceling one or more service appointments. * `appointments` (_array of CancelAppointmentInput_, required) List of service appointments to cancel. _Available in: v66.0_ ### CancelAppointmentCollectionOutput Output representation for the cancel operation. * `result` (_array of CancelAppointmentOutput_) Result of each canceled appointment, in the same order as the request. _Available in: v66.0_ _Filter group: Big_ ### GetAppointmentCandidatesSlotsInput Input representation for requesting available appointment time slots or candidate resources. * `appointments` (_array of AppointmentRequestInput_, required) List of appointment requests to retrieve slots or candidates for. _Available in: v66.0_ ### GetAppointmentCandidatesOutput Output representation for the get-appointment-candidates operation. * `result` (_array of AppointmentCandidatesResult_) Candidate appointment time slots with assigned resources for each input request. _Available in: v66.0_ _Filter group: Big_ ### GetAppointmentSlotsOutput Output representation for the get-appointment-slots operation. * `result` (_array of AppointmentSlotsResult_) Available appointment time slots for each input request. _Available in: v66.0_ _Filter group: Big_ ### RescheduleAppointmentCollectionInput Input representation for rescheduling one or more service appointments. * `rescheduleAppointments` (_array of RescheduleAppointmentInput_, required) List of service appointments to reschedule. _Available in: v66.0_ ### AppointmentCollectionOutput Output representation for the schedule and reschedule operations. * `appointments` (_array of AppointmentOutput_) Result of each scheduled or rescheduled appointment, in the same order as the request. _Available in: v66.0_ _Filter group: Big_ * `resourceAbsences` (_array of ResourceAbsenceOutput_) Resource absences (including lunch breaks) created or updated as side-effects of scheduling. ### ScheduleAppointmentCollectionInput Input representation for scheduling one or more service appointments. * `appointments` (_array of ScheduleAppointmentInput_, required) List of service appointments to schedule. _Available in: v66.0_ ### PrivacyPolicyRunRequestOutput Result of a run request for a Privacy Policy. * `errorMessage` (_string_) The error message for the run request if it was unsuccessful. * `jobId` (_string_) The resulting Id of the policy job if the run request was successful. * `success` (_boolean_) Whether the run request was successful or not. ### ConsentStatusInput Input representation for querying consent status * `fields` (_array of string_) List of specific database column names to query and return in the response * `isReturnAllFields` (_boolean_) Flag to return all available fields instead of default 5 fields * `keys` (_array of ConsentStatusKey_, required) List of consent status entries to query * `tenantId` (_string_, required) The tenant identifier ### ConsentStatusOutput Output representation containing consent status for multiple data subjects * `consents` (_array of ConsentStatusEntry_) List of consent status entries * `error` (_string_) Error information if the read operation failed * `success` (_boolean_) Indicates if the write operation was successful ### ConsentStatusWriteInput Input representation for writing consent status * `consents` (_array of ConsentStatusWriteEntry_, required) List of consent status entries to write * `tenantId` (_string_, required) The tenant identifier ### ConsentStatusWriteOutput Output representation for write operation response * `error` (_string_) Error information if the write operation failed * `reference` (_array of ConsentStatusWriteReference_) List of reference entries for written consents * `success` (_boolean_) Indicates if the write operation was successful ### ConsentExportJobStartInput Input for starting a Global Consent Store export job. The export destination (Named Credential, S3 bucket, prefix) is read server-side from the org's saved export configuration; it is never accepted from the request. clientRequestId makes the start idempotent — a repeated request with the same value returns the existing job instead of starting a new one. * `clientRequestId` (_string_) Caller-supplied idempotency key. A repeated start with the same clientRequestId returns the already-created job rather than starting a duplicate. Optional but recommended. * `destination` (_string_) Export destination kind. Currently "S3". * `format` (_string_) Output file format. Currently "CSV". * `mode` (_string_) Export mode, e.g. "DAY\_0" for the initial bulk load. * `namedCredential` (_string_) Developer name of the Named Credential to deliver the export with. When omitted, the org's saved default export configuration is used. * `scope` (_ConsentExportJobScope_) ### ConsentExportJobOutput A Global Consent Store export job. Returned by the start, read, and update resources. The coarse status is mapped from the platform GridforceJobState; gridforceState and gridforceJobId are exposed for diagnostics. * `completedDate` (_string (date-time)_) When the job reached a terminal state. Null until terminal. * `error` (_string_) Error information if the operation failed (truncated to 240 chars). * `gridforceJobId` (_string_) The underlying Gridforce job id, for cross-system diagnostics. Null until assigned. * `gridforceState` (_string_) Raw platform GridforceJobState for diagnostics (e.g. NOT\_STARTED, RUN\_HADOOP\_JOB, COPY\_DATA\_TO\_HDFS, COMPLETED\_SUCCESS, COMPLETED\_FAILURE, COMPLETED\_KILLED). * `jobId` (_string_) The Salesforce id of the export job. * `startedDate` (_string (date-time)_) When the job started. Null until it begins running. * `status` (_string_) Coarse export job status, derived from the raw platform GridforceJobState (and a pending cancel request). One of: NOT\_STARTED, QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELING, CANCELED. CANCELING is the two-phase-cancel intermediate (cancel requested; the cron has not yet aborted the job); it resolves to CANCELED once the job reaches COMPLETED\_KILLED. * `success` (_boolean_) Indicates whether the operation succeeded. ### DecodeTokenInput Input for decoding a Preference Center token * `token` (_string_, required) The encrypted Preference Center token to decode ### DecodeTokenOutput Result of decoding a Preference Center token * `dataCloudTokenIdType` (_string_) The Data Cloud token ID type (only present for DATACLOUDID tokens) * `errorMessage` (_string_) The reason the token could not be decoded (present on failure) * `success` (_boolean_) Whether the token was decoded successfully * `tokenType` (_string_) The type of token (present on success) * `tokenValue` (_string_) The original record ID, email, or contact point that was tokenized (present on success) ### RtbfRunRequestInput Input for executing a Right to Be Forgotten request * `rtbfRequestId` (_string_, required) The ID of the Right to Be Forgotten request to execute ### RtbfRunRequestOutput Result of executing a Right to Be Forgotten request * `errorMessage` (_string_) Error message if the request failed * `jobId` (_string_) The ID of the job created to process the request * `requestType` (_string_) The type of RTBF request that was executed * `success` (_boolean_) Whether the request was executed successfully ### MicrobatchingIngestionInput Microbatching ingestion input. * `contentDocumentIds` (_array of string_) List of content document IDs to create content document links between files and records. _Available in: v56.0_ * `groupBy` (_string_) Grouping of records for batch creation. The default behavior groups records by network ID. For example, if you specify account ID, records are grouped by network ID and account ID. You can specify one value, and there isn’t validation of the property. _Available in: v55.0_ * `keyPrefix` (_string_) Object keyPrefix that a specified `processType` is tied to in the microbatching framework. Required for `GENERIC` process type, otherwise optional _Available in: v55.0_ * `processType` (_string_, required) Logical name of the flow in the microbatching framework, for example, `LEAD_MS` or `GENERIC`. _Available in: v55.0_ * `requestBody` (_object_, required) Map of input fields in name value pairs. _Available in: v55.0_ Additional properties: `object`. ### MicrobatchingIngestionOutput Microbatching ingestion response. * `recordUUID` (_string_) Universally unique identifier of the ingested record. _Available in: v55.0_ _Filter group: Small_ ### ConnectMicrobatchingErrorCategoryEnum Error Category enum for connect Type: `string`. Allowed values: `AdminActionable`, `AutoRetry`, `InvalidSetup`, `NonRetryable`, `Unknown`, `UserActionable`. ### ConnectMicrobatchingErrorsSortOrderEnum Errors Sort Order enum for connect Type: `string`. Allowed values: `CreatedDateAsc`, `CreatedDateDesc`. ### MicrobatchingErrorRecordInfoCollection Collection of microbatching error records. * `count` (_integer_) Total count of records returned on current page. _Available in: v54.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token for the current page of records. _Available in: v54.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL of the current page of records. _Available in: v54.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token for the next page of records. _Available in: v54.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL of the next page of records. _Available in: v54.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token for the previous page of records. _Available in: v54.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL of the previous page of records. _Available in: v54.0_ _Filter group: Small_ * `records` (_array of MicrobatchingErrorRecordInfo_) List of microbatching error records. _Available in: v54.0_ _Filter group: Small_ ### MicrobatchingErrorResubmission Microbatching error resubmission. * `nextPageToken` (_string_) Token for the next page of records to submit. _Available in: v54.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of records to submit. _Available in: v54.0_ _Filter group: Small_ * `numberOfRecordsSubmitted` (_integer_) Total number of records submitted for reprocessing. _Available in: v54.0_ _Filter group: Small_ ### 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_ ### 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_ ### ActionLinkDefinitionInput The definition of an action link. An action link is a button on a feed element. Clicking an action link can take a user to a Web page, initiate a file download, or invoke an API call to Salesforce or to an external server. An action link includes a URL and an HTTP method, and can include a request body and header information, such as an OAuth token for authentication. Use action links to integrate Salesforce and third-party services into the feed so that users can drive productivity and accelerate innovation. * `actionType` (_object_, required) ConnectActionLinkTypeEnum Defines the type of action link. 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. Use `Ui` if you need to load a page before the user performs an action, for example, to have the user provide input or view something before the action happens. Can be defined in an action link template. _Available in: v33.0_ Includes all fields of `ConnectActionLinkTypeEnum`. * `actionUrl` (_string_, required) The action link URL. For example, a `Ui` action link URL is a Web page. A `Download` action link URL is a link to the file to download. `Ui` and `Download` action link URLs are provided to clients. An `Api` or `ApiAsync` action link URL is a REST resource. `Api` and `ApiAsync` action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with `https://`. To avoid issues due to upgrades or changing functionality in your API, we recommend using a versioned API for `actionUrl`, for example, `https://www.example.com/api/v1/exampleResource`. If your API isn’t versioned, you can use the `expirationDate` property of the Action Link Group Definition Input to avoid issues due to upgrades or changing functionality in your API. Can be defined in an action link template. _Available in: v33.0_ * `excludedUserId` (_string_) ID of a single user to exclude from performing the action. If you specify an `excludedUserId`, you can’t specify a `userId`. Can be defined in an action link template using the User Visibility and Custom User Alias fields. _Available in: v33.0_ * `groupDefault` (_boolean_) `true` if this action is the default action link in the action link group; `false` otherwise. There can be only one default action link per action link group. The default action link gets distinct styling in the Salesforce UI. Can be defined in an action link template. _Available in: v33.0_ * `headers` (_array of RequestHeaderInput_) The request headers for the `Api` and `ApiAsync` action link types. See [Action Links Overview, Authentication, and Security](/docs/platform/connect-rest-api/guide/features_action_links_overview#authentication). Can be defined in an action link template. _Available in: v33.0_ * `labelKey` (_string_, required) Key for the set of labels to show in the user interface. A set includes labels for these states: NewStatus, PendingStatus, SuccessStatus, FailedStatus. For example, if you use the `Approve` key, you get these labels: Approve, Pending, Approved, Failed. For a complete list of keys and labels, see [Action Links Labels](/docs/platform/connect-rest-api/guide/connect_appendices_action_links_labels). If none of the predefined labels work for your action link, use a custom label. To use a custom label, create an action link template. See [Create Action Link Templates](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/action_link_group_template_create.htm). Can be defined in an action link template. _Available in: v33.0_ * `method` (_object_, required) ConnectHttpRequestMethod One of these HTTP methods: * `HttpDelete` —Returns HTTP 204 on success. Response body or output class is empty. * `HttpGet` —Returns HTTP 200 on success. * `HttpHead` —Returns HTTP 200 on success. Response body or output class is empty. * `HttpPatch` —Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty. * `HttpPost` —Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success. * `HttpPut` —Return HTTP 200 on success or HTTP 204 if the response body or output class is empty. Can be defined in an action link template. _Available in: v33.0_ Includes all fields of `ConnectHttpRequestMethod`. * `requestBody` (_string_) The request body for `Api` and `ApiAsync` action link types. Escape quotation mark characters in the `requestBody` value. Can be defined in an action link template. _Available in: v33.0_ * `requiresConfirmation` (_boolean_, required) `true` to require the user to confirm the action; `false` otherwise. Can be defined in an action link template. _Available in: v33.0_ * `userId` (_string_) The ID of the user who can execute the action. If not specified or `null`, any user can execute the action. If you specify a `userId`, you can’t specify an `excludedUserId`. Can be defined in an action link template using the User Visibility and Custom User Alias fields. _Available in: v33.0_ ### ConnectPlatformActionGroupCategoryEnum Indicates the priority and relative locations of action links in an associated feed item. 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. You can create up to three action links in a `Primary` group and up to four in an `Overflow` group. Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value. _Available in: v33.0_ Type: `string`. Allowed values: `Overflow`, `Primary`. ### ConnectActionLinkExecutionsAllowedEnum Defines the number of times an action link can be executed. Values are: * `Once` —An action link can be executed only one time across all users. * `OncePerUser` —An action link can be executed only one time for each user. * `Unlimited` —An action link can be executed an unlimited number of times by each user. If the action link’s `actionType` is `Api` or `ApiAsync`, you can’t use this value. Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value. _Available in: v33.0_ Type: `string`. Allowed values: `Once`, `OncePerUser`, `Unlimited`. ### ActionLinkTemplateBindingInput A key-value pair to fill in a binding variable value from an action link template. * `key` (_string_, required) The name of the binding variable key specified in the action link template in Setup. For example, if the binding variable in the template is `{!Binding.firstName}`, the key is `firstName` _Available in: v33.0_ * `value` (_string_, required) The value of the binding variable key. For example, if the key is `firstName`, this value could be `Joan`. _Available in: v33.0_ ### ActionLinkDefinition The definition of an action link. To read this information, a request must use the same client app that was used to create the action link definition. * `actionUrl` (_string (url)_) The action link URL. For example, a `Ui` action link URL is a Web page. A `Download` action link URL is a link to the file to download. `Ui` and `Download` action link URLs are provided to clients. An `Api` or `ApiAsync` action link URL is a REST resource. `Api` and `ApiAsync` action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with `https://`. _Available in: v33.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. . _Available in: v33.0_ _Filter group: Small_ * `excludedUserId` (_string (Id)_) ID of a single user to exclude from performing the action. If you specify an `excludedUserId`, you can’t specify a `userId`. _Available in: v33.0_ _Filter group: Small_ * `groupDefault` (_boolean_) `true` if this action is the default action link in the action link group; `false` otherwise. There can be only one default action link per action link group. The default action link gets distinct styling in the Salesforce UI. _Available in: v33.0_ _Filter group: Small_ * `headers` (_array of RequestHeader_) The request headers for the `Api` and `ApiAsync` action link types. _Available in: v33.0_ _Filter group: Big_ * `id` (_string (Id)_) 18-character ID for the action link definition. _Available in: v33.0_ _Filter group: Small_ * `label` (_string_) A custom label to display on the action link button. A `label` value can be set only in an action link template. Action links have four statuses: NewStatus, PendingStatus, SuccessStatus, and FailedStatus. These strings are appended to the label for each status: * label * label Pending * label Success * label Failed For example, if the value of `label` is “See Example,” the values of the four action link states are: See Example, See Example Pending, See Example Success, and See Example Failed. An action link can use either `label` or `labelKey` to generate label names, it can’t use both. If `label` has a value, the value of `labelKey` is `None`. If `labelKey` has a value other than `None`, the value of `label` is `null`. _Available in: v34.0_ _Filter group: Small_ * `labelKey` (_string_) Key for the set of labels to show in the user interface. A set includes labels for these states: NewStatus, PendingStatus, SuccessStatus, FailedStatus. For example, if you use the `Approve` key, you get these labels: Approve, Pending, Approved, Failed. See [Action Links Labels](/docs/platform/connect-rest-api/guide/connect_appendices_action_links_labels). _Available in: v33.0_ _Filter group: Small_ * `method` (_object_) ConnectHttpRequestMethod The HTTP method. One of these values: * `HttpDelete` —Returns HTTP 204 on success. Response body or output class is empty. * `HttpGet` —Returns HTTP 200 on success. * `HttpHead` —Returns HTTP 200 on success. Response body or output class is empty. * `HttpPatch` —Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty. * `HttpPost` —Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success. * `HttpPut` —Return HTTP 200 on success or HTTP 204 if the response body or output class is empty. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `ConnectHttpRequestMethod`. * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v33.0_ _Filter group: Small_ * `requestBody` (_string_) The request body for `Api` and `ApiAsync` action link types. _Available in: v33.0_ _Filter group: Big_ * `requiresConfirmation` (_boolean_) `true` to require the user to confirm the action; `false` otherwise. _Available in: v33.0_ _Filter group: Small_ * `templateId` (_string (Id)_) The ID of the action link template from which to instantiate this action link. If the action link isn’t associated with a template, the value is `null`. _Available in: v33.0_ _Filter group: Medium_ * `type` (_object_) ConnectActionLinkTypeEnum Defines the type of action link. 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_ Includes all fields of `ConnectActionLinkTypeEnum`. * `userId` (_string (Id)_) The ID of the user who can execute the action. If not specified or `null`, any user can execute the action. If you specify a `userId`, you can’t specify an `excludedUserId`. _Available in: v33.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 (Id)_) 18-character ID of the record. _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_) Reference 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 `Reference`. * `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 (url)_) Relative URL to this record. _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 (Id)_) 18-character ID of the record. _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_) Reference 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 `Reference`. * `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 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`. * `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_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _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 `ConnectUserTypeEnum`. ### Reference 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_ ### 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`. ### NotificationType Notification type information. * `actionGroups` (_array of NotificationActionGroup_) Action groups supported by the notification type. _Available in: v66.0_ _Filter group: Small_ * `apiName` (_string_) Custom notification API name (prefixed by the namespace if it’s installed with a managed package) or standard notification type API name. _Available in: v66.0_ _Filter group: Small_ * `label` (_string_) Notification type label. _Available in: v66.0_ _Filter group: Small_ * `type` (_string_) Type of notification. For custom notifications, this is the custom notification type ID. _Available in: v66.0_ _Filter group: Small_ ### NotificationActionGroup Notification action group information. * `actions` (_array of NotificationAction_) List of notification actions in an action group. _Available in: v66.0_ _Filter group: Small_ * `name` (_string_) Notification action group name. _Available in: v66.0_ _Filter group: Small_ ### ExperienceModelPropertyTypeSummary Property type summary. * `description` (_string_) Description of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ * `detailUrl` (_string (url)_) Individual detail resource URL to the type. _Available in: v58.0_ _Filter group: Small_ * `developerName` (_string_) Developer name, or apiName, of the type. _Available in: v58.0_ _Filter group: Medium_ * `id` (_string (Id)_) ID of the type, returned only for the database-based (custom) types. _Available in: v58.0_ _Filter group: Medium_ * `namespacePrefix` (_string_) Namespace prefix that is associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fullyQualifiedName. _Available in: v58.0_ _Filter group: Medium_ * `title` (_string_) Title of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ ### NetworkDataCategoryGroup Network data category group. * `categoryGroupName` (_string_) Name of the category network group. _Available in: v59.0_ _Filter group: Small_ * `rootCategory` (_object_) NetworkDataCategory Root category. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `NetworkDataCategory`. ### DataCategoryGroupInput Data category group. * `categoryGroupName` (_string_, required) Developer name of the data category group. _Available in: v59.0_ * `rootCategory` (_object_, required) DataCategoryInput Root category of the data category group. _Available in: v59.0_ Includes all fields of `DataCategoryInputKnowledge`. ### ServiceCatalogItem Service catalog item. * `description` (_string_) Short description of the service catalog item. _Available in: v59.0_ _Filter group: Small_ * `developerName` (_string_) Developer name of the service catalog item. _Available in: v59.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the service catalog item. _Available in: v59.0_ _Filter group: Small_ * `imageId` (_string (Id)_) Image id of Service Catalog Item * `label` (_string_) Label of the service catalog item. _Available in: v59.0_ _Filter group: Small_ * `imageID` (_string_) Image ID of the service catalog item. _Available in: v59.0_ _Filter group: Small_ ### LightningKnowledgeArticleVersion Knowledge article in Lightning. * `id` (_string (Id)_) ID of the knowledge article version. _Available in: v59.0_ _Filter group: Small_ * `knowledgeArticleId` (_string (Id)_) ID of the corresponding knowledge article. _Available in: v59.0_ _Filter group: Small_ * `lastPublishedDate` (_string (date-time)_) Last published date of the article. _Available in: v59.0_ _Filter group: Small_ * `summary` (_string_) Summary of the article contents. _Available in: v59.0_ _Filter group: Medium_ * `title` (_string_) Title of the article. _Available in: v59.0_ _Filter group: Small_ * `urlName` (_string_) URL name of the article. _Available in: v59.0_ _Filter group: Small_ ### DataCategoryGroup Data category group. * `categoryGroupName` (_string_) Developer name of the data category group. _Available in: v59.0_ _Filter group: Small_ * `description` (_string_) Description of the data category group. _Available in: v59.0_ _Filter group: Small_ * `label` (_string_) Label of the data category group. _Available in: v59.0_ _Filter group: Small_ * `rootCategory` (_object_) DataCategory Root category of the data category group. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `DataCategoryKnowledge`. ### KnowledgeArticleVersion A knowledge article version. * `articleType` (_string_) Type of the knowledge article. _Available in: v36.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the knowledge article version. _Available in: v36.0_ _Filter group: Small_ * `knowledgeArticleId` (_string (Id)_) ID of the corresponding knowledge article. _Available in: v36.0_ _Filter group: Small_ * `lastPublishedDate` (_string (date-time)_) Last published date of the knowledge article. Format is ISO 8601. _Available in: v36.0_ _Filter group: Small_ * `summary` (_string_) Summary of the knowledge article contents. _Available in: v36.0_ _Filter group: Medium_ * `title` (_string_) Title of the knowledge article. _Available in: v36.0_ _Filter group: Small_ * `urlName` (_string_) URL name of the knowledge article. _Available in: v36.0_ _Filter group: Small_ ### ManagedTopicPositionInput The relative position of a managed topic. * `managedTopicId` (_string_, required) ID of existing managed topic. _Available in: v32.0_ * `position` (_integer_, required) Relative position of the managed topic, indicated by zero-indexed, ascending whole numbers. _Available in: v32.0_ ### TopicImages Images associated with a topic. * `coverImageUrl` (_string_) 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 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_ ### ConnectArticleTopicJobTypeEnum Type of operation to perform on articles and topics. Values are: * `AssignTopicsToArticle` —Assign topics to articles in a data category. * `UnassignTopicsFromArticle` —Unassign topics from articles in a data category. _Available in: v40.0_ Type: `string`. Allowed values: `AssignTopicsToArticles`, `UnassignTopicsFromArticles`. ### TopicSuggestion Topic suggestion. * `existingTopic` (_object_) Topic Topic that already exists or `null` for a new topic _Available in: v28.0_ _Filter group: Small_ Includes all fields of `TopicSbi`. * `name` (_string_) Name of the topic _Available in: v28.0_ _Filter group: Small_ ### FileSummarySbi Summary description of a file. * `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 `FilesConnectRepositorySbi`. * `contentModifiedDate` (_string (date-time)_) 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)_) ID of the content version. _Available in: v62.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) 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)_) URL to the file. _Available in: v26.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: 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 `ExternalFilePermissionInformationSbi`. * `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 (Id)_) 18-character ID of the record. _Available in: v23.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 `ModerationFlagsSbi`. * `modifiedDate` (_string (date-time)_) 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 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_) Reference 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 `Reference`. * `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_) Reference Reference to the parent folder. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `Reference`. * `pdfRenditionStatus` (_string_) Specifies if a PDF preview version of the file has been rendered. _Available in: v24.0_ _Filter group: Big_ * `publishStatus` (_object_) ConnectFilePublishStatusEnum Publish status of the file. One of these values: * `PendingAccess` —File is pending publishing. * `PrivateAccess` —File is private. * `PublicAccess` —File is public. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectFilePublishStatusEnum`. * `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: v26.0_ _Filter group: Medium_ * `renditionUrl240By180` (_string (url)_) 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)_) 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)_) 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` (_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`. * `sharingPrivacy` (_object_) ConnectFileSharingPrivacyEnum Sharing privacy of a file. Values are: * `None` —File is visible to anyone with record access. * `PrivateOnRecords` —File is private on records. _Available in: v41.0_ _Filter group: Medium_ Includes all fields of `ConnectFileSharingPrivacyEnum`. * `sharingRole` (_object_) 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_ Includes all fields of `ConnectFileSharingRoleEnum`. * `systemModstamp` (_string (date-time)_) 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_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ * `versionNumber` (_string_) Version number of the file. _Available in: v24.0_ _Filter group: Medium_ ### OauthStagedCredentialStateEnum Current state of the OAuth consumer's staged credentials. _Available in: v65.0_ _Filter group: Small_ Type: `string`. Allowed values: `Active`, `Expired`, `Rotated`. ### OauthStagedCredentialsCommandEnum Staged credentials command. The only available command is `rotate` . _Available in: v65.0_ Type: `string`. Allowed values: `Rotate`. ### AppOauthUsage OAuth usage information for an external client app. * `accessTokenFormat` (_string_) OAuth token format that the app issues, for example JWT or Opaque. _Available in: v59.0_ _Filter group: Small_ * `availableActions` (_string_) Available actions for this app. _Available in: v59.0_ _Filter group: Small_ * `description` (_string_) External client app description. _Available in: v59.0_ _Filter group: Small_ * `developerName` (_string_) External client app developer name. _Available in: v59.0_ _Filter group: Small_ * `identifier` (_string_) External client app identifier. _Available in: v59.0_ _Filter group: Small_ * `isFromPackage` (_boolean_) Indicates whether the app was installed from a package ( `true` ) or not ( `false` ). _Available in: v59.0_ _Filter group: Small_ * `usageDetailsUrl` (_string (url)_) URL to the usage details for the external client app. _Available in: v59.0_ _Filter group: Small_ ### AppOauthUsageUser OAuth user. * `accessTokenFormat` (_string_) OAuth token format that the app issues (for example, JWT or Opaque) _Available in: v59.0_ _Filter group: Small_ * `appDeveloperName` (_string_) App developer name. _Available in: v59.0_ _Filter group: Small_ * `appIdentifier` (_string_) App identifier. _Available in: v59.0_ _Filter group: Small_ * `initialConnectionAt` (_string_) Date and time of the refresh token row creation. _Available in: v59.0_ _Filter group: Small_ * `lastUsedAt` (_string_) Date and time of the last token issuance. _Available in: v59.0_ _Filter group: Small_ * `revocationUrl` (_string (url)_) URL for the GET request to the OAuth Usage API for the app. _Available in: v59.0_ _Filter group: Small_ * `useCount` (_integer_) Number of access tokens issued by this refresh token. _Available in: v59.0_ _Filter group: Small_ * `userIdentifier` (_string_) Token owner's user identifier. _Available in: v59.0_ _Filter group: Small_ * `username` (_string_) Token owner's username. _Available in: v59.0_ _Filter group: Small_ ### AppOauthUsageToken Refresh token. * `accessTokenFormat` (_string_) OAuth token format that the app issues (JWT or Opaque) _Available in: v59.0_ _Filter group: Small_ * `appDeveloperName` (_string_) App developer name. _Available in: v59.0_ _Filter group: Small_ * `appIdentifier` (_string_) App identifier. _Available in: v59.0_ _Filter group: Small_ * `initialConnectionAt` (_string_) Date and time of the refresh token row creation. _Available in: v59.0_ _Filter group: Small_ * `lastUsedAt` (_string_) Date and time of the last token issuance. _Available in: v59.0_ _Filter group: Small_ * `revocationUrl` (_string (url)_) URL for the GET request to the OAuth Usage API for the app. This URL includes the token identifier and can be used to revoke a token. _Available in: v59.0_ _Filter group: Small_ * `useCount` (_integer_) Number of access tokens issued by this refresh token. _Available in: v59.0_ _Filter group: Small_ * `userIdentifier` (_string_) Token owner's user identifier. _Available in: v59.0_ _Filter group: Small_ * `username` (_string_) Token owner's username. _Available in: v59.0_ _Filter group: Small_ ### MyDomainValidationStatus A validation error for a proposed domain. One of these values: * `Duplicate` —The proposed domain is already in use. * `Invalid` —The proposed domain is not a valid CNAME. * `Valid` —The proposed domain is valid. _Available in: v36.0_ _Filter group: Small_ Type: `string`. Allowed values: `Duplicate`, `Invalid`, `Valid`. ### CredentialAuthenticationProtocol Authentication protocol of the external credential. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `AwsSv4`, `Basic`, `Custom`, `Jwt`, `OAuth`. ### CredentialAuthenticationProtocolVariant Authentication protocol variant of the external credential. Values are: * `AwsSv4_STS` —AWS Signature Version 4 with Security Token Service. * `ClientCredentialsClientSecret` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body. * `ClientCredentialsClientSecretBasic` —OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication. * `ClientCredentialsJwtAssertion` —OAuth 2.0 Client Credentials JSON Web Token assertion. * `JwtBearer` —OAuth 2.0 JSON Web Token bearer flow. * `NoAuthentication` —No authentication. * `RolesAnywhere` —AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere. If specified, the authentication protocol variant must match the actual protocol variant of the external credential. _Available in: v57.0_ Type: `string`. Allowed values: `AwsSv4_STS`, `ClientCredentialsClientSecret`, `ClientCredentialsClientSecretBasic`, `ClientCredentialsJwtAssertion`, `JwtBearer`, `NoAuthentication`, `RolesAnywhere`. ### CredentialAuthenticationStatus Status of the credential authentication. Values are: * `Configured` —Credential has all required credentials for at least one principal. * `NotConfigured` —Credential isn’t configured. * `Unknown` —Credential status can’t be determined because the authentication protocol is custom. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Configured`, `NotConfigured`, `Unknown`. ### CredentialValue Credential value. * `encrypted` (_boolean_) Specifies whether the credential value is encrypted (`true`) or not (`false`). _Available in: v56.0_ _Filter group: Small_ * `revision` (_integer_, nullable) Revision number of a short-lived credential. _Available in: v58.0_ _Filter group: Big_ * `value` (_string_, nullable) Value of the credential. _Available in: v56.0_ _Filter group: Small_ ### CredentialValueInput Credential value input. Authentication protocols have credential allowlists and encryption rules. * `AwsSv4` — `awsAccessKeyId` (not encrypted), `awsSecretAccessKey` (encrypted), `awsRoleArn` (not encrypted) * `Custom` —Any credential name is valid (user sets encryption rules) * `encrypted` (_boolean_, required) Specifies whether the value of the credential is encrypted (`true`) or not (`false`). _Available in: v56.0_ * `revision` (_integer_) Revision number of a short-lived credential, such as OAuthToken. If the provided revision isn’t the latest version, the authentication endpoint refreshes the credential. _Available in: v58.0_ * `value` (_string_, required) Value of the credential. _Available in: v56.0_ ### ExternalAuthIdentityProviderCredential External auth identity provider credential. * `credentialName` (_string_) Name of the external auth identity provider credential. _Available in: v62.0_ _Filter group: Small_ * `credentialValue` (_string_) Value of the external auth identity provider credential. _Available in: v62.0_ _Filter group: Small_ * `encrypted` (_boolean_) Indicates whether the external auth identity provider credential is encrypted ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ ### ExternalAuthIdentityProviderCredentialInput External auth identity provider credential input. * `credentialName` (_string_, required) Name of the external auth identity provider credential. _Available in: v62.0_ * `credentialValue` (_string_, required) Value of the external auth identity provider credential. _Available in: v62.0_ ### IdentityProviderAuthFlow Authentication flow to get tokens to call protected APIs. _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `AuthorizationCode`, `ClientCredentials`, `SalesforceDefined`. ### IdentityProviderAuthProtocol Authentication protocol required to access the external system. _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `OAuth`, `SalesforceDefined`. ### IdentityProviderClientAuth Client authentication method that describes how credentials are sent to the authorization server. Defaults to `ClientSecretBasic`. _Available in: v63.0_ Type: `string`. Allowed values: `ClientSecretBasic`, `ClientSecretPost`, `Custom`. ### ExternalAuthIdentityProviderParameterInput External auth identity provider parameter input. * `parameterName` (_string_, required) The name of the external auth identity provider parameter. _Available in: v63.0_ * `parameterType` (_object_, required) ExternalAuthIdentityProviderParamType Parameter type for an external auth identity provider. _Available in: v63.0_ Includes all fields of `ExternalAuthIdentityProviderParamType`. * `parameterValue` (_string_) If `parameterType` describes a literal value then the literal value is stored in this property. _Available in: v63.0_ * `sequenceNumber` (_integer_) Specifies the order of parameters to apply when an external auth identity provider has more than one parameter. Priority is from lower to higher numbers, for example, `1` is the highest priority. _Available in: v63.0_ ### ExternalAuthIdentityProviderParameter External auth identity provider parameter. * `parameterName` (_string_) The name of the external auth identity provider parameter. _Available in: v63.0_ _Filter group: Small_ * `parameterType` (_object_) ExternalAuthIdentityProviderParamType Parameter type for an external auth identity provider. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ExternalAuthIdentityProviderParamType`. * `parameterValue` (_string_) If `parameterType` describes a literal value then the literal value is stored in this property. _Available in: v63.0_ _Filter group: Small_ * `sequenceNumber` (_integer_) Specifies the order of parameters to apply when an external auth identity provider has more than one parameter. Priority is from lower to higher numbers, for example, `1` is the highest priority. _Available in: v63.0_ _Filter group: Small_ ### CredentialCustomHeaderInput Credential custom header input. * `headerName` (_string_, required) Header name. _Available in: v58.0_ * `headerValue` (_string_, required) Header value. _Available in: v58.0_ * `id` (_string_) Header ID. _Available in: v58.0_ * `sequenceNumber` (_integer_, required) Sequence number. _Available in: v58.0_ ### ExternalCredentialParameterInput External credential parameter input. * `id` (_string_) Parameter ID. _Available in: v58.0_ * `parameterDescription` (_string_) Parameter description. _Available in: v58.0_ * `parameterName` (_string_, required) Parameter name of the external credential. _Available in: v58.0_ * `parameterType` (_object_, required) ExternalCredentialParameterType Parameter type of the external credential. _Available in: v58.0_ Includes all fields of `ExternalCredentialParameterType`. * `parameterValue` (_string_, required) Parameter value of the external credential. _Available in: v58.0_ ### ExternalCredentialPrincipalInput External credential principal input. * `id` (_string_) ID of the principal external credential parameter. _Available in: v58.0_ * `parameters` (_array of ExternalCredentialParameterInput_) List of external credential parameters. depending on the `authenticationProtocol` and `authenticationVariant` values of the External Credential Input _Available in: v58.0_ * `principalName` (_string_, required) Principal name. _Available in: v58.0_ * `principalType` (_object_, required) CredentialPrincipalType Type of credential principal. _Available in: v58.0_ Includes all fields of `CredentialPrincipalType`. * `sequenceNumber` (_integer_, required) Sequence number. _Available in: v58.0_ ### CredentialCustomHeader Credential custom header. * `headerName` (_string_) Header name. _Available in: v57.0_ _Filter group: Small_ * `headerValue` (_string_) Header value that can contain formulas. _Available in: v57.0_ _Filter group: Small_ * `id` (_string_) ID of the custom header parameter. _Available in: v58.0_ _Filter group: Small_ * `sequenceNumber` (_integer_) Sequence number of the header. The sequence number determines the order of the header. _Available in: v57.0_ _Filter group: Small_ ### ExternalCredentialParameter External credential parameter. * `id` (_string_) Parameter ID. _Available in: v58.0_ _Filter group: Small_ * `parameterDescription` (_string_) Parameter description. _Available in: v58.0_ _Filter group: Small_ * `parameterName` (_string_) Parameter name. If the `parameterType` is `AuthParameter`, valid values are: * `AwsAccountId` —Valid for AwsSv4. * `AwsProfileArn` —Valid for AwsSv4 with RolesAnywhere. * `AwsRegion` —Valid for AwsSv4. * `AwsService` —Valid for AwsSv4. * `AwsStsDuration` —Valid for AwsSv4 with STS or RolesAnywhere. * `AwsStsExternalId` —Valid for AwsSv4 with STS. * `AwsTrustAnchorArn` —Valid for AwsSv4 with RolesAnywhere. * `Scope` —Valid for OAuth. Other parameter types can be any value. _Available in: v57.0_ _Filter group: Small_ Allowed values: `AwsAccountId`, `AwsProfileArn`, `AwsRegion`, `AwsService`, `AwsStsDuration`, `AwsStsExternalId`, `AwsTrustAnchorArn`, `Scope`. * `parameterType` (_object_) ExternalCredentialParameterType Parameter type of the external credential. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `ExternalCredentialParameterType`. * `parameterValue` (_string_) Parameter value. If the `parameterType` is `JwtBodyClaim` or `JwtHeaderClaim`, the parameter value can contain formulas. If the `parameterType` is `AuthProvider` or `SigningCertificate`, the parameter value is the fully qualified entity name of the corresponding entity. _Available in: v57.0_ _Filter group: Small_ ### ExternalCredentialPrincipal External credential principal. If you don’t have the View Setup and Configuration permission, some properties are empty or show limited information. * `authenticationStatus` (_object_) CredentialAuthenticationStatus Status of the credential authentication. Values are: * `Configured` —Credential has all required credentials for at least one principal. * `NotConfigured` —Credential isn’t configured. * `Unknown` —Credential status can’t be determined because the authentication protocol is custom. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialAuthenticationStatus`. * `id` (_string_) ID of the external credential principal. _Available in: v58.0_ _Filter group: Medium_ * `parameters` (_array of ExternalCredentialParameter_) List of external credential parameters. _Available in: v58.0_ _Filter group: Medium_ * `principalAccess` (_array of ExternalCredentialPrincipalAccess_) List of access entities associated with the external credential principal. _Available in: v58.0_ _Filter group: Medium_ * `principalName` (_string_) Name of the external credential named principal. _Available in: v56.0_ _Filter group: Small_ * `principalType` (_object_) CredentialPrincipalType Type of credential principal. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `CredentialPrincipalType`. * `sequenceNumber` (_integer_, nullable) Sequence number of the external credential principal. _Available in: v58.0_ _Filter group: Medium_ ### NamedCredentialCalloutOptionsInput Named credential callout options input. * `allowMergeFieldsInBody` (_boolean_, required) Specifies whether to allow merge fields in the HTTP body (`true`) or not (`false`). _Available in: v58.0_ * `allowMergeFieldsInHeader` (_boolean_, required) Specifies whether to allow merge fields in the HTTP header (`true`) or not (`false`). _Available in: v58.0_ * `generateAuthorizationHeader` (_boolean_, required) Specifies whether to generate an authorization header (`true`) or not (`false`). _Available in: v58.0_ ### NetworkConnectionInput Network connection input. * `developerName` (_string_, required) Developer name of the network connection. _Available in: v58.0_ * `namespace` (_string_) Namespace of the network connection. _Available in: v58.0_ ### NamedCredentialParameterInput Named credential parameter input. * `id` (_string_) ID of the parameter. _Available in: v58.0_ * `managedByFeatureCapabilities` (_NamedCredentialParameterManagedByFeatureCapabilitiesInput_) * `parameterDescription` (_string_) Description of the parameter. _Available in: v58.0_ * `parameterName` (_string_, required) Name of the parameter. _Available in: v58.0_ * `parameterType` (_object_, required) NamedCredentialParameterType Type of named credential parameter. _Available in: v58.0_ Includes all fields of `NamedCredentialParameterType`. * `parameterValue` (_string_, required) Value of the parameter. _Available in: v58.0_ ### NamedCredentialType Type of named credential. _Available in: v58.0_ _Filter group: Small_ Type: `string`. Allowed values: `ExternalKnowledge`, `Nc__Sample__SampleStandard`, `PrivateEndpoint`, `Sample__Sub__TestStandard`, `SecuredEndpoint`. ### NamedCredentialCalloutOptions Named credential callout options. * `allowMergeFieldsInBody` (_boolean_) Specifies whether to allow merge fields in the HTTP body (`true`) or not (`false`). _Available in: v58.0_ _Filter group: Small_ * `allowMergeFieldsInHeader` (_boolean_) Specifies whether to allow merge fields in the HTTP header (`true`) or not (`false`). _Available in: v58.0_ _Filter group: Small_ * `generateAuthorizationHeader` (_boolean_) Specifies whether to generate an authorization header (`true`) or not (`false`). _Available in: v58.0_ _Filter group: Small_ ### CalloutStatus Indicates whether a named credential is enabled for callout. _Available in: v59.0_ _Filter group: Small_ Type: `string`. Allowed values: `Disabled`, `Enabled`. ### NamedCredentialParameter Named credential parameter. * `id` (_string_) ID of the parameter. _Available in: v58.0_ _Filter group: Small_ * `managedByFeatureCapabilities` (_NamedCredentialParameterManagedByFeatureCapabilities_) * `parameterName` (_string_) Name of the parameter. _Available in: v58.0_ _Filter group: Small_ * `parameterType` (_object_) NamedCredentialParameterType Type of named credential parameter. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `NamedCredentialParameterType`. * `parameterValue` (_string_) Value of the parameter. _Available in: v58.0_ _Filter group: Small_ ### NetworkConnectionTopologies Inbound and outbound network connection topologies output representation * `connectionType` (_object_) ExternalConnectionType Connection type. Value is `AwsPrivateLink`. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ExternalConnectionType`. ### AwsInboundNetworkConnectionProperties AWS inbound network connection properties. * `awsVpcEndpointId` (_string_) VPC endpoint ID of the AWS inbound network connection. _Available in: v51.0_ _Filter group: Small_ * `region` (_string_) Cloud region of the AWS inbound network connection. _Available in: v51.0_ _Filter group: Small_ ### AwsOutboundNetworkConnectionProperties AWS outbound network connection properties. * `awsVpcEndpointId` (_string_) VPC endpoint ID of the AWS outbound network connection. _Available in: v51.0_ _Filter group: Small_ * `awsVpcEndpointServiceName` (_string_) VPC endpoint service name of the AWS outbound network connection. _Available in: v51.0_ _Filter group: Small_ * `region` (_string_) Cloud region of the AWS outbound network connection. _Available in: v51.0_ _Filter group: Small_ ### ExternalConnectionStatus Status of the network connection. _Available in: v51.0_ _Filter group: Small_ Type: `string`. Allowed values: `Allocating`, `DeletedRemotely`, `PendingAcceptance`, `PendingActivation`, `Ready`, `RejectedRemotely`, `TeardownInProgress`, `Unprovisioned`. ### SobjectSubtypeEnum Object subtype of the job definition. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `None`, `PersonAccount`. ### ConnectDuplicateJobStatusEnum Status of the job. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `Canceled`, `Completed`, `Failed`, `InProgress`, `NotStarted`, `ResultsDeleted`. ### CustomDomain Definition of a custom domain. * `domainId` (_string_) ID of the custom domain. _Available in: v60.0_ _Filter group: Small_ * `domainName` (_string_) Domain name of the custom domain. For example, `www.example.com` . _Available in: v60.0_ _Filter group: Small_ ### CustomDomainAssociationTypeEnum Type of org that contains the Experience Cloud site or Salesforce Site content that the custom domain serves. Custom domains exist only in production orgs. * `Production` —The custom domain serves content from a site on the same org. * `Sandbox` —The custom domain serves content from a site on a sandbox. _Available in: v60.0_ _Filter group: Small_ Type: `string`. Allowed values: `Production`, `Sandbox`. ### CustomDomainConfigurationOptionEnum The pending domain configuration option. * `CdnPartner` —A Salesforce content delivery network (CDN) partner serves the domain. * `ExternalHttps` —A non-Salesforce service or host serves your custom domain. This option includes third-party CDNs and proxy solutions. * `NoHttps` —The custom domain uses a temporary non-HTTPS configuration for initial setup. * `SitesRuntime` —The custom domain is served on Salesforce servers with your HTTPS certificate. _Available in: v66.0_ _Filter group: Small_ Type: `string`. Allowed values: `CdnPartner`, `ExternalHttps`, `NoHttps`, `SitesRuntime`. ### CustomDomainStatusTypeEnum Custom domain status. Values are: * `AwaitingActivation` —The domain provisioning process is complete. To use the updated domain, activate the domain. * `AwaitingCustomURL` —The custom domain requires a custom URL to start provisioning. Only applies to custom domains with the SitesRuntime configurationOption. * `Completed` —The custom domain is active and in use. * `DomainNameValidated` — `domainName` ownership has been validaed by Salesforce. * `DomainNameValidationFailed` —Salesforce couldn’t validate the `domainName`. Update the CNAME in DNS and attempt to validate the domain again. * `DomainNameValidationPending` — `domainName` validation hasn’t started. * `Provisioning` —Salesforce is provisioning the custom domain. In other words, Salesforce is getting the domain ready for activation.— _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `AwaitingActivation`, `AwaitingCustomURL`, `Completed`, `DomainNameValidated`, `DomainNameValidationFailed`, `DomainNameValidationPending`, `Provisioning`. ### CustomDomainUrlSiteTypeEnum Type of site that this custom URL serves. * `Community` —An [Experience Cloud Site](/docs/platform/connect-rest-api/references/connect-rest-api-experience-cloud#tag/Experience-Cloud-Sites-Resources/operation/getCommunity). * `SalesforceSite` —A Salesforce Site. * `LegacySite` —A legacy site type, such as legacy Site.com sites. _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `Community`, `LegacySite`, `SalesforceSite`. ### CustomDomainCustomUrlStatusEnum Custom URL status. Values are: * `AwaitingPublish` —The custom URL is ready to be published from within Site.com Studio. This status applies only to custom URLs with a `siteType` of `LegacySite` when no sites of other types exist on the same domain. * `AwaitingUnpublish` —The custom URL was removed but is still published. To finish deleting the custom URL, click Unpublish in Site.com Studio. This status applies only to custom URLs with a `siteType` of `LegacySite`. * `InDevelopment` —The custom URL is ready to be published. This status applies only to custom URLs with a `siteType` of `LegacySite` when no sites of other types exist on the same domain. * `Offline` —The custom URL is associated with an inactive site. * `Preview` —The custom URL is active for an Experience Cloud site with a status of Preview. * `PublishFailed` —There was an unexpected issue with the background publishing operation for a site associated with the custom URL. This status is assigned to the custom URL after the background publishing operation is attempted every hour for two weeks without success. * `Published` —The custom URL is active and is associated with a site that is live. * `Publishing` —Salesforce is publishing the custom URL in the background. If this custom URL was previously published, the custom URL remains available throughout the publishing process. _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `AwaitingPublish`, `AwaitingUnpublish`, `InDevelopment`, `Offline`, `Preview`, `PublishFailed`, `Published`, `Publishing`. ### CdnPartnerOptions Content delivery network (CDN) partner for a custom domain that uses the Experience Cloud CDN. * `cdnPartner` (_string_) CDN partner name. Valid values are: * Onboard to Akamai * Onboard to Cloudflare _Available in: v66.0_ _Filter group: Small_ ### ConnectRecommendationReactionTypeEnum Type of reaction to a recommendation. _Available in: v45.0_ _Filter group: Small_ Type: `string`. Allowed values: `Accepted`, `Rejected`. ### ConnectRecommendationModeEnum Reserved for future use. Mode of recommendation, if you’re using Einstein Intelligent Offers, an AppExchange package. * `Intelligent` —Recommendation came from Einstein Intelligent Offers. * `Learning` —Recommendation came from a randomized process in learning mode. _Available in: v46.0_ _Filter group: Small_ Type: `string`. Allowed values: `Intelligent`, `Learning`. ### RecordSnapshot A record snapshot in a recommendation reaction. * `id` (_string_) ID of the record. _Available in: v45.0_ _Filter group: Small_ * `nameAtSnapshot` (_string_) Name of the record when the ID was recorded. _Available in: v45.0_ _Filter group: Small_ ### NBARecommendation A recommendation returned by a recommendation strategy. * `acceptanceLabel` (_string_) Text indicating user acceptance of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `aiModel` (_string_) Reserved for future use. _Available in: v47.0_ _Filter group: Small_ * `description` (_string_) Description of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `externalId` (_string_) External ID of the recommendation. This ID doesn’t need to be a Salesforce 18-character ID. For example, it can be a product number from an external system. _Available in: Small, 46.0_ _Filter group: Small_ * `imageUrl` (_string (url)_) URL to the asset file to display. _Available in: v45.0_ _Filter group: Small_ * `recommendationMode` (_string_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ Allowed values: `Intelligent`, `Learning`. * `recommendationScore` (_number (double)_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ * `rejectionLabel` (_string_) Text indicating user rejection of the recommendation. _Available in: v45.0_ _Filter group: Small_ * `target` (_object_) AbstractNBATarget Target to act on. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `AbstractNBATarget`. * `targetAction` (_object_) AbstractNBAAction Action to recommend. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `AbstractNBAAction`. ### StrategyTrace Messages and trace nodes for a recommendation strategy execution. * `messages` (_array of string_) Messages and errors from the strategy execution. _Available in: v45.0_ _Filter group: Small_ * `nodes` (_array of StrategyTraceNode_) Nodes of the strategy execution used for debugging. _Available in: v45.0_ _Filter group: Small_ ### FileAsset Representation of a file asset. * `baseAssetUrl` (_string_) Base download URL of the asset. _Available in: v38.0_ _Filter group: Small_ * `baseUnauthenticatedAssetUrl` (_string (url)_) Base download URL of the asset for unauthenticated users if `isVisibleByExternalUsers` is `true`, otherwise `null`. _Available in: v43.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the asset. _Available in: v38.0_ _Filter group: Small_ * `isVisibleByExternalUsers` (_boolean_) Indicates whether unauthenticated users can see the asset file (`true`) or not (`false`). _Available in: v43.0_ _Filter group: Small_ * `masterLabel` (_string_) Label of the asset. _Available in: v38.0_ _Filter group: Small_ * `name` (_string_) Unique name of the asset. _Available in: v38.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix of the package containing the asset. _Available in: v38.0_ _Filter group: Small_ * `type` (_string_) Type of asset. _Available in: v38.0_ _Filter group: Small_ ### SurveyInvitationSettingsInput Input representation of the settings of the survey invitation that define the participants who can respond to the survey, its expiration, and other related configurations. * `allowGuestUserResponse` (_boolean_, required) Indicates whether a guest user can respond to the survey ( `true` ) or not ( `false` ). _Available in: v56.0_ * `allowParticipantsAccessTheirResponse` (_boolean_, required) Indicates whether participants with Salesforce accounts can access their responses ( `true` ) or not ( `false` ). _Available in: v56.0_ * `collectAnonymousResponse` (_boolean_, required) Indicates whether participants can take the survey without revealing their name or other identifying information ( `true` ) or not ( `false` ). _Available in: v56.0_ * `communityId` (_string_) The ID of the Experience Cloud site related to the survey. _Available in: v56.0_ * `invitationExpirationDate` (_string (date-time)_) The date when the survey invitation expires. _Available in: v56.0_ * `invitationOwner` (_string_) The ID of the survey invitation's owner. The default value is the ID of the user running the API request. _Available in: v56.0_ * `recipientId` (_string_) The ID of the survey recipient. _Available in: v56.0_ ### SurveyNavigationActionEnum Available navigation actions on the survey page. Possible values are: * `Back` —Navigate to the previous survey page. * `Next` —Navigate to the next survey page. _Available in: v57.0_ Type: `string`. Allowed values: `Back`, `Next`. ### SurveyResponseApiStatusEnum Status of the API request. Possible values are: * `Failure` —Survey Response API isn’t successfully run. * `Success` —Survey Response API is successfully run. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Failure`, `Success`. ### SurveyDetailOutput Output representation of the details of the survey. * `label` (_string_) The label of the survey. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey. _Available in: v56.0_ _Filter group: Small_ * `surveyPage` (_SurveyQuestionPageOutput | SurveyThankYouPageOutput_) The details of the question or thank you page in the survey. _Available in: v56.0_ _Filter group: Small_ One of: `SurveyQuestionPageOutput`, `SurveyThankYouPageOutput`. * `versionLabel` (_string_) The label of the survey version. _Available in: v56.0_ _Filter group: Small_ * `versionNumber` (_integer_) The version number of the survey. _Available in: v56.0_ _Filter group: Small_ ### SurveyPageResponseInput Input representation of the details of the response to a survey page. * `name` (_string_) The API name of the survey page. Reserved for future use. _Available in: v56.0_ * `questionResponses` (_array of SurveyQuestionResponseInput_, required) The responses to the survey questions on the page. * NPS Question Type—See Survey Integer Question Response Input. * Selection Question Type—See Survey Selection Question Response Input. * Short Text or Long Text Question Type—See Survey Text Question Response Input. * Other Question Type—See Survey Question Response Input. _Available in: v56.0_ ### SurveyQuestionPageOutput The details of the question page in the survey. * `label` (_string_) The label of the survey page. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey page. _Available in: v56.0_ _Filter group: Small_ * `pageType` (_SurveyPageTypeEnum_) * `surveyQuestions` (_SurveyNpsQuestionOutput | SurveySelectionQuestionOutput | SurveyShortTextQuestionOutput | SurveyTextQuestionOutput | SurveyQuestionOutput_) List of survey questions. _Available in: v56.0_ _Filter group: Small_ One of: `SurveyNpsQuestionOutput`, `SurveySelectionQuestionOutput`, `SurveyShortTextQuestionOutput`, `SurveyTextQuestionOutput`, `SurveyQuestionOutput`. ### SurveyThankYouPageOutput Output representation of the details of the Thank You page in the survey. * `label` (_string_) The label of the survey page. _Available in: v56.0_ _Filter group: Small_ * `messageDescription` (_string_) The description for a message on the Thank You page in the survey. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey page. _Available in: v56.0_ _Filter group: Small_ * `pageType` (_SurveyPageTypeEnum_) * `redirectUrl` (_string_) The URL that respondents are automatically redirected to after completing the survey. _Available in: v56.0_ _Filter group: Small_ * `thankYouMessage` (_string_) The thank you message of the Thank You page in the survey. _Available in: v56.0_ _Filter group: Small_ * `urlButtons` (_array of SurveyURLButtonsOutput_) The buttons on the Thank You page which respondents select to navigate to URLs. _Available in: v56.0_ _Filter group: Small_ ### SurveyRecipientSurveySubjectsInput Records associated with the survey invitation. * `associateRecordIds` (_array of string_, required) ID of the associated records. _Available in: v50.0_ * `recipientId` (_string_, required) Participant ID with whose invitation the record should be associated. _Available in: v50.0_ ### SurveyRecipientEngagementContextInput Context based on which the survey invitation is sent to a participant. * `recipientEngagementContext` (_object_, required) Map each recipient with the context based on which the survey invitation is emailed. _Available in: v50.0_ Additional properties: `string`. * `recipientId` (_string_, required) Participant ID with whom the engagement context should be associated. _Available in: v50.0_ ### SurveyEmailStatusEnum Status of a survey invitation email. Values are: * `Failed` —The survey invitation email wasn't sent. * `Queued` —The survey invitation email is queued for sending. _Available in: v50.0_ _Filter group: Small_ Type: `string`. Allowed values: `Failed`, `Queued`. ### ConnectRequestMethod Represents the HTTP methods allowed for the Connect API. Type: `string`. Allowed values: `Delete`, `Get`, `Head`, `Patch`, `Post`, `Put`. ### BatchResult Describes the result of an individual request in a batch request. * `result` (_any_) The result of this individual request. The type depends on the batch resource; for an error result it is an error message. * `statusCode` (_integer_) An HTTP status code indicating the status of this individual request in the batch. ### Features Features available to the context user in the org. If a feature is disabled, the resources associated with that feature are unavailable and some feature-related properties on objects are set to `null`. * `activityReminderNotificationsEnabled` (_boolean_) Reserved for future use. _Available in: v37.0_ _Filter group: Small_ * `chatter` (_boolean_) Specifies whether Chatter is enabled. _Available in: v27.0_ _Filter group: Small_ * `chatterActivity` (_boolean_) Specifies whether user details include information about Chatter activity. _Available in: v24.0_ _Filter group: Small_ * `chatterAnswers` (_boolean_) Specifies whether Chatter Answers is enabled. With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see [End of Support for Chatter Answers in Spring ’18](https://help.salesforce.com/apex/HTViewSolution?urlname=Chatter-Answers-to-Retire-in-Spring-18). _Available in: v29.0_ _Filter group: Small_ * `chatterGlobalInfluence` (_boolean_) Specifies whether user details include global Chatter activity. _Available in: v24.0_ _Filter group: Small_ * `chatterGroupRecordSharing` (_boolean_) Specifies whether Chatter records are implicitly shared among group members when records are added to groups. _Available in: v33.0_ _Filter group: Small_ * `chatterGroupRecords` (_boolean_) Specifies whether Chatter groups can have records associated with them. _Available in: v33.0_ _Filter group: Small_ * `chatterMessages` (_boolean_) Specifies whether Chatter messages are enabled. _Available in: v24.0_ _Filter group: Small_ * `chatterTopics` (_boolean_) Specifies whether topics are enabled. _Available in: v28.0_ _Filter group: Small_ * `communitiesEnabled` (_boolean_) Specifies whether digital experiences is enabled. _Available in: v31.0_ _Filter group: Small_ * `communityModeration` (_boolean_) Specifies whether moderation is enabled. _Available in: v29.0_ _Filter group: Small_ * `communityReputation` (_boolean_) Specifies whether reputation is enabled. _Available in: v32.0_ _Filter group: Small_ * `customFiscalCalendarEnabled` (_boolean_) Specifies whether custom fiscal calendar is enabled. _Available in: v63.0_ _Filter group: Small_ * `dashboardComponentSnapshots` (_boolean_) Specifies whether the user can post dashboard component snapshots. _Available in: v24.0_ _Filter group: Small_ * `defaultCurrencyIsoCode` (_string_) ISO code of the default currency. Applicable only when `multiCurrency` is `false`. _Available in: v28.0_ _Filter group: Small_ * `defaultLocale` (_string_) Specifies the Default locale. _Available in: v63_ _Filter group: Small_ * `einsteinVoiceEnabled` (_boolean_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ * `einsteinVoiceInPilotEnabled` (_boolean_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ * `einsteinVoiceLoggingEnabled` (_boolean_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ * `einsteinVoiceProviderId` (_integer_) Reserved for future use. _Available in: v46.0_ _Filter group: Small_ * `favoritesEnabled` (_boolean_) Specifies whether favorites in Lightning are enabled. _Available in: v41.0_ _Filter group: Small_ * `favoritesLimit` (_integer_) Specifies the maximum number of favorites allowed per user. * `feedPolling` (_boolean_) Reserved for future use. _Available in: v24.0_ _Filter group: Small_ * `feedStreamEnabled` (_boolean_) Specifies whether Chatter feed streams are enabled. _Available in: v39.0_ _Filter group: Small_ * `files` (_boolean_) Specifies whether files can act as resources for Connect REST API. _Available in: v24.0_ _Filter group: Small_ * `filesOnComments` (_boolean_) Specifies whether files can be attached to comments. _Available in: v24.0_ _Filter group: Small_ * `fiscalYearStartMonth` (_integer_) Specifies the number that corresponds to the month that starts the fiscal year for the org. For example, if the org's fiscal year starts in February, the value is 2. _Available in: v63.0_ _Filter group: Small_ * `forecasting3AggregatedEnabled` (_boolean_) Specifies whether aggregated forecasting is enabled for mobile clients. _Available in: v38.0_ _Filter group: Small_ * `forecastingEnabled` (_boolean_) Specifies whether forecasting is enabled. _Available in: v38.0_ _Filter group: Small_ * `forecastingPeriodRange` (_integer_) Range of the forecasting period. _Available in: v38.0_ _Filter group: Small_ * `forecastingPeriodStart` (_integer_) Start index for the forecasting period. _Available in: v38.0_ _Filter group: Small_ * `forecastingPeriodType` (_object_) ConnectPeriodTypesEnum Time period used for forecasting. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `ConnectPeriodTypesEnum`. * `ideas` (_boolean_) Specifies whether Ideas is enabled. _Available in: v29.0_ _Filter group: Small_ * `liveAgentHostName` (_string_) Live Agent host name configured for the org. _Available in: v41.0_ _Filter group: Small_ * `managedTopicsEnabled` (_boolean_) Specifies whether managed topics are enabled. _Available in: v32.0_ _Filter group: Small_ * `maxEntitySubscriptionsPerStream` (_integer_) Specifies the maximum number of feed-enabled entities that can be subscribed to in a Chatter stream. _Available in: v39.0_ _Filter group: Small_ * `maxFilesPerFeedItem` (_integer_) Specifies the maximum number of files that can be added to a feed item. _Available in: v36.0_ _Filter group: Small_ * `maxStreamsPerPerson` (_integer_) Specifies the maximum number of Chatter streams that a user can have. _Available in: v39.0_ _Filter group: Small_ * `mobileNotificationsEnabled` (_boolean_) Reserved for future use. _Available in: v29.0_ _Filter group: Small_ * `multiCurrency` (_boolean_) Specifies whether the org uses multiple currencies (`true`) or not (`false`). When `false`, the `defaultCurrencyIsoCode` indicates the ISO code of the default currency. _Available in: v28.0_ _Filter group: Small_ * `offlineEditEnabled` (_boolean_) Specifies whether the offline object permissions are enabled for Salesforce for Android and Salesforce for iOS mobile clients. _Available in: v37.0_ _Filter group: Small_ * `publisherActions` (_boolean_) Specifies whether actions in the publisher are enabled. _Available in: v28.0_ _Filter group: Small_ * `storeDataOnDevicesEnabled` (_boolean_) Specifies whether the Salesforce for Android and Salesforce for iOS can use secure, persistent storage on mobile devices to cache data. _Available in: v30.0_ _Filter group: Small_ * `thanksAllowed` (_boolean_) For Chatter work.com, specifies whether the context user can make a thanks post. _Available in: v28.0_ _Filter group: Small_ * `trendingTopics` (_boolean_) Specifies whether trending topics are enabled. _Available in: v24.0_ _Filter group: Small_ * `userNavItemsEnabled` (_boolean_) Specifies whether users can customize the navigation bar in Lightning. _Available in: v41.0_ _Filter group: Small_ * `userNavItemsMax` (_integer_) Specifies the maximum number of personalized items per app that are allowed in the navigation bar in Lightning. _Available in: v43.0_ _Filter group: Small_ * `usesStartDateAsFiscalYearName` (_boolean_) Specifies whether the calendar year when the fiscal year begins is referred to as the year of the company's fiscal year. For example, if the fiscal year begins in November 2025, but is referred to as fiscal year 2026, the value is `false`. _Available in: v63.0_ _Filter group: Small_ * `viralInvitesAllowed` (_boolean_) Specifies whether existing Chatter users can invite people in their company to use Chatter. _Available in: v24.0_ _Filter group: Small_ * `wave` (_boolean_) Specifies whether CRM Analytics is enabled. _Available in: v36.0_ _Filter group: Small_ * `groupsCanFollow` (_boolean_) Reserved for future use. _Available in: v28.0–29.0_ _Filter group: Small_ ### Maintenance Information for the list of upcoming scheduled maintenances for the organization. * `description` (_string_) Descriptive text of the scheduled maintenance. * `maintenanceTitle` (_string_) Title of the scheduled maintenance. * `maintenanceType` (_MaintenanceTypeEnum_) * `messageEffectiveTime` (_string (date-time)_) Effective time of the maintenance message notifications. * `messageExpirationTime` (_string (date-time)_) Expiration time of the maintenance message notifications. * `scheduledEndDowntime` (_string (date-time)_) Scheduled end of downtime, if there is downtime in the scheduled maintenance window. * `scheduledEndMaintenanceTime` (_string (date-time)_) Scheduled end time of the maintenance. * `scheduledStartDowntime` (_string (date-time)_) Scheduled start of downtime, if there is downtime in the scheduled maintenance window. * `scheduledStartMaintenanceTime` (_string (date-time)_) Scheduled start time of the maintenance. ### UserSettings Settings specific to a user. * `approvalPosts` (_boolean_) User can approve workflows from Chatter posts. _Available in: v27.0_ _Filter group: Small_ * `canAccessPersonalStreams` (_boolean_) User can access personal stream feeds. _Available in: v40.0_ _Filter group: Small_ * `canFollow` (_boolean_) User can follow things. _Available in: v24.0_ _Filter group: Small_ * `canModifyAllData` (_boolean_) User has Modify all Data permission. _Available in: v24.0_ _Filter group: Small_ * `canOwnGroups` (_boolean_) User can own groups. _Available in: v24.0_ _Filter group: Small_ * `canViewAllData` (_boolean_) User has View all Data permission. _Available in: v24.0_ _Filter group: Small_ * `canViewAllGroups` (_boolean_) User has View all Groups permission. _Available in: v24.0_ _Filter group: Small_ * `canViewAllUsers` (_boolean_) User has View all Users permission. _Available in: v24.0_ _Filter group: Small_ * `canViewCommunitySwitcher` (_boolean_) User can see the site switcher menu. _Available in: v34.0_ _Filter group: Small_ * `canViewFullUserProfile` (_boolean_) User can see other user’s Chatter profile. _Available in: v24.0_ _Filter group: Small_ * `canViewPublicFiles` (_boolean_) User can see all files that are public. _Available in: v24.0_ _Filter group: Small_ * `currencySymbol` (_string_) Currency symbol to use for displaying currency values. Applicable only when the `multiCurrency` property of the Features response body is `false` . _Available in: v28.0_ _Filter group: Small_ * `externalUser` (_boolean_) User is a Chatter customer. _Available in: v24.0_ _Filter group: Small_ * `fileSyncLimit` (_integer_) Maximum number of files user can sync. _Available in: v32.0_ _Filter group: Small_ * `fileSyncStorageLimit` (_integer_) Maximum storage for synced files, in megabytes (MB). _Available in: v29.0_ _Filter group: Small_ * `folderSyncLimit` (_integer_) Maximum number of folders user can sync. _Available in: v32.0_ _Filter group: Small_ * `hasAccessToInternalOrg` (_boolean_) User is a member of the internal org. _Available in: v26.0_ _Filter group: Small_ * `hasChatter` (_boolean_) User has access to Chatter. _Available in: v31.0_ _Filter group: Small_ * `hasFieldServiceLocationTracking` (_boolean_) User has Field Service GPS tracking enabled. _Available in: v41.0_ _Filter group: Small_ * `hasFieldServiceMobileAccess` (_boolean_) User has access to the Field Service mobile app. _Available in: v41.0_ _Filter group: Small_ * `hasFileSync` (_boolean_) User has Sync Files permission. _Available in: v26.0_ _Filter group: Small_ * `hasFileSyncManagedClientAutoUpdate` (_boolean_) Administrator for the user’s org allows file sync clients to update automatically. _Available in: v34.0_ _Filter group: Small_ * `hasRestDataApiAccess` (_boolean_) User has access to REST API. _Available in: v29.0_ _Filter group: Small_ * `timeZone` (_object_) TimeZone User's time zone as selected in the user’s personal settings in Salesforce. This value doesn’t reflect a device's current location. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `TimeZone`. * `userDefaultCurrencyIsoCode` (_string_) ISO code for the default currency. Applicable only when the `multiCurrency` property of the Features response body is `true` . _Available in: v28.0_ _Filter group: Small_ * `userId` (_string (Id)_) 18-character ID of the user. _Available in: v24.0_ _Filter group: Small_ * `userLocale` (_string_) Locale of user. _Available in: v24.0_ _Filter group: Small_ ### ConnectZoneVisibilityTypeEnum Zone visibility type. One of these values: * `Community` —Available in an Experience Cloud site. * `Internal` —Available internally only. * `Portal` —Available in a portal. _Available in: v29.0_ _Filter group: Small_ Type: `string`. Allowed values: `Community`, `Internal`, `Portal`. ### ZoneSearchResult The result of a search within a Chatter Answers zone. * `hasBestAnswer` (_boolean_) Indicates whether or not the search result has a best answer _Available in: v29.0_ _Filter group: Small_ * `id` (_string_) ID of the search result. The search result can be a question or an article. _Available in: v29.0_ _Filter group: Small_ * `title` (_string_) Title of the search result _Available in: v29.0_ _Filter group: Small_ * `type` (_object_) ConnectZoneSearchResultTypeEnum Type of the search result. One of these values: * `Article` —Search results contain only articles. * `Question` —Search results contain only questions. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectZoneSearchResultTypeEnum`. * `voteCount` (_string_) Number of votes given to the search result _Available in: v29.0_ _Filter group: Small_ ### BotInfo Information about the bot associated with the conversation application. * `botId` (_string_) ID of the bot. _Available in: v54.0_ _Filter group: Small_ * `botName` (_string_) Name of the bot. _Available in: v54.0_ _Filter group: Small_ * `lastModifiedDate` (_string (date-time)_) Last modified date of the bot definition. _Available in: v54.0_ _Filter group: Small_ * `eTag` (_string_, read-only) ETag like field, readOnly, handy while caching. ### ConversationApplicationIntegrationType Conversation application integration types. _Available in: v54.0_ _Filter group: Small_ Type: `string`. Allowed values: `Api`, `Slack`. ### UtterancePredictionInput Utterance and associated intent information for a bot. * `intent` (_string_, required) API name of the intent associated with the utterance. _Available in: v66.0_ * `utterance` (_string_, required) Utterance of the bot. _Available in: v66.0_ ### UtterancePredictionOutput Prediction information for an utterance. * `confidenceRating` (_string_, nullable) Confidence rating of the prediction based on the confidence score. Valid values: * `EXCELLENT` —Confidence score of 0.9 or higher. * `HIGH` —Confidence score of 0.7–0.89. * `AVERAGE` —Confidence score 0.5–0.69. * `BELOW AVERAGE` —Confidence score of 0.3–0.49. * `LOW` —Confidence score of 0.29 or lower. _Available in: v66.0_ _Filter group: Small_ Allowed values: `EXCELLENT`, `HIGH`, `AVERAGE`, `BELOW AVERAGE`, `LOW`. * `confidenceScore` (_string_, nullable) Confidence score of the prediction. Valid values are from 0–1.0. A higher score means that the prediction is more likely to be accurate. _Available in: v66.0_ _Filter group: Small_ * `intent` (_string_) API name of the intent associated with the utterance. _Available in: v66.0_ _Filter group: Small_ * `predictedIntent` (_string_) API name of the predicted intent for the utterance. _Available in: v66.0_ _Filter group: Small_ * `predictionOutcome` (_string_, nullable) The result of the prediction. Valid values: * `UN_PROCESSED` —Returned an error. * `PASS` —Predicted intent is accurate. * `FAIL` —Predicted intent is inaccurate. _Available in: v66.0_ _Filter group: Small_ Allowed values: `UN_PROCESSED`, `PASS`, `FAIL`. * `utterance` (_string_) The utterance that an intent is being predicted for. _Available in: v66.0_ _Filter group: Small_ ### UtterancePredictionSummaryOutput Prediction summary for multiple utterances. * `count` (_integer_) Total number of utterances used for prediction. _Available in: v66.0_ _Filter group: Small_ * `errorCount` (_integer_, nullable) Total number of utterances that returned an error. _Available in: v66.0_ _Filter group: Small_ * `failCount` (_integer_, nullable) Total number of utterances that were predicted inaccurately. _Available in: v66.0_ _Filter group: Small_ * `intentCoverageRate` (_number (double)_, nullable) Percent of intents that were predicted accurately for at least one utterance. _Available in: v66.0_ _Filter group: Small_ * `successCount` (_integer_, nullable) Total number of utterances that were predicted accurately. _Available in: v66.0_ _Filter group: Small_ * `successRate` (_number (double)_, nullable) Percent of utterances that were predicted inaccurately. _Available in: v66.0_ _Filter group: Small_ ### ProgramApplicationItemInput Input representation of the item for a customer program application. * `productAttributes` (_array of ProductAttributeInput_) A list of ProductAttributes associated with the Product * `programProductId` (_string_, required) A valid program product ID associated with the program. _Available in: v58.0_ * `status` (_string_) Status of the item. _Available in: v58.0_ ### AttributeCreationStrategyEnum Possible values for Attribute Creation Strategy Enum Type: `string`. Allowed values: `All`, `None`. ### ProgramApplicationFileInput Input representation of the files or attachment for a customer program application. * `contentDocumentId` (_string_, required) A valid content document record ID _Available in: v58.0_ ### CalmAssetActionInput Asset action input consumed by Customer Asset Lifecycle Management. The asset action object represents a change made to a lifecycle-managed asset during its lifecycle, specifically, the difference in quantity, amount, and monthly recurring revenue. * `actionDate` (_string (date-time)_, required) Date when the change occurred. This value can be different from the start date of the asset state period related to this asset action. For example, suppose that on 01/01 a user cancels a subscription as of 06/01. Create an asset action with an action date of 01/01, and set the start date of the related asset state period to 06/01. _Available in: v50.0_ * `amount` (_number (double)_, required) The change in amount resulting from the asset action. _Available in: v50.0_ * `category` (_string_, required) Asset action category for reporting. _Available in: v50.0_ * `mrrChange` (_number (double)_, required) The change in monthly recurring revenue resulting from the asset action. _Available in: v50.0_ * `quantityChange` (_number (double)_, required) The change in quantity resulting from the asset action. _Available in: v50.0_ ### CalmAssetActionSourceInput Asset action source input consumed by Customer Asset Lifecycle Management. The asset action source is an optional asset action child object for tracking a Salesforce order product, a work order line item, or an external reference to a change. You can provide multiple asset action sources for a single asset action. * `actualTax` (_number (double)_) Actual tax. _Available in: v50.0_ * `adjustmentAmount` (_number (double)_) Adjustment amount. _Available in: v50.0_ * `endDate` (_string (date-time)_) End date. _Available in: v50.0_ * `estimatedTax` (_number (double)_) Estimated tax. _Available in: v50.0_ * `externalReference` (_string_) ID of an external object that caused the asset action. _Available in: v50.0_ * `externalReferenceDataSource` (_string_) Data source for an external object that caused the asset action. _Available in: v50.0_ * `productAmount` (_number (double)_) Product amount. _Available in: v50.0_ * `quantity` (_number (double)_) Quantity. _Available in: v50.0_ * `referenceEntityItem` (_string (Id)_) ID of the Salesforce object that caused the asset action. Supported Salesforce objects: Order Product and Work Order Line Item. _Available in: v50.0_ * `startDate` (_string (date-time)_) Start date. _Available in: v50.0_ * `transactionDate` (_string (date-time)_) Date of the transaction related to the asset action. _Available in: v50.0_ ### CalmAssetStatePeriodInput Asset state period input consumed by Customer Asset Lifecycle Management. The asset state period represents the current quantity, amount, and monthly recurring revenue for a lifecycle-managed asset during a period. You create asset state periods to represent the creation of an asset, asset changes, and asset cancellations. When the current date reaches the start date of the next asset state period, the asset’s quantity, amount, and monthly recurring revenue fields are updated on the basis of the now-current asset state period. * `amount` (_number (double)_, required) Amount of revenue allocated for the time defined by the asset state period. _Available in: v50.0_ * `endDate` (_string (date-time)_) Service end date for the asset state period. _Available in: v50.0_ * `mrr` (_number (double)_, required) Monthly recurring revenue for the time defined by the asset state period. _Available in: v50.0_ * `quantity` (_number (double)_, required) Quantity of the asset during the asset state period. _Available in: v50.0_ * `startDate` (_string (date-time)_, required) Service start date for the asset state period. _Available in: v50.0_ ### CalmAssetOutput Asset output representation for a lifecycle-managed asset. * `id` (_string (Id)_) ID of the asset. _Available in: v50.0_ _Filter group: Big_ ### CalmAssetActionOutput Asset action output representation for a lifecycle-managed asset. * `id` (_string (Id)_) ID of the asset action. _Available in: v50.0_ _Filter group: Big_ ### CalmAssetActionSourceOutput Response received from an asset action source for a lifecycle-managed asset. * `id` (_string (Id)_) ID of the asset action source. _Available in: v50.0_ _Filter group: Big_ * `referenceId` (_string_) ID of the salesforce entity or external entity that caused the asset action. _Available in: v50.0_ _Filter group: Big_ ### CalmAssetStatePeriodOutput Response received from an asset state period for a lifecycle-managed asset. * `id` (_string (Id)_) ID of the asset state period. _Available in: v50.0_ _Filter group: Big_ ### ConnectorsCallCoachingUserInfo User information for Einstein Conversation Insights partners. * `userEmail` (_string_) User email. _Available in: v49.0_ _Filter group: Small_ * `userId` (_string_) User ID. _Available in: v49.0_ _Filter group: Small_ ### ConnectorsCallInput Voice call and recording properties. * `activityId` (_string_) ID of task logged. _Available in: v49.0_ * `callType` (_object_, required) ConnectorsCallTypeEnum Type of call. _Available in: v49.0_ Includes all fields of `ConnectorsCallTypeEnum`. * `consented` (_boolean_) Specifies whether the caller for inbound calls or the recipient for outbound calls consented to recording (`true`) or not (`false`). _Available in: v49.0_ * `endDateTime` (_string (date-time)_, required) Call end time. _Available in: v49.0_ * `externalId` (_string_, required) External ID of call. _Available in: v49.0_ * `fromPhoneNumber` (_string_, required) Phone number that initiated the call. _Available in: v49.0_ * `mediaProviderId` (_string_, required) ID of media provider. _Available in: v49.0_ * `numberChannels` (_integer_) Number of audio channels in call recording. _Available in: v49.0_ * `recordId` (_string_) Salesforce account, case, contact, or lead ID. _Available in: v49.0_ * `recordingDuration` (_integer_, required) Duration of call recording in seconds. _Available in: v49.0_ * `recordingFormat` (_object_, required) ConnectorsRecordingFormatEnum Recording format. _Available in: v49.0_ Includes all fields of `ConnectorsRecordingFormatEnum`. * `sourceType` (_string_) Specifies whether a call is related to a sales or service use case. Values are: * `Sales` * `Service` Values are case-sensitive. If no value is provided, it is set to “Sales” by default. _Available in: v51.0_ * `startDateTime` (_string (date-time)_, required) Call start time. _Available in: v49.0_ * `toPhoneNumber` (_string_, required) Phone number that received the call. _Available in: v49.0_ * `userChannel` (_integer_) Audio channel number for user's side of call recording. Value is 0 or 1, where 0 means left channel for dual channel recording. _Available in: v49.0_ * `userEmail` (_string_) Salesforce user email address of the person who initiated or received the call. Required if `userId` isn’t specified _Available in: v49.0_ * `userId` (_string_) Salesforce user ID of the person who initiated or received the call. Required if `userEmail` isn’t specified _Available in: v49.0_ * `vendorType` (_string_) Specifies the call vendor. Values are: * `AmazonConnect` * `Custom` * `DialPad` * `RingCentral` * `Twilio` * `TwilioTrial` If the vendor isn’t specified or is unknown, the default value is `Custom` . _Available in: v57.0_ ### ConnectorsVoiceCallResult Result of posting a voice call. * `errorMsg` (_string_) Error message. _Available in: v49.0_ _Filter group: Small_ * `externalId` (_string_) External ID of the voice call. _Available in: v49.0_ _Filter group: Small_ * `isSuccess` (_boolean_) Specifies whether posting the voice call was successful (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `uploadUrl` (_string_) URL for uploading the call recording. _Available in: v49.0_ _Filter group: Small_ * `voiceCallId` (_string_) ID of the voice call. _Available in: v49.0_ _Filter group: Small_ ### Address Address. * `city` (_string_) Name of the city _Available in: v23.0_ _Filter group: Small_ * `country` (_string_) Name of the country _Available in: v23.0_ _Filter group: Small_ * `formattedAddress` (_string_) Address formatted by locale _Available in: v25.0_ _Filter group: Small_ * `state` (_string_) Name of the state, province, or so on _Available in: v23.0_ _Filter group: Small_ * `street` (_string_) Street number _Available in: v23.0_ _Filter group: Small_ * `zip` (_string_) Zip or postal code _Available in: v23.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_ ### DatacloudImportStatus Represents the status for each `contactId` for this request. * `datacloudId` (_string_) The contact’s ID. Each `contactId` is a unique numeric value. _Available in: v35.0_ _Filter group: Small_ * `importStatus` (_object_) DatacloudImportStatusTypeEnum The import status for each contact listed in the request. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `DatacloudImportStatusTypeEnum`. ### ConnectDatacloudUserTypeEnum The Data.com user type. * `Monthly` —A user type that’s assigned monthly point limits for purchasing Data.com records. Only the assigned user can use monthly points. Points expire at the end of the month. Monthly is the default setting for `DatacloudUserType`. * `Listpool` —A user type that allows users to draw from a pool of points to purchase Data.com records. _Available in: v32.0_ Type: `string`. Allowed values: `Listpool`, `Monthly`. ### OauthProviderInfo The provider of the OAuth service. * `authorizationUrl` (_string_) The URL used for authorization. _Available in: v37.0_ _Filter group: Small_ * `name` (_string_) The name of the OAuth service provider. _Available in: v37.0_ _Filter group: Small_ ### EmailMergeFieldCollection The merge fields for an object. * `mergeFields` (_array of string_) List of merge fields for a single object. _Available in: v39.0_ _Filter group: Small_ ### CleanDataServiceOutput A data service associated with an active data integration rule. * `cleanDataServiceId` (_string (Id)_) ID of the data service associated with a data integration rule for a record. _Available in: v37.0_ _Filter group: Small_ * `dataServiceMasterLabel` (_string_) Name of the data service associated with a data integration rule for a record. _Available in: v37.0_ _Filter group: Small_ ### CleanMetricOutput Metrics for a data service associated with an active data integration rule. * `cleanRuleErrorsUrl` (_string_) URL where update errors for the data service can be downloaded. _Available in: v37.0_ _Filter group: Small_ * `cleanRuleId` (_string (Id)_) ID of the data integration rule that uses the data service. _Available in: v37.0_ _Filter group: Small_ * `cleanRuleName` (_string_) Name of the data integration rule that uses the data service. _Available in: v37.0_ _Filter group: Small_ * `entityName` (_string_) Name of the record type associated with the data service. _Available in: v37.0_ _Filter group: Small_ * `errorCount` (_integer_) Number of records with update errors for the data integration rule. _Available in: v37.0_ _Filter group: Small_ * `matchedRecords` (_integer_) Number of records with a data integration rule status of In Sync, Different, or Skipped. _Available in: v37.0_ _Filter group: Small_ * `processedRecords` (_integer_) Number of records processed by the data integration rule. _Available in: v37.0_ _Filter group: Small_ * `totalRecords` (_integer_) Number of total records that are available for processing by the data integration rule. _Available in: v37.0_ _Filter group: Small_ ### CleanStatusOutput Status of an active data integration rule for a record. * `dataServiceName` (_string_) Data service associated with the data integration rule. _Available in: v37.0_ _Filter group: Small_ * `lastCleanDate` (_string (date-time)_) Date when the record was last updated with the data integration rule in ISO 8601 format. _Available in: v37.0_ _Filter group: Small_ * `needCompare` (_boolean_) Indicates whether there are field value differences between the Salesforce record and the matching record in the data service. _Available in: v37.0_ _Filter group: Small_ * `ruleId` (_string (Id)_) ID of the data integration rule. _Available in: v37.0_ _Filter group: Small_ * `ruleName` (_string_) Name of the data integration rule. _Available in: v37.0_ _Filter group: Small_ * `status` (_string_) Status of the data integration rule. For more information and available values, see “Statuses for Data Integration” in Salesforce Help. _Available in: v37.0_ _Filter group: Small_ * `statusId` (_string (Id)_) ID of the status for the data integration rule. _Available in: v37.0_ _Filter group: Small_ ### ContentTaxonomyUserSummary Information about a user related to a content taxonomy or its terms. * `id` (_string (Id)_) ID of the user. _Available in: v63.0_ _Filter group: Small_ * `name` (_string_) Name of the user. _Available in: v63.0_ _Filter group: Small_ * `url` (_string (url)_, nullable) Connect REST API resource URL for the user. _Available in: v63.0_ _Filter group: Medium_ ### ContentTaxonomyPath Path to a term in a content taxonomy. * `label` (_string_) Text representation of the path from the root, joined with a delimiter, such as `Fruit>Citrus>Orange` . _Available in: v63.0_ _Filter group: Small_ * `taxonomyFragment` (_object_) ContentTaxonomyPathFragment Path fragment representing the taxonomy. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ContentTaxonomyPathFragment`. * `termFragments` (_array of ContentTaxonomyPathFragment_) Path fragments representing the terms from root term to the term, inclusive. _Available in: v63.0_ _Filter group: Small_ ### LightningModelTypesConfigInput Input for lightning model types configuration. * `descriptor` (_string_, required) Descriptor of type. In the descriptor examples, `apexClassType` is the data type and `c__Hotel` is the name of the Apex class where `c` indicates the default namespace for all custom types: `apexClassType/c__Hotel`. Similarly, `apexClassType/c__FlightBookingAgent$Flight` is the descriptor when `FlightBookingAgent` is the parent class with a nested `Flight` Apex class. _Available in: v64.0_ * `editorConfig` (_object_) LightningModelEditorConfigInput Editor configuration of the type. _Available in: v64.0_ Includes all fields of `LightningModelEditorConfigInput`. * `rendererConfig` (_object_) LightningModelRendererConfigInput Renderer configuration of the type. _Available in: v64.0_ Includes all fields of `LightningModelRendererConfigInput`. * `schemaConfig` (_object_) LightningModelSchemaConfigInput Schema configuration of the type. _Available in: v64.0_ Includes all fields of `LightningModelSchemaConfigInput`. * `typeUIConfigOutputOptions` (_LightningModelTypeUIConfigOutputOptionsInput_) ### LightningModelTypes Details about lightning model types. * `description` (_string_) Description of the type from the schema.json. _Available in: v64.0_ _Filter group: Small_ * `descriptor` (_string_) Descriptor of the type from the query parameters. _Available in: v64.0_ _Filter group: Small_ * `developerName` (_string_) Developer name, or API name, of the type. _Available in: v64.0_ _Filter group: Small_ * `editorConfig` (_object_) Editor configuration for the specified target. _Available in: v64.0_ _Filter group: Big_ Additional properties: `object`. * `errorDetails` (_object_) LightningModelTypesError Lightning Model Types error details. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `LightningModelTypesError`. * `id` (_string (Id)_) 18-character ID of the Type. This is returned for the database-based (Custom) types only. _Available in: v64.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix that is associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fully qualified name. _Available in: v64.0_ _Filter group: Small_ * `rendererConfig` (_object_) Renderer configuration for the specified target. _Available in: v64.0_ _Filter group: Big_ Additional properties: `object`. * `schema` (_object_) JSON schema definition (schema.json) of the type. _Available in: v64.0_ _Filter group: Big_ Additional properties: `object`. * `title` (_string_) Title of the type from the schema.json. _Available in: v64.0_ _Filter group: Small_ ### LightningTypeSummary Summary of a lightning type. * `createdBy` (_object_) LightningTypeUser User who created the type. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `LightningTypeUser`. * `createdDate` (_string (date-time)_) Date when the type was created. _Available in: v64.0_ _Filter group: Small_ * `description` (_string_) Description of the type from the schema.json. _Available in: v64.0_ _Filter group: Small_ * `detailUrl` (_string (url)_) URL to detailed information about the type. _Available in: v64.0_ _Filter group: Small_ * `developerName` (_string_) Developer name, or API name, of the type. _Available in: v64.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the Type. This is returned for the database-based (Custom) types only. _Available in: v64.0_ _Filter group: Medium_ * `namespacePrefix` (_string_) Namespace prefix that is associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fully qualified name. _Available in: v64.0_ _Filter group: Medium_ * `source` (_object_) LightningModelTypesSourceEnum Source of the Lightning type. Values are: * `Standard` —Standard type provided out-of-the-box by Salesforce. * `Custom` —Custom type created in the org. * `Managed` —Type that was installed from a managed package. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `LightningModelTypesSourceEnum`. * `title` (_string_) Title of the type from the schema.json. _Available in: v64.0_ _Filter group: Small_ * `updatedBy` (_object_) LightningTypeUser User who updated the type. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `LightningTypeUser`. * `updatedDate` (_string (date-time)_) Date when the type was updated. _Available in: v64.0_ _Filter group: Small_ ### LightningModelTypesSourceEnum Source of the Lightning type. Values are: * `Standard` —Standard type provided out-of-the-box by Salesforce. * `Custom` —Custom type created in the org. * `Managed` —Type that was installed from a managed package. _Available in: v65.0_ _Filter group: Small_ Type: `string`. Allowed values: `Custom`, `Managed`, `Standard`. ### ObjectMetadata Search metadata related to the object. * `dataCategories` (_object_, nullable) Metadata on each data category for the object. _Available in: v63.0_ _Filter group: Small_ Additional properties: `DataCategoryMetadata`. * `fields` (_object_) Metadata on each field of the object. _Available in: v63.0_ _Filter group: Small_ Additional properties: `FieldMetadata`. * `label` (_string_) Name of the object. _Available in: v63.0_ _Filter group: Small_ * `labelPlural` (_string_) Plural name of the object. _Available in: v63.0_ _Filter group: Small_ * `objectApiName` (_string_) API name of the object. _Available in: v63.0_ _Filter group: Small_ * `themeInfo` (_object_) ThemeInfo Theme of the object. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ThemeInfo`. ### Parameters Search query parameters. * `configurationName` (_string_, nullable) The search configuration name. _Available in: v63.0_ _Filter group: Small_ * `dataCategories` (_array of DataCategory_, nullable) The Data Category values. _Available in: v63.0_ _Filter group: Small_ * `displayFields` (_array of string_, nullable) Display fields for the object. _Available in: v63.0_ _Filter group: Small_ * `filters` (_array of Filter_, nullable) Filters for the search. _Available in: v63.0_ _Filter group: Small_ * `highlights` (_boolean_, nullable) Specifies whether search generates a text highlight ( `true` ) or not ( `false` ). The default is `false` . _Available in: v63.0_ _Filter group: Small_ * `offset` (_integer_, nullable) Search page offset position. _Available in: v63.0_ _Filter group: Small_ * `orderBy` (_array of OrderBy_, nullable) Order by list for the results. _Available in: v63.0_ _Filter group: Small_ * `pageSize` (_integer_, nullable) Number of results per page. _Available in: v63.0_ _Filter group: Small_ * `q` (_string_) Query terms for search. _Available in: v63.0_ _Filter group: Small_ * `spellcheck` (_boolean_, nullable) Specifies whether search applies spellcheck ( `true` ) or not ( `false` ). The default is `true` . _Available in: v63.0_ _Filter group: Small_ ### SearchObject Record results for the keyword search. * `displayFields` (_array of string_) Fields to display from the response. _Available in: v63.0_ _Filter group: Small_ * `objectApiName` (_string_) Object API name. _Available in: v63.0_ _Filter group: Small_ * `orderBy` (_array of AppliedOrderBy_) Applied order for object search. _Available in: v63.0_ _Filter group: Small_ * `searchResults` (_array of SearchResult_) Search results from the query. _Available in: v63.0_ _Filter group: Small_ * `spellCorrectionInfo` (_object_) SpellCorrectionInfo Spell correction information for the object search. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `SpellCorrectionInfo`. * `status` (_object_) Status Provides status on the object search such as error messages and warnings. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `Status`. * `pageInfo` (_object_) PageInfo Page position information for the object search. _Available in: v63.0–64.0_ _Filter group: Small_ Includes all fields of `PageInfo`. ### QueryInfo Contains Search query execution information. * `queryId` (_string_, nullable) Unique identifier assigned to a search query to enable tracking usage and analysis of user interactions with search results. _Available in: v65.0_ _Filter group: Small_ * `sobjects` (_object_) Query execution information per object. _Available in: v64.0_ _Filter group: Small_ Additional properties: `ObjectQueryInfo`. * `status` (_object_) Status Status on the object search such as error messages and warnings. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `Status`. ### SearchResultGroup Record results from a keyword search. * `objectApiName` (_string_) Object API name. _Available in: v64.0_ _Filter group: Small_ * `results` (_array of SearchResult_) List of Search results. _Available in: v64.0_ _Filter group: Small_ ### DataCategoryInput Data category. * `categories` (_array of string_) List of the data category name to filter * `groupName` (_string_) Name of the data category group to filter * `operator` (_DataCategoryOperator_) * `categoryName` (_string_, required) Developer name of the data category group. _Available in: v59.0_ * `childCategories` (_array of DataCategoryInput_, required) List of subcategories. _This property is recursive: each item has the same structure as `DataCategoryInput`._ _Available in: v59.0_ ### FilterInput Filter input for object search. * `field` (_string_) Field to use in the filter. _Available in: v63.0_ * `operator` (_object_) FilterOperator Filter operator. Values are: * `EqOp` —Equal * `ExcludesOp` —Excludes * `GtOp` —Greater than * `GteOp` —Greater than or equal * `InOp` —In * `IncludesOp` —Includes * `LikeOp` —Like * `LtOp` —Less than * `LteOp` —Less than or equal * `NeOp` —Not equal * `NinOp` —Not in _Available in: v63.0_ Includes all fields of `FilterOperator`. * `values` (_BooleanList | DoubleList | LongListInput | StringListInput_) Values for the filter. Do not mix data types for filter values, for example, `["A", "B", "C"]` is valid, but `["A", -7, false]` is not valid. _Available in: v63.0_ One of: `BooleanList`, `DoubleList`, `LongListInput`, `StringListInput`. ### OrderByInput Sort order for the search results. * `field` (_string_) Field to order the results by. _Available in: v63.0_ * `order` (_object_) OrderDirection Order direction. Default value is `Ascending` . _Available in: v63.0_ Includes all fields of `OrderDirection`. * `orderNulls` (_object_) OrderNulls Null value order. Values are: * `Firsts` —Null values are sorted first. * `Lasts` —Null values are sorted last. Default value is `Firsts` . _Available in: v63.0_ Includes all fields of `OrderNulls`. ### ObjectQueryInfo Contains search query execution information for the object. * `displayFields` (_array of string_, nullable) Fields to display from the response. _Available in: v64.0_ _Filter group: Small_ * `hasMoreResults` (_boolean_, nullable) Specifies whether there are more records to fetch matching the search query for the object ( `true` ) or not ( `false` ). _Available in: v64.0_ _Filter group: Small_ * `nameField` (_string_, nullable) Name field identifier of the object. _Available in: v64.0_ _Filter group: Small_ * `numberOfMatches` (_integer_, nullable) Number of results for the object matching the search query. _Available in: v64.0_ _Filter group: Small_ * `orderBy` (_array of AppliedOrderBy_, nullable) Applied order for object search. _Available in: v64.0_ _Filter group: Small_ * `source` (_string_, nullable) Source name for the object. _Available in: v64.0_ _Filter group: Small_ * `spellCorrectionInfo` (_object_) SpellCorrectionInfo Spell correction information for the object search. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `SpellCorrectionInfo`. * `status` (_object_) Status Status on the object search such as error messages and warnings. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `Status`. ### SearchResult Record results from a keyword search. * `apiName` (_string_) Object API name. _Available in: v64.0_ _Filter group: Small_ * `chunks` (_array of Chunk_, nullable) Content chunks for the search result. _Available in: v63.0_ _Filter group: Small_ * `fields` (_object_) Field values by API name. _Available in: v63.0_ _Filter group: Small_ Additional properties: `RecordFieldValue`. * `id` (_string (Id)_) ID of the record. _Available in: v63.0_ _Filter group: Small_ * `matchInfo` (_object_) MatchInfo Search information related to the search result. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `MatchInfo`. * `sourceUrl` (_string_, nullable) Source URL from where the record originated. _Available in: v64.0_ _Filter group: Small_ ### RecordsetFilterCriteria Recordset filter criteria and the filtered records. * `criteriaId` (_string (Id)_) Recordset filter criteria ID. _Available in: v53.0_ _Filter group: Big_ * `recordIds` (_array of string (Id)_) List of filtered record IDs. _Available in: v53.0_ _Filter group: Big_ ### CreatedFile Represents a single file created during a fetch optimization files operation. * `contentVersionId` (_string_) ID of the Content Version record created in the org for this file. _Available in: v66.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the file was created successfully. true if the Content Version record was created without errors. _Available in: v66.0_ _Filter group: Small_ ### ShiftPatternError Shifts from pattern error response. * `code` (_string_) Error code. _Available in: v53.0_ _Filter group: Small_ * `invalidServiceResourceId` (_string_) ID of invalid service resource. _Available in: v53.0_ _Filter group: Small_ * `message` (_string_) Error message. _Available in: v53.0_ _Filter group: Small_ ### PlatformActionGroupActivities 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 `ConnectPlatformActionGroupCategoryEnumActivities`. * `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_ ### WorkTypeInput Work type. * `blockTimeAfterAppointmentInMinutes` (_integer_) Period after the appointment that is typically blocked for this work type. _Available in: v49.0_ * `blockTimeBeforeAppointmentInMinutes` (_integer_) Period before the appointment that is typically blocked for this work type. _Available in: v49.0_ * `durationInMinutes` (_integer_) Duration of the appointment in minutes. Required if `id` isn’t provided _Available in: v49.0_ * `id` (_string_) ID of the work type. Required if `durationInMinutes` isn’t provided _Available in: v49.0_ * `operatingHoursId` (_string_) ID of the operating hours. _Available in: v49.0_ * `operatingHoursTimeZone` (_string_) Time zone for the operating hours. _Available in: v49.0_ * `skillRequirements` (_array of SkillRequirementInput_) List of skills required to complete the tasks associated with this work type. _Available in: v49.0_ * `timeFrameEndInMinutes` (_integer_) Ending of the appointment in minutes. _Available in: v49.0_ * `timeFrameStartInMinutes` (_integer_) Beginning of the appointment in minutes. _Available in: v49.0_ ### GetAllAppointmentSlotsListResult Get appointment slots result * `territorySlots` (_array of GetAllAppointmentSlotsTerritorySlot_) List of appointment territory slots. _Available in: v49.0_ _Filter group: Small_ ### GetEngagementChannelTypeListResult Get engagement channel type list result * `engagementChannelTypes` (_array of GetEngagementChannelTypeResult_) List of Engagement Channel Types ### GetGroupAppointmentsListResult Get group appointments result * `groupAppointments` (_array of GroupAppointmentResult_) Get Group Appointments List ### AssignedResourceInput Input representation of the assigned resource details. * `extendedFields` (_array of ExtendedFieldInput_) Custom fields. _Available in: v48.0_ * `isPrimaryResource` (_boolean_) Indicates whether the assigned resource is the primary resource. For multi-resource appointments, only one resource can be a primary resource. Required if multi-resource scheduling is enabled. _Available in: v48.0_ * `isRequiredResource` (_boolean_, required) Indicates whether the assigned resource is a required resource. _Available in: v48.0_ * `serviceResourceId` (_string_, required) Resource who is assigned to the service appointment. _Available in: v48.0_ ### LeadInput Lead input. * `company` (_string_) Lead’s company. _Available in: v48.0_ * `email` (_string_) Lead’s email address. _Available in: v48.0_ * `extendedFields` (_array of ExtendedFieldInput_) Custom fields. _Available in: v48.0_ * `firstName` (_string_) Lead’s first name. _Available in: v48.0_ * `lastName` (_string_, required) Lead’s last name. _Available in: v48.0_ * `phone` (_string_) Lead’s phone number. _Available in: v48.0_ ### ServiceAppointmentInput Input representation of the service appointment details. * `additionalInformation` (_string_) Additional information about the service appointment. _Available in: v48.0_ * `appointmentMode` (_object_) SvcApptModeEnum Mode of the service appointment. The default value is `Regular`. _Available in: v60.0_ Includes all fields of `SvcApptModeEnum`. * `appointmentType` (_string_) Specifies the API name of the appointment type for the service appointment. _Available in: v48.0_ * `attendeeLimit` (_integer_) Maximum number of customers that’s allowed to attend the service appointment. Required if the appointment mode is Group. _Available in: v60.0_ * `city` (_string_) City where the appointment is completed. _Available in: v48.0_ * `comments` (_string_) Comments about the appointment. _Available in: v48.0_ * `contactId` (_string_) Contact associated with the parent record. _Available in: v48.0_ * `country` (_string_) Country where the appointment is completed. _Available in: v48.0_ * `description` (_string_) Description of the appointment. _Available in: v48.0_ * `engagementChannelTypeId` (_string_) ID of the engagement channel type to associate with the appointment. You can use engagement channel type only if: * **Schedule Appointments Using Engagement Channels** is enabled in Salesforce Scheduler Settings in your Salesforce org. * Shifts are defined in the scheduling policy. For more information on setting up shifts in the scheduling policy, see [Define Shift Rules in Scheduling Policy](https://help.salesforce.com/s/articleView?id=platform.ls_use_shifts_to_determine_time_slots.htm&type=5). Engagement channel types are not supported with operating hours rules in the scheduling policy. _Available in: v56.0_ * `extendedFields` (_array of ExtendedFieldInput_) Custom fields. _Available in: v48.0_ * `parentRecordId` (_string_, required) Parent record associated with the appointment. _Available in: v48.0_ * `postalCode` (_string_) Postal code where the appointment is completed. _Available in: v48.0_ * `schedEndTime` (_string (date-time)_) Time at which the appointment is scheduled to end. Ensure the scheduled start time and end time align with the available time slots. _Available in: v48.0_ * `schedStartTime` (_string (date-time)_) Time at which the appointment is scheduled to start. Ensure the scheduled start time and end time align with the available time slots. _Available in: v48.0_ * `serviceTerritoryId` (_string_) Service territory associated with the appointment. _Available in: v48.0_ * `state` (_string_) State where the service appointment is completed. _Available in: v48.0_ * `street` (_string_) Street number and name where the service appointment is completed. _Available in: v48.0_ * `subject` (_string_) Short phrase describing the appointment. _Available in: v48.0_ * `workTypeId` (_string_) Work type associated with the service appointment. If specified, it is added to the service appointment record. _Available in: v48.0_ ### ServiceAppointmentResult Result of the POST method. * `assignedResourceIds` (_array of string_) IDs of the assigned resources _Available in: v48.0_ _Filter group: Small_ * `parentRecordId` (_string_) ID of the parent record. _Available in: v48.0_ _Filter group: Small_ * `serviceAppointmentId` (_string_) ID of the service appointment created. _Available in: v48.0_ _Filter group: Small_ ### GetServiceTerritoriesListResult Get service territories list result * `serviceTerritories` (_array of GetServiceTerritoriesResult_) List of service territories. _Available in: v48.0_ _Filter group: Small_ ### ExtendedFieldInput Input representation for extended fields * `name` (_string_) Extended Field Name * `value` (_string_) Extended Field Value ### WaitlistCheckInResult Output representation of the waitlist check in result. * `participantId` (_string_) ID of the participant who has an appointment. _Available in: v59.0_ _Filter group: Small_ * `serviceAppointmentId` (_string_) ID of the service appointment. _Available in: v59.0_ _Filter group: Small_ * `waitlistParticipantId` (_string_) ID of the waitlist participant. _Available in: v59.0_ _Filter group: Small_ ### WaitlistListResult Output representation of the result of the list of waitlists. * `waitlists` (_array of WaitlistResult_) List of waitlists that are associated with a service appointment. _Available in: v59.0_ _Filter group: Small_ ### ForecastingManager Represents a forecast manager, including their level above a specified user in the forecast hierarchy. * `firstName` (_string_) First name of the forecast manager at this role. _Available in: v36.0_ _Filter group: Small_ * `hierarchyLevel` (_integer_) Level of this forecasting manager above the forecasting manager requested in the hierarchy tree. _Available in: v36.0_ _Filter group: Small_ * `lastName` (_string_) Last name of the forecast manager at this role. _Available in: v36.0_ _Filter group: Small_ * `localizedName` (_string_) Localized name. _Available in: v38.0_ _Filter group: Small_ * `smallPhotoUrl` (_string_) URL to the user’s small photo. _Available in: v41.0_ _Filter group: Small_ * `territory2Id` (_string (Id)_) Unique identifier of the territory attached to this profile. _Available in: v44.0_ _Filter group: Small_ * `territory2Name` (_string_) Name of the territory attached to this profile. _Available in: v44.0_ _Filter group: Small_ * `userId` (_string (Id)_) User ID of the forecast manager user. _Available in: v36.0_ _Filter group: Small_ * `userRoleId` (_string (Id)_) ID for the user role object attached to this profile. _Available in: v36.0_ _Filter group: Small_ * `userRoleName` (_string_) Name of the role of the user. _Available in: v41.0_ _Filter group: Small_ ### ForecastingUser A representation of a forecasting user. * `displayLabel` (_string_) Label of an entry in the user’s dropdown menu on the forecasts page. _Available in: v44.0_ _Filter group: Big_ * `firstName` (_string_) First name of the forecasting user. _Available in: v36.0_ _Filter group: Big_ * `lastName` (_string_) Last name of the forecasting user. _Available in: v36.0_ _Filter group: Big_ * `territoryId` (_string_) ID of a territory that’s included in the user’s dropdown menu on the forecasts page. _Available in: v44.0_ _Filter group: Big_ * `territoryName` (_string_) Name of a territory that’s included in the user’s dropdown menu on the forecasts page. _Available in: v44.0_ _Filter group: Big_ * `userId` (_string_) ID of the forecasting user. _Available in: v36.0_ _Filter group: Big_ ### MyForecasts This is the represenation of a my forecasts entity * `formattedLabel` (_string_) For territory-based forecast types, the composite label of the user and the territory. For role-based forecast types, the user’s full name. _Available in: v44.0_ _Filter group: Big_ * `territoryId` (_string_) TerritoryId of a territory that the forecast user belongs to * `territoryName` (_string_) Territory Name of a territory that the forecast user belongs to * `userId` (_string_) Unique identifier of the forecasting user. _Available in: v44.0_ _Filter group: Small_ * `userRoleId` (_string_) Unique identifier of the forecasting user’s role attached to this profile. _Available in: v44.0_ _Filter group: Small_ ### ForecastingUserAccess Information about whether the context user has access to view another user’s forecast. * `canAccess` (_boolean_) Specifies whether the context user can access the forecast user (`true`) or not (`false`). _Available in: v36.0_ _Filter group: Small_ * `forecastingTypeId` (_string_) ID of the forecast type associated with the hierarchy. Determines which hierarchy to check: user role or territory. _Available in: v43.0_ _Filter group: Small_ * `territory2Id` (_string_) ID of the territory for which we’re checking access. _Available in: v43.0_ _Filter group: Small_ * `userId` (_string_) ID of the user being queried. _Available in: v36.0_ _Filter group: Small_ ### TwbExportFiltersInput Export filters for a Translation Workbench export request. * `contentFilter` (_object_, required) TwbExportContentFilterEnum Content filter. Values are: * `SourceAndTranslations` —Export both source and translations for the target languages specified in `languages`. * `Source` —Export only source language content in the context user’s default language. _Available in: v67.0_ Includes all fields of `TwbExportContentFilterEnum`. * `languages` (_array of string_) Target languages, such as `en` , `es` , or `fr` , for export. Required if `contentFilter` is `SourceAndTranslations` , otherwise ignored _Available in: v67.0_ * `setupComponentsFilter` (_array of string_) Filter by setup component developer or API names, such as `ActionLinkGroupTemplateItem` , `ExternalString` , or `CustomFieldDefinition` . _Available in: v67.0_ * `statusFilter` (_object_, required) TwbExportStatusFilterEnum Status filter. Value are: * `AllRecords` —Export all records regardless of translation status. * `MissingOrOutdated` —Export only missing or outdated translations. _Available in: v67.0_ Includes all fields of `TwbExportStatusFilterEnum`. * `timeRangeFilter` (_object_) TwbTimeRangeFilterInput Date range filter for export. _Available in: v67.0_ Includes all fields of `TwbTimeRangeFilterInput`. * `translationType` (_object_) TwbTranslationTypeEnum Translation type. Values are: * `Data` —Reserved for future use. Specifying `Data` results in an error in version 67.0 and later. * `Metadata` —Export metadata translations, such as setup components. If unspecified, defaults to `Metadata` . _Available in: v67.0_ Includes all fields of `TwbTranslationTypeEnum`. ### TwbExportFormatEnum Export file format. Values are: * `Stf` —Salesforce Translation Format * `Xliff` —XML Localization Interchange File Format _Available in: v67.0_ Type: `string`. Allowed values: `Stf`, `Xliff`. ### TwbJobStatusEnum Status of the import job. _Available in: v67.0_ _Filter group: Small_ Type: `string`. Allowed values: `Cancelled`, `Completed`, `Failed`, `InProgress`, `Pending`. ### TwbDownloadLinkOutput Download link in a Translation Workbench export. * `fileName` (_string_) Name of the export file. _Available in: v67.0_ _Filter group: Small_ * `fileSize` (_integer (int64)_) Size of the export file in bytes. _Available in: v67.0_ _Filter group: Small_ * `language` (_string_) Language code of the export file or `Bilingual` for multi-language exports. _Available in: v67.0_ _Filter group: Small_ * `url` (_string_) Download URL for the export file. _Available in: v67.0_ _Filter group: Small_ ### TwbReportLinkOutput Report link in a Translation Workbench job status. * `fileName` (_string_) Name of the report file. _Available in: v67.0_ _Filter group: Small_ * `reportType` (_object_) TwbReportTypeEnum Type of report. _Available in: v67.0_ _Filter group: Small_ Includes all fields of `TwbReportTypeEnum`. * `url` (_string_) Download URL for the report file. _Available in: v67.0_ _Filter group: Small_ ### TwbImportSummaryOutput Translation Workbench import job summary statistics. * `failedFiles` (_integer_) Number of files that had errors. _Available in: v67.0_ _Filter group: Small_ * `successfulFiles` (_integer_) Number of files processed without errors. _Available in: v67.0_ _Filter group: Small_ * `totalFiles` (_integer_) Total number of files processed. _Available in: v67.0_ _Filter group: Small_ ### PardotBusinessUnitContextItem Pardot business unit context item. * `id` (_string_) ID of the PardotTenant record. _Available in: v55.0_ _Filter group: Small_ * `isCurrent` (_boolean_) Specifies whether the business unit is selected as the context user's current business unit context in the business unit switcher of the Pardot Lightning app (`true`) or not (`false`). _Available in: v55.0_ _Filter group: Small_ * `name` (_string_) Name of the Pardot business unit as it is specified in the `MasterLabel` of the PardotTenant record. _Available in: v55.0_ _Filter group: Small_ ### PrimingRecord Record associated with the briefcase. * `fields` (_object_, nullable) Map of field names and values. _Available in: v64.0_ _Filter group: Small_ Additional properties: `object`. * `id` (_string (Id)_) Record ID. _Available in: v54.0_ _Filter group: Small_ * `systemModstamp` (_string (date-time)_) The systemModstamp of the record. * `systemModStamp` (_string (date)_) `SystemModStamp` of the record. _Available in: v54.0_ _Filter group: Small_ ### PrimingRuleError Priming rule that has an error. * `ruleId` (_string_) ID of the rule that was processed with an error. _Available in: v54.0_ _Filter group: Small_ ### PrimingRecordsStats Statistics for records primed for briefcases. * `recordCountServed` (_integer_) Maximum number of records that can be returned by processed rules. _Available in: v54.0_ _Filter group: Small_ * `recordCountTotal` (_integer_) Maximum number of records that can be returned across all briefcases. _Available in: v54.0_ _Filter group: Small_ * `ruleCountServed` (_integer_) Total number of rules processed in the current relay (including all relay requests made so far). _Available in: v54.0_ _Filter group: Small_ * `ruleCountTotal` (_integer_) Total number of rules across all briefcases. _Available in: v54.0_ _Filter group: Small_ ### ListShareCategory Groups and roles associated with a list. * `imageColor` (_string_) Color of the image for the recipient. _Available in: v44.0_ _Filter group: Small_ * `imageUrl` (_string (url)_) URL of the image for the recipient. _Available in: v44.0_ _Filter group: Small_ * `shareLabel` (_string_) Translated label to show in the UI for this category of shares. _Available in: v44.0_ _Filter group: Small_ * `shareType` (_object_) ListShareType Type of group a list view is shared with. Values are: * `ChannelProgramGroup` —Shared with a channel program. * `Regular` —Shared with a group. * `Role` —Shared with a role. * `RoleAndSubordinates` —Shared with a role and all subordinates types. * `RoleAndSubordinatesInternal` —Shared with a role and subordinates that aren’t partners. * `Territory` —Shared with a territory. * `TerritoryAndSubordinates` —Shared with a territory and its subordinates. _Available in: v44.0_ _Filter group: Small_ Includes all fields of `ListShareType`. * `shares` (_array of ListShare_) List of structures for shared groups. _Available in: v44.0_ _Filter group: Small_ * `sharesListComplete` (_boolean_) Indicates whether the shares list contains all available results (`true`) or not (`false`). _Available in: v44.0_ _Filter group: Small_ ### FlowApprovalProcess Details about a flow approval process, its status, and available actions. * `approvalProcessName` (_string_) The name of the flow approval process. _Available in: v66.0_ _Filter group: Small_ * `availableActions` (_array of FlowApprovalProcessAction_) Available actions for the flow approval process. _Available in: v66.0_ _Filter group: Small_ * `isApprovalInProgress` (_boolean_) Specifies whether one or more approval submissions are in progress ( `true` ) or not ( `false` ). _Available in: v66.0_ _Filter group: Small_ ### FlowOrchestrationStageInstance Orchestration stage instance. * `completionTime` (_string_, nullable) The duration of the stage in seconds. _Available in: v63.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the orchestration stage instance. _Available in: v54.0_ _Filter group: Small_ * `label` (_string_, nullable) Orchestration stage instance label. _Available in: v54.0_ _Filter group: Small_ * `name` (_string_, nullable) Orchestration stage instance name. _Available in: v54.0_ _Filter group: Small_ * `status` (_object_) ConnectFlowOrchestrationStatusEnum Status of the orchestration instance. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectFlowOrchestrationStatusEnum`. * `stepInstances` (_array of FlowOrchestrationStepInstance_) Orchestration stage instance steps. _Available in: v54.0_ _Filter group: Small_ ### ConnectFlowOrchestrationStatusEnum Status of the orchestration instance. _Available in: v54.0_ _Filter group: Small_ Type: `string`. Allowed values: `Canceled`, `Completed`, `Discontinued`, `Error`, `InProgress`, `NotStarted`, `Suspended`. ### NavigationMenuItem Navigation menu item. * `actionType` (_object_) ConnectNavigationMenuItemActionTypeEnum Event, URL type, or modal navigation menu item. Values are: * `Event` —Event-based navigation. `Event` is internal only and can’t be used in custom components. * `ExternalLink` —URL outside of your Experience Cloud site. * `InternalLink` —Relative URL inside your Experience Cloud site. * `Modal` —Modal, such as Account Switcher. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectNavigationMenuItemActionTypeEnum`. * `actionValue` (_string_, nullable) For `Event` action type, the event fully qualified name for the navigation menu item. For `ExternalLink` and `InternalLink` action types, the route URL for the navigation menu item. For `Modal` action type, the component fully qualified name for the navigation menu item. _Available in: v49.0_ _Filter group: Small_ * `imageUrl` (_string (url)_, nullable) URL to the image of the navigation menu item. _Available in: v47.0_ _Filter group: Small_ * `label` (_string_) Label for the navigation menu item. _Available in: v47.0_ _Filter group: Small_ * `pageReference` (_object_) NavigationMenuPageReference Page reference for the navigation menu item. Page reference is returned only for the Storefront Categories data source. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `NavigationMenuPageReference`. * `subMenu` (_array of NavigationMenuItem_) Submenu for the navigation menu item. _This property is recursive: each item has the same structure as `NavigationMenuItem`._ _Available in: v47.0_ _Filter group: Small_ * `target` (_object_) ConnectNavigationMenuItemOpenTargetEnum Target for the navigation menu item. Values are: * `CurrentWindow` —Navigation menu item opens in the current window. * `NewWindow` —Navigation menu item opens in a new window. _Available in: v47.0_ _Filter group: Small_ Includes all fields of `ConnectNavigationMenuItemOpenTargetEnum`. * `url` (_string_) Route URL or event fully qualified name for the navigation menu item. In version 49.0 and later, this information is returned in `actionValue`. _Available in: v47.0–48.0_ _Filter group: Small_ * `urlType` (_string_) URL type or event of the navigation menu item. Values are: * `Event` —Event based navigation. `Event` is internal only and can’t be used in custom components. * `ExternalLink` —URL outside of your Experience Cloud site. * `InternalLink` —Relative URL inside your Experience Cloud site. In version 49.0 and later, this information is returned in `actionType`. _Available in: v47.0–48.0_ _Filter group: Small_ Allowed values: `Event`, `ExternalLink`, `InternalLink`. ### QuipContentDocumentLink Content document link related to a Quip document. * `contentDocumentId` (_string_) ID of the content document. _Available in: v49.0_ _Filter group: Small_ * `quipLinkedEntities` (_array of QuipLinkedEntity_) List of related linked entities. _Available in: v49.0_ _Filter group: Small_ ### PlatformTypeEnum Platform type of messaging channel Type: `string`. Allowed values: `Enhanced`, `Standard`. ### ArticleRecommendationsRuntimeMetric Article recommendations runtime metric. * `activeUserCount` (_integer_) Number of agents who had recommendations displayed. _Available in: v52.0_ _Filter group: Small_ * `attachCount` (_integer_) Number of times recommendations were attached. _Available in: v52.0_ _Filter group: Small_ * `detachCount` (_integer_) Number of times recommendations were detached. _Available in: v52.0_ _Filter group: Small_ * `dismissCount` (_integer_) Number of times recommendations were dismissed. _Available in: v52.0_ _Filter group: Small_ * `engagementCount` (_integer_) Number of times recommendations were clicked to open, hovered, attached, detached, and dismissed. _Available in: v52.0_ _Filter group: Small_ * `engagementUserCount` (_integer_) Number of agents who clicked to open, hovered, attached, detached, and dismissed recommendations. _Available in: v52.0_ _Filter group: Small_ * `hoverOrOpenCount` (_integer_) Number of times recommendations were clicked to open or hovered. _Available in: v52.0_ _Filter group: Small_ * `metricsDate` (_string (date-time)_) Date of metrics computation. Metrics are aggregated on a monthly basis and are computed on the first day of each month for the previous month. _Available in: v52.0_ _Filter group: Small_ * `recommendationCount` (_integer_) Number of recommendations displayed. _Available in: v52.0_ _Filter group: Small_ * `recommendationDisplayedRecordsCount` (_integer_) Number of records where recommendations were displayed. _Available in: v52.0_ _Filter group: Small_ * `recommendationEngagementRecordsCount` (_integer_) Number of records where agents clicked to open, hovered, attached, detached, and dismissed recommendations. _Available in: v52.0_ _Filter group: Small_ ### ReplyRecommendationsMetric Reply recommendations metric. * `activeAgentCount` (_integer_) Number of agents who were shown recommendations (MAU). _Available in: v52.0_ _Filter group: Small_ * `agentsEngaged` (_integer_) Number of agents who interacted with a recommendation. _Available in: v52.0_ _Filter group: Small_ * `conversationsCount` (_integer_) Number of unique conversations in which recommendations were served. _Available in: v52.0_ _Filter group: Small_ * `conversationsWithEngagements` (_integer_) Number of distinct conversations that used the recommendation (post or edit interactions). _Available in: v52.0_ _Filter group: Small_ * `metricsDate` (_string (date-time)_) Date of metrics computation. Metrics are aggregated on a monthly basis and are computed on the first day of each month for the previous month. _Available in: v52.0_ _Filter group: Small_ * `predictionsCount` (_integer_) Number of times recommendations are displayed to agents. _Available in: v54.0_ _Filter group: Small_ * `recommendationsCount` (_integer_) Number of recommendations displayed to agents. _Available in: v52.0_ _Filter group: Small_ * `recommendationsEditCount` (_integer_) Number of times agents edited a recommendation. _Available in: v52.0_ _Filter group: Small_ * `recommendationsNotHelpfulCount` (_integer_) Number of times agents indicated that a recommendation was not helpful. _Available in: v52.0_ _Filter group: Small_ * `recommendationsPostCount` (_integer_) Number of times agents posted a recommendation. _Available in: v52.0_ _Filter group: Small_ ### ActivitySharingTypeEnum Type of sharing operation. * `Everyone` —The activity is shared with everyone. * `MyGroups` —The activity is shared only with a selection of the context user’s groups. * `OnlyMe` —The activity is private. _Available in: v39.0_ Type: `string`. Allowed values: `Everyone`, `MyGroups`, `OnlyMe`. ### ConversationEntry Entry in the conversation. * `clientDuration` (_integer (int64)_) Client duration for the conversation entry, in milliseconds. _Available in: v51.0_ _Filter group: Small_ * `clientTimestamp` (_integer (int64)_) Client timestamp for the conversation entry, in milliseconds. _Available in: v51.0_ _Filter group: Small_ * `identifier` (_string_) Identifier for the conversation entry. _Available in: v51.0_ _Filter group: Small_ * `messageText` (_string_) Message text for the conversation entry. This text is returned only for message entry types containing static content messages of text type. _Available in: v51.0_ _Filter group: Small_ * `relatedRecords` (_array of string_) List of IDs of records related to the conversation entry. Supported related records include the messaging session (`MessagingSession.Id`), voice call (`VoiceCall.Id`), and conversation entry (`ConversationEntry.MessageIdentifier`). _Available in: v52.0_ _Filter group: Small_ * `sender` (_object_) ConversationParticipant Sender for the conversation entry. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ConversationParticipant`. * `serverReceivedTimestamp` (_integer (int64)_) Server received timestamp for the conversation entry, in milliseconds. _Available in: v51.0_ _Filter group: Small_ ### ConversationEntryUpdateInput Conversation entry update. * `identifier` (_string_, required) Identifier of the updated conversation entry. _Available in: v51.0_ * `messageText` (_string_, required) Message text of the updated conversation entry. _Available in: v51.0_ * `relatedRecords` (_array of string_) List of IDs of records to associate with the conversation entry. Supported related records include the messaging session (`MessagingSession.Id`), voice call (`VoiceCall.Id`), and conversation entry (`ConversationEntry.MessageIdentifier`). _Available in: v52.0_ ### ConversationEntryUpdate Conversation entry update result. * `failureReason` (_string_) If the update failed, the reason it failed. _Available in: v51.0_ _Filter group: Small_ * `identifier` (_string_) Identifier for the updated conversation entry. _Available in: v51.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the status of the update attempt is success (`true`) or not (`false`). _Available in: v51.0_ _Filter group: Small_ ### ConversationBulkUploadStatus Status of the bulk upload of a conversation. * `conversationId` (_string_) ID of the conversation. _Available in: v51.0_ _Filter group: Small_ * `errorDetail` (_string_) Error detail for the conversation. _Available in: v51.0_ _Filter group: Small_ * `failedEntryCount` (_integer_) Number of failed entries for the conversation. _Available in: v51.0_ _Filter group: Small_ * `failedEntryIds` (_array of string_) List of failed conversation entry IDs for the conversation. _Available in: v51.0_ _Filter group: Small_ * `lastUpdatedTimestamp` (_integer (int64)_) Timestamp for the last update of the conversation, in milliseconds. _Available in: v51.0_ _Filter group: Small_ * `status` (_string_) Status for the conversation upload request. _Available in: v51.0_ _Filter group: Small_ * `successEntryCount` (_integer_) Number of successful entries for the conversation. _Available in: v51.0_ _Filter group: Small_ * `uploadId` (_string_) Upload ID for the conversation. _Available in: v51.0_ _Filter group: Small_ ### ConversationBulkUpload Conversation bulk upload result. * `conversationIdentifier` (_string_) Identifier for the conversation. _Available in: v51.0_ _Filter group: Small_ * `errorDetail` (_string_) If the upload failed, the reason it failed. _Available in: v51.0_ _Filter group: Small_ * `status` (_string_) Status of the upload attempt. _Available in: v51.0_ _Filter group: Small_ * `uploadId` (_string_) Upload ID for the conversation. _Available in: v51.0_ _Filter group: Small_ ### WorkTypeGroupEstWaitTimeInfo Output representation of the estimated wait time for a specific work type group. * `workTypeGroupEstimatedWaitTime` (_string_) Estimated wait time for the work type group. _Available in: v65.0_ _Filter group: Small_ * `workTypeGroupId` (_string_) ID of the work type group. _Available in: v65.0_ _Filter group: Small_ ### CancelAppointmentInput Input representation for a single appointment to cancel. * `appointmentId` (_string (Id)_) ServiceAppointment ID or ScheduledObject ID (e.g., Interaction). When a ScheduledObject ID is provided, the system resolves the linked ServiceAppointment automatically. * `cancellationReason` (_string_) Reason for canceling the appointment. _Available in: v66.0_ * `referenceId` (_string_) Caller-supplied identifier echoed back on the corresponding entry in the response. Required (and must be unique within the request) when the request contains more than one appointment; optional for single-appointment requests. Format: max 80 characters, pattern {@code \[A-Za-z0-9\_-\]+}. * `schedulingPolicyId` (_string (Id)_) Scheduling policy ID. Used by the ESO/O2 engine for OnField routing. When omitted, the org's default OnSite scheduling policy is applied. Has no effect on the InBusiness branch (no rules evaluated). * `status` (_string_, required) Status to set on the canceled appointment. Must be `Canceled` . _Available in: v66.0_ * `serviceAppointmentId` (_string_, required) ID of the service appointment to cancel. _Available in: v66.0_ ### CancelAppointmentOutput Cancel appointment result * `appointmentId` (_string (Id)_) Canceled appointment ID * `errors` (_array of AppointmentError_) Cancel appointment errors * `referenceId` (_string_) Echoes the {@code referenceId} supplied on the corresponding request appointment, if any. Null when not supplied on the input. ### AppointmentRequestInput Input representation of a single appointment request used for retrieving available slots or candidates. * `assignedResources` (_array of AssignedResourceInputUnifiedScheduling_, required) Service resources to consider for the appointment. Each entry must set `isRequiredResource` to `true` . `isPrimaryResource` isn't supported on this operation. _Available in: v66.0_ * `auxiliaryDetails` (_object_, required) AuxiliaryDetailsInput Additional appointment details, such as engagement channel types. _Available in: v66.0_ Includes all fields of `AuxiliaryDetailsInput`. * `coreDetails` (_object_, required) CoreDetailsInput Core appointment details, including the start and end of the search window, work configuration, and location constraints. _Available in: v66.0_ Includes all fields of `CoreDetailsInput`. * `filterByResources` (_array of string_) IDs of service resources for which to restrict the slot or candidate search. _Available in: v66.0_ * `operatingHoursId` (_string (Id)_) Operating hours ID for OnField GetSlots. Required for this operation — ESO uses this to determine which timeslots to generate for the resource. A resource can belong to multiple territories each with different operating hours. No fallback; ESO will error if omitted. * `schedulingMethod` (_object_, required) SchedulingMethodEnum Scheduling method for the appointment. Valid value is `OnSite` . _Available in: v66.0_ Includes all fields of `SchedulingMethodEnum`. * `schedulingPolicyId` (_string (Id)_) ID of the scheduling policy to apply. _Available in: v66.0_ * `serviceAppointmentId` (_string (Id)_) Service appointment ID for OnField In-DB mode. When provided without coreDetails, the system reads all appointment details (time window, work type, territory) directly from the existing ServiceAppointment record in the database. * `serviceAppointmentParent` (_object_) ServiceAppointmentParentInput Parent record that the service appointment is associated with, such as an account or a lead. _Available in: v66.0_ Includes all fields of `ServiceAppointmentParentInput`. * `timeZoneId` (_string_) TimeZoneSidKey value for slot generation (OnField GetSlots). Optional — if omitted, the Unified layer defaults to GMT (matching the Salesforce platform default). Note: a territory spanning multiple time zones may yield unexpected results with the GMT default. Recommend Unified API PM review before mandating this field. ### AppointmentCandidatesResult Output representation of candidate appointment time slots with assigned resources for a single input request. * `candidates` (_array of AppointmentCandidateOutput_) Candidate appointment time slots with assigned resources that match the input request. _Available in: v66.0_ _Filter group: Big_ ### AppointmentSlotsResult Output representation of available appointment time slots for a single input request. * `slots` (_array of AppointmentSlotOutput_) Available appointment time slots that match the input request. _Available in: v66.0_ _Filter group: Big_ ### RescheduleAppointmentInput Input representation for a single appointment to reschedule. * `appointmentId` (_string (Id)_, required) ID of the service appointment to reschedule. _Available in: v66.0_ * `assignedResources` (_array of RescheduleAssignedResourceInput_) Service resources to add, update, or remove on the rescheduled appointment. Omit to keep the existing resource assignments. _Available in: v66.0_ * `endTime` (_string (date-time)_, required) New end time for the appointment, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). _Available in: v66.0_ * `referenceId` (_string_) Caller-supplied identifier echoed back on the corresponding entry in the response. Required (and must be unique within the request) when the request contains more than one appointment; optional for single-appointment requests. Format: max 80 characters, pattern {@code \[A-Za-z0-9\_-\]+}. * `schedulingMethod` (_object_, required) SchedulingMethodEnum Scheduling method for the appointment. Valid value is `OnSite` . _Available in: v66.0_ Includes all fields of `SchedulingMethodEnum`. * `schedulingPolicyId` (_string (Id)_) ID of the scheduling policy to apply. _Available in: v66.0_ * `startTime` (_string (date-time)_, required) New start time for the appointment, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). _Available in: v66.0_ ### AppointmentOutput Output representation of a single scheduled or rescheduled appointment. * `errors` (_array of AppointmentError_) Errors that occurred for this appointment. Empty when the operation succeeds. _Available in: v66.0_ _Filter group: Big_ * `operation` (_object_) OperationEnum Operation performed for this appointment. Valid values are `CreateOperation` , `UpdateOperation` , and `DeleteOperation` . _Available in: v66.0_ _Filter group: Big_ Includes all fields of `OperationEnum`. * `reason` (_string_) The reason the appointment was changed * `referenceId` (_string_) Echoes the {@code referenceId} supplied on the corresponding request appointment, if any. Null for {@code Affected} appointments (which are produced by the scheduling engine and do not correspond to a single input appointment). * `scheduledObject` (_ScheduledObjectResultOutput_) * `schedulingStatus` (_object_) SchedulingStatusEnum Status of the scheduling operation. Valid values are `Success` , `ScheduleError` , and `PersistError` . _Available in: v66.0_ _Filter group: Big_ Includes all fields of `SchedulingStatusEnum`. * `schedulingType` (_object_) SchedulingTypeEnum Type of scheduling action. Valid values are `Requested` and `Affected` . _Available in: v66.0_ _Filter group: Big_ Includes all fields of `SchedulingTypeEnum`. * `serviceAppointment` (_object_) ServiceAppointmentResultOutput Identifiers of the created or updated service appointment and its assigned resources. _Available in: v66.0_ _Filter group: Big_ Includes all fields of `ServiceAppointmentResultOutput`. ### ResourceAbsenceOutput ResourceAbsence (or LunchBreak) record produced as a side-effect of scheduling. ### ScheduleAppointmentInput Input representation for a single appointment to schedule. * `assignedResources` (_array of AppointmentAssignedResourceInput_, required) Service resources to assign to the appointment. _Available in: v66.0_ * `auxiliaryDetails` (_object_) AuxiliaryDetailsInput Additional appointment details, such as the engagement channel type. _Available in: v66.0_ Includes all fields of `AuxiliaryDetailsInput`. * `coreDetails` (_object_, required) CoreDetailsInput Core appointment details, including start and end time, status, and work configuration. _Available in: v66.0_ Includes all fields of `CoreDetailsInput`. * `referenceId` (_string_) Caller-supplied identifier echoed back on the corresponding entry in the response. Required (and must be unique within the request) when the request contains more than one appointment; optional for single-appointment requests. Used to correlate response appointments to request appointments in bulk requests where input order alone is insufficient (e.g. response interleaves Affected outputs). Format: max 80 characters, pattern {@code \[A-Za-z0-9\_-\]+} (matches Salesforce Composite API convention). * `scheduledObjectApiName` (_string_) Scheduled object API name * `scheduledObjectId` (_string (Id)_) ID of an existing scheduled object (Interaction, Visit, etc.) to link to the ServiceAppointment. The entity type is resolved at runtime from the ID key prefix. Mutually exclusive with scheduledObjectApiName. * `schedulingMethod` (_object_, required) SchedulingMethodEnum Scheduling method for the appointment. Valid value is `OnSite` . _Available in: v66.0_ Includes all fields of `SchedulingMethodEnum`. * `schedulingPolicyId` (_string (Id)_) ID of the scheduling policy to apply. _Available in: v66.0_ * `serviceAppointmentId` (_string (Id)_) ID of an existing ServiceAppointment to use instead of creating a new one. Mutually exclusive with coreDetails, serviceAppointmentParent, and assignedResources. * `serviceAppointmentParent` (_object_, required) ServiceAppointmentParentInput Parent record that the service appointment is associated with, such as an account or a lead. _Available in: v66.0_ Includes all fields of `ServiceAppointmentParentInput`. ### ConsentStatusKey Represents a single consent status key for querying * `additionalConsentOptions` (_string_) Additional consent options * `additionalConsentParameters` (_string_) Additional consent parameters * `additionalPartitionId` (_string_) The additional partition ID * `brand` (_string_) The brand * `consentCaptureTime` (_string (date-time)_) The consent capture time * `consentDoiCapture` (_string (date-time)_) The consent double opt-in capture time * `consentEffectiveFrom` (_string (date-time)_) The consent effective from date * `consentEffectiveTo` (_string (date-time)_) The consent effective to date * `consentGiver` (_string_) The consent giver * `consentGiverRecordId` (_string_) The consent giver record ID * `consentObjectRecordId` (_string_) The consent object record ID * `consentObjectSourceRecordId` (_string_) The consent object source record ID * `consentPurpose` (_string_) Used to be Communication Subscription * `consentStatus` (_string_) The consent status * `consentType` (_string_) The consent type * `consentingType` (_string_) The consenting type * `contactPointSourceRecord` (_string_) The contact point source record * `contactPointType` (_string_) The contact point type * `contactPointTypeRecordId` (_string_) The contact point type record ID * `contactPointValue` (_string_) The contact point value * `dataSubjectKey` (_string_) The data subject key * `dataSubjectRecordId` (_string_) The data subject record ID * `dataUsePurpose` (_string_) The data use purpose * `dataUsePurposeRecordId` (_string_) The data use purpose record ID * `engagementChannel` (_string_) The engagement channel * `engagementChannelSourceRecordId` (_string_) The engagement channel source record ID * `globalConsentKey` (_string_) The global consent key, stored as MASTER\_ALTERNATE\_KEY in the database * `guId` (_string_) The unique identifier for the consent record * `masterAlternateKeyFormatId` (_string_) The master alternate key format core id * `residencyCountry` (_string_) The residency country * `residencyStateProvince` (_string_) The residency state/province ### ConsentStatusEntry Represents a single consent status entry * `additionalConsentOptions` (_string_) Additional consent options * `additionalConsentParameters` (_string_) Additional consent parameters * `additionalPartitionId` (_string_) The additional partition ID * `brand` (_string_) The brand * `consentCaptureTime` (_string (date-time)_) The consent capture time * `consentDoiCapture` (_string (date-time)_) The consent double opt-in capture time * `consentEffectiveFrom` (_string (date-time)_) The consent effective from date * `consentEffectiveTo` (_string (date-time)_) The consent effective to date * `consentGiver` (_string_) The consent giver * `consentGiverRecordId` (_string_) The consent giver record ID * `consentObjectRecordId` (_string_) The consent object record ID * `consentObjectSourceRecordId` (_string_) The consent object source record ID * `consentPurpose` (_string_) Used to be Communication Subscription * `consentStatus` (_string_) The consent status * `consentType` (_string_) The consent type * `consentingType` (_string_) The consenting type * `contactPointSourceRecord` (_string_) The contact point source record * `contactPointType` (_string_) The contact point type * `contactPointTypeRecordId` (_string_) The contact point type record ID * `contactPointValue` (_string_) The contact point value * `dataSubjectKey` (_string_) The data subject key * `dataSubjectRecordId` (_string_) The data subject record ID * `dataUsePurpose` (_string_) The data use purpose * `dataUsePurposeRecordId` (_string_) The data use purpose record ID * `engagementChannel` (_string_) The engagement channel * `engagementChannelSourceRecordId` (_string_) The engagement channel source record ID * `globalConsentKey` (_string_) The global consent key, stored as MASTER\_ALTERNATE\_KEY in the database * `guid` (_string_) The unique identifier for the consent record * `masterAlternateKeyFormatId` (_string_) The master alternate key format core id * `residencyCountry` (_string_) The residency country * `residencyStateProvince` (_string_) The residency state/province ### ConsentStatusWriteEntry Represents a single consent status entry for writing * `additionalConsentOptions` (_string_) Additional consent options * `additionalConsentParameters` (_string_) Additional consent parameters * `additionalPartitionId` (_string_) The additional partition ID * `brand` (_string_) The brand * `consentCaptureTime` (_string (date-time)_) The consent capture time * `consentDoiCapture` (_string (date-time)_) The consent double opt-in capture time * `consentEffectiveFrom` (_string (date-time)_) The consent effective from date * `consentEffectiveTo` (_string (date-time)_) The consent effective to date * `consentGiver` (_string_) The consent giver * `consentGiverRecordId` (_string_) The consent giver record ID * `consentObjectRecordId` (_string_) The consent object record ID * `consentObjectSourceRecordId` (_string_) The consent object source record ID * `consentPurpose` (_string_) Used to be Communication Subscription * `consentStatus` (_string_, required) The consent status * `consentType` (_string_, required) The consent type * `consentingType` (_string_) The consenting type * `contactPointSourceRecord` (_string_) The contact point source record * `contactPointType` (_string_) The contact point type * `contactPointTypeRecordId` (_string_) The contact point type record ID * `contactPointValue` (_string_) The contact point value * `dataSubjectKey` (_string_, required) The data subject key * `dataSubjectRecordId` (_string_) The data subject record ID * `dataUsePurpose` (_string_) The data use purpose * `dataUsePurposeRecordId` (_string_) The data use purpose record ID * `engagementChannel` (_string_) The engagement channel * `engagementChannelSourceRecordId` (_string_) The engagement channel source record ID * `globalConsentKey` (_string_, required) The global consent key, stored as MASTER\_ALTERNATE\_KEY in the database * `masterAlternateKeyFormatId` (_string_, required) The master alternate key format core id * `residencyCountry` (_string_) The residency country * `residencyStateProvince` (_string_) The residency state/province ### ConsentStatusWriteReference Represents a reference entry for written consent * `dataSubjectKey` (_string_) The data subject key * `globalConsentKey` (_string_) The global consent key, stored as MASTER\_ALTERNATE\_KEY in the database ### ConsentExportJobScope Scope of a Global Consent Store export job. * `globalConsentDefinitions` (_array of string_) Ids of the Global Consent Definitions to export. When omitted, all definitions in scope for the org are exported. ### MicrobatchingErrorRecordInfo Microbatching error record information. * `contentDocumentIds` (_array of string_) List of content document IDs used to create content document links between files and records. _Available in: v56.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the failed record. _Available in: v54.0_ _Filter group: Small_ * `errorCategory` (_string_) Error category of the failed record. _Available in: v54.0_ _Filter group: Small_ * `errorCode` (_string_) API error code associated with the failed record. _Available in: v54.0_ _Filter group: Small_ * `errorMessage` (_string_) Error message associated with the failed record. _Available in: v54.0_ _Filter group: Small_ * `groupBy` (_string_) Optional grouping associated with the failed record. _Available in: v54.0_ _Filter group: Small_ * `keyPrefix` (_string_) Key prefix of the failed record. _Available in: v54.0_ _Filter group: Small_ * `networkId` (_string_) Experience Cloud site ID of the failed record. _Available in: v54.0_ _Filter group: Small_ * `processType` (_string_) Process type of the failed record. _Available in: v54.0_ _Filter group: Small_ * `recordUUID` (_string_) Record UUID of the failed record. _Available in: v54.0_ _Filter group: Small_ * `requestBody` (_array of MicrobatchingErrorRecordInfoRequestBody_) Request body of the failed record. _Available in: v54.0_ _Filter group: Small_ * `retryCount` (_integer_) Manual resubmission retry count. _Available in: v54.0_ _Filter group: Small_ * `status` (_string_) Status of the failed record. _Available in: v54.0_ _Filter group: Small_ ### ConnectActionLinkTypeEnum Defines the type of action link. 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. Use `Ui` if you need to load a page before the user performs an action, for example, to have the user provide input or view something before the action happens. Can be defined in an action link template. _Available in: v33.0_ Type: `string`. Allowed values: `Api`, `ApiAsync`, `Download`, `Ui`. ### RequestHeaderInput An HTTP request header name and value pair. * `name` (_string_, required) The name of the request header. _Available in: v33.0_ * `value` (_string_, required) The value of the request header. _Available in: v33.0_ ### ConnectHttpRequestMethod One of these HTTP methods: * `HttpDelete` —Returns HTTP 204 on success. Response body or output class is empty. * `HttpGet` —Returns HTTP 200 on success. * `HttpHead` —Returns HTTP 200 on success. Response body or output class is empty. * `HttpPatch` —Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty. * `HttpPost` —Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success. * `HttpPut` —Return HTTP 200 on success or HTTP 204 if the response body or output class is empty. Can be defined in an action link template. _Available in: v33.0_ Type: `string`. Allowed values: `HttpDelete`, `HttpGet`, `HttpHead`, `HttpPatch`, `HttpPost`, `HttpPut`. ### RequestHeader An HTTP request header name and value pair. * `name` (_string_) The name of the request header. _Available in: v33.0_ _Filter group: Small_ * `value` (_string_) The value of the request header. _Available in: v33.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_ ### OutOfOffice User's out-of-office message. * `message` (_string_) Out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ ### 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_ ### 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 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`. ### NotificationAction Notification action detail. * `actionKey` (_string_) Unique action identifier. _Available in: v66.0_ _Filter group: Small_ * `label` (_string_) Label for action. _Available in: v66.0_ _Filter group: Small_ * `name` (_string_) Name of action. _Available in: v66.0_ _Filter group: Small_ * `pushEnabled` (_boolean_) Specifies if the action is enabled for push notification (`true`) or not (`false`). _Available in: v68.0_ _Filter group: Small_ * `type` (_string_) Type of action taken by the mobile app. Valid values are: * `NotificationApiAction` —Client makes an API call to execute the notification action. * `Share` —Client-side action to share notification content. _Available in: v66.0_ _Filter group: Small_ Allowed values: `NotificationApiAction`, `Share`. ### DataCategoryInputKnowledge Data category. * `categoryName` (_string_, required) Developer name of the data category group. _Available in: v59.0_ * `childCategories` (_array of DataCategoryInputKnowledge_, required) List of subcategories. _This property is recursive: each item has the same structure as `DataCategoryInputKnowledge`._ _Available in: v59.0_ ### DataCategoryKnowledge Data category. * `categoryName` (_string_) Developer name of the data category. _Available in: v59.0_ _Filter group: Small_ * `childCategories` (_array of DataCategoryKnowledge_) List of subcategories. _This property is recursive: each item has the same structure as `DataCategoryKnowledge`._ _Available in: v59.0_ _Filter group: Small_ * `label` (_string_) Label of the data category. _Available in: v59.0_ _Filter group: Small_ ### FilesConnectRepositorySbi Description of a Content Hub repository. * `authentication` (_FilesConnectRepositoryAuthenticationSbi_) * `features` (_FilesConnectRepositoryFeaturesSbi_) * `id` (_string (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `label` (_string_) The repository label. * `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_) Reference 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 `Reference`. * `name` (_string_) The repository name. * `providerType` (_FilesConnectProviderTypeSbi_) * `rootFolderItemsUrl` (_string (url)_) URL to the Connect resource for the list of items in the repository root folder. * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### ExternalFilePermissionInformationSbi External file permissions related information * `externalFilePermissionTypes` (_array of FilesConnectPermissionTypeSbi_) 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` (_string_) 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_ Allowed values: `DomainSharing`, `PrivateSharing`, `PublicSharing`. * `repositoryPublicGroups` (_array of RepositoryGroupSummarySbi_) 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_ ### ModerationFlagsSbi Represents a number of flags on a feed item or comment. * `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_) ModerationFlagsCollectionSbi Collection of flags. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ModerationFlagsCollectionSbi`. ### ConnectFilePublishStatusEnum Specifies the publish status of a file. Type: `string`. Allowed values: `PendingAccess`, `PrivateAccess`, `PublicAccess`. ### ConnectFileSharingOptionEnum Specifies the sharing option of a file. 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. Type: `string`. Allowed values: `Admin`, `Collaborator`, `Owner`, `Viewer`, `WorkspaceManaged`. ### ExternalAuthIdentityProviderParamType Parameter type for an external auth identity provider. _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `AuthorizeRequestQueryParameter`, `IdentityProviderOptions`, `ManagedByComponent`, `ManagedByFeature`, `RefreshRequestBodyParameter`, `RefreshRequestHttpHeader`, `RefreshRequestQueryParameter`, `SfHttpRequestExtensionName`, `TokenRequestBodyParameter`, `TokenRequestHttpHeader`, `TokenRequestQueryParameter`. ### ExternalCredentialParameterType Parameter type of the external credential. _Available in: v57.0_ _Filter group: Small_ Type: `string`. Allowed values: `AdditionalRefreshStatusCode`, `AuthParameter`, `AuthProvider`, `AuthProviderUrl`, `AuthProviderUrlQueryParameter`, `ExternalAuthIdentityProvider`, `JwtBodyClaim`, `JwtHeaderClaim`, `ManagedByComponent`, `ManagedByFeature`, `SfHttpRequestExtensionName`, `SigningCertificate`. ### ExternalCredentialPrincipalAccess External credential principal access. * `developerName` (_string_) Developer name of the associated access entity. _Available in: v58.0_ _Filter group: Small_ * `id` (_string_) ID of the associated access entity. _Available in: v58.0_ _Filter group: Small_ * `type` (_object_) ExternalCredentialPrincipalAccessType Access type of the external credential principal. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `ExternalCredentialPrincipalAccessType`. ### NamedCredentialParameterManagedByFeatureCapabilitiesInput Named Credential Managed By Feature parameter capabilities input representation * `globalNamedPrincipalCredential` (_boolean_) Enables the Global Named Principal capability * `managedFeatureEnabledCallout` (_boolean_) Enables the Managed Feature Enabled Callout capability * `readOnlyNamedCredential` (_boolean_) Enables the Read Only capability * `systemUserNamedCredential` (_boolean_) Enables the System User capability ### NamedCredentialParameterType Type of named credential parameter. One of these values: * `AllowedManagedPackageNamespaces` * `ClientCertificate` * `ConnectionStatus` * `CustomParameter`: `CustomParameter` is available only for named credentials with the `ExternalKnowledge` type. * `ManagedByComponent` * `ManagedByFeature` * `ManagedByNamespace` * `SfHttpRequestExtensionName` Type: `string`. Allowed values: `AllowedManagedPackageNamespaces`, `ClientCertificate`, `ConnectionStatus`, `CustomParameter`, `ManagedByComponent`, `ManagedByFeature`, `ManagedByNamespace`, `SfHttpRequestExtensionName`. ### NamedCredentialParameterManagedByFeatureCapabilities Output representation for Named Credential Parameter Managed By Feature Capabilities * `globalNamedPrincipalCredential` (_boolean_) Enables the Global Named Principal capability * `managedFeatureEnabledCallout` (_boolean_) Enables the Managed Feature Enabled Callout capability * `readOnlyNamedCredential` (_boolean_) Enables the Read Only capability * `systemUserNamedCredential` (_boolean_) Enables the System User capability ### AbstractNBATarget A base class for a recommendation target returned by a recommendation strategy * `type` (_NBATargetTypeEnum_) ### AbstractNBAAction A base class for a recommended action returned by a recommendation strategy * `parameters` (_array of NextBestActionParameter_) List of parameters to pass to the action. _Available in: v45.0_ _Filter group: Small_ * `type` (_object_) NBAActionTypeEnum Type of action. Values are: * `Flow` —Automated process tool with multiple subtypes. _Available in: v45.0_ _Filter group: Small_ Includes all fields of `NBAActionTypeEnum`. ### StrategyTraceNode A trace node for a recommendation strategy execution. * `inputCount` (_integer_) Number of items put into the node. _Available in: v45.0_ _Filter group: Small_ * `messages` (_array of string_) Messages that occurred during node execution. _Available in: v45.0_ _Filter group: Small_ * `nodeName` (_string_) Name of the node. _Available in: v45.0_ _Filter group: Small_ * `nodeTime` (_integer (int64)_) Time spent processing inside the node. _Available in: v45.0_ _Filter group: Small_ * `nodeType` (_string_) Type of node. _Available in: v45.0_ _Filter group: Small_ * `outputCount` (_integer_) Number of items returned from the node. _Available in: v45.0_ _Filter group: Small_ * `outputs` (_array of string_) Recommendations that are returned from the node. _Available in: v45.0_ _Filter group: Small_ * `totalTime` (_integer (int64)_) Total time spent processing. _Available in: v45.0_ _Filter group: Small_ ### SurveyQuestionResponseInput Input representation of the details of the response to a question on the survey page. * `name` (_string_, required) The API name of survey question. _Available in: v56.0_ * `questionType` (_string_, required) The type of survey question. _Available in: v56.0_ ### SurveyPageTypeEnum The Enum class for Page type in Survey Type: `string`. Allowed values: `QuestionPage`, `ThankYouPage`. ### SurveyNpsQuestionOutput Output representation of the details of the NPS question on the survey page. * `description` (_string_) The description for the survey question. _Available in: v56.0_ _Filter group: Small_ * `isResponseRequired` (_boolean_) Indicates whether the response to the question is mandatory ( `true` ) or not ( `false` ). _Available in: v56.0_ _Filter group: Small_ * `label` (_string_) The label of the survey question. _Available in: v56.0_ _Filter group: Small_ * `maxScale` (_integer_) Maximum score that participants can select for an NPS question in the survey. _Available in: v56.0_ _Filter group: Small_ * `minScale` (_integer_) Minimum score that participants can select for an NPS question in the survey. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey question. _Available in: v56.0_ _Filter group: Small_ * `questionType` (_string_) The type of survey question. _Available in: v56.0_ _Filter group: Small_ * `responseDataType` (_string_) The data type of the survey question. _Available in: v56.0_ _Filter group: Small_ * `responseValue` (_integer_) Value of the response to an NPS question in a survey. _Available in: v57.0_ _Filter group: Small_ ### SurveySelectionQuestionOutput Output representation of the details of the boolean, rating, single-selection, or multiple-selection question on the survey page. * `description` (_string_) The description for the survey question. _Available in: v56.0_ _Filter group: Small_ * `isResponseRequired` (_boolean_) Indicates whether the response to the question is mandatory ( `true` ) or not ( `false` ). _Available in: v56.0_ _Filter group: Small_ * `label` (_string_) The label of the survey question. _Available in: v56.0_ _Filter group: Small_ * `maxChoicesAllowed` (_integer_) Maximum number of choices for a multiple-choice question. _Available in: v65.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey question. _Available in: v56.0_ _Filter group: Small_ * `questionChoices` (_array of SurveySelectionQuestionChoiceOutput_) Choices that are available for a boolean, rating, single-selection, or multiple-selection question in a survey. _Available in: v56.0_ _Filter group: Small_ * `questionType` (_string_) The type of survey question. _Available in: v56.0_ _Filter group: Small_ * `responseDataType` (_string_) The data type of the survey question. _Available in: v56.0_ _Filter group: Small_ * `responseValues` (_array of string_) List of survey response values for a selected question. _Available in: v57.0_ _Filter group: Small_ ### SurveyShortTextQuestionOutput Output representation of the details of the short-text question on the survey page. * `description` (_string_) The description for the survey question. _Available in: v56.0_ _Filter group: Small_ * `isResponseRequired` (_boolean_) Indicates whether the response to the question is mandatory ( `true` ) or not ( `false` ). _Available in: v56.0_ _Filter group: Small_ * `label` (_string_) The label of the survey question. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey question. _Available in: v56.0_ _Filter group: Small_ * `questionType` (_string_) The type of survey question. _Available in: v56.0_ _Filter group: Small_ * `responseDataType` (_string_) The data type of the survey question. _Available in: v56.0_ _Filter group: Small_ * `responseValue` (_string_) Value of the response to a short-text question in a survey. _Available in: v57.0_ _Filter group: Small_ * `validationFormula` (_string_) Validation regex for the short text question. _Available in: v56.0_ _Filter group: Small_ ### SurveyTextQuestionOutput Output representation of the details of the text question on the survey page. * `description` (_string_) The description for the survey question. _Available in: v56.0_ _Filter group: Small_ * `isResponseRequired` (_boolean_) Indicates whether the response to the question is mandatory ( `true` ) or not ( `false` ). _Available in: v56.0_ _Filter group: Small_ * `label` (_string_) The label of the survey question. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey question. _Available in: v56.0_ _Filter group: Small_ * `questionType` (_string_) The type of survey question. _Available in: v56.0_ _Filter group: Small_ * `responseDataType` (_string_) The data type of the survey question. _Available in: v56.0_ _Filter group: Small_ * `responseValue` (_string_) Value of the response to a long-text question in a survey. _Available in: v57.0_ _Filter group: Small_ ### SurveyQuestionOutput Output representation of the details of the question on the survey page. * `description` (_string_) The description for the survey question. _Available in: v56.0_ _Filter group: Small_ * `isResponseRequired` (_boolean_) Indicates whether the response to the question is mandatory ( `true` ) or not ( `false` ). _Available in: v56.0_ _Filter group: Small_ * `label` (_string_) The label of the survey question. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey question. _Available in: v56.0_ _Filter group: Small_ * `questionType` (_string_) The type of survey question. _Available in: v56.0_ _Filter group: Small_ * `responseDataType` (_string_) The data type of the survey question. _Available in: v56.0_ _Filter group: Small_ ### SurveyURLButtonsOutput Output representation of the details of the URL buttons on the Thank You page in the survey. * `label` (_string_) The label specified for a button on the Thank You page. _Available in: v56.0_ _Filter group: Small_ * `url` (_string_) The URL specified for a button on the Thank You page. _Available in: v56.0_ _Filter group: Small_ ### ConnectPeriodTypesEnum Time period used for forecasting. _Available in: v38.0_ _Filter group: Small_ Type: `string`. Allowed values: `Month`, `Quarter`, `Week`, `Year`. ### MaintenanceTypeEnum Type of maintenance. One of these values: * `Downtime`: Downtime maintenance. * `GenerallyAvailable`: Generally available mode. * `MaintenanceAndAvailable`: Maintenance with available mode. * `MaintenanceWithDowntime`: Scheduled maintenance with downtime. * `ReadOnly`: Maintenance with read-only mode. * `ServiceAgreement`: Service agreement maintenance. Type: `string`. Allowed values: `Downtime`, `GenerallyAvailable`, `MaintenanceAndAvailable`, `MaintenanceWithDowntime`, `ReadOnly`, `ServiceAgreement`. ### TimeZone User's time zone as selected in the user’s personal settings in Salesforce. This value doesn’t reflect a device's current location. * `gmtOffset` (_number (double)_) Signed offset, in hours, from GMT _Available in: v30.0_ _Filter group: Small_ * `name` (_string_) Display name of this time zone _Available in: v30.0_ _Filter group: Small_ ### ProductAttributeInput Input representation of the product attribute * `attributeDefinitionId` (_string_) Attribute Definition record Id * `attributePicklistValueId` (_string_) Attribute Picklist value Id * `attributeValue` (_string_) Valid value of the Attribute ### ConnectorsCallTypeEnum Type of call. _Available in: v49.0_ Type: `string`. Allowed values: `Inbound`, `Outbound`. ### ConnectorsRecordingFormatEnum Recording format. _Available in: v49.0_ Type: `string`. Allowed values: `Flac`, `Mp3`, `Wav`. ### DatacloudImportStatusTypeEnum Status of the import. One of these values: * `Duplicate`: Marks a record that is already in the org’s CRM. The API determines whether an org allows the addition of duplicate records in its CRM. * `Error`: Indicates that the selected records weren’t added to the org’s CRM. * `Success`: Indicates that selected records were added to the org’s CRM. Type: `string`. Allowed values: `Duplicate`, `Error`, `Success`. ### ContentTaxonomyPathFragment Fragment of a path in a content taxonomy, representing information about a term or the taxonomy. * `id` (_string (Id)_) ID of the term or the taxonomy. _Available in: v63.0_ _Filter group: Small_ * `label` (_string_) Label of the term or the taxonomy. _Available in: v63.0_ _Filter group: Small_ ### LightningModelEditorConfigInput Input for lightning model type editor configuration. * `target` (_object_) LightningModelTypesEditorConfigEnum Editor configuration target for lightning model type. Valid value is `LightningDesktopGenAi` . _Available in: v64.0_ Includes all fields of `LightningModelTypesEditorConfigEnum`. ### LightningModelRendererConfigInput Input for lightning model type renderer configuration. * `maxViewDepth` (_integer_) Maximum depth for sub-view definitions. Valid values are from 0 to 10. You can specify a value only when `subViewDefinitions` is set to `true` . If unspecified and `subViewDefinitions` is set to `true` , all view definitions are expanded without limit. _Available in: v64.0_ * `target` (_object_) LightningModelTypesRendererConfigEnum Renderer configuration target for lightning model types. Valid value is `LightningDesktopGenAi` . _Available in: v64.0_ Includes all fields of `LightningModelTypesRendererConfigEnum`. ### LightningModelSchemaConfigInput Input for lightning model type schema configuration. * `subSchemaDefinitions` (_boolean_) Specifies whether to include sub-schema definitions ( `true` ) or not ( `false` ). _Available in: v64.0_ ### LightningModelTypeUIConfigOutputOptionsInput Input Representation for output-shape options applied to the UI config tree returned by the lightning-model type service. * `expandConfig` (_boolean_) Boolean property to indicate if generation of config should be done or not, default true _Available in: v68.0_ * `renditionFormat` (_LightningModelRenditionOutputFormatEnum_) ### LightningModelTypesError Lightning model types error information. * `errorDescription` (_string_) Error description. _Available in: v64.0_ _Filter group: Small_ * `errorTitle` (_string_) Error title. _Available in: v64.0_ _Filter group: Small_ ### LightningTypeUser Lightning type user. * `id` (_string_) ID of the user. _Available in: v64.0_ _Filter group: Small_ * `name` (_string_) Name of the user. _Available in: v64.0_ _Filter group: Small_ ### DataCategoryMetadata Data category metadata for the object. * `groupName` (_string_) Group name of the data category. _Available in: v63.0_ _Filter group: Small_ * `label` (_string_) Label of the data category. _Available in: v63.0_ _Filter group: Small_ * `values` (_object_) Map of values for the current data category. _Available in: v63.0_ _Filter group: Small_ Additional properties: `object`. Includes all fields of `DataCategoryValueMetadata`. ### FieldMetadata Search metadata for the field of an object. * `domain` (_string_, nullable) The object that the field is associated with. _Available in: v63.0_ _Filter group: Small_ * `field` (_string_) Field path through the object. _Available in: v63.0_ _Filter group: Small_ * `fieldApiName` (_string_) API name of the field. _Available in: v63.0_ _Filter group: Small_ * `fieldType` (_object_) FieldType Field type. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `FieldType`. * `filterable` (_boolean_) Specifies whether the field is filterable ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `highlightable` (_boolean_) Specifies whether the field is highlightable ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `label` (_string_) Label of the field _Available in: v63.0_ _Filter group: Small_ * `sortable` (_boolean_) Specifies whether the field is sortable ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ ### ThemeInfo Theme information related to an object. * `color` (_string_, nullable) Color that represents the object. _Available in: v63.0_ _Filter group: Small_ * `iconUrl` (_string_, nullable) Icon that represents the object. _Available in: v63.0_ _Filter group: Small_ ### DataCategory Data category. * `categories` (_array of string_) DataCategory categories * `groupName` (_string_) DataCategory group name * `operator` (_DataCategoryOperator_) * `categoryName` (_string_) Developer name of the data category. _Available in: v59.0_ _Filter group: Small_ * `childCategories` (_array of DataCategory_) List of subcategories. _This property is recursive: each item has the same structure as `DataCategory`._ _Available in: v59.0_ _Filter group: Small_ * `label` (_string_) Label of the data category. _Available in: v59.0_ _Filter group: Small_ ### Filter Filter parameter for object search. * `field` (_string_) Filter field API name. _Available in: v63.0_ _Filter group: Small_ * `operator` (_object_) FilterOperator Filter operator. Values are: * `EqOp` —Equal * `ExcludesOp` —Excludes * `GtOp` —Greater than * `GteOp` —Greater than or equal * `InOp` —In * `IncludesOp` —Includes * `LikeOp` —Like * `LtOp` —Less than * `LteOp` —Less than or equal * `NeOp` —Not equal * `NinOp` —Not in _Available in: v63.0_ _Filter group: Small_ Includes all fields of `FilterOperator`. * `values` (_array of ListViewObjectDefinition_) Filter values. _Available in: v63.0_ _Filter group: Small_ ### OrderBy Order by parameter for object search. * `field` (_string_) API name of the field. _Available in: v63.0_ _Filter group: Small_ * `order` (_object_) OrderDirection Order direction. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `OrderDirection`. * `orderNulls` (_object_) OrderNulls Null value order. Values are: * `Firsts` —Null values are sorted first. * `Lasts` —Null values are sorted last. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `OrderNulls`. ### AppliedOrderBy Applied order for object search. * `field` (_string_) Field used to sort the results. _Available in: v63.0_ _Filter group: Small_ * `order` (_object_) OrderDirection Order direction. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `OrderDirection`. * `orderNulls` (_object_) OrderNulls Null value order. Values are: * `Firsts` —Null values are sorted first. * `Lasts` —Null values are sorted last. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `OrderNulls`. ### SpellCorrectionInfo Spell correction information for object search. * `correctedQuery` (_string_) Specifies the corrected query. _Available in: v63.0_ _Filter group: Small_ * `hasNonCorrectedResults` (_boolean_) Specifies whether some non-corrected results were returned ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ ### Status Status response for Webstore Meta Config entity creation. * `code` (_string_) Search status code. _Available in: v63.0_ _Filter group: Small_ * `message` (_string_) Search status message. _Available in: v63.0_ _Filter group: Small_ * `error` (_object_) ErrorResponseOutput Detailed error message if the operation was unsuccessful. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ErrorResponseOutput`. * `isSuccess` (_boolean_) Specifies whether the operation was successful ( `true` ) or not ( `false` ). _Available in: v64.0_ _Filter group: Small_ ### PageInfo Page position information for the object search. * `hasNextPage` (_boolean_) Specifies whether the search has more results to return ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `offset` (_integer_) Search page offset position. _Available in: v63.0_ _Filter group: Small_ * `pageSize` (_integer_) Number of results per page. _Available in: v63.0_ _Filter group: Small_ ### DataCategoryOperator Data category operator. One of these values: * `Above`: Queries the data category and all of its parent categories. * `AboveOrBelow`: Queries the data category, all of its parent categories, and all of its subcategories. * `At`: Queries the data category. * `Below`: Queries the data category and all of its subcategories. Type: `string`. Allowed values: `Above`, `AboveOrBelow`, `At`, `Below`. ### FilterOperator Filter operator. Values are: * `EqOp` —Equal * `ExcludesOp` —Excludes * `GtOp` —Greater than * `GteOp` —Greater than or equal * `InOp` —In * `IncludesOp` —Includes * `LikeOp` —Like * `LtOp` —Less than * `LteOp` —Less than or equal * `NeOp` —Not equal * `NinOp` —Not in _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `EqOp`, `ExcludesOp`, `GtOp`, `GteOp`, `InOp`, `IncludesOp`, `LikeOp`, `LtOp`, `LteOp`, `NeOp`, `NinOp`. ### BooleanList List of Boolean values. * `values` (_array of boolean_) List of Boolean values to filter on, for example, `[true, false]` . _Available in: v63.0_ ### DoubleList List of Double values. * `values` (_array of number (double)_) List of Double values to filter on. _Available in: v63.0_ ### LongListInput List of Long values. * `values` (_array of number (int64)_) List of Long values to filter on. _Available in: v63.0_ ### StringListInput List of string values. * `values` (_array of string_) List of string values to filter on, for example, `["A", "B", "C"]` . _Available in: v63.0_ ### OrderDirection Order direction. Default value is `Ascending` . _Available in: v63.0_ Type: `string`. Allowed values: `Ascending`, `Descending`. ### OrderNulls Null value order. Values are: * `Firsts` —Null values are sorted first. * `Lasts` —Null values are sorted last. Default value is `Firsts` . _Available in: v63.0_ Type: `string`. Allowed values: `Firsts`, `Lasts`. ### Chunk Content chunk for the search result. * `text` (_string_) Text extract relevant to the search query. _Available in: v63.0_ _Filter group: Small_ ### RecordFieldValue Field values by API name. * `displayValue` (_string_) Field display value. _Available in: v63.0_ _Filter group: Small_ * `highlight` (_string_) Represents field highlighting in the results. _Available in: v63.0_ _Filter group: Small_ * `value` (_object_) Field raw value. _Available in: v63.0_ _Filter group: Small_ ### MatchInfo Search information related to the search result. * `isPromoted` (_boolean_, nullable) Specifies whether search promotion affected the result ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `isSpellCorrected` (_boolean_, nullable) Specifies whether spell correction affected the result ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ ### ConnectPlatformActionGroupCategoryEnumActivities 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`. ### SkillRequirementInput Skill requirement. * `skillId` (_string_, required) ID of the skill required. _Available in: v49.0_ * `skillLevel` (_number (double)_) Level of the skill required. _Available in: v49.0_ ### GetAllAppointmentSlotsTerritorySlot Get appointment slots territory slot * `slots` (_array of GetAllAppointmentSlotsSlot_) Appointment Slots * `territoryId` (_string_) Service Territory ID ### GetEngagementChannelTypeResult Get engagement channel type result * `contactPoint` (_string_) The contact point for the engagement channel type. _Available in: v56.0_ _Filter group: Small_ * `contactPointType` (_string_) The contact point type for the engagement channel type. Possible values are: * `InPerson` * `None` * `Phone` —Available in API version 57.0 and later. * `Video` —Available in API version 57.0 and later. _Available in: v56.0_ _Filter group: Small_ * `id` (_string_) The ID of the engagement channel type record. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The name of the engagement channel type. _Available in: v56.0_ _Filter group: Small_ * `workTypeGroupIds` (_array of string_) The work type group IDs for the engagement channel type. When `workTypeID` is specified in the API request, this property is unspecified. _Available in: v56.0_ _Filter group: Small_ * `workTypeIds` (_array of string_) The work type Ids for the engagement channel type. When `workTypeGroupID` is specified in the API request, this property is unspecified. _Available in: v56.0_ _Filter group: Small_ ### GroupAppointmentResult Output representation that contains the details of a specific group appointment. * `appointmentId` (_string_) ID of the group appointment. _Available in: v61.0_ _Filter group: Small_ * `attendeeCount` (_integer_) Number of attendees who are already associated with the appointment. _Available in: v61.0_ _Filter group: Small_ * `attendeeLimit` (_integer_) Maximum attendee limit that's allowed for the appointment. _Available in: v61.0_ _Filter group: Small_ * `endTime` (_string (date-time)_) End time of the appointment. _Available in: v61.0_ _Filter group: Small_ * `engagementChannelTypeId` (_string_) ID of the engagement channel type record. _Available in: v61.0_ _Filter group: Small_ * `extendedFields` (_array of SchedulerExtendedFieldsOutput_) Details of the extended custom fields. _Available in: v61.0_ _Filter group: Small_ * `parentRecordId` (_string_) ID of the associated parent record. _Available in: v61.0_ _Filter group: Small_ * `startTime` (_string (date-time)_) Start time of the appointment. _Available in: v61.0_ _Filter group: Small_ * `territoryId` (_string_) ID of the service territory that's associated with the appointment. _Available in: v61.0_ _Filter group: Small_ * `workTypeGroup` (_object_) WorkTypeGroup ID and name of the work type group associated with the work type of the appointment. _Available in: v61.0_ _Filter group: Small_ Includes all fields of `WorkTypeGroup`. * `workTypeId` (_string_) ID of the work type for the appointment. _Available in: v61.0_ _Filter group: Small_ * `resourceIds` (_array of string_) Service resource IDs that are associated with the appointment. _Available in: v61.0_ _Filter group: Small_ ### SvcApptModeEnum Mode of the service appointment. One of these values: * `Group`: Service appointment mode is Group. * `Regular`: Default mode of service appointment. Type: `string`. Allowed values: `Group`, `Regular`. ### GetServiceTerritoriesResult Get service territories result * `city` (_string_) Service territory city. _Available in: v48.0_ _Filter group: Small_ * `country` (_string_) Service territory country. _Available in: v48.0_ _Filter group: Small_ * `id` (_string_) ID of the service territory. _Available in: v48.0_ _Filter group: Small_ * `latitude` (_number (double)_) Latitude of the service territory. _Available in: v48.0_ _Filter group: Small_ * `longitude` (_number (double)_) Longitude of the service territory. _Available in: v48.0_ _Filter group: Small_ * `name` (_string_) Name of the service territory. _Available in: v48.0_ _Filter group: Small_ * `operatingHoursId` (_string_) ID of the service territory `operatingHours` record. _Available in: v48.0_ _Filter group: Small_ * `postalCode` (_string_) Service territory postal code. _Available in: v48.0_ _Filter group: Small_ * `state` (_string_) Service territory state. _Available in: v48.0_ _Filter group: Small_ * `street` (_string_) Service territory street. _Available in: v48.0_ _Filter group: Small_ ### WaitlistResult Waitlist result * `description` (_string_) Description * `isActive` (_boolean_) Active * `name` (_string_) Waitlist Name * `serviceResources` (_array of WaitlistServiceResource_) Service Resources * `waitlistAnalytics` (_WaitlistAnalytics_) * `waitlistId` (_string_) Waitlist ID * `waitlistParticipants` (_array of WaitlistParticipantResult_) Waitlist Participants * `workTypeGroups` (_array of WaitlistWorkTypeGroup_) Work Type Groups ### TwbExportContentFilterEnum Content filter. Values are: * `SourceAndTranslations` —Export both source and translations for the target languages specified in `languages`. * `Source` —Export only source language content in the context user’s default language. _Available in: v67.0_ Type: `string`. Allowed values: `SourceAndTranslations`, `SourceOnly`. ### TwbExportStatusFilterEnum Status filter. Value are: * `AllRecords` —Export all records regardless of translation status. * `MissingOrOutdated` —Export only missing or outdated translations. _Available in: v67.0_ Type: `string`. Allowed values: `AllRecords`, `MissingOrOutdated`. ### TwbTimeRangeFilterInput Time range filter for a Translation Workbench export request. * `endDate` (_string_) End date in ISO 8601 format (UTC), for example, `2024-01-31T23:59:59Z` . Export only items modified on or before this date. _Available in: v67.0_ * `startDate` (_string_) Start date in ISO 8601 format (UTC), for example, `2024-01-01T00:00:00Z` . Export only items modified on or after this date. _Available in: v67.0_ ### TwbTranslationTypeEnum Translation type. Values are: * `Data` —Reserved for future use. Specifying `Data` results in an error in version 67.0 and later. * `Metadata` —Export metadata translations, such as setup components. If unspecified, defaults to `Metadata` . _Available in: v67.0_ Type: `string`. Allowed values: `Data`, `Metadata`. ### TwbReportTypeEnum Type of report. _Available in: v67.0_ _Filter group: Small_ Type: `string`. Allowed values: `ErrorReport`, `ValidationReport`. ### ListShare A list share. * `apiName` (_string_) API name for the group or role. _Available in: v60.0_ _Filter group: Small_ * `groupId` (_string (Id)_) ID for the group or role that the list is shared with. _Available in: v44.0_ _Filter group: Small_ * `isMember` (_boolean_) Specifies whether the context user is a member of the group, role, or territory. _Available in: v67.0_ _Filter group: Small_ * `label` (_string_) Label for the group or role. _Available in: v44.0_ _Filter group: Small_ ### FlowApprovalProcessAction Available actions for a flow approval process. * `actionLabel` (_string_) The label of an available action. _Available in: v66.0_ _Filter group: Small_ * `actionName` (_string_) The name of an available action. _Available in: v66.0_ _Filter group: Small_ * `inProgressApprovalSubmissionIds` (_array of string_) List of in-progress approval submission IDs. _Available in: v66.0_ _Filter group: Small_ * `url` (_string_) The URL of an available action. _Available in: v66.0_ _Filter group: Small_ ### FlowOrchestrationStepInstance Orchestration step instance. * `assignedTo` (_string_, nullable) The ID of the user, group, or queue that's assigned to a work item. _Available in: v63.0_ _Filter group: Small_ * `assigneeType` (_string_, nullable) The assignee type associated with a work item. Valid values are: * Group * Invalid * Queue * User _Available in: v63.0_ _Filter group: Small_ * `comments` (_string_, nullable) The string stored in an output variable with the API name of Comments from a flow called by a completed orchestration step. _Available in: v63.0_ _Filter group: Small_ * `completedBy` (_string_, nullable) The user ID of the user who completed the work item. _Available in: v63.0_ _Filter group: Small_ * `completionTime` (_string_, nullable) The duration of the step in seconds. _Available in: v63.0_ _Filter group: Small_ * `description` (_string_, nullable) The description associated with the orchestration step. _Available in: v63.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the orchestration step instance. _Available in: v54.0_ _Filter group: Small_ * `label` (_string_, nullable) Orchestration step instance label. _Available in: v54.0_ _Filter group: Small_ * `name` (_string_, nullable) Orchestration step instance name. _Available in: v54.0_ _Filter group: Small_ * `status` (_object_) ConnectFlowOrchestrationStatusEnum Status of the orchestration instance. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectFlowOrchestrationStatusEnum`. * `stepType` (_object_) ConnectFlowOrchestrationStepTypeEnum Type of orchestration step. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectFlowOrchestrationStepTypeEnum`. * `workItems` (_array of FlowOrchestrationWorkItem_) Orchestration step instance work items. _Available in: v54.0_ _Filter group: Small_ ### ConnectNavigationMenuItemActionTypeEnum Event, URL type, or modal navigation menu item. Values are: * `Event` —Event-based navigation. `Event` is internal only and can’t be used in custom components. * `ExternalLink` —URL outside of your Experience Cloud site. * `InternalLink` —Relative URL inside your Experience Cloud site. * `Modal` —Modal, such as Account Switcher. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `Event`, `ExternalLink`, `InternalLink`, `Modal`. ### NavigationMenuPageReference Navigation menu item page reference. * `attributes` (_object_) Attributes for the navigation menu item page reference. _Available in: v59.0_ _Filter group: Small_ Additional properties: `string`. * `state` (_object_) State for the navigation menu item page reference. _Available in: v59.0_ _Filter group: Small_ Additional properties: `string`. * `type` (_string_) Type for the navigation menu item page reference. _Available in: v59.0_ _Filter group: Small_ ### ConnectNavigationMenuItemOpenTargetEnum Target for the navigation menu item. Values are: * `CurrentWindow` —Navigation menu item opens in the current window. * `NewWindow` —Navigation menu item opens in a new window. _Available in: v47.0_ _Filter group: Small_ Type: `string`. Allowed values: `CurrentWindow`, `NewWindow`. ### QuipLinkedEntity Shared entity related to a Quip document. * `linkedEntity` (_object | RecordSummary | UserSummary_) Information about the user, record, or group the file is shared with. _Available in: v49.0_ _Filter group: Small_ One of: `object`, `RecordSummary`, `UserSummary`. * `linkedEntitySharingType` (_string_) Type of sharing permission. Values are: * `C` —Collaborator * `I` —Determined by location This type generally occurs when the sharing permission is not set on the file, but on the library instead. This value is also used when the context user is the owner of the file. * `N` —No access * `V` —Viewer _Available in: v49.0_ _Filter group: Small_ Allowed values: `C`, `I`, `N`, `V`. ### ConversationParticipant Participant in the conversation. * `appType` (_string_) App type for the participant. _Available in: v51.0_ _Filter group: Small_ * `role` (_string_) Role for the participant. _Available in: v51.0_ _Filter group: Small_ * `subject` (_string_) Subject for the participant. _Available in: v51.0_ _Filter group: Small_ ### AppointmentError Reschedule appointment error * `errorCode` (_string_) Error code * `message` (_string_) Error message ### AssignedResourceInputUnifiedScheduling Input representation of the assigned resource details. * `isPrimaryResource` (_boolean_) Indicates whether the assigned resource is the primary resource. For multi-resource appointments, only one resource can be a primary resource. Required if multi-resource scheduling is enabled. _Available in: v48.0_ * `isRequiredResource` (_boolean_, required) Indicates whether the assigned resource is a required resource. _Available in: v48.0_ * `serviceResourceId` (_string (Id)_, required) Resource who is assigned to the service appointment. _Available in: v48.0_ * `extendedFields` (_array of ExtendedFieldInput_) Custom fields. _Available in: v48.0_ ### AuxiliaryDetailsInput Input representation of additional appointment details, such as the engagement channel type. * `engagementChannelTypeId` (_array of string_, required) Engagement channel type for the appointment. The schedule operation accepts a single ID as a string. The get-appointment-slots and get-appointment-candidates operations accept an array of IDs. The selected engagement channel types must be associated with the work type through `EngagementChannelWorkType` records. _Available in: v66.0_ * `resourceLimitApptDistribution` (_integer_) Maximum number of appointments to distribute per resource when computing slots or candidates. Used only with the `get-appointment-slots` and `get-appointment-candidates` operations. _Available in: v66.0_ * `attendeeLimit` (_integer_) Maximum number of attendees for the appointment. Used only with the schedule operation. _Available in: v66.0_ * `comments` (_string_) Comments to record on the service appointment. Used only with the schedule operation. _Available in: v66.0_ * `description` (_string_) Description of the service appointment. Used only with the schedule operation. _Available in: v66.0_ * `extendedFields` (_object_) Custom fields to set on the service appointment. Used only with the schedule operation. _Available in: v66.0_ Additional properties: `string`. ### CoreDetailsInput Input representation of core appointment details such as start and end time, status, work configuration, and location constraints. * `appointmentMode` (_object_) AppointmentModeEnum Mode of the appointment. Valid values are `Group` and `Regular` . Default is `Regular` . _Available in: v66.0_ Includes all fields of `AppointmentModeEnum`. * `endTime` (_string (date-time)_, required) End time for the appointment, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). For the schedule operation, this is the scheduled end time. For the get-appointment-slots and get-appointment-candidates operations, this is the end of the search window. _Available in: v66.0_ * `locationConstraints` (_object_, required) LocationConstraintsInput Location constraints for the appointment, such as the service territory. _Available in: v66.0_ Includes all fields of `LocationConstraintsInput`. * `startTime` (_string (date-time)_, required) Start time for the appointment, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). For the schedule operation, this is the scheduled start time. For the get-appointment-slots and get-appointment-candidates operations, this is the start of the search window. _Available in: v66.0_ * `workConfiguration` (_object_, required) WorkConfigurationInput Work configuration for the appointment, including the work type. _Available in: v66.0_ Includes all fields of `WorkConfigurationInput`. * `status` (_string_) Status to set on the created service appointment, such as `Scheduled` . Used only with the schedule operation. Required for the schedule operation _Available in: v66.0_ * `subject` (_string_) Subject of the service appointment. Used only with the schedule operation. _Available in: v66.0_ ### SchedulingMethodEnum Scheduling method type for request-time selection. WorkType capability fields (WorkTypeRepresentation.schedulingMethod, GetWorkTypesInputRepresentation.schedulingMethod) extend this set with `Both` via an inline enum -- a WorkType can advertise support for both methods, but a request must pick one. Type: `string`. Allowed values: `InBusiness`, `OnField`. ### ServiceAppointmentParentInput Input representation of the parent record associated with a service appointment. * `id` (_string (Id)_) ID of the parent record, such as an account or a lead, that the service appointment is associated with. Required if `serviceAppointmentParentDetails` isn't provided _Available in: v66.0_ * `serviceAppointmentParentDetails` (_object_) ServiceAppointmentParentDetailsInput Details for the parent record to create alongside the service appointment. Provide this property or `id` , but not both. Required if `id` isn't provided _Available in: v66.0_ Includes all fields of `ServiceAppointmentParentDetailsInput`. ### AppointmentCandidateOutput Output representation of a single appointment candidate, which pairs an available time slot with a specific resource. * `endTime` (_string (date-time)_) End time of the candidate slot, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). _Available in: v66.0_ _Filter group: Big_ * `resourceId` (_string (Id)_) ID of the service resource available for this candidate slot. _Available in: v66.0_ _Filter group: Big_ * `startTime` (_string (date-time)_) Start time of the candidate slot, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). _Available in: v66.0_ _Filter group: Big_ * `territoryId` (_string_) ID of the service territory where the candidate is available. _Available in: v66.0_ _Filter group: Big_ ### AppointmentSlotOutput Output representation of a single available appointment time slot. * `endTime` (_string (date-time)_) End time of the slot, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). _Available in: v66.0_ _Filter group: Big_ * `remainingAppointments` (_integer_) Number of appointments that can still be booked in this slot. _Available in: v66.0_ _Filter group: Big_ * `startTime` (_string (date-time)_) Start time of the slot, in ISO 8601 format ( `YYYY-MM-DDTHH:MM:SS.sssZ` ). _Available in: v66.0_ _Filter group: Big_ * `territoryId` (_string_) ID of the service territory where the slot is available. _Available in: v66.0_ _Filter group: Big_ ### RescheduleAssignedResourceInput Input representation of a resource assignment change to apply to a rescheduled appointment. * `assignedResource` (_object_, required) AssignedResourceInput Service resource to add, update, or remove. For `DeleteOperation` , don't set `isRequiredResource` . _Available in: v66.0_ Includes all fields of `AssignedResourceInputUnifiedScheduling`. * `operation` (_object_, required) OperationEnum Operation to perform on the resource assignment. Valid values are `CreateOperation` , `UpdateOperation` , and `DeleteOperation` . _Available in: v66.0_ Includes all fields of `OperationEnum`. ### OperationEnum Operation performed for this appointment. Valid values are `CreateOperation` , `UpdateOperation` , and `DeleteOperation` . _Available in: v66.0_ _Filter group: Big_ Type: `string`. Allowed values: `CreateOperation`, `DeleteOperation`, `UpdateOperation`. ### ScheduledObjectResultOutput Scheduled object output * `resourceIds` (_array of string (Id)_) Array of resource IDs * `scheduledObjectId` (_string (Id)_) Scheduled object ID ### SchedulingStatusEnum Status of the scheduling operation. Valid values are `Success` , `ScheduleError` , and `PersistError` . _Available in: v66.0_ _Filter group: Big_ Type: `string`. Allowed values: `PersistError`, `ScheduleError`, `Success`. ### SchedulingTypeEnum Type of scheduling action. Valid values are `Requested` and `Affected` . _Available in: v66.0_ _Filter group: Big_ Type: `string`. Allowed values: `Affected`, `Requested`. ### ServiceAppointmentResultOutput Result of the POST method. * `parentId` (_string (Id)_) Service appointment parent ID * `resourceIds` (_array of string (Id)_) Array of assigned resource IDs * `serviceAppointmentId` (_string (Id)_) ID of the service appointment created. _Available in: v48.0_ _Filter group: Small_ * `assignedResourceIds` (_array of string_) IDs of the assigned resources _Available in: v48.0_ _Filter group: Small_ * `parentRecordId` (_string_) ID of the parent record. _Available in: v48.0_ _Filter group: Small_ ### AppointmentAssignedResourceInput Assigned resource details * `extendedFields` (_object_) Extended fields representation Additional properties: `string`. * `isPrimaryResource` (_boolean_) Is primary resource * `isRequiredResource` (_boolean_) Is required resource * `serviceResourceId` (_string (Id)_, required) Service resource ID ### MicrobatchingErrorRecordInfoRequestBody Microbatching error record info request body. * `fields` (_object_) Map of fields. _Available in: v54.0_ _Filter group: Small_ Additional properties: `object`. * `objectName` (_string_) Name of the object. _Available in: v54.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_ ### FilesConnectRepositoryAuthenticationSbi Authentication information related to a repository. * `authFlowUrl` (_string_) * When authentication protocol is OAuth, the URL to use to start the OAuth flow- When authentication protocol is username/password, URL to the 'Authentication Settings for External Systems' page- When authentication protocol is anonymous, URL is null. * `authProtocol` (_ConnectContenHubAuthenticationProtocolEnumSbi_) * `userHasAuthSettings` (_boolean_) True only if the user has credentials created. If the XDS is configured using 'Named Principal' identity type, true if the Admin has authenticated using his/her credentials. False otherwise. ### FilesConnectRepositoryFeaturesSbi Description of the features of a Content Hub repository. * `canBrowse` (_boolean_) Whether or not the Content Hub repository's folder hierarchy can be browsed. * `canSearch` (_boolean_) Whether or not the Content Hub repository can be searched. ### FilesConnectProviderTypeSbi Description of the type of a Content Hub repository. * `label` (_string_) The provider type localized label. * `type` (_string_) One of: ContentHubBox, ContentHubGDrive, ContentHubSharepointOffice365, ContentHubSharepoint, ContentHubSharepointOneDrive, SimpleURL. ### FilesConnectPermissionTypeSbi Description of a permission type. * `id` (_string_) The internal id of the permission type in the external repository. * `label` (_string_) The label as returned by the external repository. ### RepositoryGroupSummarySbi Detail 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` (_string_) 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_ Allowed values: `Everybody`, `EverybodyInDomain`, `Unknown`. * `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` (_ConnectDirectoryEntryTypeEnumSbi_) The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ ### ModerationFlagsCollectionSbi Represents list of flags on a feed item or comment or a content document. * `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 ModerationFlagItemSbi_) 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_ ### ExternalCredentialPrincipalAccessType Access type of the external credential principal. _Available in: v58.0_ _Filter group: Small_ Type: `string`. Allowed values: `PermissionSet`, `PermissionSetGroup`, `Profile`. ### NBATargetTypeEnum Type of target. Type: `string`. Allowed values: `Recommendation`. ### NextBestActionParameter A parameter for an action. * `name` (_string_) Name of the parameter. _Available in: v45.0_ _Filter group: Small_ * `type` (_string_) Type of the parameter. _Available in: v45.0_ _Filter group: Small_ * `value` (_string_) Value of the parameter. _Available in: v45.0_ _Filter group: Small_ ### NBAActionTypeEnum Type of action. Values are: * `Flow` —Automated process tool with multiple subtypes. _Available in: v45.0_ _Filter group: Small_ Type: `string`. Allowed values: `Flow`. ### SurveySelectionQuestionChoiceOutput The details of a boolean, rating, single selection, or a multiple selection question’s choice on the survey page. * `label` (_string_) The label of a choice for a Boolean, rating, single selection, or multiple selection question in a survey. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The name of a choice for a Boolean, rating, single selection, or multiple selection question in a survey. _Available in: v56.0_ _Filter group: Small_ ### LightningModelRenditionOutputFormatEnum Output format for the rendition config tree returned to callers of the lightning-model type service. Type: `string`. Allowed values: `Mir`, `Uem`. ### DataCategoryValueMetadata Data category values for the object's data category. * `label` (_string_) Label of the data category group. _Available in: v63.0_ _Filter group: Small_ * `valueName` (_string_) Name of the data category group. _Available in: v63.0_ _Filter group: Small_ ### FieldType Field type. _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `Address`, `AnyType`, `Base64`, `Boolean`, `Combobox`, `ComplexValue`, `Currency`, `DataCategoryGroupReference`, `Date`, `DateTime`, `Double`, `Email`, `EncryptedString`, `ExtensionEntityLookup`, `ExternalLookup`, `FloatArray`, `Id`, `ImageUrl`, `IndirectLookup`, `Integer`, `Json`, `Location`, `Long`, `MultiPicklist`, `Percent`, `PersonName`, `Phone`, `Picklist`, `PlainTextArea`, `Reference`, `RichTextArea`, `Sobject`, `String`, `SwitchablePersonName`, `TextArea`, `Time`, `Url`. ### ListViewObjectDefinition Defines the type of object displayed in a list view's rows. * `fieldId` (_string_) The API field ID for the related list object that refers to the parent record. For example, if an Account record has a related list of Contact records, then in that related list definition on the Account this value might be 'AccountId' because it is the field on the Contact record that associates this Account with those Contacts. * `type` (_string_) The SObject API type name for this object. ### ErrorResponseOutput Error response output. * `errorCode` (_string_) Error code. _Available in: v48.0_ _Filter group: Small_ * `message` (_string_) Message stating the reason for error, if any. _Available in: v48.0_ _Filter group: Small_ ### GetAllAppointmentSlotsSlot Get appointment slots slot * `endTime` (_string (date-time)_) End time of the appointment. The API returns time slots up to 31 days from the `startTime` . _Available in: v49.0_ _Filter group: Small_ * `engagementChannelTypeIds` (_array of string_, nullable) List of IDs of the engagement channel types for the service resource. _Available in: v56.0_ _Filter group: Small_ * `resources` (_array of string_) List of resources available in the specified territory. _Available in: v49.0_ _Filter group: Small_ * `startTime` (_string (date-time)_) Start time of the appointment. _Available in: v49.0_ _Filter group: Small_ ### SchedulerExtendedFieldsOutput Output representation of the extended fields for Salesforce Scheduler. * `name` (_string_) Name of the extended field. _Available in: v59.0_ _Filter group: Small_ * `value` (_string_) Value of the extended field. _Available in: v59.0_ _Filter group: Small_ ### WorkTypeGroup Work Type Group representation * `id` (_string_) WorkTypeGroup ID * `name` (_string_) WorkTypeGroup Name ### WaitlistServiceResource Output representation of the waitlist service resource. Service resources are individual users who can attend customer appointments. * `id` (_string_) ID of the service resource. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the service resource. _Available in: v59.0_ _Filter group: Small_ ### WaitlistAnalytics Output representation of the waitlist analytics. * `avgParticipants` (_integer_) Count of average participants per day. _Available in: v59.0_ _Filter group: Small_ * `avgWaitingTime` (_integer_) Average waiting time in minutes. _Available in: v59.0_ _Filter group: Small_ * `currentParticipant` (_integer_) Number of current participants in the waitlist. _Available in: v59.0_ _Filter group: Small_ * `totalWaitingTime` (_integer_) Total waiting time in minutes. _Available in: v59.0_ _Filter group: Small_ ### WaitlistParticipantResult Output representation of a waitlist participant result. A waitlist participant is a customer who is added to a waitlist. * `createdDate` (_string_) Date when the waitlist participant record was created. _Available in: v59.0_ _Filter group: Small_ * `extendedFields` (_array of SchedulerExtendedFieldsOutput_) List of extended fields associated with the waitlist participant record. _Available in: v59.0_ _Filter group: Big_ * `participant` (_object_) WaitlistParticipantParticipant Details of the participant from the waitlist participant record. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `WaitlistParticipantParticipant`. * `participantIdentifier` (_string_) Alphanumeric unique identifier of the participant in a waitlist. For example, D101, E63, or A5015. _Available in: v59.0_ _Filter group: Small_ * `serviceAppointmentId` (_string_) ID of the service appointment that’s related to the waitlist participant. _Available in: v59.0_ _Filter group: Small_ * `serviceResource` (_object_) WaitlistServiceResource Details of the service resource that’s related to the service appointment for the waitlist participant. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `WaitlistServiceResource`. * `waitlistParticipantId` (_string_) ID of the waitlist participant record. _Available in: v59.0_ _Filter group: Small_ * `workTypeGroup` (_object_) WaitlistWorkTypeGroup Details of the work type group that's associated with the service appointment. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `WaitlistWorkTypeGroup`. ### WaitlistWorkTypeGroup Output representation of the waitlist work type group. A work type group is a general appointment category or topic, such as a home loan or an investment. * `id` (_string_) ID of the work type group. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the work type group. _Available in: v59.0_ _Filter group: Small_ ### ConnectFlowOrchestrationStepTypeEnum Type of orchestration step. _Available in: v54.0_ _Filter group: Small_ Type: `string`. Allowed values: `AgxBackgroundStep`, `AgxInteractiveStep`, `ApprovalStep`, `AsynchronousBackgroundStep`, `BackgroundStep`, `InteractiveStep`, `ManagedContentRoleInteractiveStep`, `ManagedContentVariantAutoPublishBackgroundStep`, `ManagedContentVariantAutoUnpublishBackgroundStep`, `ManagedContentVariantSetLockBackgroundStep`, `ManagedContentVariantSetReadyBackgroundStep`, `MuleSoftStep`. ### FlowOrchestrationWorkItem Orchestration work item. * `assigneeId` (_string (Id)_) ID of the assignee for the orchestration work item. _Available in: v54.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the orchestration work item was created. _Available in: v61.0_ _Filter group: Small_ * `description` (_string_, nullable) Description of the orchestration work item. _Available in: v54.0_ _Filter group: Small_ * `flowType` (_string_) Flow type of the orchestration that created the orchestration work item. _Available in: v62.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the orchestration work item. _Available in: v54.0_ _Filter group: Small_ * `label` (_string_, nullable) Label key for the orchestration work item. _Available in: v54.0_ _Filter group: Small_ * `lastModifiedDate` (_string (date-time)_) Date when the work item was last modified. _Available in: v61.0_ _Filter group: Small_ * `relatedRecordId` (_string (Id)_, nullable) ID of the record the orchestration work item is related to. _Available in: v54.0_ _Filter group: Small_ * `screenFlowDeveloperName` (_string_) Developer name of the screen flow to start when assignees work on the orchestration work item. _Available in: v54.0_ _Filter group: Small_ * `screenFlowId` (_string_) ID of the screen flow to start when assignees work on the orchestration work item. _Available in: v54.0_ _Filter group: Small_ * `screenFlowInputs` (_string_) Input parameters for the screen flow. _Available in: v54.0_ _Filter group: Small_ * `status` (_object_) ConnectFlowOrchestrationWorkItemStatusEnum Status of the orchestration work item. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectFlowOrchestrationWorkItemStatusEnum`. ### Group Chatter group input. * `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_) Announcement 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_ _Filter group: Big_ Includes all fields of `Announcement`. * `bannerPhoto` (_object_) BannerPhotoQuip The banner photo for the group. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhotoQuip`. * `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_ _Filter group: Small_ * `community` (_object_) Reference 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 `Reference`. * `description` (_string_) The “Description” section of the group _Available in: v29.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_ * `isArchived` (_boolean_) `true` if the group is archived, `false` otherwise. Defaults to `false`. _Available in: v29.0_ _Filter group: Big_ * `isAutoArchiveDisabled` (_boolean_) `true` if automatic archiving is turned off for the group, `false` otherwise. Defaults to `false`. _Available in: v29.0_ _Filter group: Big_ * `isBroadcast` (_boolean_) `true` if only group owners and managers can create posts in the group, `false` otherwise. Defaults to `false`. _Available in: v36.0_ _Filter group: Big_ * `fileCount` (_integer_) Number of files posted to this group. _Available in: v24.0–27.0_ The `fileCount` property is in the Group Detail response body _Filter group: Big_ * `id` (_string_) 18-character ID of the group. _Available in: v23.0_ _Filter group: Small_ * `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 that the object is a group. The motif can also contain the record type’s base color. The icon is not the group photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `myRole` (_string_) Values are: * `GroupOwner` * `GroupManager` * `NotAMember` * `NotAMemberPrivateRequested` * `StandardMember` _Available in: v23.0_ _Filter group: Small_ * `mySubscription` (_object_) Reference If the context user is a member of this group, contains information about that subscription, otherwise `null` . _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `Reference`. * `name` (_string_) The name of the group _Available in: v29.0_ _Filter group: Small_ * `owner` (_object_) UserSummary The ID of the group owner. This property is available for PATCH requests only. _Available in: v29.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` (_string_) 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_ _Filter group: Small_ Allowed values: `PrivateAccess`, `PublicAccess`, `Unlisted`. * `information` (_object_) GroupInformation 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 `GroupInformation`. ### AppointmentModeEnum Mode of the appointment. Valid values are `Group` and `Regular` . Default is `Regular` . _Available in: v66.0_ Type: `string`. Allowed values: `Group`, `Regular`, `WalkIn`. ### LocationConstraintsInput Input representation of location constraints for an appointment. * `addressIds` (_array of string_, required) IDs of service territories to consider when retrieving available time slots or candidates. Used only with the get-appointment-slots and get-appointment-candidates operations. Required for the get-appointment-slots and get-appointment-candidates operations _Available in: v66.0_ * `id` (_string_) ID of the service territory where the appointment occurs. Used only with the schedule operation. Required for the schedule operation _Available in: v66.0_ ### WorkConfigurationInput Input representation of work configuration for an appointment. * `workDetails` (_WorkDetailsInput_) * `workTypeId` (_string (Id)_, required) ID of the work type for the appointment. The work type must be associated with the engagement channel type provided in `auxiliaryDetails` via an `EngagementChannelWorkType` record. _Available in: v66.0_ ### ServiceAppointmentParentDetailsInput Input representation of the details for the parent record to create alongside the service appointment. * `extendedFields` (_object_) Custom fields to set on the parent record. _Available in: v66.0_ Additional properties: `string`. * `parentType` (_object_, required) ParentTypeEnum Object type of the parent record to create. Valid value is `Lead` . _Available in: v66.0_ Includes all fields of `ParentTypeEnum`. ### ConnectContenHubAuthenticationProtocolEnumSbi Specifies the authentication protocol used for the repository. Type: `string`. Allowed values: `NoAuthentication`, `Oauth`, `Password`. ### ConnectDirectoryEntryTypeEnumSbi Specifies the type of directory entry. Type: `string`. Allowed values: `GroupEntry`, `UserEntry`. ### ModerationFlagItemSbi Represents flag details on a moderation enabled entity. * `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` (_string_) Type of moderation flag. Values are: * `FlagAsInappropriate` —Flag for inappropriate content. * `FlagAsSpam` —Flag for spam. _Available in: v40.0_ _Filter group: Small_ Allowed values: `FlagAsInappropriate`, `FlagAsSpam`. * `note` (_string_) Note from user who flagged the item. _Available in: v40.0_ _Filter group: Small_ * `visibility` (_string_) 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_ Allowed values: `ModeratorsOnly`, `SelfAndModerators`. ### WaitlistParticipantParticipant Output representation of the waitlist participant details. * `id` (_string_) ID of the waitlist participant. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the waitlist participant. _Available in: v59.0_ _Filter group: Small_ ### ConnectFlowOrchestrationWorkItemStatusEnum Status of the orchestration work item. _Available in: v54.0_ _Filter group: Small_ Type: `string`. Allowed values: `Assigned`, `Completed`. ### Announcement An announcement. * `expirationDate` (_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_ _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_) 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 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_ _Filter group: Medium_ * `url` (_string_) The URL to the announcement. _Available in: v33.0_ _Filter group: Small_ * `body` (_object_) MessageBodyInputRequest 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 `MessageBodyInputRequest`. * `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_ * `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_ ### BannerPhotoQuip A banner photo. * `bannerPhotoUrl` (_string_) 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_) 18-character version ID of the banner photo. _Available in: v36.0_ _Filter group: Small_ * `url` (_string_) URL to the banner photo. _Available in: v36.0_ _Filter group: Small_ * `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_ ### GroupInformation 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_ _Filter group: Small_ * `title` (_string_) The title in the “Information” section of the group. The maximum length is 240 characters (bytes). _Available in: v28.0_ _Filter group: Small_ ### WorkDetailsInput Work details * `duration` (_integer_, required) Duration * `durationType` (_DurationTypeEnum_, required) * `workAuxiliaryDetails` (_WorkAuxiliaryDetailsInput_) ### ParentTypeEnum Object type of the parent record to create. Valid value is `Lead` . _Available in: v66.0_ Type: `string`. Allowed values: `Lead`, `WorkOrder`. ### FeedItem Feed item input. * `actor` (_string_) 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_ * `attachment` (_string_) You can specify only one of these values in the attachment parameter. Values are: * [Attachment Input: Canvas App](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) (v29.0–31.0) * [Attachment Input: Existing Content](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) (v23.0–31.0) * [Attachment Input: Feed Poll](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) (v26.0–31.0) * [Attachment Input: Link](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) (v23.0–31.0) * [Attachment Input: New File Upload](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) (v23.0–31.0) As of API version 32.0, use the `capabilities` property. _Filter group: Medium_ Allowed values: `Approval`, `BasicTemplate`, `Canvas`, `CaseComment`, `Content`, `DashboardComponent`, `EmailMessage`, `Link`, `Poll`, `RecordSnapshot`, `TrackedChange`. * `body` (_object_) MessageBodyInputRequest Description of message body. Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a `describeSObjects()` call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field. The body can contain up to 25 mentions. If you specify `originalFeedElementId` to share a feed item, use the `body` property to add the first comment to the feed item. To edit this property in a feed item, make a PATCH request to `/chatter/feed-elements/{feedElementId}`. Editing feed posts is supported in version 34.0 and later. Required unless the feed item has a content capability or a link capability _Available in: v23.0_ _Filter group: Small_ Includes all fields of `MessageBodyInputRequest`. * `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. As of API version 39.0, use the `isSharable` property. _Available in: v27.0–38.0_ _Filter group: Medium_ * `capabilities` (_object_) FeedElementCapabilities The capabilities that define the behavior of this feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilities`. * `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. 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_) Reference 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 `Reference`. * `event` (_boolean_) `true` if feed item created due to an event change, `false` otherwise. _Available in: v23.0_ _Filter group: Medium_ * `feedElementType` (_string_) 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_ _Filter group: Small_ Allowed values: `Bundle`, `FeedItem`, `Recommendation`. 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_) Specifies whether to bookmark the new feed item for the user (`true`) or not (`false`). The default value is `false`. 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, 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`. * `modifiedDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `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`. 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`. * `myLike` (_object_) Reference If the context user has liked the comment, this property is a reference to the specific like, `null` otherwise. 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 `Reference`. * `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 `Reference`. * `originalFeedItemActor` (_string_) 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_ Allowed values: `null`. * `parent` (_string_) 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 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_ * `photoUrl` (_string_) URL of the photo associated with the feed item. _Available in: v23.0_ _Filter group: Medium_ * `preamble` (_object_) FeedItemPreambleMessageBody 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_ Includes all fields of `FeedItemPreambleMessageBody`. * `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. 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` (_string_) The `type` property always returns all types, regardless of API version. However, not all types are valid with all API versions. As of API version 32.0, use the `capabilities` property to determine what can be done with a feed item. See [Capabilities](/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_ Allowed values: `ActivityEvent`, `AdvancedTextPost`, `ApprovalPost`, `AttachArticleEvent`, `BasicTemplateFeedItem`, `CallLogPost`, `CanvasPost`, `CaseCommentPost`, `ChangeStatusPost`, `ChatTranscriptionPost`, `CollaborationGroupCreated`, `CollaborationGroupUnarchived`, `ContentPost`, `CreateRecordEvent`, `DashboardComponentAlert`, `DashboardComponentSnapshot`, `EmailMessageEvent`, `FacebookPost`, `LinkPost`, `MilestoneEvent`, `PollPost`, `ProfileSkillPost`, `QuestionPost`, `ReplyPost`, `RypplePost`, `SocialPost`, `TextPost`, `TrackedChange`, `UserStatus`. * `url` (_string_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ * `visibility` (_string_) Who can see the post. Valid 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. Default values: * For external users, the default value is `AllUsers`. External users must use this value to see their posts. * For internal users, the default value is `InternalUsers`. Internal users can accept this value or use the value `AllUsers` to allow external users to see their posts. If the parent of the feed item is a user, group, or direct message, the `visibility` of the feed item must be `AllUsers`. _Available in: v26.0_ _Filter group: Small_ Allowed values: `InternalUsers`, `AllUsers`. * `originalFeedElementId` (_string_) To share a feed element, specify its 18-character ID . You can’t share a post and upload a file in the same request body. In API version 39.0 and later, use the `capabilities.feedEntityShare.feedEntityId` property. _Available in: v31.0–38.0_ * `originalFeedItemId` (_string_) To share a feed item, specify its 18-character ID . In API version 32.0–38.0, use the `originalFeedElementId` property. In API version 39.0 and later, use the `capabilities.feedEntityShare.feedEntityId` property. _Available in: v24.0–31.0_ * `subjectId` (_string_) The ID of the parent this feed element is being posted to. This value can be the ID of a user, group, or record, or the string `me` to indicate the context user. In version 45.0 and later, you can move a feed element from one public group to another by setting this property to the ID of the new public group. You can’t include or change any other properties when moving a feed element. _Available in: v31.0_ ### MessageBodyInputRequest Message body input. * `messageSegments` (_array of string_) 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 Segmetn Input: Text _Available in: v23.0_ ### DurationTypeEnum Duration type Type: `string`. Allowed values: `Hours`, `Minutes`. ### WorkAuxiliaryDetailsInput Work auxiliary details * `blockTimeAfterAppointmentInMinutes` (_integer_) Block time after appointment in minutes * `blockTimeBeforeAppointmentInMinutes` (_integer_) Block time before appointment in minutes * `timeFrameEndInMinutes` (_integer_) Time frame end in minutes * `timeFrameStartInMinutes` (_integer_) Time frame start in minutes ### FeedElementCapabilities A container for all capabilities that can be included when creating a feed element. In API version 30.0 and earlier, most feed items can have comments, likes, topics, and so on. In version 31.0 and later, every feed item (and feed element) can have a unique set of capabilities. If a capability property exists on a feed element, that capability is available, even if the capability property doesn’t have a value. For example, if the `ChatterLikes` capability property exists on a feed element (with or without a value), the context user can like that feed element. If the capability property doesn’t exist, it isn’t possible to like that feed element. A capability can also contain associated data. For example, the `Moderation` capability contains data about moderation flags. #### XML example ``` 0Agxx00000000d1CAA 0Agxx00000000d2DFY false 069D00000001IOh 069D00000002IOg ``` * `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 Describes action links that can be created or updated on a feed element. To associate an action link group with a feed element, the client must be the same client app that created the action link group definition and the user must either be the user who created the definition or have View all Data permission. _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 Create or update a bookmark on a feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `BookmarksCapability`. * `bundle` (_GenericBundleCapability | TrackedChangeBundleCapability_) 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_ One of: `GenericBundleCapability`, `TrackedChangeBundleCapability`. * `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 Create or update a canvas app associated with a feed element. _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`. * `content` (_object_) ContentCapability Attach or update a file on a comment. Use this class to attach a new file or update a file that has already been uploaded to Salesforce. This request body isn’t available for feed posts in version 36.0 and later. In version 36.0 and later, use Files Capability Input. _Available in: v32.0–35.0_ _Filter group: Small_ Includes all fields of `ContentCapability`. * `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 Create or update the members of 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 Create or update extensions associated with a feed element. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ExtensionsCapability`. * `feedEntityShare` (_object_) FeedEntityShareCapability Share a feed entity with a feed post or comment. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedEntityShareCapability`. * `files` (_object_) FilesCapability Attach up to 10 files that have already been uploaded or remove one or more files from a feed element. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `FilesCapability`. * `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 Create or update a link attached to a feed element. _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 Create or vote on a poll feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `PollCapability`. * `questionAndAnswers` (_object_) QuestionAndAnswersCapability Create or edit a question feed element or set the best answer of the existing question feed element. _Available in: v32.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 Change the status of a feed post or comment. _Available in: v44.0_ _Filter group: Small_ Includes all fields of `StatusCapability`. * `topics` (_object_) TopicsCapability Assign topics to a feed element. _Available in: v38.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 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. 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_ ### FeedItemBody Chatter feed item body. * `isRichText` (_boolean_) Indicates if the body is rich text. _Available in: v35.0_ _Filter group: Small_ * `messageSegments` (_array of string_) 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_ ### 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. As of API version 32.0, use the `items` property. _Available in: v23.0–31.0_ _Filter group: Small_ * `myLike` (_object_) Reference 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 `Reference`. * `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 string_) 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`. ### FeedItemPreambleMessageBody Feed item preamble message body. * `messageSegments` (_array of string_) Collection of message segments, based on type. Segments can be one or more of the following: * Message Segment: Entity Link * Message Segment: Link (version 35.0 and later) * Message Segment: Text _Available in: v27.0_ _Filter group: Medium_ * `text` (_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”. _Available in: v27.0_ _Filter group: Small_ ### FeedItemTopics Feed item topic input. * `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_ * `topicId` (_string_) ID of an existing topic Required for existing topics if the `topicName` property isn’t used _Available in: v29.0_ * `topicName` (_string_) Name of a new or existing topic, up to 150 characters Required for new topics; required for existing topics if the `topicId` property isn’t used _Available in: v29.0_ ### ApprovalCapability If a feed element has this capability, it includes information about an approval. * `id` (_string_) 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_) The process instance step ID. The associated record represents one step in an approval process. _Available in: v32.0_ _Filter group: Small_ * `status` (_string_) The status of the approval. One of these values: * `Approved` * `Fault` * `Held` * `NoResponse` * `Pending` * `Reassigned` * `Rejected` * `Removed` * `Started` _Available in: v32.0_ _Filter group: Small_ ### AssociatedActionsCapability Describes action links that can be created or updated on a feed element. To associate an action link group with a feed element, the client must be the same client app that created the action link group definition and the user must either be the user who created the definition or have View all Data permission. An action link is a button on a feed element. Clicking an action link can take a user to a Web page, initiate a file download, or invoke an API call to Salesforce or to an external server. An action link includes a URL and an HTTP method, and can include a request body and header information, such as an OAuth token for authentication. Use action links to integrate Salesforce and third-party services into the feed so that users can drive productivity and accelerate innovation. * `platformActionGroups` (_array of PlatformActionGroupActivities_) 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_ * `actionLinkGroupIds` (_array of string_) The action link group IDs to associate with the feed element. Associate one `Primary` and up to 10 total action link groups to a feed item. Action link groups are returned in the order specified in this property. Get an action link group ID in the response from a request to [/connect/action-link-group-definitions](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Action-Links-Resources/operation/postActionLinkGroupDefinitionCollection). _Available in: v33.0_ ### 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` (_string_) 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_ Allowed values: `Announcement`. ### BookmarksCapability Create or update a bookmark on a feed element. * `isBookmarkedByCurrentUser` (_boolean_) Specifies if the feed element should be bookmarked for the user (`true`) or not (`false`). _Available in: v32.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. **Note**: Bundled posts contain feed-tracked changes and are in record feeds only. * `bundleType` (_string_) Type of bundle. The value is `GenericBundle` . _Available in: v31.0_ _Filter group: Small_ * `page` (_object_) FeedElementPage A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementPage`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.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. **Note**: Bundled posts contain feed-tracked changes and are in record feeds only. * `changes` (_array of FeedTrackedChange_) Collection of feed tracked changes. _Available in: v31.0_ _Filter group: Small_ * `bundleType` (_string_) Type of bundle. The value is `TrackedChanges` . _Available in: v31.0_ _Filter group: Small_ * `page` (_object_) FeedElementPage A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementPage`. * `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 Create or update a canvas app associated with a feed element. * `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_) 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` (_string_) 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_ Allowed values: `Customer`, `CustomerService`. * `createdBy` (_object | UserSummary_) Information about the user who created the comment. _Available in: v32.0_ _Filter group: Small_ One of: `object`, `UserSummary`. * `createdDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z. _Available in: v32.0_ _Filter group: Small_ * `eventType` (_string_) 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_ Allowed values: `NewInternal`, `NewPublished`, `NewPublishedByCustomer`, `PublishExisting`, `PublishExistingByCustomer`, `UnpublishExistingByCustomer`, `UnpublishExsiting`. * `id` (_string_) 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_ * `page` (_object_) LikePage Likes information for this feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LikePage`. * `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 `Reference`. ### CloseCapability Set a feed element to closed. 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 to set the feed element to 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`. ### ContentCapability Create or update a file associated with a comment. To attach or remove files from a feed post (instead of a comment) in version 36.0 and later, use Files Capability Input. * `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 of the content for links and Google docs. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Description of the file to be uploaded. Optional for new content. Not supported for existing content _Available in: v32.0_ _Filter group: Small_ * `downloadUrl` (_string_) URL to the content. _Available in: v32.0_ _Filter group: Small_ * `externalDocumentUrl` (_string_) 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_) 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 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 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 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_) 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` (_string_) 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_ Allowed values: `Allowed`, `Restricted`. * `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. This value is used as the file name for new content. For example, if the title is My Title, and the file is a .txt file, the file name is My Title.txt. Required for new content. Not supported for existing content _Available in: v32.0_ _Filter group: Small_ * `versionId` (_string_) Version ID of the file. _Available in: v32.0_ _Filter group: Medium_ * `contentDocumentId` (_string_) ID of the existing content. Required for existing content. Not supported for new content _Available in: v32.0_ ### 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 Create or update the members of 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. Optional when creating a direct message (POST). Not supported when updating a direct message (PATCH) _Available in: v39.0_ _Filter group: Small_ * `membersToAdd` (_array of string_) List of user IDs for members to include in the direct message. Required when creating a direct message (POST). Optional when updating a direct message (PATCH) _Available in: v39.0_ * `membersToRemove` (_array of string_) List of user IDs for members to remove from the direct message. Optional when updating a direct message (PATCH). Not supported when creating a direct message (POST) _Available in: v40.0_ ### EditCapability If a feed element or comment has this capability, it can be edited by users who have permission. * `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](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementEditCapabilityIsEditableByMe) or [Comment Capability, Editability](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getCommentEditCapabilityIsEditableByMe) resource. _Available in: v34.0_ _Filter group: Small_ * `isEditableByMeUrl` (_string_) The URL to check if the context user is able to edit this feed element or comment. _Available in: v34.0_ _Filter group: Medium_ * `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_) 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` (_string_) 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_ Allowed values: `aiAssisted`, `aiAutomated`. * `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` (_string_) 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_ Allowed values: `Inbound`, `Outbound`. * `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_ Allowed values: `Large`, `Normal`. * `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` (_string_) Status of an email message on a case. Values are: * `DraftStatus` * `ForwardedStatus` * `NewStatus` * `ReadStatus` * `RepliedStatus` * `SentStatus` _Available in: v47.0_ _Filter group: Small_ * `subject` (_string_) Subject of the email message. _Available in: v32.0_ _Filter group: Small_ * `textBody` (_string_) Body of the email message. 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 A icon. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Icon`. * `linkRecordId` (_string_) A ID associated with the link if the link URL refers to a Salesforce record. _Available in: v32.0_ _Filter group: Small_ * `linkUrl` (_string_) 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 Share a feed entity with a feed post or comment. * `feedEntity` (_FeedItemSummary | FeedEntityNotAvailableSummary_) The summary of the feed entity that is shared with the feed element or comment. _Available in: v39.0_ _Filter group: Small_ One of: `FeedItemSummary`, `FeedEntityNotAvailableSummary`. * `feedEntityId` (_string_) ID of the feed entity to share with the feed post or comment. _Available in: v39.0_ ### FilesCapability Attach up to 10 files that have already been uploaded or remove one or more files from a feed element. #### XML example ``` 069D00000001IOh 069D00000002IOg ``` * `items` (_array of Content_) A collection of file IDs and the operations to be carried out on the 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 Create or update a link attached to a feed element. * `url` (_string_) URL of the link. _Available in: v32.0_ _Filter group: Small_ * `urlName` (_string_) Name 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 Mute or unmute a feed element. * `isMutedByMe` (_boolean_) Indicates whether the feed element is muted for the context user. Default value is `false`. _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 `Reference`. ### PinCapability Pin or unpin a feed element 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 to pin (`true`) or unpin (`false`) the entity. _Available in: v41.0_ _Filter group: Small_ * `entityId` (_string_) ID of the entity to pin or unpin. In version 41.0 and later, `entityId` must be a feed item ID. In version 41.0–42.0, only one feed item can be pinned per feed. In version 43.0 and later, three feed items can be pinned per feed. _Available in: v41.0_ ### PollCapability Create or vote on a poll feed element. To create a poll, use the [Feed Elements, Post and Search](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) resource. To vote on a poll, use the [Feed Elements Capability, Poll](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getPollCapability) resource. #### XML example for creating a poll ``` Monday Tuesday ``` * `choices` (_array of FeedPollChoice_) The choices used to create a new poll. You must specify 2–10 poll choices for each poll. Required for creating a poll _Available in: v32.0_ * `myChoiceId` (_string_) ID of an existing choice on the feed poll. Used to vote on an existing poll. Required for voting on a poll _Available in: v32.0_ * `totalVoteCount` (_string_) Total number of votes cast on the feed poll element. _Available in: v32.0_ ### QuestionAndAnswersCapability Create or edit a question feed element or set the best answer of the existing question feed element. * `bestAnswer` (_object_) Comment Comment selected as the best answer for the question. _Available in: v32.0_ Includes all fields of `Comment`. * `bestAnswerSelectedBy` (_object_) UserSummary User who selected the best answer for the question. _Available in: v32.0_ 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_ * `candidateAnswers` (_object_) CandidateAnswersStatus Status of candidate answers for the question. _Available in: v41.0_ 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_ Includes all fields of `Reference`. * `questionTitle` (_string_) Title for a question feed element. To edit the title of a question, make a PATCH request to `/chatter/feed-elements/{feedElementId}`. Editing question titles is supported in version 34.0 and later. Required to POST or PATCH a question. _Available in: v32.0_ * `bestAnswerId` (_string_) A comment ID to use as a best answer for a question feed element. The best answer comment must already exist on the question feed element. Required to PATCH the best answer. Not supported in POST requests. _Available in: v32.0_ ### ReadByCapability Mark feed elements as read by the context user. * `isReadByMe` (_boolean_) Specifies to mark the feed element as read (`true`) for the context user. _Available in: v40.0_ _Filter group: Small_ * `lastReadDateByMe` (_string_) Specifies the last date, in ISO 8601 format, when the feed element is marked as read for the context user. If you don’t specify a date or you specify a future date, the current system date is used. _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` (_NonEntityRecommendation | object_) A collection of recommendations. _Available in: v32.0_ _Filter group: Small_ One of: `NonEntityRecommendation`, `object`. ### 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` (_string_) Message type of the social post. Values are: * `Comment` * `Direct` * `Post` * `PrivateMessage` * `Reply` * `Retweet` * `Tweet` _Available in: v38.0_ _Filter group: Small_ * `name` (_string_) Title or heading of the social post. _Available in: v36.0_ _Filter group: Small_ * `postUrl` (_string_) External URL to the social post on the social network. _Available in: v36.0_ _Filter group: Small_ * `provider` (_string_) Social network that this social post belongs to. Values are: * `Facebook` * `GooglePlus` * `Instagram` * `InstagramBusiness` * `KakaoTalk` * `Kik` * `Line` * `LinkedIn` * `Messenger` * `Other` * `Pinterest` * `QQ` * `Rypple` * `SinaWeibo` * `SMS` * `Snapchat` * `Telegram` * `Twitter` * `VKontakte` * `WeChat` * `WhatsApp` * `YouTube` _Available in: v36.0_ _Filter group: Small_ * `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 Change the status of a feed post or comment. * `feedEntityStatus` (_string_) 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. Posts that have a status of `PendingReview` or `Published` can’t be changed to a status of `Draft` and vice versa. Only admins can change the status of a post or comment to or from `Isolated` status. _Available in: v37.0_ _Filter group: Small_ Allowed values: `Draft`, `Isolated`, `PendingReview`, `Published`. * `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 Assign topics to a feed element. * `canAssignTopics` (_boolean_) `true` if a topic can be assigned to the feed element, `false` otherwise. _Available in: v32.0_ * `items` (_array of Topic_) A collection of topics associated with this feed element. _Available in: v32.0_ * `contextTopicName` (_string_) Name of the parent topic in the site to which the feed element belongs. _Available in: v38.0_ * `topics` (_array of string_) List of topics to assign to the feed element. _Available in: v38.0_ ### 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 Upvote or downvote a feed element or a comment. * `downVoteCount` (_integer (int64)_) Number of downvotes. _Available in: v41.0_ _Filter group: Small_ * `myVote` (_string_) Specifies the context user’s vote. Values are: * `Down` * `None` * `Up` _Available in: v41.0_ _Filter group: Small_ * `upVoteCount` (_integer (int64)_) Number of upvotes. _Available in: v41.0_ _Filter group: Small_ * `vote` (_string_) Type of vote for a feed element or comment. Values are: * `Down` * `None` * `Up` _Available in: v41.0_ ### Comment A comment. * `attachment` (_string_) Values are: * [Attachment Input: Existing Content](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) * [Attachment Input: New File Upload](/docs/platform/connect-rest-api/guide/intro_what_is_chatter_connect) As of version 32.0, use the `capabilities` property. _Available in: v24.0–31.0_ _Filter group: Medium_ * `body` (_object_) MessageBodyInputRequest The body of the comment. Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a `describeSObjects()` call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field. To edit this property in a comment, make a PATCH request to `/chatter/comments/{commentId}`. Editing comments is supported in version 34.0 and later. Rich text and inline images are supported in comment bodies in version 35.0 and later. Inline images in content bodies must use content document (069) image files previously uploaded to Salesforce. Entity links are supported in version 43.0 and later. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `MessageBodyInputRequest`. * `capabilities` (_object_) CommentCapabilities Capabilities of the comment, such as a file attachment. You can edit a comment’s body, but you can’t update a comment’s capabilities. _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_) 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 `Reference`. * `feedItem` (_object_) Reference Feed item on which the comment is posted. As of version 32.0, use the `feedElement` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `Reference`. * `id` (_string_) 18-character ID of the comment. _Available in: v23.0_ _Filter group: Small_ * `isDeletable` (_boolean_) 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_ * `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`. * `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 `Reference`. * `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 `Reference`. * `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 of the parent comment for a threaded comment. _Available in: v44.0_ _Filter group: Small_ * `type` (_string_) 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_ Allowed values: `ContentComment`, `TextComment`. * `url` (_string_) 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`. ### Like Chatter like. * `id` (_string_) 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 `Reference`. * `url` (_string_) 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`. ### 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_) 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_) 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_ ### Topic Topic input. * `createdDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v28.0_ _Filter group: Big_ * `description` (_string_) Text description of the topic _Available in: v28.0_ _Filter group: Big_ * `id` (_string_) 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](/docs/platform/connect-rest-api/guide/connect_error_responses#status-codes-and-error-responses). _Available in: v33.0_ _Filter group: Small_ * `name` (_string_) Name of the topic Use this property to change only the capitalization and spacing of the topic name. _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 to the topic detail page _Available in: v29.0_ _Filter group: Small_ * `idsToMerge` (_array of string_) List of up to five secondary topic IDs to merge with the primary topic If any of the secondary topics are navigational or featured topics, they lose their topic type, topic images, and children topics. Their feed items are reassigned to the primary topic. If you merge a topic with a content topic, the content associations are preserved. If you merge a topic with an inactive endorsee, the endorsement isn’t mapped to the primary topic. _Available in: v33.0_ ### 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 `Reference`. ### 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` (_string_) 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_ * `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_ ### 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_ ### 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_ ### 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_) BannerPhotoQuip User’s banner photo. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhotoQuip`. * `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_) 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_) Reference 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 `Reference`. * `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}` . _Available in: v24.0_ _Filter group: Small_ * `userType` (_string_) 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_ Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`. ### 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 (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `label` (_string_) Repository label. _Available in: v32.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_) Reference 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 `Reference`. * `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, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### DashboardComponentSnapshot Dashboard component snapshot input. * `componentId` (_string_) 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_) 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_) 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_) 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_) The source URL to retrieve the thumbnail image of a snapshot. Access this URL with OAuth credentials. _Available in: v32.0_ _Filter group: Small_ * `parentId` (_string_) A user, group, or dashboard ID to which you are posting the snapshot. _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_ * `feedItemBody` (_object_) MessageBodyInputRequest Contains the text that accompanies the feed item associated with the dashboard component snapshot. _Available in: v25.0_ Includes all fields of `MessageBodyInputRequest`. * `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_ ### 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_) 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_) 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 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 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_ ### 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`. ### 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_ * `domain` (_string_) Service domain to which the extension belongs. By convention, this is the third portion of the extension point name (epn). For example, if the epn is `Commerce_Domain_Cart_Calculate` , the service domain is `Cart` ; and if the epn is `Commerce_Endpoint_Account_Address` , the service domain is `Account` . _Available in: v58.0_ _Filter group: Big_ * `epn` (_string_) Extension point name (unique identifier for an extension). For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. _Available in: v58.0_ _Filter group: Big_ * `name` (_string_) Name of the extension. By convention, this is the fourth portion of the extension point name (epn). For example, if the epn is `Commerce_Domain_Cart_Calculate` , the name is `Calculate` . _Available in: v58.0_ _Filter group: Big_ * `product` (_string_) Extension family name. By convention, this is the first portion of the extension point name (epn). For example, if the epn is `Commerce_Domain_Cart_Calculate` , the extension family name is `Commerce` . _Available in: v58.0_ _Filter group: Big_ * `type` (_string_) Type of extension. Valid values are: * `Domain` * `Endpoint` _Available in: v58.0_ _Filter group: Big_ ### FeedItemSummary A feed item summary. * `actor` (_RecordSummary | UserSummary | UnauthenticatedUser_) Entity that created the feed entity. _Available in: v39.0_ _Filter group: Small_ One of: `RecordSummary`, `UserSummary`, `UnauthenticatedUser`. * `body` (_object_) FeedItemBody Information about the feed entity. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) FeedElementCapabilities Container for all capabilities that can be included with a feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilities`. * `createdDate` (_string_) 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` (_string_) Type of feed entity. * `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: v39.0_ _Filter group: Small_ Allowed values: `Bundle`, `FeedItem`, `Recommendation`. * `header` (_object_) FeedItemBody Title of the post. This property contains renderable plain text for all the message segments. If a client doesn’t know how to render a feed element type, it should render this text. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string_) 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_) When the feed item was modified in the form of an ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z. _Available in: v39.0_ _Filter group: Small_ * `originalFeedItem` (_object_) Reference Reference to the original feed item if this feed item is a shared feed item; otherwise, `null`. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `Reference`. * `originalFeedItemActor` (_RecordSummary | UserSummary | UnauthenticatedUser_) If this feed item is a shared feed item, information about the original poster of the feed item; otherwise, `null`. _Available in: v39.0_ _Filter group: Medium_ One of: `RecordSummary`, `UserSummary`, `UnauthenticatedUser`. * `parent` (_FileSummary | object | RecordSummary | UserSummary_) Parent of the feed entity. _Available in: v39.0_ _Filter group: Medium_ One of: `FileSummary`, `object`, `RecordSummary`, `UserSummary`. * `photoUrl` (_string_) 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 to the feed entity. _Available in: v39.0_ _Filter group: Small_ * `visibility` (_string_) Specifies who can see a feed item. * `AllUsers` —Visibility is not limited to internal users. * `InternalUsers` —Visibility is limited to internal users. _Available in: v39.0_ _Filter group: Small_ Allowed values: `AllUsers`, `InternalUsers`. ### FeedEntityNotAvailableSummary A summary when the feed entity isn’t available. * `actor` (_RecordSummary | UserSummary | UnauthenticatedUser_) _Available in: v39.0_ _Filter group: Small_ One of: `RecordSummary`, `UserSummary`, `UnauthenticatedUser`. * `body` (_object_) FeedItemBody _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `createdDate` (_string_) _Available in: v39.0_ _Filter group: Small_ * `feedElementType` (_string_) _Available in: v39.0_ _Filter group: Small_ * `id` (_string_) _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` (_FileSummary | object | RecordSummary | UserSummary_) _Available in: v39.0_ _Filter group: Medium_ One of: `FileSummary`, `object`, `RecordSummary`, `UserSummary`. * `relativeCreatedDate` (_string_) _Available in: v39.0_ _Filter group: Small_ * `url` (_string_) _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 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 to the content. _Available in: v36.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: 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_) 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 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 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 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 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` (_string_) 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_ Allowed values: `Allowed`, `Restricted`. * `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_ Allowed values: `Processing`, `Failed`, `Success`, `Na`. * `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_ Allowed values: `Processing`, `Failed`, `Success`, `Na`. * `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_ Allowed values: `Processing`, `Failed`, `Success`, `Na`. * `title` (_string_) Title of the file. _Available in: v36.0_ _Filter group: Small_ * `versionId` (_string_) Version ID of the file. _Available in: v36.0_ _Filter group: Medium_ ### MediaReference A media reference. * `mediaUrl` (_string_) URL to stream or download the media. _Available in: v41.0_ _Filter group: Small_ * `thumbnailUrl` (_string_) If one exists, URL of the media’s thumbnail. _Available in: v41.0_ _Filter group: Small_ ### FeedPollChoice Feed poll choice. * `id` (_string_) 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_) 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_) 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_) 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_ ### NonEntityRecommendation A recommendation for a non-Salesforce entity, such as an application. This response body isn’t available in version 34.0 and later. In version 34.0 and later, the Chatter Recommendation response body is used for all recommendations. * `displayLabel` (_string_) Localized label of the non-entity object. _Available in: v32.0_ _Filter group: Small_ * `explanation` (_object_) ExplanationSummary The recommendation explanation. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ExplanationSummary`. * `motif` (_object_) Motif Motif for the non-entity object. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Motif`. * `recommendationType` (_string_) Specifies the type of record being recommended. * `apps` * `articles` * `files` * `groups` * `records` * `topics` * `users` _Available in: v32.0_ _Filter group: Small_ ### ChatterRecommendation A Chatter, custom, or static recommendation. * `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/v67.0/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`. * `explanation` (_object_) ExplanationSummary The recommendation explanation. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ExplanationSummary`. * `object` (_FileSummary | Group | RecordSummary | UserSummary_) The object with which the receiver is recommended to take action. In version 32.0 and later, use the `entity` property. _Available in: v23.0–31.0_ _Filter group: Small_ One of: `FileSummary`, `Group`, `RecordSummary`, `UserSummary`. * `platformActionGroup` (_object_) PlatformActionGroupActivities A platform action group instance with state appropriate for the context user. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `PlatformActionGroupActivities`. * `recommendationType` (_string_) Specifies the type of record being recommended. * `apps` * `articles` * `files` * `groups` * `records` * `topics` * `users` _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Not available after version 23.0. _Available in: v23.0–23.0_ * `url` (_string_) URL to the recommendation. _Available in: v34.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 (Id)_) 18-character ID of the record. _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_) Reference 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 `Reference`. * `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 RecordSection_) List of record view sections. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _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 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_ ### SocialPostStatus The status of a social post. * `message` (_string_) Status message. _Available in: v36.0_ _Filter group: Small_ * `type` (_string_) Status type. Values are: * `ApprovalPending` * `ApprovalRecalled` * `ApprovalRejected` * `Deleted` * `Failed` * `Hidden` * `Pending` * `Sent` * `Unknown` _Available in: v36.0_ _Filter group: Small_ ### CommentCapabilities Comment capabilities input. * `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 to attach to the comment. _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 Feed entity to share to the comment. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `FeedEntityShareCapability`. * `record` (_object_) RecordCapability Existing knowledge article to attach to the comment. _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`. ### 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 when the item was flagged. Format is ISO 8601. _Available in: v40.0_ _Filter group: Small_ * `id` (_string_) ID of the moderation flag. _Available in: v40.0_ _Filter group: Small_ * `moderationType` (_string_) Type of moderation flag. Values are: * `FlagAsInappropriate` —Flag for inappropriate content. * `FlagAsSpam` —Flag for spam. _Available in: v40.0_ _Filter group: Small_ Allowed values: `FlagAsInappropriate`, `FlagAsSpam`. * `note` (_string_) Note from user who flagged the item. _Available in: v40.0_ _Filter group: Small_ * `visibility` (_string_) 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_ Allowed values: `ModeratorsOnly`, `SelfAndModerators`. ### 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 input. **Note**: Setting a user status is no longer available as of version 25.0. Post feed items to the feed instead, using Feed Item Input. * `body` (_array of FeedItemBody_) Description of message body. _Available in: v23.0–24.0_ _Filter group: Small_ * `parentId` (_string_) 18-character ID _Available in: v23.0–25.0_ _Filter group: Small_ * `url` (_string_) 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_ ### 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_ Allowed values: `NoAuthentication`, `Oauth`, `Password`. * `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_ ### DirectMessageMembershipActivity Direct message membership activity. * `activityDate` (_string_) 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_ ### UnauthenticatedUser Unauthenticated user. * `name` (_string_) Either the name in the From field of the source email, or the email address from the source email. _Available in: v24.0_ _Filter group: Small_ * `type` (_string_) _Available in: v24.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_ * `contentSize` (_integer_) Size of the file in bytes. _Available in: v24.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: 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_ * `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`. * `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_ * `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_ * `id` (_string_) 18-character ID of the file. _Available in: v24.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 that the object is a file. The motif can also contain the object’s base color. The icon is not a preview of the file. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, contains information about the subscription, otherwise `null` . _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `Reference`. * `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_ Allowed values: `Chatter`, `Content`, `FileField`. * `owner` (_object_) UserSummary Owner of the file. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `parentFolder` (_object_) Reference Reference to the parent folder. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `Reference`. * `pdfRenditionStatus` (_string_) Specifies if a PDF preview version of the file has been rendered. _Available in: v24.0_ _Filter group: Big_ * `publishStatus` (_string_) Publish status of the file. One of these values: * `PendingAccess` —File is pending publishing. * `PrivateAccess` —File is private. * `PublicAccess` —File is public. _Available in: v29.0_ _Filter group: Small_ Allowed values: `PendingAccess`, `PrivateAccess`, `PublicAccess`. * `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` (_string_) 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_ Allowed values: `Allowed`, `Restricted`. * `sharingPrivacy` (_string_) Sharing privacy of a file. Values are: * `None` —File is visible to anyone with record access. * `PrivateOnRecords` —File is private on records. _Available in: v41.0_ _Filter group: Medium_ Allowed values: `None`, `PrivateOnRecords`. * `sharingRole` (_string_) 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_ Allowed values: `Admin`, `Collaborator`, `Owner`, `Viewer`, `WorkspaceManaged`. * `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_ Allowed values: `Processing`, `Failed`, `Success`, `Na`. * `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_ Allowed values: `Processing`, `Failed`, `Success`, `Na`. * `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_ Allowed values: `Processing`, `Failed`, `Success`, `Na`. * `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_ ### 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_) 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`. ### ExplanationSummary A summary explanation for a Chatter recommendation. * `detailsUrl` (_string_) URL to explanation details or `null` if the Chatter recommendation doesn’t have a detailed explanation. _Available in: v24.0_ _Filter group: Small_ * `summary` (_string_) Summary explanation for the Chatter recommendation. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Indicates the reason for the Chatter recommendation. * `ArticleHasRelatedContent` —Articles with related content to a context article. * `ArticleViewedTogether` —Articles often viewed together with the article that the context user just viewed. * `ArticleViewedTogetherWithViewers` —Articles often viewed together with other records that the context user views. * `Custom` —Custom recommendations. * `FilePopular` —Files with many followers or views. * `FileViewedTogether` —Files often viewed at the same time as other files that the context user views. * `FollowedTogetherWithFollowees` —Users often followed together with other records that the context user follows. * `GroupMembersFollowed` —Groups with members that the context user follows. * `GroupNew` —Recently created groups. * `GroupPopular` —Groups with many active members. * `ItemViewedTogether` —Records often viewed at the same time as other records that the context user views. * `PopularApp` —Applications that are popular. * `RecordOwned` —Records that the context user owns. * `RecordParentOfFollowed` —Parent records of records that the context user follows. * `RecordViewed` —Records that the context user recently viewed. * `TopicFollowedTogether` —Topics often followed together with the record that the context user just followed. * `TopicFollowedTogetherWithFollowees` —Topics often followed together with other records that the context user follows. * `TopicPopularFollowed` —Topics with many followers. * `TopicPopularLiked` —Topics on posts that have many likes. * `UserDirectReport` —Users who report to the context user. * `UserFollowedTogether` —Users often followed together with the record that the context user followed . * `UserFollowsSameUsers` —Users who follow the same users as the context user. * `UserManager` —The context user’s manager. * `UserNew` —Recently created users. * `UserPeer` —Users who report to the same manager as the context user. * `UserPopular` —Users with many followers. * `UserViewingSameRecords` —Users who view the same records as the context user. _Available in: v24.0_ _Filter group: Small_ 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`. ### 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_) _Available in: v22.0_ _Filter group: Small_ ### 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_) ListViewObjectDefinition The definition of the type of the objects in this list view. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ListViewObjectDefinition`. * `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_ ### RecordSection A section of record fields on a record detail. * `columnCount` (_integer_) When rendering fields in a record section, the layout of the fields should be rendered in rows and columns with the number of columns described here. * `columnOrder` (_ConnectRecordColumnOrderEnum_) * `fields` (_array of AbstractRecordField_) The fields and values for the record contained in this section. * `heading` (_string_) A localized label to display with this section of fields when rendering. * `isCollapsible` (_boolean_) True if this section of fields can be collapsed to hide all of the fields. ### RecordCapability Attach an existing knowledge article to a comment. * `recordId` (_string_) ID of the existing knowledge article to attach. _Available in: v42.0_ _Filter group: Small_ * `url` (_string_) URL to the record. _Available in: v42.0_ _Filter group: Small_ ### VerifiedCapability Mark a comment 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 to mark the comment as verified (`true`) or unverified (`false`). Only verified comments can be marked as unverified, and only unverified comments can be marked as verified. _Available in: v41.0_ _Filter group: Small_ * `isVerifiedByAnonymized` (_boolean_) Specifies whether to mark the comment as verified by an anonymous user (`true`). If a user previously verified a comment and then requested the activity to be deleted, use `isVerifiedByAnonymized` to maintain the verification and anonymize the value of `lastVerifiedByUser`. You can’t set `isVerified` and `isVerifiedByAnonymized` to `true` at the same time. `isVerifiedByAnonymized` can be set to `true` only if `isVerified` is already set to `true`. You can’t set `isVerifiedByAnonymized` to `false`. After `isVerifiedByAnonymized` is set to `true`, it can be undone only when another user marks the comment as unverified and then reverifies the comment. _Available in: v43.0_ * `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_) 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_ ### 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`. ### 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_ ### 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_ ### 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`. ### ConnectRecordColumnOrderEnum Order in which fields are rendered in a grid. One of these values: * `LeftRight`: Fields are rendered from left to right. * `TopDown`: Fields are rendered from the top down. Type: `string`. Allowed values: `LeftRight`, `TopDown`. ### AbstractRecordField A field on a record object. * `type` (_string_) The type of this field. ### 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` (_object_) ConnectDirectoryEntryTypeEnum The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `ConnectDirectoryEntryTypeEnum`. ### FilesConnectGroupTypeEnum Type of group. One of these values: * `Everybody`: Group is public to everybody. * `EverybodyInDomain`: Group is public to everybody in the same domain. * `Unknown`: Group type is unknown. Type: `string`. Allowed values: `Everybody`, `EverybodyInDomain`, `Unknown`. ### ConnectDirectoryEntryTypeEnum The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Type: `string`. Allowed values: `GroupEntry`, `UserEntry`. ### 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. * `id` (_string (Id)_) 18-character ID of the record. _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_) Reference 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 `Reference`. * `name` (_string_) The localized name _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### 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 record. _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_) Reference 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 `Reference`. * `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_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### 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_) 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_ ### AbstractUser Basic details of a user in the organization. * `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 (Id)_) 18-character ID of the record. _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_ * `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_) Reference 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 `Reference`. * `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 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_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _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 `ConnectUserTypeEnum`. ### ExperienceModelRenderableTypeDetail Represents the common details about a Renderable Type (i.e., Content Type, Block Type, Property Type, etc.). * `description` (_string_) Description of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ * `designConfig` (_object_) Design configuration for the specified target. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `developerName` (_string_) Developer name, or apiName, of the type. _Available in: v58.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the type, returned only for database-based (custom) types. _Available in: v58.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fullyQualifiedName. _Available in: v58.0_ _Filter group: Small_ * `renditionConfig` (_object_) Rendition configuration for the specified target. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `schema` (_object_) JSON schema definition, or schema.json, of the type. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `title` (_string_) The title of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ ### ExperienceModelTypeDetail Represents the common details about a Type. * `description` (_string_) Description of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ * `developerName` (_string_) Developer name, or apiName, of the type. _Available in: v58.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the type, returned only for database-based (custom) types. _Available in: v58.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fullyQualifiedName. _Available in: v58.0_ _Filter group: Small_ * `schema` (_object_) JSON schema definition, or schema.json, of the type. _Available in: v58.0_ _Filter group: Big_ Additional properties: `object`. * `title` (_string_) The title of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ ### AbstractExperienceModelTypeCollection Abstract Collection Representation of a UEM Type i.e. Block, Property, or Content type. * `count` (_integer_) Number of types returned. _Available in: v58.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the page of types. _Available in: v58.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) URL to the next page of types. _Available in: v58.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of types. _Available in: v58.0_ _Filter group: Medium_ ### AbstractExperienceModelTypeSummary Abstract Summary Representation of a UEM Type i.e. Block, Property, or Content type.A collection of this is returned in the list endpoints. * `description` (_string_) Description of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ * `detailUrl` (_string (url)_) Individual detail resource URL to the type. _Available in: v58.0_ _Filter group: Small_ * `developerName` (_string_) Developer name, or apiName, of the type. _Available in: v58.0_ _Filter group: Medium_ * `id` (_string (Id)_) ID of the type, returned only for the database-based (custom) types. _Available in: v58.0_ _Filter group: Medium_ * `namespacePrefix` (_string_) Namespace prefix that is associated with the type. Refer to a type using the namespacePrefix\_\_developerName notation, or fullyQualifiedName. _Available in: v58.0_ _Filter group: Medium_ * `title` (_string_) Title of the type in its schema.json. _Available in: v58.0_ _Filter group: Small_ ### AbstractFile Description of a file. * `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 `FilesConnectRepositorySbi`. * `contentModifiedDate` (_string (date-time)_) 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)_) ID of the content version. _Available in: v62.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) 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)_) URL to the file. _Available in: v26.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: 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 `ExternalFilePermissionInformationSbi`. * `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 (Id)_) 18-character ID of the record. _Available in: v23.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 `ModerationFlagsSbi`. * `modifiedDate` (_string (date-time)_) 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 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_) Reference 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 `Reference`. * `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_) Reference Reference to the parent folder. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `Reference`. * `pdfRenditionStatus` (_string_) Specifies if a PDF preview version of the file has been rendered. _Available in: v24.0_ _Filter group: Big_ * `publishStatus` (_object_) ConnectFilePublishStatusEnum Publish status of the file. One of these values: * `PendingAccess` —File is pending publishing. * `PrivateAccess` —File is private. * `PublicAccess` —File is public. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectFilePublishStatusEnum`. * `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: v26.0_ _Filter group: Medium_ * `renditionUrl240By180` (_string (url)_) 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)_) 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)_) 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` (_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`. * `sharingPrivacy` (_object_) ConnectFileSharingPrivacyEnum Sharing privacy of a file. Values are: * `None` —File is visible to anyone with record access. * `PrivateOnRecords` —File is private on records. _Available in: v41.0_ _Filter group: Medium_ Includes all fields of `ConnectFileSharingPrivacyEnum`. * `sharingRole` (_object_) 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_ Includes all fields of `ConnectFileSharingRoleEnum`. * `systemModstamp` (_string (date-time)_) 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_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ * `versionNumber` (_string_) Version number of the file. _Available in: v24.0_ _Filter group: Medium_ ### ConnectExternalItemSharingTypeEnumSbi Specifies the current sharing status of an external item Type: `string`. Allowed values: `DomainSharing`, `PrivateSharing`, `PublicSharing`. ### FilesConnectGroupTypeEnumSbi Specifies the type of group. Type: `string`. Allowed values: `Everybody`, `EverybodyInDomain`, `Unknown`. ### AbstractDirectoryEntrySummarySbi Description of a directory entry with summary information. * `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_ * `id` (_string_) ID of the group. _Available in: v35.0_ _Filter group: Small_ * `type` (_ConnectDirectoryEntryTypeEnumSbi_) ### ConnectNetworkModerationTypeEnum Specifies the type of flag Type: `string`. Allowed values: `FlagAsInappropriate`, `FlagAsSpam`. ### ConnectNetworkModerationVisibilityEnum Specifies the visibility behavior of a flag to various user types. Type: `string`. Allowed values: `ModeratorsOnly`, `SelfAndModerators`. ### ConnectionProperties Representation of Network Connection Properties ### SurveyPageOutput The details of the page in the survey. * `label` (_string_) The label of the survey page. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) The API name of the survey page. _Available in: v56.0_ _Filter group: Small_ * `pageType` (_SurveyPageTypeEnum_) ### CalmBaseInput Base representation for asset generation in asset management service. * `assetAction` (_object_) CalmAssetActionInput Asset action that creates the asset. _Available in: v50.0_ Includes all fields of `CalmAssetActionInput`. * `assetActionSources` (_array of CalmAssetActionSourceInput_) List of asset action sources. _Available in: v50.0_ ### AbstractListInput Abstract primitive list ### FslResponse Base output representation for ESO operations ### MigratedEsoOperationInputBase Migration base input representation for ESO operations. ### EsoOperationInput The common input representation for ESO operations. ### AbstractServiceAppointmentInput Service Appointment input representation * `assignedResources` (_array of AssignedResourceInput_) Service resource who is assigned to a service appointment. When updating an appointment, pass the complete list of resources needed. If you don’t pass a resource that is assigned to a service appointment, the API deletes that assigned resource. For example, suppose that an existing service appointment has assigned resources: A and B and if you pass assigned resources: B and C. The API checks the resource availability of B and C for existing work type and service territory, and if both are available, the service appointment gets updated with: * Resource A—Deleted * Resource B—Updated * Resource C—Created However, if you don’t pass any of the assigned resources, the API assumes there is no change. When updating an appointment, you can use `extendedFields` to add values to any of the fields, including custom fields, in `assignedResources` as long as you have edit access to those fields. _Available in: v51.0_ * `lead` (_object_) LeadInput Prospect or lead. Required if `serviceAppointment` isn’t provided. Required to create a service appointment with unauthenticated guest users. _Available in: v48.0_ Includes all fields of `LeadInput`. * `schedulingPolicyId` (_string_) ID of the `AppointmentSchedulingPolicy` object. If no scheduling policy is passed in the request body, the default configurations are used. The only scheduling policy configuration that is used in determining time slots is the enforcement of account visiting hours. _Available in: v51.0_ * `serviceAppointment` (_object_) ServiceAppointmentInput Appointment to complete a service work for a customer. When creating an appointment, you can use `extendedFields` to add values to any of the fields, including custom fields, in `serviceAppointment` as long as you have edit access to those fields. Required if `lead` isn’t provided _Available in: v48.0_ Includes all fields of `ServiceAppointmentInput`. ### AbstractDirectoryEntrySummary Description of a directory entry with summary information. * `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_ * `id` (_string_) ID of the group. _Available in: v35.0_ _Filter group: Small_ * `type` (_object_) ConnectDirectoryEntryTypeEnum The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `ConnectDirectoryEntryTypeEnum`.