Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpActivation Class
CdpActivationExternalPlatform Class
CdpActivationTarget Class
CdpAudienceDMO Class
CdpCalculatedInsight Class
CdpConnection Class
CdpDataSpace Class
CdpDataStreams Class
CdpIdentityResolution Class
CdpMachineLearning Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceCatalogManagement Class
CommercePromotions Class
CommerceQuotes Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExtendedCommerceDelivery Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FlowApprovalProcesses Class
FulfillmentOrder Class
IBusinessObjectivesAndRecsFamily Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentChannels Class
ManagedContentDelivery Class
ManagedContentSpaces Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
OptimizationFiles Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
RecordFilterCriteriaFamily Class
Records Class
RecordUi Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Search Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi.AbstractBaseSequenceInputRepresentation
ConnectApi.AbstractCheckoutAddressInput
ConnectApi.AbstractList
ConnectApi.ActionInfoInputRepresentation
ConnectApi.ActionLinkDefinitionInput
ConnectApi.ActionLinkGroupDefinitionInput
ConnectApi.ActionLinkTemplateBindingInput
ConnectApi.ActivationAdditionalAttributesConfigInput
ConnectApi.ActivationContactPointInput
ConnectApi.ActivationDefinitionInput
ConnectApi.ActivationTargetInput
ConnectApi.ActivationTargetSubjectConfigInput
ConnectApi.ActivitySharingInput
ConnectApi.AddressRequest
ConnectApi.AdjustItemInputRepresentation
ConnectApi.AdjustOrderItemSummaryInputRepresentation
ConnectApi.AlternativeInput
ConnectApi.AlternativePaymentMethod
ConnectApi.AnnouncementInput
ConnectApi.ArticleTopicAssignmentJobInput
ConnectApi.AssignedResourcesInput
ConnectApi.AssociatedActionsCapabilityInput
ConnectApi.AssociateRecordsWithRecipientInput
ConnectApi.AttributeFilterInput
ConnectApi.AttributeLimitingExpressionInput
ConnectApi.AttributeSetInputRepresentation
ConnectApi.AudienceCriteriaInput
ConnectApi.AudienceCriterionInput
ConnectApi.AudienceCriterionValueInput
ConnectApi.AudienceInput
ConnectApi.AuditParamsRequest
ConnectApi.AuthApiPaymentMethodRequest
ConnectApi.AuthorizationReversalRequest
ConnectApi.AuthorizationRequest
ConnectApi.BankPaymentMethodRequest
ConnectApi.BannerPhotoInput
ConnectApi.BaseApiPaymentMethodRequest
ConnectApi.BaseComparisonInput
ConnectApi.BasePaymentMethodRequest
ConnectApi.BaseRequest
ConnectApi.BatchInput
ConnectApi.BinaryInput
ConnectApi.BookmarksCapabilityInput
ConnectApi.BooleanList
ConnectApi.BotVersionActivationInput
ConnectApi.BusinessObjectivesInputRepresentation
ConnectApi.BusObjAssociationsInputRepresentation
ConnectApi.BusObjInputRepresentation
ConnectApi.BusObjInsightsInputRepresentation
ConnectApi.BusObjRecommendationInputRepresentation
ConnectApi.CalculateCartInput
ConnectApi.CalculateTaxRequest
ConnectApi.CancelAllOrderItemsInputRepresentation
ConnectApi.CanvasCapabilityInput
ConnectApi.CapacityRequestInputRepresentation
ConnectApi.CaptureRequest
ConnectApi.CardPaymentMethodRequest
ConnectApi.PromotionCartAdjustmentGroupInput
ConnectApi.cartCouponInput
ConnectApi.PromotionCartDeliveryGroupInput
ConnectApi.CartEvaluateShippingInput
ConnectApi.CartEvaluateTaxInput
ConnectApi.CartFromQuoteInput
ConnectApi.CartInventoryReservationInputRepresentation (Pilot)
ConnectApi.CartItemInput
ConnectApi.CartItemPromotionCollectionInputRepresentation
ConnectApi.CartItemPromotionInputRepresentation
ConnectApi.CartMessagesVisibilityInput
ConnectApi.CartInput
ConnectApi.CartShippingAddressInput
ConnectApi.CartToWishlistInput
ConnectApi.CdpAssetReferenceInput
ConnectApi.CdpCalculatedInsightInput
ConnectApi.CdpIdentityResolutionConfigInput
ConnectApi.CdpIdentityResolutionConfigPatchInput
ConnectApi.CdpIdentityResolutionMatchCriterion
ConnectApi.CdpIdentityResolutionMatchCriterionPartyIdentificationInfo
ConnectApi.CdpIdentityResolutionMatchRule
ConnectApi.CdpIdentityResolutionReconciliationFieldRule
ConnectApi.CdpIdentityResolutionReconciliationRule
ConnectApi.CdpIdentityResolutionReconciliationSource
ConnectApi.CdpIdentityResolutionRunNowInput
ConnectApi.CdpMlBasePredictInput
ConnectApi.CdpMlPredictSettingsInput
ConnectApi.CdpQueryInput
ConnectApi.CdpSegmentDbtInput
ConnectApi.CdpSegmentDbtModelInput
ConnectApi.CdpSegmentInput
ConnectApi.ChangeInputRepresentation
ConnectApi.ChangeItemFee​InputRepresentation
ConnectApi.ChangeItemFeeTaxInputRepresentation
ConnectApi.ChangeItemFeeWithTaxInputRepresentation
ConnectApi.ChangeItemInputRepresentation
ConnectApi.ChangeOrderAdjustmentGroupSummaryInputRepresentation
ConnectApi.ChangeOrderDeliveryGroupSummaryInputRepresentation
ConnectApi.ChangeOrderItemAdjustmentLineSummaryInputRepresentation
ConnectApi.ChangeOrderItemSummaryInputRepresentation
ConnectApi.ChangeOrderItemTaxLineItemSummaryInputRepresentation
ConnectApi.ChangeOrderSummaryInputRepresentation
ConnectApi.ChatterGroupInput
ConnectApi.ChatterStreamInput
ConnectApi.CommentCapabilitiesInput
ConnectApi.CommentInput
ConnectApi.CommerceAddressFieldInput
ConnectApi.CommerceAddressInput
ConnectApi.CommerceNoteInput
ConnectApi.CompositeCommerceProductInputRepresentation
ConnectApi.CompositeCommerceVariationInputRepresentation
ConnectApi.ConfirmHeldFOCapacityInputRepresentation
ConnectApi.ConfirmHeldFOCapacityRequestInputRepresentation
ConnectApi.ContactPointAttributeInput
ConnectApi.ContactPointSourceInput
ConnectApi.ConnectionDbSchemaCollectionInput
ConnectApi.ContactPointAttributeInput
ConnectApi.ContactPointSourceInput
ConnectApi.ContactPointAttributeInput
ConnectApi.ContactPointSourceInput
ConnectApi.ContentCapabilityInput
ConnectApi.ContentHubFieldValueInput
ConnectApi.ContentHubItemInput
ConnectApi.ContractInputRepresentation
ConnectApi.CouponCodeRedemptionInput
ConnectApi.CreateCreditMemoInputRepresentation
ConnectApi.CreateInvoiceFromChangeOrdersInputRepresentation
ConnectApi.CreateMultipleInvoicesFromChangeOrdersInputRepresentation
ConnectApi.CreateOrderPaymentSummaryInputRepresentation
ConnectApi.CreateQuoteFromCartInput
ConnectApi.CreateQuoteFromProductInput
ConnectApi.CreateServiceAppointmentInput
ConnectApi.CredentialCustomHeaderInput
ConnectApi.CredentialInput
ConnectApi.CredentialValueInput
ConnectApi.CreditMemoInputRepresentation
ConnectApi.CuratedEntityInput
ConnectApi.CustomListAudienceCriteriaInput
ConnectApi.DataConnectorInput
ConnectApi.DataSourceNameConfigInput
ConnectApi.DeliveryAddressInputRepresentation
ConnectApi.DeliveryEstimationProductInputRepresentation
ConnectApi.DeliveryRoutingEngineInputRepresentation
ConnectApi.DirectMessageCapabilityInput
ConnectApi.DistinctValueRefinementInput
ConnectApi.DistributePickedQuantitiesInputRepresentation
ConnectApi.DistributeToOrdersInputRepresentation
ConnectApi.DMOFilterInput
ConnectApi.DmoFilterLimitInput
ConnectApi.DoubleList
ConnectApi.EgressPropertiesInput
ConnectApi.​EinsteinLlm​Additional​ConfigInput
ConnectApi.​EinsteinPrompt​Template​GenerationsInput
ConnectApi.EnsurePaymentCreditInputRepresentation
ConnectApi.EnsureFundsAsyncInputRepresentation
ConnectApi.EnsureRefundsAsyncInputRepresentation
ConnectApi.EntityLinkSegmentInput
ConnectApi.EstimateDeliveryDateInputRepresentation
ConnectApi.ExtendedFieldInput
ConnectApi.ExtensionInput
ConnectApi.ExtensionsCapabilityInput
ConnectApi.ExternalAuthIdentityProviderCredentialInput
ConnectApi.ExternalAuthIdentityProviderCredentialsInput
ConnectApi.ExternalAuthIdentityProviderInput
ConnectApi.ExternalAuthIdentityProviderParameterInput
ConnectApi.ExternalCredentialInput
ConnectApi.ExternalCredentialParameterInput
ConnectApi.ExternalCredentialPrincipalInput
ConnectApi.FeedElementCapabilitiesInput
ConnectApi.FeedElementCapabilityInput
ConnectApi.FeedElementInput
ConnectApi.FeedEntityShareCapabilityInput
ConnectApi.FeedItemInput
ConnectApi.fetchFilesInput
ConnectApi.FileIdInput
ConnectApi.FilesCapabilityInput
ConnectApi.SearchFilter
ConnectApi.FindRoutesWithFewestSplitsGroupUsingOCIInputRepresentation
ConnectApi.FindRoutesWithFewestSplitsInputRepresentation
ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentation
ConnectApi.FindRoutesWithFewestSplitsUsingOCIItemInputRepresentation
ConnectApi.FormFieldInput
ConnectApi.FormInput
ConnectApi.FormSubmissionFieldInput
ConnectApi.FormSubmissionInput
ConnectApi.FulfillmentGroupInputRepresentation
ConnectApi.FulfillmentOrderInputRepresentation
ConnectApi.FulfillmentOrderInvoiceInputRepresentation
ConnectApi.FulfillmentOrderLineItemInputRepresentation
ConnectApi.FulfillmentOrderLineItemsToCancelInputRepresentation
ConnectApi.GetFOCapacityValuesRequestInputRepresentation
ConnectApi.GroupInformationInput
ConnectApi.HashtagSegmentInput
ConnectApi.HoldFOCapacityInputRepresentation
ConnectApi.HoldFOCapacityRequestInputRepresentation
ConnectApi.InlineImageSegmentInput
ConnectApi.InnerEnsureFundsAsyncInputRepresentation
ConnectApi.InviteInput
ConnectApi.InvoiceToPayInputRepresentation
ConnectApi.ItemQuantityInputRepresentation
ConnectApi.LeadInput
ConnectApi.LinkCapabilityInput
ConnectApi.LinkSegmentInput
ConnectApi.LocationAvailabilityInputRepresentation
ConnectApi.LocationInputRepresentation
ConnectApi.LocationListInputRepresentation
ConnectApi.LongList
ConnectApi.ManagedContentBodyInput
ConnectApi.ManagedContentChannelCreateRepresentation
ConnectApi.ManagedContentChannelUpdateRepresentation
ConnectApi.ManagedContentDocumentCloneInput
ConnectApi.ManagedContentDocumentInput
ConnectApi.ManagedContentItemsDeleteInput
ConnectApi.ManagedContentMetadataCollectionInput
ConnectApi.ManagedContentProviderInstanceInput
ConnectApi.ManagedContentPublishInput
ConnectApi.ManagedContentSpaceInput
ConnectApi.ManagedContentSpaceChannelInputRepresentation
ConnectApi.ManagedContentSpaceChannelsInputRepresentation
ConnectApi.ManagedContentSpaceUpdateInput
ConnectApi.ManagedContentUnpublishInput
ConnectApi.ManagedContentVariantUpdateInput
ConnectApi.ManagedTopicPositionCollectionInput
ConnectApi.ManagedTopicPositionInput
ConnectApi.MarkupBeginSegmentInput
ConnectApi.MarkupEndSegmentInput
ConnectApi.MCSFolderShareInput
ConnectApi.MCSFolderShareCollectionUpdateInput
ConnectApi.MentionSegmentInput
ConnectApi.MessageBodyInput
ConnectApi.MessageSegmentInput
ConnectApi.MultipleEnsureFundsAsyncInputRepresentation
ConnectApi.MultipleFulfillmentOrderInputRepresentation
ConnectApi.MultipleFulfillmentOrderInvoicesInputRepresentation
ConnectApi.MuteCapabilityInput
ConnectApi.NamedCredentialCalloutOptionsInput
ConnectApi.NamedCredentialInput
ConnectApi.NamedCredentialParameterInput
ConnectApi.NBAStrategyInput
ConnectApi.NetworkConnectionInput
ConnectApi.NewUserAudienceCriteriaInput
ConnectApi.OAuthCredentialAuthUrlInput
ConnectApi.OCICreateReservationInputRepresentation
ConnectApi.OCICreateReservationSingleInputRepresentation
ConnectApi.OCIFulfillReservationInputRepresentation
ConnectApi.OCIFulfillReservationSingleInputRepresentation
ConnectApi.OCIGetInventoryAvailabilityInputRepresentation
ConnectApi.OCIReleaseReservationInputRepresentation
ConnectApi.OCIReleaseReservationSingleInputRepresentation
ConnectApi.OCITransferReservationInputRepresentation
ConnectApi.OCITransferReservationSingleInputRepresentation
ConnectApi.OCIUpdateReservationInputRepresentation
ConnectApi.OCIUpdateReservationSingleInputRepresentation
ConnectApi.SearchOrderBy
ConnectApi.OrderItemSummaryInputRepresentation
ConnectApi.OrderItemSummaryAdjustmentCollectionInput
ConnectApi.OrderItemSummaryAdjustmentInput
ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput
ConnectApi.OrderSummaryInputRepresentation
ConnectApi.OrderSummaryLookupInput
ConnectApi.OrderSummaryVerificationInput
ConnectApi.OrderToCartInput
ConnectApi.PaymentCreditSequenceInputRepresentation
ConnectApi.PaymentCreditSequenceItemInputRepresentation
ConnectApi.PaymentGroupRequest
ConnectApi.PaymentInfoInputRepresentation
ConnectApi.PaymentInitiationSourceInputRepresentation
ConnectApi.PaymentMethodTokenizationRequest
ConnectApi.PhotoInput
ConnectApi.PinCapabilityInput
ConnectApi.PollCapabilityInput
ConnectApi.PostAuthApiPaymentMethodRequest
ConnectApi.PostAuthRequest
ConnectApi.PreviewCartToExchangeOrderInputRepresentation
ConnectApi.PricingInput
ConnectApi.PricingLineItemInput
ConnectApi.ProductSearchGroupingInput
ConnectApi.ProductSearchInput
ConnectApi.ProductVariationInputRepresentation
ConnectApi.PromotionCartDeliveryGroupInput
ConnectApi.PromotionCartInput
ConnectApi.PromotionCartItemInput
ConnectApi.PromotionEvaluateInput
ConnectApi.PromotionParentProductsInput
ConnectApi.PromotionProductCategoriesInput
ConnectApi.QuantityWithSkuInputRepresentation
ConnectApi.QueryPathInput
ConnectApi.QueryPathInputConfig
ConnectApi.QuerySqlInput
ConnectApi.QuerySqlParameterItem
ConnectApi.QuestionAndAnswersCapabilityInput
ConnectApi.RangeRefinementInput
ConnectApi.RankAverageDistanceInputRepresentation
ConnectApi.ReadByCapabilityInput
ConnectApi.SequenceOrderPaymentSummaryInputRepresentation
ConnectApi.sharedOrderPaymentSummarySequenceInputRepresentation
ConnectApi.SubmitCartToExchangeOrderInputRepresentation
ConnectApi.RecipientEngagementContextInput
ConnectApi.RecommendationAudienceInput
ConnectApi.RecommendationDefinitionInput
ConnectApi.RecommendationReactionInput
ConnectApi.RecordCapabilityInput
ConnectApi.RecordsetFilterCriteriaInput
ConnectApi.ReferencedRefundRequest
ConnectApi.RefinementInput
ConnectApi.RefundInstructionsHintInputRepresentation
ConnectApi.RefundRequest
ConnectApi.RefundSequenceItemInputRepresentation
ConnectApi.ReleaseHeldFOCapacityInputRepresentation
ConnectApi.ReleaseHeldFOCapacityRequestInputRepresentation
ConnectApi.RequestHeaderInput
ConnectApi.ReturnItemsInputRepresentation
ConnectApi.ReturnOrderInputRepresentation
ConnectApi.ReturnOrderItemDeliveryChargeInputRepresentation
ConnectApi.ReturnOrderItemFeeInputRepresentation
ConnectApi.ReturnOrderItemInputRepresentation
ConnectApi.ReturnOrderLineItemInputRepresentation
ConnectApi.ReturnOrderLineItemFeeInputRepresentation
ConnectApi.RoutingProductInputRepresentation
ConnectApi.SaleApiPaymentMethodRequest
ConnectApi.SaleRequest
ConnectApi.ScheduledRecommendationInput
ConnectApi.SearchDataCategory
ConnectApi.SearchRequest
ConnectApi.SellerDetailsRequest
ConnectApi.ServiceAppointmentInput
ConnectApi.ShiftsFromPatternInput
ConnectApi.ShippingCarrierInputRepresentation
ConnectApi.ShippingCarrierMethodInputRepresentation
ConnectApi.StaticDataInput
ConnectApi.StatusCapabilityInput
ConnectApi.StreamSubscriptionInput
ConnectApi.StringList
ConnectApi.SurveyInvitationEmailInput
ConnectApi.TargetCollectionInput
ConnectApi.TargetCollectionUpdateInput
ConnectApi.TargetInput
ConnectApi.TargetLocationInputRepresentation
ConnectApi.TargetUpdateInput
ConnectApi.TaxAddressRequest
ConnectApi.TaxAddressesRequest
ConnectApi.TaxCustomerDetailsRequest
ConnectApi.TaxLineItemRequest
ConnectApi.TaxTransactionRequest
ConnectApi.TextClassificationsInputRepresentation
ConnectApi.TextSegmentInput
ConnectApi.TopicInput
ConnectApi.TopicNamesInput
ConnectApi.TopicsCapabilityInput
ConnectApi.TypeAndFilterInput
ConnectApi.updateQuoteInput
ConnectApi.UpdateServiceAppointmentInput
ConnectApi.UpDownVoteCapabilityInput
ConnectApi.UserInput
ConnectApi.WishlistInput
ConnectApi.WishlistItemInput
ConnectApi.WishlistUpdateInput
ConnectApi.WrappedValue
Retired ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ConnectApi.BotVersionActivationInput

Activation status of the bot version.
Property Type Description Required or Optional Available Version
status ConnectApi.​BotVersion​ActivationStatus Activation status of the bot version. Values are:
  • Active
  • Inactive
Activation status must be specified in the status or postBody parameter.		 Optional 50.0