Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi Enums

Enums specific to the ConnectApi namespace.

ConnectApi enums inherit all properties and methods of Apex enums.

Enums are not versioned. Enum values are returned in all API versions. Clients must handle values they don't understand gracefully.

Enum Description
ConnectApi.​ActionLink​ExecutionsAllowed Number of times an action link can be executed.
  • Once—An action link can be executed only one time across all users.
  • OncePerUser—An action link can be executed only one time for each user.
  • Unlimited—An action link can be executed an unlimited number of times by each user. If the action link’s actionType is Api or ApiAsync, you can’t use this value.
ConnectApi.​ActionLinkType Type of action link.
  • Api—The action link calls a synchronous API at the action URL. Salesforce sets the status to SuccessfulStatus or FailedStatus based on the HTTP status code returned by your server.
  • ApiAsync—The action link calls an asynchronous API at the action URL. The action remains in a PendingStatus state until a third party makes a request to /connect/action-links/actionLinkId to set the status to SuccessfulStatus or FailedStatus when the asynchronous operation is complete.
  • Download—The action link downloads a file from the action URL.
  • Ui—The action link takes the user to a web page at the action URL.
ConnectApi.​ActivationPlatformCustomerFileSource Customer file source of the activation platform.
  • First_And_Third_Party
  • First_Party
  • Third_Party
ConnectApi.ActivationStatus Status of the activation.
  • Active
  • Processing
  • Error
  • Inactive
ConnectApi.ActivationTargetStatusEnum Status of the activation target.
  • Active
  • Processing
  • Error
  • Inactive
ConnectApi.​ActivitySharingType Type of sharing operation.
  • Everyone—The activity is shared with everyone.
  • MyGroups—The activity is shared only with a selection of the context user’s groups.
  • OnlyMe—The activity is private.
ConnectApi.ActivityType Type of activity.
  • All
  • Event
  • Task
ConnectApi.AccountHolderType Bank account holder type.
  • Business
  • Individual
ConnectApi.AccountType Bank account type.
  • Business
  • Savings
ConnectApi.​AdjustmentAmountScope Scope of the price adjustment amount.
  • Total—The adjustment scope is the total price.
  • Unit—The adjustment scope is the unit price.
  • UnproratedTotal—The adjustment scope is the unprorated total price.
ConnectApi.​AdjustmentType How the price adjustment amount is calculated.
  • AdjustmentAmount—The adjustment is a fixed amount.
  • AdjustmentPercentage—The adjustment is a percentage.
ConnectApi.​Application Application that initiated the payment request.
  • RLM
ConnectApi.​ArticleTopicJobType Type of operation to perform on articles and topics.
  • AssignTopicsToArticle—Assign topics to articles in a data category.
  • UnassignTopicsFromArticle—Unassign topics from articles in a data category.
ConnectApi.AsyncOperationStatus Asynchronous processing status of the cart, if asynchronous processing is enabled for the store.
  • Completed
  • Errored
  • Processing
ConnectApi.​AudienceCriteriaOperator Operator used in the personalization audience criterion.
  • Contains
  • Equal
  • GreaterThan
  • GreaterThanOrEqual
  • Includes
  • LessThan
  • LessThanOrEqual
  • NotEqual
  • NotIncludes
  • StartsWith
ConnectApi.​AudienceCriteriaType Type of personalization audience criterion.
  • Audience—Criterion based on audience.
  • Default—Audience has no criteria.
  • Domain—Criterion based on domain.
  • FieldBased—Criterion based on object fields.
  • GeoLocation—Criterion based on location.
  • Permission—Criterion based on standard or custom permissions.
  • Profile—Criterion based on profile.
ConnectApi.AudienceDMODeltaType Delta type of the activation.
  • A—ADDED
  • D—DELETED
  • E—EXISTING
  • U—UPDATED
ConnectApi.BankType Bank type.
  • ACH—Automated Clearing House transaction
  • BACS—Bankers' Automated Clearing Services transaction
  • BECS—Bulk Electronic Clearing System transaction
  • SepaDebit—Single Euro Payments Area transaction
ConnectApi.​BannerStyle Decorates a feed item with a color and set of icons.
  • Announcement—An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.
ConnectApi.BillingFrequency Billing frequency for a subscription.
  • Annual
  • Monthly
ConnectApi.​BotVersion​ActivationStatus Activation status of the bot version.
  • Active
  • Inactive
ConnectApi.​BundleType Type of bundle.
  • GenericBundle—A bundle that contains no additional information and is just a collection of feed elements.
  • TrackedChanges—A bundle that represents a collection of feed-tracked changes. The bundle includes summary information about the feed-tracked changes that make up the bundle.
ConnectApi.​CalculatedInsight​DefinitionTypeEnum Definition type of the calculated insight.
  • CALCULATED_METRIC
  • CALCULATED_METRIC
  • CALCULATED_METRIC
ConnectApi.​CalculateTaxType Type of tax calculation.
  • Actual—Calculated tax represents the final taxed amount for the transaction.
  • Estimated—Calculated tax represents only an estimated value before the transaction is finalized.
ConnectApi.CalloutStatus Indicates whether a named credential is enabled for callout.
  • Disabled
  • Enabled
ConnectApi.​CardCategory Indicates a credit card or debit card.
  • CreditCard
  • DebitCard
ConnectApi.​CardType Credit card issuer.
  • AmericanExpress
  • DinersClub
  • JCB
  • Maestro
  • MasterCard
  • Visa
ConnectApi.​CartItemSortOrder Sort order for items in a cart.
  • CreatedDateAsc—Sorts by oldest creation date.
  • CreatedDateDesc—Sorts by most recent creation date.
  • NameAsc—Sorts by name in ascending alphabetical order (A–Z).
  • NameDesc—Sorts by name in descending alphabetical order (Z–A).
  • SalesPriceAsc—Sorts from lowest to highest negotiated price.
  • SalesPriceDesc—Sorts from highest to lowest negotiated price.
ConnectApi.​CartItemSubType Subtype of item in a cart.
  • Bonus—A bonus product.
  • Gift—A gift product.
ConnectApi.​CartItemType Type of item in a cart.
  • DeliveryCharge
  • Product
ConnectApi.​CartMessageSeverity Severity of cart message.
  • Error
  • Info
  • Warning
ConnectApi.​CartPromotionType Level of the promotion target.
  • Cart—The target is cart-level.
  • Item—The target is item-level.
ConnectApi.​CartStatus Status of the cart.
  • Active—Cart is created and available for modifications, like adding or removing products or promotions.
  • Checkout—Cart is in checkout. If the customer modifies the cart, the current checkout session is canceled.
  • Closed—Checkout is complete and an order was created. The cart cannot be modified.
  • PendingClosed—Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified. This value is available in API version 57.0 and later.
  • PendingDelete—Cart is marked for delete, but the request isn't completed yet. The cart can’t be modified.
  • Processing—Cart is processing. For example, taxes are being calculated. The cart can’t be modified.
ConnectApi.​CartTaxType Tax type of the cart.
  • Automatic—Automatic taxation policy.
  • Gross—Gross taxation policy.
  • Net—Net taxation policy.
ConnectApi.​CartType Type of cart.
  • Cart—Cart created by a customer.
  • PayNowReadOnly—Clone of a Template cart that the customer can check out with using the Pay Now feature.
  • Template—Cart created by an internal user.
ConnectApi.​CaseActorType Type of user who made the comment.
  • Customer—if a Chatter customer made the comment
  • CustomerService—if a service representative made the comment
