Connect REST API Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Batch Resource
Connect Resources
Content Workspace Permissions Resource
Dashboard Component Snapshot Resource
Email Merge Field Services Resource
External Email Services Resource
Influence Resource
Knowledge Article View Stat Resource
Likes Resource
Messaging Channels Resource
Motifs Resources
Navigation Menu Items
Push Notifications Resource
Quip Related Records Resource
Share Captured Activity Resource
Subscriptions Resource
Subscriptions Notifications Member Resource
Newer Version Available
Connect REST API Resources
Connect REST API resources are sometimes called endpoints.
-
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 take action to drive productivity and accelerate innovation. -
Activity Reminders
Get a list of upcoming activity reminders in Salesforce Classic. -
Announcements Resources
Get the announcements for the specified parent or create an announcement. Also get information about, update, or delete an announcement. -
Async Query Resources
Submit Async SOQL queries to be processed asynchronously and check on their status. Use async query resources to make consistent SOQL queries, no matter what size the data is or where the data is stored. -
B2B Commerce on Lightning Resources
Get, create, update, and delete your commerce data. Work with carts, products, wishlists, and search settings. -
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. -
Call Coaching Resources
Call coaching is available as part of High Velocity Sales. Get the current status of call coaching. Post metadata about a new voice call and recording. Upload an audio recording of a voice call. -
Chatter Resources
Get a directory of Chatter feeds, groups, and users resources. Control when Chatter email digests are sent. Get a list of supported emojis. Get extensions. Get link metadata. Get information about, update, and delete Chatter streams. -
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 a community or a channel. Search managed content in a community or channel. Get managed content delivery channels for the context user. Get the binary stream of published managed content. -
Comments Resources
Get information about, edit, like, upvote, verify, or delete a comment. Determine whether the context user can edit a comment. -
Commerce Payments Resources
Information about Commerce Payments, including content, rendered version, and sharing. -
Communities Resources
Get information about communities, create a community, and publish a community. Get the community templates available to the context user. -
Communities Knowledge Resources
Get trending articles for a community. Get trending and top-viewed articles for a topic in a community. Increase article view counts. -
Communities Moderation Resources
Information about whether a user has flagged a feed element, comment, or file as inappropriate. Also used to delete flags. -
Connect Resources
Information about the context user’s organization and settings, and information about the communities the context user is a member of. -
Content Workspace Permissions Resource
Get a user's permissions for a content workspace. -
Custom Recommendation Audience Resources
Target specific audiences for your custom recommendations. Use these resources to get information about, create, update, and delete recommendation audiences. -
Custom Recommendation Definition Resources
Recommendation definitions allow you to create custom recommendations that appear in communities, encouraging users to watch videos, take training and more. Use these resources to get information about, create, modify, and delete recommendation definitions. Also get information about, upload, modify, and delete recommendation definition photos. -
Dashboard Component Snapshot Resource
A snapshot of a dashboard component. -
Datacloud Resources
Information about Datacloud resources used to purchase Data.com contacts or companies. Use the Datacloud resources to purchase Data.com contacts or companies and get information about your purchases, including how many credits are available for your use. You can also add contacts to selected companies or import contacts to your CRM. -
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. -
Environment Hub Resources
Use Environment Hub resources to create new orgs and connect existing orgs to the hub. -
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. -
External Email Services Resource
Get information about the external email services available to the context user. -
Feed Elements Resources
Information about feed elements. Access, edit, post, search, and delete feed elements. Access a feed element’s capabilities, including bundles and their feed elements. -
Feeds Resources
Feeds are made up of feed items. There are many feed types. Each feed type has an algorithm that determines which feed items it contains. -
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
Information about files, including content, rendered version, and sharing. Information about asset files, including content and rendition. -
Folders Resources
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. -
Groups Resources
Information about groups, such as the group's members, photo, and the groups in the organization. Create and delete a group, add members to a group, and change the group photo. -
Influence Resource
List of the percentile thresholds used to categorize an organization’s users by their influence in Chatter. -
Knowledge Article View Stat Resource
Increase the view count of a knowledge article by one. -
Lightning Scheduler Resources
Get service territories and create service appointments using lightning scheduler resources. -
Likes Resource
Information about the specified like. Also used to delete a like. -
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 a community. Get a list of managed topics. Create a managed topic hierarchy. Create, delete, or reorder managed topics in a community. -
Mentions Resources
Information about users and groups that a user can mention in a feed item body or comment body. When a user or group is mentioned, they receive notification. -
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. -
Missions Resources
Update a user’s mission activity count. Export and purge mission activity for a user. Purge mission activity for all users. Get a user’s mission progress. -
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. -
Navigation Menu Items
Get navigation menu items for a community. -
Next Best Action Resources
Get a recommendation, execute a recommendation strategy, and manage reactions to recommendations. -
Notifications Resources
Get or update notifications. Get the status of notifications. -
Notification Settings Resources
Get, set, and reset notification settings and notification app settings. -
Personalization Resources
Get a list of audiences that include the context user. Create, get, update, and delete an audience. Get a list of targets that match the context user, based on the audiences that include the user. Create, delete, and update targets. Get target information for a batch of target IDs and get details about 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 connected apps on users’ devices. This resource is only accessible when the session is established with a connected app that is developed in the same organization or installed in the same package as the recipient’s connected app. -
Question and Answers Resources
Get question and answers suggestions. Get top unanswered questions for the context user in a community. -
Quip Related Records Resource
Get records related to a Quip document. -
Records Resources
Get information about the followers of a record. Add and remove topics from records. -
Salesforce Order Management Resources
Manage orders and the order fulfillment process. Available in Salesforce Order Management orgs. -
Scheduled Custom Recommendations Resources
Get information about, create, update, or delete scheduled custom recommendations. -
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. -
Social Engagement Resources
Provide social functionality, such as access to managed social accounts and social post intents, for service agents. -
Social Engagement Setup Resources
Configure the Social Customer Service product. -
Subscriptions Resource
Information about the specified subscription. Also used to delete a subscription, for example, to unfollow a record or a topic. -
Subscriptions Notifications Member Resource
Get information about the frequency with which a user receives subscription notifications. Subscribe or unsubscribe a user from receiving notifications. -
Topics Resources
List of topics for the organization, list of suggested topics for a specified string of text, feed item, or record, list of trending topics for the organization, information about a specified topic, endorsements for a specific topic, information about the files posted recently to a specified topic, information about the groups recently contributing to a specified topic, knowledgeable people for a specified topic, and list of topics related to a specified topic. -
User Profiles Resources
The user profile data populates the profile page (also called the Chatter profile page). This data includes user information (such as address, manager, and phone number), some user capabilities (permissions), and a set of subtab apps, which are custom tabs on the profile page. -
Users Resources
Information about the user, such as who is following the user, the user’s files or recommendations. Also used for posting feed items and updating conversation status. -
Zones Resources
Information about Chatter Answers zones.