Salesforce Docs Portal

Connect REST API

Integrate mobile apps, intranet sites, and third-party web applications with Salesforce using Connect REST API.

See Also

Connect REST API Reference Documentation Improvements

We’re replacing the separate pages for resources, request bodies, and response bodies. Instead, we’re providing a unified, single-page layout that expands to show details as you need them.

Where: This change applies to Lightning Experience, Salesforce Classic, and all versions of the Salesforce mobile app in all editions in all API versions.

When: This change is available in July 2026.

Why: Existing resource pages automatically redirect to the correct resource in the new interface. Request and response body pages redirect to the main API reference page because this information appears in context with its associated resources.

The new interface also provides these improvements.

  • Reference content includes all API version information, so you don’t need to select the API version from a dropdown list.
  • Reference information follows the OpenAPI Specification (OAS) standard for REST APIs.

    You can download the OAS from the interface.

  • The interface provides more streamlined navigation and clearer data structures by using a three-panel layout for navigation, details, and examples.

To access the new reference interface, see Connect REST API Developer Guide reference.

Connect REST API Rate Limit Changes

To avoid potentially restrictive per user, per application, per hour Connect REST API rate limits, we migrated orgs to the per org, per 24-hour Salesforce Platform API rate limit. Only requests that require Chatter are subject to the per user, per application, per hour rate limit.

Where: This change applies to Lightning Experience, Salesforce Classic, and all versions of the Salesforce mobile app in all editions in all API versions.

How: If your org is experiencing Connect REST API rate limit issues, contact Salesforce Customer Support.

New and Changed Connect REST API Resources

These resources are new or have changes.

Agentforce

Create a knowledge article library or a custom retriever library
Make a POST request to the /einstein/data-libraries resource for the KNOWLEDGE or RETRIEVER source library types.
Get a paginated list of file references for an SFDRIVE library
Make a GET request to the /einstein/data-libraries/libraryId/files resource for a list of files in a file-based library. Use the pageSize and offset query parameters to traverse the paginated list.
Delete an individual file from an SFDRIVE library
Make a DELETE request to the new /einstein/data-libraries/libraryId/files/fileId resource to delete a file from a file-based library.
Enable Intelligent Context when you create an SFDRIVE library
Set groundingSource.indexMode to ENHANCED to enable intelligent context processing when you make a POST request to the /einstein/data-libraries resource. Intelligent Context processing consumes additional Data 360 credits, but it improves retrieval accuracy for tables and infographics.

Bot Utterance Intent Prediction Resources

Predict the intent of utterances for a bot
Make a POST request to the new /connect/bots/utterance-prediction/intent resource.
New request body: Bot Utterance Collection Prediction Input
New response body: Bot Utterance Collection Prediction Output
Predict the intent of utterances for a bot using the bot's existing intent set and utterances
Make a POST request to the new /connect/bots/utterance-prediction/intentFromSet resource.
New request body: Bot Utterance Collection Prediction From Set Input
New response body: Bot Utterance Collection Prediction Output

Commerce

Get renewal pricing forecasts for Commerce subscriptions
Make a POST request to the existing commerce/webstores/webstoreId/subscriptions/renewal-price-forecast resource.
New request body: CommerceSubscriptionRenewalPriceForecastInput
New response body: CommerceSubscriptionRenewalPriceForecast
BEHAVIOR CHANGE: Place an order for a Commerce store checkout
The existing /commerce/webstores/webstoreId/checkouts/activeOrCheckoutId/orders/actions resource now validates for existing Order Summaries before processing. When an Order Summary exists for the cart, the API fails the request, rolls back the transaction, and creates a process exception. This prevents duplicate order creation when the Order Ingestion Job retries order processing for carts with payments that remain open due to internal failures.

Data 360