ConnectApi.​CaseComment​EventType Event type of a comment in Case Feed.
  • NewInternal—A case comment that has newly been marked Internal Only.
  • NewPublished—A newly published case comment.
  • NewPublishedByCustomer—A case comment by a customer that was newly published.
  • PublishExisting—An existing case comment that was republished.
  • PublishExistingByCustomer—An existing case comment by a customer that was republished.
  • UnpublishExistingByCustomer—An existing case comment by a customer that was unpublished.
  • UnpublishExsiting—An existing case comment that was unpublished.

    Unfortunately, this typo is in the code, not the documentation. Use this spelling in your code.

    Note

ConnectApi.​CdpIdentityResolution​ConfigurationType Source object for an identity resolution ruleset.
  • Account
  • Individual
ConnectApi.​CdpIdentityResolution​MatchMethodType Match method for a match rule criterion.
  • Exact—Exact match.
  • ExactNormalized—Exact normalized match.
  • Fuzzy—Fuzzy match with medium precision.
  • FuzzyHigh—Fuzzy match with high precision.
  • FuzzyLow—Fuzzy match with low precision.
ConnectApi.​CdpIdentityResolution​ReconciliationRuleType Default reconciliation rule applied to fields in the object the reconciliation rule applies to.
  • LastUpdated
  • MostFrequent
  • SourceSequence
ConnectApi.​CdpIdentityResolution​RunNowResultCode Result of an identity resolution ruleset job run.
  • ExceededMaximumNumberOf​SuccessfulRunsAllowedIn24Hours
  • IdentityResolutionJobIsAlready​Running
  • NoPendingChangesJobRunSkipped
  • SuccessfullySubmittedIdentity​ResolutionJobRunRequest
ConnectApi.​CdpMlModelPredictionTypeEnum Type of the model prediction.
  • BinaryClassification-Binary classification.
  • Generic-Generic/unknown.
  • MulticlassClassification-Multiclass classification.
  • Regression-Regression.
ConnectApi.​CdpMlPredictAggregateFunctionStatusEnum Status of the prediction aggregate function.
  • Error
  • Success
ConnectApi.​CdpMlPredictAggregateFunctionTypeEnum Type of the prediction aggregate function.
  • Average
  • Median
  • Sum
ConnectApi.​CdpMlPredictStatusEnum Status of the prediction.
  • Error
  • Success
ConnectApi.​CdpMlPredictTypeEnum Type of input data for the prediction.
  • RawData-Raw data.
  • RecordOverrides-Record IDs with user-provided overrides.
  • Records-Record IDs.
ConnectApi.​CommentType Type of comment.
  • ContentComment—Comment holds a content capability.
  • TextComment—Comment contains only text.
ConnectApi.​CommerceAddressSort Sort order for Commerce addresses.
  • CreatedDateAsc—Sort in ascending order of created date.
  • CreatedDateDesc—Sort in descending order of created date.
  • NameAsc—Sort in ascending order of name.
  • NameDesc—Sort in descending order of name.
ConnectApi.​CommerceSearch​AttributeType Search attribute type.
  • Custom
  • PricebookEntry
  • ProductAttribute
  • ProductCategory
  • Product2
  • Standard
ConnectApi.​CommerceSearchFacet​DisplayType Display type of the facet.
  • CategoryTree
  • DatePicker
  • MultiSelect
  • SingleSelect
ConnectApi.​CommerceSearch​FacetType Search facet type.
  • DistinctValue
  • Range
ConnectApi.​CommerceSearch​GroupingOption Grouping option for search results.
  • BestMatch—Search results are grouped by the best-match product of the variation group.
  • NoGrouping—Search results aren’t grouped.
  • VariationParent—Search results are grouped by the variation parent.
ConnectApi.​CommerceSearch​IndexBuildType Build type of the index.
  • Full
  • Incremental
ConnectApi.​CommerceSearch​IndexCreationType Creation type of the index.
  • Manual
  • Scheduled
ConnectApi.​CommerceSearch​IndexStatus Status of the index.
  • Completed
  • Failed
  • InProgress
ConnectApi.​CommerceSearch​IndexUsage Usage of the index.
  • Live
  • OutOfUse
ConnectApi.​CommerceSearch​SortRuleDirection Direction of the sort rule.
  • Ascending—Sorts in ascending alphanumeric order (A–Z, 0–9).
  • Default—When no direction is defined, sorts by relevance.
  • Descending—Sorts in descending alphanumeric order (Z–A, 9–0).
ConnectApi.​CommerceSearch​SortRule​LabelSuffix Label suffix of the sort rule.
  • Ascen—Label suffix for 'Asc'
  • Ascending—Label suffix for 'Ascending'
  • Az—Label suffix for 'A-Z'
  • Descen—Label suffix for 'Desc'
  • Descending—Label suffix for 'Descending'
  • FewMany—Label suffix for 'Few-Many'
  • HeavyLight—Label suffix for 'Heavy-Light'
  • HighLow—Label suffix for 'High-Low'
  • HighestLowest—Label suffix for 'Highest-Lowest'
  • LightHeavy—Label suffix for 'Light-Heavy'
  • LowHigh—Label suffix for 'Low-High'
  • LowestHighest—Label suffix for 'Lowest-Highest'
  • ManyFew—Label suffix for 'Many-Few'
  • NewOld—Label suffix for 'New-Old'
  • Newest—Label suffix for 'Newest'
  • NewestOldest—Label suffix for 'Newest-Oldest'
  • NineZero—Label suffix for '9-0'
  • OldNew—Label suffix for 'Old-New'
  • Oldest—Label suffix for 'Oldest'
  • OldestNewest—Label suffix for 'Oldest-Newest'
  • PriceDecreasing—Label suffix for '$$-$'
  • PriceIncreasing—Label suffix for '$-$$'
  • ThickThin—Label suffix for 'Thick-Thin'
  • ThinThick—Label suffix for 'Thin-Thick'
  • Za—Label suffix for 'Z-A'
  • ZeroNine—Label suffix for '0-9'
ConnectApi.​CommerceSearch​SortRuleType Type of sort rule.
  • ProductAttributeBased—Sorts by product attribute fields.
  • ProductBased—Sorts by product field data.
  • Relevancy—Sorts by product and catalog term frequency.
  • SortByPricebook—Sorts by product prices defined in the specified pricebook (version 55.0 and later).
ConnectApi.​CommerceSearchTop​ProductType Type of the top product to return for each product group in search results.
  • VariationParent
ConnectApi.CommunityFlag​ReasonType Reason a post, comment, or file is flagged.
  • FlaggedByRule—Moderation rule flagged the item.
  • FlaggedBySystem—Einstein flagged the item.
  • FlaggedByUserAsInappropriate—User flagged the item as inappropriate.
  • FlaggedByUserAsSpam—User flagged the item as spam.
ConnectApi.​CommunityFlag​Type Type of moderation flag.
  • FlagAsInappropriate—Flag for inappropriate content.
  • FlagAsSpam—Flag for spam.
ConnectApi.​CommunityFlag​Visibility Visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
ConnectApi.​CommunityStatus Status of the Experience Cloud site.
  • Live
  • Inactive
  • UnderConstruction
ConnectApi.CompressionFormatEnum Compression format for the output file.
  • Bzip2
  • Gzip
  • None-No compression
ConnectApi.ConnectInsightUnitEnum Unit for an insight.
  • Count
  • Currency
  • Dollar
  • Number
  • Percent
ConnectApi.ContactPointType Type of contact point.
  • Email
  • Maid
  • Ott
  • Phone
  • Push
  • Subscriber_Key_Email
  • Subscriber_Key_Phone
  • WhatsApp
ConnectApi.ContactPointPref Type of contact point.
  • ContactPointPrefAny
  • ContactPointPrefBusiness
  • ContactPointPrefPersonal
  • ContactPointPrefPrimary
ConnectApi.​ContentHub​Authentication​Protocol Authentication protocol used for the repository.
  • NoAuthentication—Repository doesn’t require authentication.
  • Oauth—Repository uses OAuth authentication protocol.
  • Password—Repository uses user name and password authentication protocol.
