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 Rate Limit Changes

To avoid potentially restrictive per user, per application, per hour Connect REST API rate limits, we’re migrating orgs to the per org, per 24-hour Salesforce Platform API rate limit. Orgs created in Summer ’24 and later are already using the Salesforce Platform API rate limit. For migrated and new orgs, 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.

When: Org migrations to the Salesforce Platform API rate limit continue on a rolling basis. Migrations occur in the background without notification.

New and Changed Connect REST API Resources

These resources are new or have changes.

Commerce

Get the Commerce subscription action history
Make a GET request to the new /commerce/webstores/webstoreId/subscriptions/subscriptionId/action-history resource.
New request parameter: effectiveAccountId
New response body: Commerce Subscription Actions History
Exclude dynamic attributes information for the product from the response
Make a GET request to the existing /commerce/webstores/webstoreId/products/productId resource.
New request parameter: excludeDynamicAttributeInfo

Custom Domain

Get the pending configuration for a custom domain
Make a GET request to the new /connect/custom-domain/domains/domainId/pending-configuration resource.
New response body: Custom Domain Pending Configuration Detail

Data 360

Publish a Batch DMO activation
Make a POST request to the new /ssot/activation/activationId/actions/publish resource.
New request body: Activation Publish Action Input
New response body: Activation Publish Action Output
Get a list of data clean room collaborations
Make a GET request to the new /ssot/data-clean-rooms/collaborations resource.
New response body: Data Clean Room Collaboration Collection Output
Create a data clean room collaboration
Make a POST request to the new /ssot/data-clean-rooms/collaborations resource.
New request body: Data Clean Room Collaboration Input
New response body: Data Clean Room Collaboration Output
Accept a data clean room collaboration invitation
Make a PUT request to the new /ssot/data-clean-rooms/collaborations/collaborationIdOrApiName/actions/accept-invitations resource.
New request body: Data Clean Room Accept Invitation Input
New response body: Data Clean Room Member Output
Reject a data clean room collaboration invitation
Make a PUT request to the new /ssot/data-clean-rooms/collaborations/collaborationIdOrApiName/actions/reject-invitations resource.
New request body: Data Clean Room Reject Invitation Input
New response body: Data Clean Room Member Output
Run a data clean room query
Make a POST request to the new /ssot/data-clean-rooms/collaborations/collaborationIdOrApiName/actions/run resource.
New request body: Data Clean Room Query Job Input
New response body: Data Clean Room Query Job Output
Get a list of data clean room query jobs
Make a GET request to the new /ssot/data-clean-rooms/collaborations/collaborationIdOrApiName/jobs resource.
New response body: Data Clean Room Query Job Collection Output
Get a list of data clean room providers
Make a GET request to the new /ssot/data-clean-rooms/providers resource.
New response body: Data Clean Room Provider Collection Output
Create a data clean room provider
Make a POST request to the new /ssot/data-clean-rooms/providers resource.
New request body: Data Clean Room Provider Input
New response body: Data Clean Room Provider Output
Get a data clean room provider
Make a GET request to the new /ssot/data-clean-rooms/providers/providerIdOrName resource.
New response body: Data Clean Room Provider Output
Get a list of all templates associated with a data clean room provider
Make a GET request to the new /ssot/data-clean-rooms/providers/providerIdOrName/templates resource.
New response body: Data Clean Room Template Collection Output
Get a list of data clean room specifications
Make a GET request to the new /ssot/data-clean-rooms/specifications resource.
New response body: Data Clean Room Specification Collection Output
Create a data clean room specification
Make a POST request to the new /ssot/data-clean-rooms/specifications resource.
New request body: Data Clean Room Data Specification Input
New response body: Data Clean Room Data Specification Output
Get a list of data clean room templates
Make a GET request to the new /ssot/data-clean-rooms/templates resource.
New response body: Data Clean Room Template Collection Output
Get a list of data kits or create a data kit
Make a GET or POST request to the new /ssot/data-kits resource.
New request body: Data Kit Input
New response body: Data Kit Collection Output
Get a list of available components within data kits
Make a GET request to the new /ssot/data-kits/available-components resource.
New response body: Data Kit Component Collection Output
Delete or update data kit components
Make a DELETE or PATCH request to the new /ssot/data-kits/dataKitDevName resource.
New request body: Data Kit Patch Input
New response body: Data Kit Output
Deploy data kit components
Make a POST request to the new /ssot/data-kits/dataKitDevNameresource.
New request body: Data Kit Deploy Input
New response body: Data Kit Async Output
Get a list of member components and dependencies for a data kit
Make a GET request to the new /ssot/data-kits/manifest resource.
New response body: Data Kit Members Collection Output
Assign a confidence score to each field in the extracted data
Make a POST request to the existing /ssot/document-processing/actions/extract-data resource.
New request parameter: extractDataWithConfidenceScore
Specify the starting page number for data extraction
Make a POST request to the existing /ssot/document-processing/actions/extract-data resource.
New request parameter: startPage
Specify the ending page number for data extraction
Make a POST request to the existing /ssot/document-processing/actions/extract-data resource.
New request parameter: endPage
Get a list of metadata entities
Make a GET request to the new /ssot/metadata-entities resource.
New response body: Query Metadata Entities Output

