ConnectApi Namespace

The ConnectApi namespace (also called Connect in Apex) provides classes for accessing the same data available in Connect REST API. Use Connect in Apex to create custom experiences in Salesforce.

For information about working with the ConnectApi classes, see Connect in Apex.

  • ActionLinks Class

    Create, delete, and get information about an action link group definition; get information about an action link group; get action link diagnostic information.

  • Announcements Class

    Access information about announcements and post announcements.

  • BotVersionActivation Class

    Access and update activation information of a bot version.

  • CdpActivation Class

    Get, create, update, and delete Data 360 activations.

  • CdpActivationExternalPlatform Class

    Get Data 360 activation external platforms.

  • CdpActivationTarget Class

    Get, create, and update Data 360 activation targets.

  • CdpAudienceDMO Class

    Get activation records from Data 360 Audience Data Model Objects (DMOs).

  • CdpCalculatedInsight Class

    Create, delete, get, run, and update Data 360 calculated insights.

  • CdpConnection Class

    Get database schemas for a Data 360 connection.

  • CdpDataSpace Class

    Get Data 360 data spaces.

  • CdpDataStreams Class

    Run Data 360 data streams.

  • CdpIdentityResolution Class

    Create, delete, get, run, and update Data 360 identity resolution rulesets.

  • CdpMachineLearning Class

    Make a machine-learning prediction with Data 360.

  • CdpQuery Class

    Get Data 360 metadata and query data.

  • CdpSegment Class

    Create, delete, get, publish, and update Data 360 segments.

  • Chatter Class

    Access information about followers and subscriptions for records.

  • ChatterFavorites Class

    Chatter favorites give you easy access to topics, list views, and feed searches.

  • ChatterFeeds Class

    Get, post, and delete feed elements, likes, comments, and bookmarks. You can also search feed elements, share feed elements, and vote on polls.

  • ChatterGroups Class

    Information about groups, such as the group’s members, photo, and the groups the specified user is a member of. Add members to a group, remove members, and change the group photo.

  • ChatterMessages Class

    Get, send, search, and reply to private messages. You can also get and search private conversations, mark conversations as read, and get a count of unread private messages.

  • ChatterUsers Class

    Access information about users, such as activity, followers, subscriptions, files, and groups.

  • Clm Class

    Create and update Contract Lifecycle Management (CLM) contracts using object ID.

  • CommerceBuyerExperience Class

    Create, delete, or get commerce addresses. Get order delivery group, order item, order shipments, shipment items, and order summaries. Get adjustments for order items and order summaries.

  • CommerceCart Class

    Get, create, update, calculate, and delete carts. Get cart items, add items to carts, update and delete cart items.

  • CommerceCatalog Class

    Get products, product categories, and product category paths.

  • CommerceCatalogManagement Class

    Create or update a composite product. Create a variation product.

  • CommercePromotions Class

    Evaluate promotions for Commerce orders. Get coupon code redemption usage.

  • CommerceQuotes Class

  • CommerceSearch Class

    Get sort rules for the live search index. Get product search suggestions. Search products.

  • CommerceSearchConnectFamily Class

    Search products by search term or category in a webstore.

  • CommerceSearchSettings Class

    Get indexes. Get index logs. Create an index of a product catalog.

  • CommerceStorePricing Class

    Get product prices.

  • CommerceWishlist Class

    Get, create, update, and delete wishlists. Add wishlists to carts. Get wishlist items, add items to wishlists, and delete wishlist items.

  • Communities Class

    Get information about Experience Cloud sites in your org.

  • CommunityModeration Class

    Get information about flagged feed items and comments in an Experience Cloud site. Add and remove flags from comments and feed items.

  • ContentHub Class

    Access Files Connect repositories and their files and folders.

  • ConversationApplicationDefinition Class

    Access information about a conversation application definition.

  • Datacloud Class

    Purchase Data.com contact or company records, and retrieve purchase information.

  • EinsteinLLM Class

    Get a list of prompt templates and generate LLM responses for prompt templates.

  • EmailMergeFieldService Class

    Extract a list of merge fields for an 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.

  • EmployeeProfiles Class

    Get, set and crop, and delete employee banner photos and photos.

  • Exchanges Class

    Preview and submit cart to exchange orders.

  • ExtendedCommerceDelivery Class

    Access information about delivery estimation.

  • ExternalEmailServices Class

    Access information about integration with external email services, such as sending email within Salesforce through an external email account.

  • ExternalManagedAccount Class

    Get externally managed accounts.

  • FieldService Class

    Preview and create shifts from a pattern.

  • FlowApprovalProcesses Class

    Get the status and available actions for flow approval processes.

  • FulfillmentOrder Class

    Fulfill orders in Order Management.

  • IBusinessObjectivesAndRecsFamily Class

    Get and patch business objectives, or goals. Get, create, patch, and update recommended actions for business objectives.

  • Knowledge Class

    Get information about trending articles in Experience Cloud sites.

  • LightningScheduler Class

    Create and update service appointments.

  • ManagedContent Class

    Clone managed content. Create and get managed content. Create, delete, or update a digital asset management (DAM) provider instance. Bulk delete managed content. Delete and replace variants. Get channels. Get DAM providers. Get targets that managed content space folders can be shared with. Get and update targets that managed content space folders are shared with. Expose managed content as metadata. Publish and unpublish content.

  • ManagedContentChannels Class

    Get managed content channels. Create, get, update, or delete a managed content channel.

  • ManagedContentDelivery Class

    Get channels. Get collection items. Get managed content. Get a managed content rendition.

  • ManagedContentSpaces Class

    Create, get, update, or delete a managed content space. Get channels in a managed content space. Add or remove channels from a managed content space.

  • ManagedTopics Class

    Get managed topics in an Experience Cloud site. Create, delete, and reorder managed topics.

  • MarketingIntegration Class

    Get, save, and submit a microsites marketing integration form for an Experience Cloud site.

  • Mentions Class

    Access information about mentions. A mention is an “@” character followed by a user or group name. When a user or group is mentioned, they receive a notification.

  • Missions Class

    Export and purge mission activity for users. Get a user’s mission progress. Update mission activity counts for users.

  • NamedCredentials Class

    Create, refresh, get, delete, replace, and update credentials. Create and get external credentials. Create and get named credentials. Create, get, delete, and update external auth identity providers. Get the URL for the OAuth token flow for an external credential.

  • NavigationMenu Class

    Get navigation menu items for an Experience Cloud site.

  • NextBestAction Class

    Execute recommendation strategies, get recommendations, manage recommendation reactions.

  • OmnichannelInventoryService Class

    Route orders to inventory locations in Order Management.

  • OMSAnalytics Class

    Get products with return rates, get text classified into different classifications using text analysis, and capture the return reasons from external sources based on the product ids.

  • OptimizationFiles Class

    Fetch files associated with optimization requests for Enhanced Scheduling and Optimization. Requires Field Service to be enabled for the org and the running user to have Field Service enabled.

  • Orchestration Class

    Get orchestration instances.

  • OrderPaymentSummary Class

    Work with payments in Order Management.

  • OrderSummary Class

    Work with orders in Order Management.

  • OrderSummaryCreation Class

    Create Order Summaries in Order Management.

  • Organization Class

    Access information about an org.

  • PardotBusinessUnitContext Class

    Get the Pardot business units the context user has access to.

  • Payments Class

    Authorize a payment, capture an authorized payment, and refund an authorized payment.

  • Personalization Class

    Get assigned personalization audiences that match the user context. Create, get, update, and delete an audience. Get personalization targets that match the user context, based on the assigned audiences that include the user. Create and update targets. Get and delete a target.

  • PickTicket Class

    Create tickets to fulfill orders.

  • QuestionAndAnswers Class

    Access question and answers suggestions.

  • Recommendations Class

    Get and reject Chatter, custom, and static recommendations. Create, get, update, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations.

  • RecordFilterCriteriaFamily Class

    Filter records on recordset filter criteria.

  • Records Class

    Access information about record motifs, which are small icons used to distinguish record types in the Salesforce UI.

  • RecordUi Class

    Get picklist values by record type.

  • RegisterGuestBuyer Class

    Register a guest buyer for a webstore using an account ID, enabling a guest buyer to order on behalf of another buyer.

  • Repricing Class

    Perform functions related to repricing orders in Order Management.

  • ReturnOrder Class

    Process ReturnOrders in Order Management, limited to 2,000 requests per hour.

  • Routing Class

    Route orders to inventory locations in Order Management.

  • SalesforceInbox Class

    Access information about Automated Activity Capture, which is available in Einstein and Salesforce Inbox.

  • Search Class

    Search objects using keywords or a natural language query.

  • Sites Class

    Search an Experience Cloud site.

  • SmartDataDiscovery Class

    Get predictions on Salesforce objects.

  • SocialEngagement Class

    Manage information about social accounts or fan pages for social networks.

  • Surveys Class

    Send survey invitations by email.

  • TaxPlatform Class

    Apply or cancel tax.

  • Topics Class

    Access information about topics, such as their descriptions, the number of people talking about them, related topics, and information about groups contributing to the topic. Update a topic’s name or description, merge topics, and add and remove topics from records and feed items.

  • UserProfiles Class

    Access user profile data. 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.

  • Zones Class

    Access information about Chatter Answers zones in your organization. Zones organize questions into logical groups, with each zone having its own focus and unique questions.

  • ConnectApi Input Classes

    Some ConnectApi methods take arguments that are instances of ConnectApi input classes.

  • ConnectApi Output Classes

    Most ConnectApi methods return instances of ConnectApi output classes.

  • ConnectApi Enums

    Enums specific to the ConnectApi namespace.

  • ConnectApi Exceptions

    The ConnectApi namespace contains exception classes.

  • ConnectApi Utilities

    The ConnectApi namespace contains a utility class.

  • ConnectApi Release Notes

    Use the Salesforce Release Notes to learn about the most recent updates and changes to the ConnectApi namespace in Apex.