ConnectApi.​ContentHub​DirectoryEntry​Type Type of directory entry.
  • GroupEntry
  • UserEntry
ConnectApi.​ContentHub​ExternalItem​SharingType Sharing status for the external file.
  • DomainSharing—File is shared with the domain.
  • PrivateSharing—File is private or shared only with individuals.
  • PublicSharing—File is publicly shared.
ConnectApi.​ContentHub​GroupType Type of group.
  • Everybody—Group is public to everybody.
  • EverybodyInDomain—Group is public to everybody in the same domain.
  • Unknown—Group type is unknown.
ConnectApi.​ContentHub​ItemType Item types.
  • Any—Includes files and folders.
  • FilesOnly—Includes files only.
  • FoldersOnly—Includes folders only.
ConnectApi.​ContentHub​StreamSupport Support for content streaming.
  • ContentStreamAllowed
  • ContentStreamNotAllowed
  • ContentStreamRequired
ConnectApi.​ContentHub​VariableType Data type of the value of the field.
  • BooleanType
  • DateTimeType
  • DecimalType
  • HtmlType
  • IdType
  • IntegerType
  • StringType
  • UriType
  • XmlType
ConnectApi.​Conversation​Application​IntegrationType Conversation application integration types.
  • Api
  • Slack
ConnectApi.​CreateCredential​Action Action to take when creating the credential.
  • Refresh
ConnectApi.​CredentialAuthentication​Protocol Authentication protocol of the external credential.
  • AwsSv4
  • Basic
  • Custom
  • Jwt
  • OAuth
ConnectApi.​CredentialAuthentication​ProtocolVariant Authentication protocol variant of the external credential.
  • AwsSv4_STS—AWS Signature Version 4 with Security Token Service.
  • ClientCredentialsClientSecret—OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body.
  • ClientCredentialsClientSecretBasic—OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication.
  • ClientCredentialsJwtAssertion—OAuth 2.0 Client Credentials JSON Web Token assertion.
  • JwtBearer—OAuth 2.0 JSON Web Token bearer flow.
  • NoAuthentication—No authentication.
  • RolesAnywhere—AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere.
ConnectApi.​CredentialAuthentication​Status Status of the credential authentication.
  • Configured—Credential has all required credentials for at least one principal.
  • NotConfigured—Credential isn’t configured.
  • Unknown—Credential status can’t be determined because the authentication protocol is custom.
ConnectApi.​CredentialPrincipalType Type of credential principal.
  • AwsStsPrincipal
  • NamedPrincipal
  • PerUserPrincipal
ConnectApi.​CurrencyInfoDisplayTypeEnum Display metadata type of the currency info.
  • IsoCode—ISO code of the currency.
ConnectApi.DaoObjectFieldTypeQueryEnum Type of the calculated insight field.
  • Dimension
  • Measure
  • ObjectTypeUnspecified
ConnectApi.​DataCategoryOperator Data category operator.
  • Above—Queries the data category and all of its parent categories.
  • AboveOrBelow—Queries the data category, all of its parent categories, and all of its subcategories.
  • At—Queries the data category.
  • Below—Queries the data category and all of its subcategories.
ConnectApi.DataConnectorTypeEnum Data connector type of the activation target.
  • AmazonS3
  • AzureBlob
  • DataCloud
  • GoogleCloudStorage
  • SalesforceMarketingCloud
  • Sftp
ConnectApi.DataExportAttributeSource Activation attribute source.
  • Direct
  • Related
ConnectApi.DataExportAttributeType Type of activation attribute.
  • Computed_Dimension
  • Computed_Measure
  • Model
  • Model_Related
  • Non_Aggregatable_Computed_Measure
ConnectApi.DataExportRefreshMode Refresh type of the activation.
  • Full_Refresh
  • Incremental
ConnectApi.​DataExportRunStatus Last publish status of the activation.
  • Error
  • Partner_Error
  • Partner_Processing
  • Publishing
  • Queued
  • Segment_Error
  • Skipped
  • Success
ConnectApi.DataGraphObjectType Data type of an object for a data graph.
  • Adg
  • AdgActivationAudience
  • AdgExternal
  • Bridge
  • Calculated
  • CalculatedRealTime
  • CalculatedStreaming
  • Curated
  • Custom
  • Derived
  • MlPrediction
  • ObjectTypeUnspecified
  • Package
  • SegmentMembership
  • Standard
  • System
  • Transform
ConnectApi.DataGraphStatus Status of the data graph.
  • Error
  • Inprogress
  • Published
  • Ready
  • StatusUnspecified
  • Unrecognized
ConnectApi.​DatacloudUserType Type of user.
  • Monthly—A user type that’s assigned monthly point limits for purchasing Data.com records. Only the assigned user can use monthly points. Points expire at the end of the month. Monthly is the default setting for DatacloudUserType.
  • Listpool—A user type that allows users to draw from a pool of points to purchase Data.com records.
ConnectApi.​DatacloudImport​StatusTypeEnum Status of the import.
  • Success—Indicates that selected records were added to the org’s CRM.
  • Duplicate—Marks a record that is already in the org’s CRM. The API determines whether an org allows the addition of duplicate records in its CRM.
  • Error—Indicates that the selected records weren’t added to the org’s CRM.
ConnectApi.DataSpaceStatusEnum Status of the data space.
  • Active—The data space is active.
  • Error—The data space has an error.
  • Processing—The data space is being processed.
ConnectApi.​DigestPeriod Time period that’s included in a Chatter email digest.
  • DailyDigest—The email includes up to the 50 latest posts from the previous day.
  • WeeklyDigest—The email includes up to the 50 latest posts from the previous week.
ConnectApi.EgressFileNameTypeEnum Type of egress file name.
  • Custom
  • Predetermined
ConnectApi.​EmailMessage​AutomationType Automation type of the email message.
  • aiAssisted—The email message was created with the assistance of AI.
  • aiAutomated—The email message was created automatically by AI.
ConnectApi.​EmailMessage​Direction Direction of an email message on a case.
  • Inbound—An inbound message (sent by a customer).
  • Outbound—An outbound message (sent to a customer by a support agent).
ConnectApi.​EmailMessage​Status Status of an email message on a case.
  • DraftStatus
  • ForwardedStatus
  • NewStatus
  • ReadStatus
  • RepliedStatus
  • SentStatus
ConnectApi.​ExtensionInformationType Information type of the extension.
  • Lightning
ConnectApi.​​ExternalAuthIdentity​ProviderParamType Parameter type for an external auth identity provider.
  • AuthorizeRequestQueryParameter
  • IdentityProviderOptions
  • ManagedByComponent
  • ManagedByFeature
  • RefreshRequestBodyParameter
  • RefreshRequestHttpHeader
  • RefreshRequestQueryParameter
  • TokenRequestBodyParameter
  • TokenRequestHttpHeader
  • TokenRequestQueryParameter
ConnectApi.​​ExternalCredential​​ParameterType Parameter type of the external credential.
  • AdditionalRefreshStatusCode
  • AuthParameter
  • AuthProvider
  • AuthProviderUrl
  • AuthProviderUrlQueryParameter
  • JwtBodyClaim
  • JwtHeaderClaim
  • ManagedByComponent
  • ManagedByFeature
  • SigningCertificate
ConnectApi.​​ExternalCredential​PrincipalAccessType Access type of the external credential principal.
  • PermissionSet
  • PermissionSetGroup
  • Profile
ConnectApi.​FeedCommentSortOrder Order of comments.
  • CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
  • CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
  • Relevance—Sorts by most relevant content.
ConnectApi.​FeedDensity Density of the feed.
  • AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
