Connect REST API Developer Guide
Connect REST API Resources
We’re making major improvements to the Connect REST API reference content in July 2026. We’re replacing the separate pages for resources, request bodies, and response bodies with a unified, single-page layout that expands to show details as you need them. Existing resource pages will automatically redirect to the correct resource in the new interface. Request and response body pages will redirect to the main API reference page because this information appears in context with its associated resources. To preview the new interface, see the Data 360 Connect REST API.
Important
For Chatter REST API resources, see Chatter REST API Resources.
-
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. -
Activity Reminders Resources
Get upcoming activity reminders in Salesforce Classic. Get, update, or delete an activity reminder in Salesforce Classic. -
Agentforce Data Libraries (Beta)
Agentforce Data Libraries enhance the accuracy of AI features like Agentforce Agents by connecting them to your trusted data sources. Data libraries use unstructured or semi-structured data so that they can take large sets of information that exist on the web, in documents, or as large text inputs in fields, and turn that into more useful, searchable information. -
Application for Program
Create an application for a program. -
Batch Resource
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. -
Bot Utterance Intent Prediction Resources
Predict the intent of utterances for a bot. -
Bot Version Activation Resource
Get and change the activation information of a bot version. -
Briefcase Priming Records Resource
Get a list of records related to an offline briefcase. -
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. -
CMS Managed Content Resources
Get published managed content versions for an Experience Cloud site or a channel. Search managed content in an Experience Cloud site or channel. Get managed content delivery channels for the context user. Get published managed content versions for a channel. Search managed content in a channel. Get the binary stream of published managed content. Get or update the searchable status for managed content types in a channel. Get a piece of managed content. Get a managed content folder. -
Commerce B2B Resources
Get, create, update, and delete your commerce data. Work with address management, carts, checkouts, orders, products, promotions, taxes, wishlists, and search settings. -
Commerce Einstein Webstore Resources
Get the status of a Commerce Einstein deployment. Get the Commerce Einstein configuration. Export and purge Commerce Einstein activity. Get Commerce Einstein product recommendations. -
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. -
Content Taxonomy Resources
Create, get, update, delete, and search content taxonomy terms. -
Content Workspace Permissions Resource
Get a user's permissions for a content workspace. -
Conversation Application Definition Resource
Get information about an integration’s conversation application definition and the associated bot. -
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. -
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. -
Prompt Templates Resources
Get prompt template data and generate LLM responses using prompt templates. -
Einstein Recommendation Resources
Get runtime metrics for Einstein Article and Einstein Reply Recommendations. -
Email Merge Field Services Resource
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. -
Employee Profiles Resources
Get, upload and crop, and delete an employee photo or banner photo. -
Enhanced CMS Workspaces Resources
Get managed content channels. Create a managed content channel. Get, update, or delete a managed content channel. Get managed content delivery channels. Get collection items for a channel or Experience Cloud site. Get a collection of published contents for a channel or Experience Cloud site. Get a piece of published content for a channel or Experience Cloud site. Search for content in a channel or Experience Cloud site. Get the binary stream of a media node of published content in a channel. Get or update the searchable status for managed content types in a channel. Get search indexes or trigger search indexing for a channel. Create managed content. Get a version of a piece of content. Clone a piece of managed content. Get, add, or remove taxonomy term associations from managed content. Get digital asset management (DAM) providers. Create, update, or delete a DAM provider instance. Publish and unpublish content. Create, update, get, or delete a managed content variant. Get a managed content folder. Get targets that a managed content space folder can be shared with. Get or update the targets that a managed content space folder is shared with. Search for managed content items, including variants and folders, in spaces and folders. Get managed content spaces. Create, get, or update a managed content space. Get channels for a managed content space. Add or remove channels from a managed content space. -
Environment Hub Resources
Use Environment Hub resources to create new orgs and connect existing orgs to the hub. -
Experience Cloud CMS Content Search Resource
Search an Experience Cloud site. -
Experience Cloud Microsites Resources
Get, save, and submit marketing integration forms for an Experience Cloud site. -
Experience Cloud Sites Knowledge Resources
Get trending articles for an Experience Cloud site. Get trending and top-viewed articles for a topic in an Experience Cloud site. Increase article view counts. -
Experience Cloud Sites Moderation Resources
Get information about whether a user has flagged a file as inappropriate. Delete flags on files. Get audit statistics for a user in an Experience Cloud site. -
Experience Cloud Sites Resources
Get information about Experience Cloud sites, create a site, and publish a site. Get the Experience Builder templates available to the context user. Get externally managed accounts for sites. -
Experience Model Resources
Get experience model property types. -
External Email Services Resource
Get information about the external email services available to the context user. -
Field Service Recordset Filter Criteria Resource
Filter records on recordset filter criteria. -
Field Service Shifts from Pattern Resource
Preview and create up to 2,000 shifts from a pattern. -
Files Connect Repository Resources
A Files Connect repository is an external content repository that’s connected to Salesforce. Use these resources to get a list of repositories, to get information about a repository or a repository file, and to get the content of a repository file. Also use these resources to get information about the files and folders in a repository folder. Use these resources to get a repository’s directory entries, permissions, and permission types. Also use these resources to update a repository’s permissions. -
Files Resources
Get the file upload config. Get information about files, including content, rendered version, and sharing. Get information about asset files, including content and rendition. -
Flow Approval Processes Resource
Get the status and available actions for flow approval processes. -
Folders Resources
Get information about a folder or the contents of a folder. Modify, delete, and add items to folders. -
Forecasts Resources
Get information about forecast users, managers, and the forecast hierarchy. -
Knowledge Article View Stat Resource
Increase the view count of a knowledge article by one. -
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 Resource
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. -
Navigation Menu Items Resource
Get navigation menu items for an Experience Cloud site. -
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. -
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 Resource
Fetch the files generated for an optimization request in Enhanced Scheduling and Optimization. -
Orchestration Resources
Get orchestration instances or details about an orchestration instance. -
Pardot Business Unit Context Resource
Get the Pardot business units the context user has access to. -
Personalization Engagement Signals Resources
Get, create, and delete engagement signals. Create and delete engagement signal metrics. Get, create, and delete compound metrics. -
Personalization Experimentation Resources
Create, manage, and retrieve personalization experiments. -
Personalization Recommenders Resources
Create, manage, and retrieve personalization recommenders. -
Personalization Transformers Resource
Get, create, update, or delete Personalization Transformers. -
Personalization Resources
Get a list of assigned audiences that match the user context. Get audience information for a batch of audience IDs. Create, get, update, and delete an audience. Get a list of targets that match the user context, based on the assigned audiences that include the user. Create and update targets. Get target information for a batch of target IDs. Get and delete a target. -
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. -
Push Notifications Resource
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. -
Quick Text Resource
Get the body of a quick text. -
Quip Related Records Resource
Get records related to a Quip document. -
Salesforce Omnichannel Inventory Resources
Manage inventory across locations. Available in Salesforce Omnichannel Inventory. -
Salesforce Order Management Resources
Manage orders and the order fulfillment process. Available in Salesforce Order Management orgs. -
Salesforce Payments Resources
Information about Salesforce Payments, including content, rendered version, and sharing. -
Salesforce Scheduler Resources
Get service territories and create service appointments using Salesforce Scheduler resources. -
Search Resources
Search objects using keywords or questions. -
Share Captured Activity Resource
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. -
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. -
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. -
Topics on Records Resource
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. -
Translation Workbench Resources
Create an asynchronous Translation Workbench export or import job. Get the status of a Translation Workbench export or import job. -
Type System Resources
Use Type System resources to retrieve information about the types available in your org. -
User Files Resources
Get information about a user’s files. Upload a file. -
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.