Disable a clean room collaboration
Make a POST request to the new /ssot/data-clean-room/collaborations/collaborationIdOrApiName/actions/disable resource.
New response body: Data Clean Room Collaboration Output
Refresh clean room collaboration metadata
Make a PUT request to the new /ssot/data-clean-room/collaborations/collaborationIdOrApiName/actions/refresh-metadata resource.
New response body: Data Clean Room Generic Response Output
Get clean room collaboration result objects
Make a GET request to the new /ssot/data-clean-room/collaborations/collaborationIdOrApiName/result-data-objects resource.
New response body: Data Clean Room Collaboration Result Data Object Collection Output
Delete a clean room specification
Make a DELETE request to the new /ssot/data-clean-room/specifications/specificationIdOrApiName resource.
Get clean room collaborations for a use case template
Make a GET request to the new /ssot/data-clean-room/templates/useCaseTemplateType/collaborations resource.
New response body: Data Clean Room Collaboration Collection For Use Case Type Output
Test the clean room connection
Make a POST request to the new /ssot/data-clean-room/test-connection resource.
New request body: Clean Room Test Connection Input
New response body: Clean Room Test Connection Output
Activate a data graph
Make a POST request to the new /ssot/data-graphs/dataGraphName/actions/activate resource.
New request body: Data Graph Activate Input
Delete data space members
Make a DELETE request to the new /ssot/data-spaces/idOrName/members resource.
Detect a Document AI schema
Make a POST request to the new /ssot/document-processing/actions/detect-schema resource.
New request body: Idp Schema Detection Input
New response body: Idp Schema Detection Output
Note
Note Data 360 Retrievers Connect API is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.
Get a list of retrievers
Make a GET request to the new /ssot/machine-learning/retrievers resource.
New response body: ML Retriever Collection Output
Create a retriever
Make a POST request to the new /ssot/machine-learning/retrievers resource.
New request body: ML Retriever Input
New response body: ML Retriever Output
Review a Custom SQL retriever
Make a POST request to the new /ssot/machine-learning/retrievers/actions/review resource.
New request body: ML Retriever Review Input
New response body: ML Retriever Review Output
Delete, get, or update a retriever
Make a DELETE, GET, or PATCH request to the new /ssot/machine-learning/retrievers/retrieverIdOrName resource.
New request body: ML Retriever Update Input
New response body: ML Retriever Output
Get a list of retriever configuration versions
Make a GET request to the new /ssot/machine-learning/retrievers/retrieverIdOrName/configurations resource.
New response body: ML Retriever Configuration Collection Output
Create a retriever configuration
Make a POST request to the new /ssot/machine-learning/retrievers/retrieverIdOrName/configurations resource.
New request body: ML Retriever Configuration Base Input
New response body: ML Retriever Configuration Detail Output
Delete, get, or update a retriever configuration
Make a DELETE, GET, or PATCH request to the new /ssot/machine-learning/retrievers/retrieverIdOrName/configurations/retrieverConfigurationIdOrName resource.
New request body: ML Retriever Configuration Update Input
New response body: ML Retriever Configuration Detail Output

Media Cloud

Create revenue schedules for a collection of opportunity line items
Make a POST request to the /connect/media/asm/actions/generate-revenue-schedules resource.
New request body: RevenueScheduleGenerationBulkInput
New response body: RevenueScheduleGenerationBulk
Get the details of a list of revenue schedules for a media opportunity
Make a POST request to the /connect/media/asm/actions/generate-revenue-schedules resource.
New request body: RevenueScheduleRetrievalInput
New response body: RevenueScheduleRetrievalOutputRepresentation

Notifications

Get supported notification type details and actions (generally available)
Make a GET request to the new /connect/notifications/types resource.
Execute an action for a notification (generally available)
Make a POST request to the new /connect/notifications/notificationId/actionKey resource.

Revenue Cloud for Communications

Get product details, such as attributes, hierarchy, or cardinality, for a specified product ID
Make a POST request to the /connect/consumer/products/{productId} resource.
New request body: CMEProductDetailsInput
New response body: CMEProductBaseDetailsOutput
Get a list of products for a specified catalog, category, or subcategory
Make a POST request to the /connect/consumer/products resource.
New request body: CMEProductListInput
New response body: CMEProductListOutput
Retrieve details for multiple products
Make a POST request to the /connect/consumer/products/bulk resource.
New request body: CMEBulkProductSpecificationsInput
New response body: CMEBulkProductSpecificationsOutput
Retrieve and update a product’s configuration from a configurator
Make a POST request to the /connect/consumer/configure resource.
New request body: CMEProductConfigurationInput
New response body: CMEProductConfigurationOutput
Create a sales transaction, such as an order or a quote, with integrated pricing and configuration
Make a POST request to the /connect/consumer/place resource.
New request body: CMEPlaceSalesTransactionInput
New response body: CMEPlaceSalesTransactionOutput
Create single order for all items present in the cart
Make a POST request to the /connect/consumer/checkout resource.
New request body: CreateOrderFromCartInput
New response body: CreateOrderFromCartOutput