ConnectApi.​FeedElementCapability​Type Capabilities of a feed element in API versions 31.0 and later. If a capability exists on a feed element, the capability is available, even if the value doesn’t exist or is null. If the capability doesn’t exist, it isn’t available.
  • AssociatedActions—The feed element includes information about actions associated with it.
  • Approval—The feed element includes information about an approval.
  • Banner—The body of the feed element has an icon and border.
  • Bookmarks—The context user can bookmark the feed element. Bookmarked feed elements are visible in the bookmarks feed.
  • Bundle—The feed element has a group of other feed elements that display as a bundle in the feed. The bundle type determines the additional data associated with the bundle.
  • CallCollaboration—The feed element has a recording comment.
  • Canvas—The feed element renders a canvas app.
  • CaseComment—The feed element has a case comment in the case feed.
  • ChatterLikes—The context user can like the feed element.
  • Close—The feed element can’t be edited, commented on, or deleted. If the feed element is a poll, it can’t be voted on.
  • Comments—The context user can add comments to the feed element.
  • Content—The feed element has a file.
  • DashboardComponentSnapshot—The feed element has a dashboard component snapshot.
  • DirectMessageThe feed element is a direct message.
  • Edit—Users who have permission can edit the feed element.
  • EmailMessage—The feed element has an email message from a case.
  • Extensions—The feed element has one or more extension attachments.
  • FeedEntityShareThe feed element has a feed entity shared with it.
  • Files—The feed element has one or more file attachments.
  • Interactions—The feed element has information about user interactions.
  • MediaReferencesThe feed element has one or more media references.
  • Moderation—Users in an Experience Cloud site can flag the feed element for moderation.
  • Mute—The context user can mute the feed element.
  • Origin—A feed action created the feed element.
  • Pin—Users who have permission can pin the feed element.
  • Poll—The feed element has poll voting.
  • QuestionAndAnswers—The feed element has a question, and users can add answers to the feed element instead of comments. Users can also select the best answer.
  • ReadBy—The context user can mark the feed element as read.
  • Recommendations—The feed element has a recommendation.
  • Record—The comment has a record attachment.
  • RecordSnapshot—The feed element has all the snapshot fields of a record for a single create record event.
  • SocialPost—The feed element can interact with a social post on a social network.
  • Status—The feed element has a status that determines its visibility.
  • Topics—The context user can add topics to the feed element.
  • TrackedChanges—The feed element has all changes to a record for a single tracked change event.
  • UpDownVoteUsers can upvote or downvote the feed element.
  • VerifiedUsers who have permission can mark a comment as verified or unverified.
ConnectApi.​FeedElement​Type Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element.
  • Bundle—A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.
  • FeedItem—A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.
  • Recommendation—A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.
ConnectApi.​FeedEntity​Status Status of the feed post or comment.
  • Draft—The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts.
  • Isolated—The feed post or comment is isolated, and only admins can see it.
  • PendingReview—The feed post or comment isn’t approved yet and therefore isn’t published or visible.
  • Published—The feed post or comment is approved and visible.
ConnectApi.​FeedFavorite​Type Origin of the feed favorite.
  • ListView
  • Search
  • Topic
ConnectApi.​FeedFilter Filter value for a feed.
  • AllQuestions—Feed elements that are questions.
  • AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
  • CommunityScoped—Feed elements that are scoped to Experience Cloud sites. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to sites in the future. Feed elements that are always visible in all sites are filtered out. This value is valid only for the UserProfile feed.
  • QuestionsWithCandidateAnswersFeed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
  • QuestionsWithCandidateAnswers​ReviewedPublishedFeed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
  • Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
  • SolvedQuestions—Feed elements that are questions and that have a best answer.
  • UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
  • UnansweredQuestionsWithCandidate​AnswersFeed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
  • Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
  • UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.
ConnectApi.​FeedItem​AttachmentType Attachment type for feed item output objects.
  • Approval—A feed item requiring approval.
  • BasicTemplate—A feed item with a generic rendering of an image, link, and title.
  • Canvas—A feed item that contains the metadata to render a link to a canvas app.
  • CaseComment—A feed item created from a comment to a case record.
  • CaseComment—A feed item created from a comment to a case record.
  • Content—A feed item with a file attached.
  • DashboardComponent—A feed item with a dashboard attached.
  • EmailMessage—An email attached to a case record in Case Feed.
  • Link—A feed item with a URL attached.
  • Poll—A feed item with a poll attached.
  • Question—A feed item with a question attached.
  • RecordSnapshot—The feed item attachment contains a view of a record at a single ConnectApi.FeedItemType.CreateRecordEvent.
  • TrackedChange—All changes to a record for a single ConnectApi.FeedItemType.TrackedChange event.
ConnectApi.​FeedItemType Type of feed item.
  • ActivityEvent—Feed item generated in Case Feed when an event or task associated with a parent record with a feed enabled is created or updated.
  • AdvancedTextPost—A feed item with advanced text formatting, such as a group announcement post.
  • ApprovalPost—Feed item with an approval capability. Approvers can act on the feed item parent.
  • AttachArticleEvent—Feed item generated when an article is attached to a case in Case Feed.
  • BasicTemplateFeedItem—Feed item with an enhanced link capability.
  • CallLogPost—Feed item generated when a call log is saved to a case in Case Feed.
  • CanvasPost—Feed item generated by a canvas app in the publisher or from Connect REST API or Connect in Apex. The post itself is a link to a canvas app.
  • CaseCommentPost—Feed item generated when a case comment is saved in Case Feed.
  • ChangeStatusPost—Feed item generated when the status of a case is changed in Case Feed.
  • ChatTranscriptionPost—Feed item generated in Case Feed when a Live Agent chat transcript is saved to a case.
  • CollaborationGroupCreated—Feed item generated when a new public group is created. Contains a link to the new group.
  • CollaborationGroupUnarchived—Deprecated. Feed item generated when an archived group is activated.
  • ContentPost—Feed item with a content capability.
  • CreateRecordEvent—Feed item that describes a record created in the publisher.
  • DashboardComponentAlert—Feed item with a dashboard alert.
  • DashboardComponentSnapshot—Feed item with a dashboard component snapshot capability.
  • EmailMessageEvent—Feed item generated when an email is sent from a case in Case Feed.
  • FacebookPost—Deprecated. Feed item generated when a Facebook post is created from a case in Case Feed.
  • LinkPost—Feed item with a link capability.
  • MilestoneEvent—Feed item generated when a case milestone is either completed or reaches a violation status. Contains a link to the case milestone.
  • PollPost—Feed item with a poll capability. Viewers of the feed item are allowed to vote on the options in the poll.
  • ProfileSkillPost—Feed item generated when a skill is added to a user’s profile.
  • QuestionPost—Feed item generated when a question is asked.

    As of API version 33.0, a feed item of this type can have a content capability and a link capability.

  • ReplyPost—Feed item generated by a Chatter Answers reply.
  • RypplePost—Feed item generated when a user posts thanks.
  • SocialPost—Feed item generated when a social post is created from a case in Case Feed.
  • TextPost—Feed item containing text only.
  • TrackedChange—Feed item created when one or more fields on a record have been changed.
  • UserStatus—Deprecated. A user's post to their own profile.
ConnectApi.​FeedItem​VisibilityType Type of users who can see a feed item.
  • AllUsers—Visibility is not limited to internal users.
  • InternalUsers—Visibility is limited to internal users.
ConnectApi.​FeedSortOrder Order of feed items in the feed.
  • CreatedDateAscSorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Isolated, Moderation, and PendingReview feeds.
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
  • MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
  • Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.