Notifications

Note
Note Notification Actions is a beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com and applicable terms in the Product Terms Directory. Use of this beta service is at the customer’s sole discretion.
Get supported notification type details and actions (beta)
Make a GET request to the new /connect/notifications/types resource.
New response body: Notification Type Collection
Execute an action for a notification (beta)
Make a POST request to the new /connect/notifications/notificationId/actionKey resource.
New response body: Action Result

Orchestration

Get orchestration instances associated with another orchestration
Make a GET request to the existing /connect/interaction/orchestration/instances resource.
New request parameter: relatedOrchestrationId

Salesforce CMS

Get the specified version of a piece of managed content
Make a GET request to the existing /connect/cms/contents/contentKeyOrId resource.
New optional request parameter: contentVersion
Get digital asset management (DAM) providers for a managed content space
Make a GET request to the existing /connect/cms/digital-asset-management-providers resource.
New request parameter: contentSpaceId
Update a digital asset management (DAM) provider instance
Made a PATCH request to the existing /connect/cms/digital-asset-management-providers/providerInstanceId resource.

Salesforce Flow

Get the status and available actions for flow approval processes
Make a GET request to the new /connect/interaction/flow-approval-process/status resource.
New response body: Flow Approval Process Collection

Salesforce Personalization

Create, list, get, and delete engagement signals
Make a POST request to the new /personalization/engagement-signals resource to create an engagement signal.
Make a GET request to the new /personalization/engagement-signals?queryParameters resource to list engagement signals.
Make a GET request to the new /personalization/engagement-signals/idOrName resource to get a single engagement signal.
Make a DELETE request to the new /personalization/engagement-signals/idOrName resource to delete an engagement signal.
New request body: Engagement Signal Input
New response bodies: Engagement Signal, Engagement Signal Collection
Create and delete engagement signal metrics
Make a POST request to the new /personalization/engagement-signals/idOrName/metrics resource to create an engagement signal metric.
Make a DELETE request to the new /personalization/engagement-signals/idOrName/metrics/idOrName resource to delete an engagement signal metric.
New request body: Engagement Signal Metric Input
New response body: Engagement Signal Metric
Create, get, and delete engagement signal compound metrics
Make a POST request to the new /personalization/compound-metrics resource to create a compound metric.
Make a GET request to the new /personalization/compound-metrics/compoundMetricIdOrName resource to get a compound metric.
Make a DELETE request to the new /personalization/compound-metrics/compoundMetricIdOrName resource to delete a compound metric.
New request body: Engagement Signal Compound Metric Input
New response body: Engagement Signal Compound Metric
Create, get, update, and delete personalization experiments
Make a POST request to the new /personalization/abn-experiments/?action=${action} resource to create a personalization experiment.
Make a GET request to the new /personalization/abn-experiments/${IdOrName} resource to get a personalization experiment.
Make a PATCH request to the new /personalization/abn-experiments/${IdOrName}?action=${action} resource to update a personalization experiment.
Make a DELETE request to the new /personalization/abn-experiments/${IdOrName} resource to delete a personalization experiment.
New request body: Personalization Experiment Input
New response body: Personalization Experiment

Changed Connect REST API Request Bodies

These request bodies have changes.

Commerce

Ensure Funds Async Input
This request body has these new properties.
  • isAllowPartial—Specifies if the invoice can be funded through multiple, partial payments.
  • SequencePaymentInputRepresentation—Payment sequence input for capturing and applying funds to the invoice.
  • sequences—Specifies the payment sequence in which the funds are captured for the invoice.
BEHAVIOR CHANGE: Commerce Subscription Renew Input
This request body has this behavior change.
  • subscriptionIds—Supports renewing multiple subscriptions per request. Contact Salesforce Customer Support to enable bulk renewal permissions.

Changed Connect REST API Response Bodies

These response bodies have changes.

Commerce

Product Details
This response body has this new property.
  • dynamicAttributeCount—Count of dynamic attributes associated with a product.
Product Variation Info
This response body has this new property.
  • variationCount—Count of available product variations.
Search Results Rule Output
This response body has this new property.
  • lastModifiedDate—Last modified date of the search result rule.

Data 360

Activation Output
This response body has this new property.
  • activationType—Type of activation flow, such as ApiTriggered, Dmo, Segment, or Template.

Salesforce CMS

Managed Content Document
This response body has these new and changed properties.
  • contentVersion—Content version of the managed content.
  • variantVersion—Variant version of the managed content.
  • version—This property is no longer returned. For version information, use contentVersion and variantVersion.
Managed Content Provider Collection
This response body has this new property.
  • contentSpaceId—ID of the managed content space, if provided.
Managed Content Provider Instance
This response body has this new property.
  • isEnabledForSpace—Specifies whether the provider instance is enabled for the managed content space.

Service Email

Email Message Capability
This response body has this new property.
  • emailSize—Size of a case’s email message HTML body.