Translation Workbench (Beta)

Note
Note Translation Workbench Connect API is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.
Create an asynchronous translation export job
Make a POST request to the new /connect/i18n/translation/export resource.
New request body: Translation Workbench Export Input
New response body: Translation Workbench Export Job
Get the status of a translation export job
Make a GET request to the new /connect/i18n/translation/export/jobId/status resource.
New response body: Translation Workbench Export Job Status
Create an asynchronous translation import job
Make a POST request to the new /connect/i18n/translation/import resource.
Request body: Binary translation file in a multipart/form-data request
New response body: Translation Workbench Import Job
Get the status of a translation import job
Make a GET request to the new /connect/i18n/translation/import/jobId/status resource.
New response body: Translation Workbench Import Job Status

Changed Connect REST API Request Bodies

These request bodies have changes.

Commerce

Searchable Attribute Input
This request body has this new property.
  • weight—Specifies the relative contribution of each searchable field to the relevance ranking of search results.
Payment Token Input
This request body has this new property.
  • hasSubscriptionProduct—Specifies whether the cart contains subscription products. Use this field to authorize saved payment methods for Commerce subscriptions with third-party gateways.
BEHAVIOR CHANGE: Commerce Subscription Renew Input
This request body has this behavior change.
  • subscriptionIds—Supports renewing multiple subscriptions per request. Bulk renewal is available by default without contacting Salesforce Customer Support.

Data 360

Activation Definition Input
This request body has these new properties.
  • activationType—Type of activation, such as ApiTriggered or Segment.
  • sourceDmoName—Developer name of the source DMO for ApiTriggered activation types.

Changed Connect REST API Response Bodies

These response bodies have changes.

Commerce

Pricing Result Line Item
This response body has these new properties.
  • contractId—Specifies the ID of the contract.
  • contractItemPriceId—Specifies the ID of the contract item price.
Product Price Entry
This response body has these new properties.
  • contractId—Specifies the ID of the contract.
  • contractItemPriceId—Specifies the ID of the contract item price.
Product Price
This response body has these new properties.
  • contractId—Specifies the ID of the contract.
  • contractItemPriceId—Specifies the ID of the contract item price.
Searchable Attribute
This response body has this new property.
  • weight—Specifies the relative contribution of each searchable field to the relevance ranking of search results.

Data 360

Activation Output
This response body has these new properties.
  • activationType–Type of activation, such as ApiTriggered or Segment.
  • sourceDmoName–Developer name of the source DMO for ApiTriggered activation types.
Data Clean Room Collaboration Output
This response body has these new and changed properties.
  • dataSpace–Data space details for the clean room, such as ID, name, label, and filter.
  • dataSpaceName–This property no longer exists. Use dataSpace instead.
Data Clean Room Template Output
This response body has this new property.
  • metadataConfiguration–Configuration metadata containing member-specific settings and use-case-dependent operational parameters.
Data Clean Room Member Output
This response body has these new properties.
  • memberConfigs–List of member configurations, such as the external ID and output destination.
  • memberDataCloudRegion–Region of the member org.
  • memberDomainUrl–Domain URL of the member org.

Lists

List Share
This response body has this new property.
  • isMember–Specifies whether the context user is a member of the group, role, or territory.

Notifications

Notification
This response body has this new property.
  • actionGroup—Action group for the notification.
Notification Setting
This response body has these new properties that are reserved for future use.
  • advancedEmailEnabled
  • advancedSlackEnabled
  • advancedTeamsEnabled

Organization

Maintenance Information
This response body has this changed property.
  • maintenanceType—This property now supports the ServiceAgreement maintenance type.