ConnectApi.​FeedType Type of feed.
  • BookmarksContains all feed items saved as bookmarks by the context user.
  • CompanyContains all feed items except feed items of type TrackedChange. To see the feed item, the user must have sharing access to its parent.
  • DirectMessageModerationContains all direct messages that are flagged for moderation. The Direct Message Moderation feed is available only to users with Moderate Experiences Chatter Messages permissions.
  • DirectMessagesContains all feed items of the context user’s direct messages.
  • Draft—Contains all the feed items that the context user drafted.
  • FilesContains all feed items that contain files posted by people or groups that the context user follows.
  • Filter—Contains the news feed filtered to contain feed items whose parent is a specified object type.
  • GroupsContains all feed items from all groups the context user either owns or is a member of.
  • Home—Contains all feed items associated with any managed topic in an Experience Cloud site.
  • Isolated—Contains all the feed items and comments that are isolated.
  • LandingContains all feed items that best drive user engagement when the feed is requested. Allows clients to avoid an empty feed when there aren’t many personalized feed items.
  • ModerationContains all feed items that are flagged for moderation, except direct messages. The moderation feed is available only to users with Moderate Experiences Feeds permissions.
  • Mute—Contains all feed items that the context user muted.
  • NewsContains all updates for people the context user follows, groups the user is a member of, and files and records the user is following. Contains all updates for records whose parent is the context user.
  • PendingReviewContains all feed items and comments that are pending review.
  • PeopleContains all feed items posted by all people the context user follows.
  • RecordContains all feed items whose parent is a specified record, which could be a group, user, object, file, or any other standard or custom object. When the record is a group, the feed also contains feed items that mention the group. When the record is a user, the feed contains only feed items on that user. You can get another user’s record feed.
  • StreamsContains all feed items for any combination of up to 25 feed-enabled entities that the context user subscribes to in a stream. Examples of feed-enabled entities include people, groups, and records,
  • ToContains all feed items with mentions of the context user. Contains feed items the context user commented on and feed items created by the context user that are commented on.
  • TopicsContains all feed items that include the specified topic.
  • UserProfile—Contains feed items created when a user changes records that can be tracked in a feed. Contains feed items whose parent is the user and feed items that @mention the user. This feed is different than the news feed, which returns more feed items, including group updates. You can get another user’s user profile feed.
ConnectApi.​FieldChange​ValueType Value type of a field change.
  • NewValue—A new value
  • OldValue—An old value
ConnectApi.​FieldType Field type.
  • Address
  • AnyType
  • Base64
  • Boolean
  • Combobox
  • ComplexValue
  • Currency
  • DataCategoryGroupReference
  • Date
  • DateTime
  • Double
  • Email
  • EncryptedString
  • ExtensionEntityLookup
  • ExternalLookup
  • FloatArray
  • Id
  • ImageUrl
  • IndirectLookup
  • Integer
  • Json
  • Location
  • Long
  • MultiPicklist
  • Percent
  • PersonName
  • Phone
  • Picklist
  • PlainTextArea
  • Reference
  • RichTextArea
  • Sobject
  • String
  • SwitchablePersonName
  • TextArea
  • Time
  • Url
ConnectApi.FileDelimiterEnum Field delimiter for the output file.
  • BrokenPipe
  • Caret
  • Colon
  • Comma
  • Hash
  • Pipe
  • Semicolon
  • Slash
  • Tab
  • Tilde
  • Underscore
ConnectApi.​FilePreviewFormat Format of the file preview.
  • Audio—Preview format is MP3.
  • Jpg—Preview format is JPG.
  • Pdf—Preview format is PDF.
  • Svg—Preview format is compressed SVG.
  • Thumbnail—Preview format is 240 x 180 PNG.
  • ThumbnailBig—Preview format is 720 x 480 PNG.
  • ThumbnailTiny—Preview format is 120 x 90 PNG.
  • Video—Preview format is MP4.
ConnectApi.​FilePreviewStatus Availability status of the file preview.
  • Available—Preview is available.
  • InProgress—Preview is being processed.
  • NotAvailable—Preview is unavailable.
  • NotScheduled—Generation of the preview isn’t scheduled yet.
ConnectApi.​FilePublishStatus Publish status of the file.
  • PendingAccess—File is pending publishing.
  • PrivateAccess—File is private.
  • PublicAccess—File is public.
ConnectApi.​FileSharingOption Sharing option of the file.
  • Allowed—Resharing of the file is allowed.
  • Restricted—Resharing of the file is restricted.
ConnectApi.​FileSharingPrivacy Sharing privacy of a file.
  • None—File is visible to anyone with record access.
  • PrivateOnRecords—File is private on records.
ConnectApi.​FileSharingType Sharing role of the file.
  • Admin—Owner permission, but doesn’t own the file.
  • Collaborator—Viewer permission, and can edit, change permissions, and upload a new version of a file.
  • Owner—Collaborator permission, and can make a file private, and delete a file.
  • Viewer—Can view, download, and share a file.
  • WorkspaceManaged—Permission controlled by the library.
ConnectApi.FilterConjunction Conjunction for the activation attribute filter expression.
  • FilterConjunctionAnd
  • FilterConjunctionOr
ConnectApi.​FilterOperator Filter operator.
  • EqOp—Equal
  • ExcludesOp—Excludes
  • GtOp—Greater than
  • GteOp—Greater than or equal
  • InOp—In
  • IncludesOp—Includes
  • LikeOp—Like
  • LtOp—Less than
  • LteOp—Less than or equal
  • NeOp—Not equal
  • NinOp—Not in
ConnectApi.FilterOperatorDataType Type of attribute.
  • FilterOperatorDataTypeBoolean
  • FilterOperatorDataTypeDate
  • FilterOperatorDataTypeDateOnly
  • FilterOperatorDataTypeExactlyRelativeDate
  • FilterOperatorDataTypeNumber
  • FilterOperatorDataTypeRelateToNowDate
  • FilterOperatorDataTypeText
ConnectApi.FilterSortOrder The sort order for filtering.
  • FilterSortOrderAsc
  • FilterSortOrderDesc
ConnectApi.​FolderItem​Type Type of item in a folder.
  • file
  • folder
ConnectApi.FormFieldType Type of marketing integration form field.
  • Boolean
  • Date
  • EmailAddress
  • Number
  • Text
ConnectApi.​FormulaFilter​Type Formula filter type for the personalization audience.
  • AllCriteriaMatch—All audience criteria are true (AND operation).
  • AnyCriterionMatches—Any audience criterion is true (OR operation).
  • CustomLogicMatches—Audience criteria match the custom formula (for example, (1 AND 2) OR 3).
ConnectApi.​GoalDefinitionCategoryEnum Definition category of the business objective, or goal.
  • Webstore
ConnectApi.​GroupArchive​Status Archive status of groups.
  • All—All groups, including groups that are archived and groups that aren’t archived.
  • Archived—Groups that are archived.
  • NotArchived—Groups that aren’t archived.
ConnectApi.​GroupEmail​Frequency Frequency with which a user receives email.
  • EachPost
  • DailyDigest
  • WeeklyDigest
  • Never
  • UseDefault
ConnectApi.​GroupMembership​Type Type of membership the user has with the group.
  • GroupOwner
  • GroupManager
  • NotAMember
  • NotAMemberPrivateRequested
  • StandardMember
ConnectApi.​GroupMembership​RequestStatus Status of a request to join a private group.
  • Accepted
  • Declined
  • Pending
ConnectApi.​GroupViral​InvitationsStatus Status of an invitation to join a group.
  • ActedUponUser—The user was added to the group. An email was sent asking the user to visit the group.
  • Invited—An email was sent asking the user to sign up for the org.
  • MaxedOutUsers—The group has the maximum allowed members.
  • MultipleError—The user wasn’t invited due to multiple errors.
  • NoActionNeededUser—The user is already a member of the group.
  • NotVisibleToExternalInviter—The user is not accessible to the user sending the invitation.
  • Unhandled—The user couldn’t be added to the group for an unknown reason.
ConnectApi.​GroupVisibility​Type Group visibility type.
  • PrivateAccess—Only members of the group can see posts to this group.
  • PublicAccess—All users within the Experience Cloud site can see posts to this group.
  • Unlisted—Reserved for future use.
ConnectApi.​HttpRequest​Method HTTP method.
  • HttpDelete—Returns HTTP 204 on success. Response body or output class is empty.
  • HttpGet—Returns HTTP 200 on success.
  • HttpHead—Returns HTTP 200 on success. Response body or output class is empty.
  • HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty.
  • HttpPost—Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success.
  • HttpPut—Return HTTP 200 on success or HTTP 204 if the response body or output class is empty.
ConnectApi.​IdentityProviderAuthFlow Authentication flow to get tokens to call protected APIs.
  • AuthorizationCode
ConnectApi.​IdentityProviderAuthProtocol Authentication protocol required to access the external system.
  • OAuth
ConnectApi.​IdentityProviderClientAuth Client authentication method that describes how credentials are sent to the authorization server.
  • ClientSecretBasic
  • ClientSecretPost
ConnectApi.​LinkMetadataSource Source of the link metadata.
  • None—Link metadata wasn’t retrieved.
  • Sfdc—Salesforce is the source.
ConnectApi.​LinkMetadataType Type of link that the metadata represents.
  • Error—Link metadata couldn’t be retrieved.
  • Link—Represents a link.
  • None—Link metadata wasn’t retrieved because the link isn’t an allowed domain.
  • Photo—Represents a photo.
  • Rich—Represents rich content, typically HTML content.
  • Unknown—Link metadata was retrieved, but the type is unknown.
  • Video—Represents a video.
ConnectApi.​MaintenanceType Type of maintenance.
  • Downtime—Downtime maintenance.
  • GenerallyAvailable—Generally available mode.
  • MaintenanceAndAvailable—Maintenance with available mode.
  • MaintenanceWithDowntime—Scheduled maintenance with downtime.
  • ReadOnly—Maintenance with read-only mode.
ConnectApi.​ManagedContent​ChannelType Type of managed content channel.
  • CloudToCloud—Cloud-to-Cloud integrated channel.
  • Community—Experience Cloud site channel.
  • ConnectedApp—Channel served by a connected app.
  • PublicUnauthenticated—Public channel. All published content is publicly available.
  • UserPermission—Channel backed by a system permission. All published content is available only to users with the permission.
ConnectApi.​ManagedContent​CloneStatus Status of the managed content clone.
  • PartialSuccess
  • Success
ConnectApi.​ManagedContent​MediaType Type of managed content media.
  • Document
  • Image
ConnectApi.​ManagedContent​NodeType Type of managed content node.
  • Date
  • DateTime
  • Media
  • MediaSource
  • MultilineText
  • NameField
  • RichText
  • Text
  • Url
ConnectApi.​ManagedContent​ProviderType Type of managed content provider.
  • DigitalAssetManager
ConnectApi.​ManagedContent​SpaceChannel​Operation Operation to perform on the channel and managed content space.
  • Add—Add a channel to a managed content space.
  • Remove—Remove a channel from a managed content space.
ConnectApi.​ManagedContent​SpaceChannel​Status Status of the add or remove operation for a channel and managed content space.
  • Added—Channel was added to the managed content space.
  • Failed—Add or remove operation failed.
  • Pending—Add or remove operation is pending.
  • Removed—Channel was removed from the managed content space.
ConnectApi.​ManagedContent​SpaceType Type of managed content space.
  • Content
  • Marketing
ConnectApi.​ManagedContent​VariantStatus Status of the managed content variant.
  • Draft—Content isn’t published.
  • Published—Content is published and available for use in your live sites.
  • Revised—Content that’s published and edited. Publish this content to make the changes available for use in your live sites.
ConnectApi.ManagedTopic​Type Type of managed topic.
  • Content—Topics that are associated with native content.
  • Featured—Topics that are featured, for example, on the Experience Cloud site home page, but don’t provide overall navigation.
  • Navigational—Topics that display in a navigational menu in the Experience Cloud site.
ConnectApi.MarkupType Type of rich text markup.
  • Bold—Bold tag.
  • Code—Code tag.
  • Hyperlink—Hyperlink anchor tag.
  • Italic—Italic tag.
  • ListItem—List item tag.
  • OrderedList—Ordered list tag.
  • Paragraph—Paragraph tag.
  • Strikethrough—Strikethrough tag.
  • Underline—Underline tag.
  • UnorderedList—Unordered list tag.
ConnectApi.​MCSFolderShare​Status Status of sharing a managed content space folder.
  • PendingShare
  • PendingUnshare
  • Shared
ConnectApi.​MentionCompletionType Type of mention completion.
  • All—All mention completions, regardless of the type of record to which the mention refers.
  • Group—Mention completions for groups.
  • User—Mention completions for users.
ConnectApi.​MentionValidation​Status Type of validation error for a proposed mention, if any.
  • Disallowed—The proposed mention is invalid and is rejected because the context user is trying to mention something that is not allowed. For example, a user who is not a member of a private group is trying to mention the private group.
  • Inaccessible—The proposed mention is allowed, but the user or record being mentioned isn’t notified. They don't have access to the parent record that’s being discussed.
  • Ok—There is no validation error for this proposed mention.
ConnectApi.​MessageSegment​Type Type of message segment, such as text, link, field change name, or field change value.
  • EntityLink
  • FieldChange
  • FieldChangeName
  • FieldChangeValue
  • Hashtag
  • InlineImage
  • Link
  • MarkupBegin
  • MarkupEnd
  • Mention
  • MoreChanges
  • ResourceLink
  • Text
ConnectApi.​NamedCredential​ParameterType Type of named credential parameter.
  • AllowedManagedPackageNamespaces
  • ClientCertificate
  • ConnectionStatus
ConnectApi.​NamedCredentialType Type of named credential.
  • PrivateEndpoint
  • SecuredEndpoint
ConnectApi.​NavigationMenuItem​ActionType Event, URL type, or modal navigation menu item.
ConnectApi.​NavigationMenuItem​OpenTarget Target for the navigation menu item.
ConnectApi.​NavigationMenuItem​Type Type of navigation menu item.
ConnectApi.​NBAActionType Type of action.
  • Flow—Automated process tool with multiple subtypes.
ConnectApi.​NBAFlowType Type of recommended flow.
  • AutoLaunchedFlow—Autolaunched flow that runs in the background.
  • Flow—Screen flow that accepts user inputs.
ConnectApi.​NBATargetType Type of target.
  • Recommendation
ConnectApi.​OperationType Operation to carry out on the file.
  • Add—Adds the file to the feed element.
  • Remove—Removes the file from the feed element.
ConnectApi.​OrchestrationInstanceStatus Status of the orchestration instance.
  • Canceled
  • Completed
  • Discontinued
  • Error
  • InProgress
  • NotStarted
  • Suspended
ConnectApi.​OrchestrationStepType Type of orchestration step.
  • AsynchronousBackgroundStep
  • ApprovalStep
  • BackgroundStep
  • InteractiveStep
  • ManagedContentRoleInteractiveStep
  • ManagedContentVariantAutoPublishBackgroundStep
  • ManagedContentVariantAutoUnpublishBackgroundStep
  • ManagedContentVariantSetLock​BackgroundStep
  • ManagedContentVariantSetReady​BackgroundStep
  • MuleSoftStep
ConnectApi.​OrchestrationWorkItemStatus Status of the orchestration work item.
  • Assigned
  • Completed
ConnectApi.​OrderDeliveryGroup​SummarySort Sort order for order delivery group summaries.
  • IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
  • IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).
ConnectApi.​OrderItemSummarySort Sort order for order item summaries.
  • IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
  • IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).
ConnectApi.​OrderNulls Null value order.
  • Firsts—Null values are sorted first.
  • Lasts—Null values are sorted last.
ConnectApi.​OrderShipment​ItemSort Sort order for order shipment items.
  • IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
  • IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).
ConnectApi.​OrderShipmentSort Sort order for order shipments.
  • ExpectedDeliveryDateAsc—Sorts by the oldest expected delivery date.
  • ExpectedDeliveryDateDesc—Sorts by the most recent expected delivery date.
  • ShipmentNumberAsc—Sorts by shipment number in ascending order (0–9).
  • ShipmentNumberDesc—Sorts by shipment number in descending order (9–0).
ConnectApi.​OrderSummary​Adjustment​Aggregates​Status Order summary adjustment aggregate job status.
  • Failed—The adjustment aggregate data job for the order summary failed.
  • InProgress—The adjustment aggregate data job for the order summary is in progress.
  • NotInitiated—The adjustment aggregate data job for the order summary is not initiated.
  • Submitted—The adjustment aggregate data job for the order summary is submitted.
ConnectApi.​OrderSummary​ Adjustment​Target​Type Type of price adjustment in promotions.
  • SplitLine—Price adjustment on an order item.
  • Header—Price adjustment on the entire order.
ConnectApi.​OrderSummary​SortOrder Sort order for order summaries.
  • CreatedDateAsc—Sorts by the oldest created date.
  • CreatedDateDesc—Sorts by the most recent created date.
  • OrderedDateAsc—Sorts by the oldest ordered date.
  • OrderedDateDesc—Sorts by the most recent ordered date.
ConnectApi.​PeriodType Time period used for forecasting.
  • Month
  • Quarter
  • Week
  • Year
ConnectApi.​PlatformAction​GroupCategory Location of an action link group on an associated feed element.
  • Primary—The action link group is displayed in the body of the feed element.
  • Overflow—The action link group is displayed in the overflow menu of the feed element.
ConnectApi.​PlatformActionStatus Status of the action.
  • FailedStatus—The action link execution failed.
  • NewStatus—The action link is ready to be executed. Available for Download and Ui action links only.
  • PendingStatus—The action link is executing. Choosing this value triggers the API call for Api and ApiAsync action links.
  • SuccessfulStatus—The action link executed successfully.
ConnectApi.​PlatformActionType Type of platform action.
  • ActionLink—An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce UI.
  • CustomButton—When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
  • ProductivityAction—Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions.
  • QuickAction—A global or object-specific action.
  • StandardButton—A predefined Salesforce button such as New, Edit, or Delete.
ConnectApi.PreDeterminedFileNameEnum Predetermined name of the output file. Either customFilename or predeterminedFilename must be present.
  • Activation
  • Segment
  • SegmentActivation
ConnectApi.​PriceAdjustmentTierType Type of price adjustment for the tier.
  • AmountBasedAdjustment—Price is adjusted by a specified amount.
  • PercentageBasedAdjustment—Price is adjusted by a specified percentage.
ConnectApi.​PricingTermUnit Unit of time used to define a pricing term.
  • Months—Product is priced on a monthly basis.
  • Annual—Product is priced on an annual basis.
ConnectApi.​ProductAttributeViewType View type for product attributes.
  • ColorSwatch
  • Dropdown
  • Pill
ConnectApi.​ProductClass Class of product.
  • Bundle
  • Set
  • Simple
  • Variation
  • VariationParent
ConnectApi.​ProductMediaType Type of product media.
  • Document
  • Image
  • Video
ConnectApi.​ProductMediaUsageType Usage type of a product media item within a media group.
  • Attachment—Product media group with product documents as attachments.
  • Banner—Product category media group with banner images of the product.
  • Listing—Product media group with listing images of the product.
  • Standard—Product media group with standard images and videos of the product.
  • Tile—Product category media group with tile images of the product.
ConnectApi.​PublishSchedule Publish refresh schedule.
  • One—Refreshes every hour. Used to rapidly publish UI and DBT-based segments.
  • Four—Refreshes every four hours. Used to rapidly publish UI and DBT-based segments.
  • Twelve—Refreshes every twelve hours.
  • TwentyFour—Refreshes every twenty-four hours.
ConnectApi.​PublishStatus Publish status of a personalization audience, target, or navigation menu item.
  • Draft
  • Live
ConnectApi.​SwatchDisplayTypeEnum Swatch display metadata type.
  • Color—Color of the swatch.
ConnectApi.QuerySqlStatusEnum Completion status of the query.
  • Finished
  • ResultsProduced
  • Running
  • Unspecified
ConnectApi.​RecommendationActionType Action to take on a recommendation.
  • follow—Follow a file, record, topic, or user.
  • join—Join a group.
  • view—View a file, group, article, record, user, custom, or static recommendation.
ConnectApi.​RecommendationAudience​CriteriaType Custom recommendation audience criteria type.
  • CustomList—A custom list of users makes up the audience.
  • MaxDaysInCommunity—New members make up the audience.
ConnectApi.​RecommendationAudience​MemberOperationType Operation to carry out on the custom recommendation audience members.
  • Add—Adds specified members to the audience.
  • Remove—Removes specified members from the audience.
ConnectApi.​RecommendationChannel A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or show recommendations based on time of day or geographic locations.
  • CustomChannel1Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Experience Builder to determine where recommendations appear.
  • CustomChannel2—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels.
  • CustomChannel3—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels.
  • CustomChannel4—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels.
  • CustomChannel5—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels.
  • DefaultChannel—Default recommendation channel. Recommendations appear by default on the Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder.
ConnectApi.​RecommendationExplanationType Reason for a Chatter recommendation.
  • ArticleHasRelatedContent—Articles with related content to a context article.
  • ArticleViewedTogether—Articles often viewed together with the article that the context user just viewed.
  • ArticleViewedTogetherWithViewers—Articles often viewed together with other records that the context user views.
  • Custom—Custom recommendations.
  • FilePopular—Files with many followers or views.
  • FileViewedTogether—Files often viewed at the same time as other files that the context user views.
  • FollowedTogetherWithFollowees—Users often followed together with other records that the context user follows.
  • GroupMembersFollowed—Groups with members that the context user follows.
  • GroupNew—Recently created groups.
  • GroupPopular—Groups with many active members.
  • ItemViewedTogether—Records often viewed at the same time as other records that the context user views.
  • PopularApp—Applications that are popular.
  • RecordOwned—Records that the context user owns.
  • RecordParentOfFollowed—Parent records of records that the context user follows.
  • RecordViewed—Records that the context user recently viewed.
  • TopicFollowedTogether—Topics often followed together with the record that the context user just followed.
  • TopicFollowedTogetherWithFollowees—Topics often followed together with other records that the context user follows.
  • TopicPopularFollowed—Topics with many followers.
  • TopicPopularLiked—Topics on posts that have many likes.
  • UserDirectReport—Users who report to the context user.
  • UserFollowedTogether—Users often followed together with the record that the context user followed .
  • UserFollowsSameUsers—Users who follow the same users as the context user.
  • UserManager—The context user’s manager.
  • UserNew—Recently created users.
  • UserPeer—Users who report to the same manager as the context user.
  • UserPopular—Users with many followers.
  • UserViewingSameRecords—Users who view the same records as the context user.
ConnectApi.​RecommendationReactionType Type of reaction to a recommendation.
  • Accepted
  • Rejected
ConnectApi.​RecommendationType Type of record being recommended.
  • apps
  • articles
  • files
  • groups
  • records
  • topics
  • users
ConnectApi.​RecommendedObjectType Type of object being recommended.
  • Today—Static recommendations that don’t have an ID, for example, the Today app recommendation.
ConnectApi.​RecordColumnOrder Order in which fields are rendered in a grid.
  • LeftRight—Fields are rendered from left to right.
  • TopDown—Fields are rendered from the top down.
ConnectApi.​RecordFieldType Data type of a record field.
  • Address
  • Blank
  • Boolean
  • Compound
  • CreatedBy
  • Date
  • DateTime
  • Email
  • LastModifiedBy
  • Location
  • Name
  • Number
  • Percent
  • Phone
  • Picklist
  • Reference
  • Text
  • Time
ConnectApi.​RelatedFeedPostType Type of related feed post.
  • Answered—Related questions that have at least one answer.
  • BestAnswer—Related questions that have a best answer.
  • Generic—All types of related questions, including answered, with a best answer, and unanswered.
  • Unanswered—Related questions that don’t have answers.
ConnectApi.RelationshipCardinality Cardinality of the relationship of a field for object data of the data graph.
  • CardinalityUnspecified
  • ManyToOne
  • OneToMany
  • OneToOne
ConnectApi.​SavedPaymentMethodStatus Saved payment method status.
  • AlreadyExists
  • Created
  • Updated
ConnectApi.SearchBoostBuryRuleAction Action of the boost and bury rule.
  • Boost—Boost rule. Increases search result rankings for targeted products.
  • Bury—Bury rule. Decreases search result rankings for targeted products.
ConnectApi.SearchBoostBuryRuleOperation Operation for the conditions of the target expression in the boost and bury rule.
  • AllOf—All-of operation.
  • AnyOf—Any-of operation.
ConnectApi.​SearchOrder Order direction.
  • Ascending
  • Descending
ConnectApi.​SegmentType Type of segment.
  • Dbt—Data build tool
ConnectApi.​SellingModelType Type of product selling model.
  • Evergreen—A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it.
  • OneTime—A product that isn’t sold as a subscription.
  • TermDefined—A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends.
ConnectApi.​SitesPageType Type of site search result item.
  • ContentPage
  • SitePage
ConnectApi.​SocialNetwork​Provider Social network provider.
  • Facebook
  • GooglePlus
  • Instagram
  • InstagramBusiness
  • KakaoTalk
  • Kik
  • Line
  • LinkedIn
  • Messenger
  • Other
  • Pinterest
  • QQ
  • Rypple
  • SinaWeibo
  • SMS
  • Snapchat
  • Telegram
  • Twitter
  • VKontakte
  • WeChat
  • WhatsApp
  • YouTube
ConnectApi.​SocialPost​MessageType Message type of the social post.
  • Comment
  • Direct
  • Post
  • PrivateMessage
  • Reply
  • Retweet
  • Tweet
ConnectApi.​SocialPostStatusType State of the social post.
  • ApprovalPending
  • ApprovalRecalled
  • ApprovalRejected
  • Deleted
  • Failed
  • Hidden
  • Pending
  • Sent
  • Unknown
ConnectApi.​SortOrder Order for sorting.
  • Ascending—Items are in ascending alphabetical order (A-Z).
  • Descending—Items are in descending alphabetical order (Z-A).
  • MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.
ConnectApi.​StandardEntryClassCode Three-letter code that identifies the type of electronic payment transaction being processed within the Automated Clearing House (ACH) network.
  • CCD—Corporate Credit or Debit
  • PPD—Prearranged Payment and Deposit
  • TEL—Telephone-Initiated Entry
  • WEB—Internet Initiated/Mobile
ConnectApi.​SurveyEmailStatusEnum Status of a survey invitation email.
  • Failed—The survey invitation email wasn't sent.
  • Queued—The survey invitation email is queued for sending.
ConnectApi.SvcApptModeEnum Mode of the service appointment.
  • Group— Service appointment mode is Group.
  • Regular— Default mode of service appointment.
ConnectApi.TargetType Target type of a promotion discount.
  • Shipping—Promotion discounts shipping amount.
  • Transaction—Promotion discounts total transaction amount.
ConnectApi.SwatchDisplayTypeEnum Display metadata type of the swatch.
  • Color—Color of the swatch.
ConnectApi.​TaxTransactionStatus Status of a tax transaction.
  • Committed—Tax has been committed to the transaction.
  • Uncommitted—Tax hasn’t been committed to the transaction.
ConnectApi.​TaxTransactionType Type of tax transaction.
  • Credit—Transaction is a credit transaction.
  • Debit—Transaction is a debit transaction.
  • Void—Reserved for internal use in case of input. In case of output, this value specifies that the tax engine has voided the document that's mentioned as the referenceDocumentCode property value.
ConnectApi.​TopicSort Order returned by the sort.
  • popularDesc—Sorts topics by popularity with the most popular first. This value is the default.
  • alphaAsc—Sorts topics alphabetically.
ConnectApi.TypeEnum Type of the SQL parameter.
  • ArrayOfX
  • BigInt
  • Bool
  • Char
  • Date
  • Double
  • Foat
  • Integer
  • Numeric
  • Oid
  • SmallInt
  • Time
  • Timestamp
  • TimestampTZ
  • Unspecified
  • Varchar
ConnectApi.​UpDownVoteValue Type of vote for a feed element or comment.
  • Down
  • None
  • Up
ConnectApi.UserActivityType Type of user activity.
  • Bookmark—User bookmarked a post.
  • ChatterActivity—Total counts of posts and comments made and likes and comments received for a user.
  • ChatterLike—User liked a post or comment.
  • Comment—User commented on a post.
  • CompanyVerify—User verified comment.
  • DownVote—User downvoted a post or comment.
  • FeedEntityRead—User read a post.
  • FeedRead—User read a feed.
  • Mute—User muted a post.
  • Post—User made a post.
  • TopicEndorsement—User endorsed another user on a topic or received endorsement on a topic.
  • UpVote—User upvoted a post or comment.
ConnectApi.​UserMission​ActivityType Type of mission activity for a user.
  • FeedItemAnswerAQuestion—User answered a question.
  • FeedItemLikeSomething—User liked a post or comment.
  • FeedItemMarkAnswerAsBest—User marked an answer as the best answer.
  • FeedItemPostQuestion—User posted a question.
  • FeedItemReceiveAComment—User received a comment on a post.
  • FeedItemReceiveALike—User received a like on a post or comment.
  • FeedItemReceiveAnAnswer—User received an answer to a question.
  • FeedItemWriteAComment—User commented on a post.
  • FeedItemWriteAPost—User made a post.
  • FeedItemYourAnswerMarkedBest—​User’s answer was marked as the best answer.
ConnectApi.​UserProfile​TabType Type of user profile tab.
  • CustomVisualForce—Tab that displays data from a Visualforce page.
  • CustomWeb—Tab that displays data from any external web-based application or web page.
  • Element—Tab that displays generic content inline.
  • Feed—Tab that displays the Chatter feed.
  • Overview—Tab that displays user details.
ConnectApi.​UserType Type of user.
  • ChatterGuest—User is an external user in a private group.
  • ChatterOnly—User is a Chatter Free customer.
  • Guest—User is unauthenticated.
  • Internal—User is a standard org member.
  • Portal—User is an external user in an Experience Cloud site.
  • System—User is Chatter Expert or a system user.
  • Undefined—User is a user type that is a custom object.
ConnectApi.​WishlistItem​SortOrder Sort order for wishlist items.
  • CreatedDateAsc—Sorts by oldest creation date.
  • CreatedDateDesc—Sorts by most recent creation date.
ConnectApi.​WorkflowProcess​Status Status of a workflow process.
  • Approved
  • Fault
  • Held
  • NoResponse
  • Pending
  • Reassigned
  • Rejected
  • Removed
  • Started
ConnectApi.​ZoneSearch​ResultType Zone search result type.
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
ConnectApi.​ZoneShowIn Zone search result location.
  • Community—Available in an Experience Cloud site.
  • Internal—Available internally only.
  • Portal—Available in a portal.