Network

This type extends the Metadata metadata type and inherits its fullName field.

Declarative Metadata File Suffix and Directory Location

Network components are stored in the networks directory of the corresponding package directory. The file name matches the site name, and the extension is .network.

Version

This object is available in API version 28.0 and later.

Fields

Field	Field Type	Description
allowedExtensions	string	Specifies the types of files allowed in your site. This list of file types lets you control what your members upload and also prevents spammers from polluting your site with inappropriate files. Available in API version 36.0 and later.
allowInternalUserLogin	boolean	Determines whether internal users can log in with their internal credentials on the site login page. Available in API version 40.0 and later.
allowMembersToFlag	boolean	Determines whether users in the site can flag posts or comments as inappropriate. Flagged items are sent to a moderator for review. Available in API version 29.0 and later.
branding	Branding	The color scheme, header, and footer used in the site. Deprecated in API version 41.0 and later. Replaced by the NetworkBranding type.
caseCommentEmailTemplate	string	Email template used when notifying members when a case comment has been modified or added to a case. Lightning email templates aren’t packageable. We recommend using a Classic email template.
changePasswordTemplate	string	Email template used when notifying a user that their password has been reset. Lightning email templates aren’t packageable. We recommend using a Classic email template.
chgEmailVerNewTemplate	string	Email template used to verify a user’s email address change. This email is sent to the new email address. You can't update this template via Metadata API. Note
chgEmailVerOldTemplate	string	Email template used to verify a user’s email address change. This email is sent to the old email address. You can't update this template via Metadata API. Note
communityRoles	CommunityRoles	Identifies users with Customer, Partner, or Employee roles in a site. Available in API version 41.0 and later.
description	string	Description of the site.
deviceActEmailTemplate	string	The ID of the device activation email template. The template is used to customize the device activation email for community users. Available in API version 53.0 and later.
disablePvtPagesForPwdResetInLWR	boolean	Determines whether private pages in an LWR site are available to users who haven’t completed setting up or resetting their password. Set to `(true)` by default for all LWR sites except those that use custom Visualforce password-management pages. When set to `(true)`, private pages are unavailable until password setup or reset is complete. In LWR sites that use custom Visualforce pages for password management, make these pages public. Otherwise, visitors can’t access them to set up or reset their password. Available in API version 67.0 and later.
disableReputationRecordConversations	boolean	When reputation levels are enabled for the site, determines whether to exclude contributions to records when counting points toward reputation levels. Available in API version 41.0 and later.
emailFooterLogo	string	The document name of the logo that appears in the footer of emails. Available in API version 41.0 and later.
emailFooterText	string	The text that appears in the footer of emails. Available in API version 41.0 and later.
emailSenderAddress	string	Required. Email address from which emails are sent. You can add the sender email address via the `emailSenderAddress` field only when you deploy Network for the first time to create a new Experience Cloud site. You must verify that email address before you can use it as the sender email address. You can't update this field via Metadata API. If you attempt to update this field via Metadata API, your changes are ignored and Salesforce doesn’t show an error. To update the email address in this field, go to the site’s Administration workspace, select Emails, and then edit the Email Address field. Note
emailSenderName	string	Required. Name from which emails are sent.
embeddedLoginEnabled	boolean	Option to place Salesforce login form directly on an external website. This setting enables users to log in without being redirected to a separate Salesforce page.
enableApexCDNCaching	boolean	Determines whether public data from @wire calls to Apex methods is cached for guest users. This setting applies only to sites using Salesforce's CDN for Digital Experiences.
enableCustomVFErrorPageOverrides	boolean	Determines whether to use custom Visualforce error pages instead of the default Visualforce error pages. Available in API version 41.0 and later.
enableDirectMessages	boolean	Determines whether site users can send direct messages to start a private conversation with one or more members. Available in API version 41.0 and later.
enableExperienceBundleBasedSnaOverrideEnabled	boolean	Determines whether the Builder-based SNA page is used (`true`) or not (`false`) and overrides the existing SNA page when an experience is published. Available in API version 52.0 and later.
enableGuestChatter	boolean	Specifies whether guest users can access public Chatter groups in the site without logging in.
enableGuestFileAccess	boolean	Determines whether guest users view asset files shared with the site on publicly accessible pages and login pages. If public access is enabled in Experience Builder at the page or site level, this property is automatically enabled. Available in API version 41.0 and later.
enableGuestMemberVisibility	boolean	Determines if unauthenticated guest users can see the authenticated members (`true`) or not (`false`). Available in API version 47.0 and later.
enableImageOptimizationCDN	boolean	Determines whether to optimize cached images for guest users on all devices when a site uses Salesforce’s CDN for Digital Experiences. Available in API version 56.0 and later.
enableInvitation	boolean	Determines whether users can invite others to the site.
enableKnowledgeable	boolean	Determines if members can see who’s knowledgeable on topics and endorse people for their knowledge on a topic. Available in API version 30.0 and later.
enableMemberVisibility	boolean	Controls user visibility on a per-site basis. If `true`, the See other members of this site preference is enabled for the selected site. Available in API version 45.0 and later.
enableNicknameDisplay	boolean	Determines if user nicknames display instead of their first and last names in most places in the site. Set to `false` by default. Available in API version 32.0 and later.
enablePrivateMessages	boolean	Determines if members can send and receive private messages. Available in API version 30.0 and later.
enableReputation	boolean	Determines if reputation is calculated and displayed for members. Available in API version 31.0 and later. If enabled, reputationLevels and reputationPointsRules are used. If no reputationLevels or reputationPointsRules are defined in the data file, the default values are used.
enableShowAllNetworkSettings	boolean	Shows settings that are hidden by default based on how the site is set up. Available in API version 41.0 and later.
enableSiteAsContainer	boolean	Determines whether the site is an Experience Builder site (`true`) or a Salesforce Tabs + Visualforce site (`false`).
enableTalkingAboutStats	boolean	Determines whether users see how many people are discussing a topic. The number of people discussing the topic appears as the user types the topic and the system gives topic suggestions. Available in API version 41.0 and later.
enableTopicAssignmentRules	boolean	Enables the org to use rules to automatically assign topics to articles in a site. After it’s enabled, admins set up rules to map topics to Salesforce Knowledge data categories. This field is available in API version 40.0 and later.
enableTopicSuggestions	boolean	Enables topic suggestions when users write posts. Available in API version 41.0 and later.
enableUpDownVote	boolean	Replaces the option to like a question or answer with the option to upvote or downvote. Available in API version 41.0 and later.
expFriendlyUrlsAsDefault	boolean	Determines whether URL slugs are enabled by default on Product and Category pages of LWR Commerce stores (available in API version 58.0 and later) Custom object pages on enhanced LWR sites (available in API version 60.0 and later) Account and contact pages on enhanced LWR sites (available in API version 61.0 and later)
feedChannel	string	Displays the feed of all channel program record or group interactions, including posts, questions, and attachments. This field is available in API version 28.0 and later.
forgotPasswordTemplate	string	Required. The email template used when a user forgets their password. Lightning email templates aren’t packageable. We recommend using a Classic email template.
gatherCustomerSentimentData	boolean	Gathers data when a customer looks at articles and cases in sites, for use in the Community 360 feature. This field is available in API version 40.0 and later.
lockoutTemplate	string	The email template used to communicate with users when they get locked out of their org because of too many failed login attempts. Available in API version 43.0 and later. Lightning email templates aren’t packageable. We recommend using a Classic email template.
logoutUrl	string	Specifies the URL that members are redirected to when they log out from your site. This field is available in API version 28.0 and later.
maxFileSizeKb	int	Specifies the maximum file size (in KBs) that members can upload in your site. Available in API version 36.0 and later. Enter a number between 3072 KB and your org’s maximum file size. To use the default limit of 2 GB, leave this field empty.
navigationLinkSet	NavigationLinkSet	Represents the navigation menu in a site. A navigation menu consists of items that users can click to go to other parts of the site. This field is available in API versions 37.0 to 46.0. In API version 47.0 and later, use the NavigationMenu type instead.
networkAuthApiSettings	NetworkAuthApiSettings	The settings that control enablement, access, and security for the Headless Registration Flow, Headless Forgot Password Flow, Headless Passwordless Login Flow, and their associated APIs. Available in API version 60.0 and later.
networkMemberGroups	NetworkMemberGroups	The profiles and permission sets that have access to the site. Users with these profiles or permission sets are members of the site. If a Chatter customer (from a customer group) is assigned a permission set that is also associated with a site, the Chatter customer isn’t added to the site. Note
networkOptionsBit	boolean	Indicates whether email messages sent on behalf of users with an unverified email domain are sent from the site’s emailSenderAddress (`true`). If NetworkOptionsBit is `false`, email messages sent on behalf of users with an unverified email domain are sent from the org-wide substitute email address if one is set. If NetworkOptionsBit is `false` and no org-wide substitute email address is set, email messages from senders with an unverified email domain are suppressed. The default value is `false`. Available in API version 68.0 and later.
networkPageOverrides	NetworkPageOverride	The settings in the Administration area (in Experience Management or Experience Workspaces) that control which page type Change Password, Forgot Password, Home, and Login each point to. Available in API version 40.0 and later.
newSenderAddress	string	Email address that has been entered as the new value for EmailSenderAddress but hasn’t been verified yet. After a user has requested to change the sender email address and has successfully responded to the verification email, the NewSenderAddress value overwrites the value in EmailSenderAddress. This value becomes the email address from which emails are sent.
pendingSecondaryEmailAddress	string	The secondary sender email address that’s pending verification. Salesforce doesn’t send emails from this address until it’s verified. Available in API version 67.0 and later.
pwdlessRegEmailTemplate	string	The email template used when a user registers without a password. Instead of a password,they use an identity verification method, such as a verification code or link, which the user completes to finalize the registration or login process. Lightning email templates aren’t packageable. We recommend using a Classic email template.
picassoSite	string	Name of the site of ChatterNetworkPicasso type that's linked to the Experience Cloud site.
recommendationAudience	RecommendationAudience	Creates an audience of new members, or can be used to manage customized lists of audience members to organize and target recommendations. Available in API version 41.0 and later.
recommendationDefinition	RecommendationDefinition	Represents a custom recommendation to drive engagement. Targets a specific audience and uses channels to specify a location for the recommendation. Available in API version 41.0 and later.
reputationLevels	ReputationLevelDefinitions	The reputation levels assigned to members when they accrue points by performing certain actions.
reputationPointsRules	ReputationPointsRules	The points members accrue when they perform certain defined actions.
secondaryEmailSenderEnabled	boolean	Indicates whether email messages that contain sensitive data are sent from a secondary sender email address (`true`), instead of via email relay (`false`). The default value is `false`. Available in API version 67.0 and later.
selfRegMicroBatchSubErrorEmailTemplate	reference	The email template used to communicate with users when their self-registration request, using micro-batching failed. Available in API version 54.0 and later.
selfRegProfile	string	The profile assigned to users who self-register. This value is used only if selfRegistration is enabled for the site. Available in API version 29.0 and later.
selfRegistration	boolean	Determines whether self-registration is available for the site.
sendWelcomeEmail	boolean	Determines whether a welcome email is sent when a new user is added to the site.
site	string	Required. The CustomSite associated with the Experience Cloud site.
siteArchiveStatus	SitesArchiveStatus	Specifies whether the site has been archived. Available values are: NotArchived—The site hasn’t been archived. TemporarilyArchived—The site is archived, but can be unarchived in the future.
status	NetworkStatus[]	Required. Status of the site. Available values are: `Live`—The site is online and members can access it. `DownForMaintenance`—The site was previously published but was taken offline. Members with the Create and Set Up Experiences permission can still access the setup for offline sites regardless of profile or membership. Members aren’t able to access offline sites, but they still appear in the user interface dropdown as SiteName (Offline). `UnderConstruction`—The site hasn’t yet been published. Users with the Create and Set Up Experiences permission can access sites in this status if their profile is associated with the site. After a site is published, it can never be in this status again.
tabs	NetworkTabSet	Required. The tabs that are available in the site. The user that created the site selected these tabs.
urlPathPrefix	string	The first part of the path on the site's URL that distinguishes this site from other sites. For example, if your site URL is `MyDomainName`.my.site.com/partners, then partners is the urlPathPrefix.
verificationTemplate	string	The email template used to communicate with users when they must verify their identity, for example, when they log in without a password or from a new device. Available in API version 44.0 and later. Lightning email templates aren’t packageable. We recommend using a Classic email template.
welcomeTemplate	string	The email template used when sending welcome emails to new members. Lightning email templates aren’t packageable. We recommend using a Classic email template.

Branding

Represents the branding and color scheme applied to the Experience Cloud site. Available in API version 40.0 and earlier. Replaced by NetworkBranding in API version 41.0 and later.

Field	Field Type	Description
loginFooterText	string	The text that appears in the footer of the login page.
loginLogo	string	The logo that appears on the login page for external users.
pageFooter	string	An image that appears on the footer of the pages. Must be an .html file.
pageHeader	string	An image that appears on the header of the pages. Can be an .html, .gif, .jpg, or .png file.
primaryColor	string	The color used for the active tab.
primaryComplementColor	string	Font color used with primaryColor.
quaternaryColor	string	The background color for pages.
quaternaryComplementColor	string	Font color used with quaternaryColor.
secondaryColor	string	The color used for the top borders of lists and tables.
tertiaryColor	string	The background color for section headers on edit and detail pages.
tertiaryComplementColor	string	Font color used with tertiaryColor.
zeronaryColor	string	The background color for the header.
zeronaryComplementColor	string	Font color used with zeronaryColor.

CommunityRoles

The labels used to identify users with Customer, Partner, or Employee roles in an Experience Cloud site. Available in API version 41.0 and later.

Field	Field Type	Description
customerUserRole	string	The label for the Customer user role.
employeeUserRole	string	The label for the Employee user role.
partnerUserRole	string	The label for the Partner user role.

NavigationLinkSet

Represents the navigation menu in an Experience Cloud site. A navigation menu consists of items that users can click to go to other parts of the site. Available in API versions 37.0 to 46.0. In API version 47.0, use NavigationMenu instead.

Field	Field Type	Description
navigationMenuItem	NavigationMenuItem[]	A list of menu items in a NavigationLinkSet. Use this object to create, delete, or update menu items in your site’s navigation menu.

NavigationMenuItem

Represents a single menu item in the NavigationLinkSet subtype (API version 37.0 to 46.0) or in the NavigationMenu type (API version 47.0 and later). Use this subtype to create, delete, or update menu items in your site’s navigation menu.

Field	Field Type	Description
defaultListViewId	string	If the value of the type field is `SalesforceObject`, the value is the ID of the default list view for the object.
label	string	Required. The text that appears in the navigation menu for this item.
menuItemBranding	NavigationMenuItemBranding	Branding for the navigation menu item. Available in API version 47.0 and later.
position	int	Required. The location of the menu item in the navigation menu.
publiclyAvailable	boolean	When set to `true`, gives access to guest users.
subMenu	NavigationSubMenu	A list of child menu items. This field is available in API 39.0 and later.
target	string	Required if type is `ExternalLink`, `InternalLink`, or `SalesforceObject`. If type is `ExternalLink` or `InternalLink`, the target is the URL that the link points to. For `ExternalLink`, your entry looks like this: `https://salesforce.com`. For `InternalLink`, use a relative URL, such as `/contactsupport`. If type is `MenuLabel` or `NavigationalTopic`, target isn’t used.
targetPreference	string	Backed by a picklist that includes preferences for the target field. Valid values are: `None` `OpenInExternalTab`—Used for external links to determine whether to open in an external tab.
type	string	Required. The type of navigation menu item. Valid values are: `SalesforceObject`—Available objects include accounts, cases, contacts, and custom objects. `ExternalLink`—Links to a URL outside of your site. For example, `https://salesforce.com`. `InternalLink`—Links to a relative URL inside your site. For example, `/contactsupport`. `MenuLabel`—A parent heading for your navigation menu. See NavigationSubMenu for how to nest items underneath the menu label. This value is available in API 39.0 and later. `NavigationalTopic`—A dropdown list with links to the navigational topics in your site. You can’t nest other items of type `MenuLabel` or `NavigationalTopic` under `MenuLabel`.

NavigationSubMenu

A list of child menu items. Only NavigationMenuItem items of type MenuLabel can have items in a NavigationSubMenu. Available in API 39.0 and later.

Field	Field Type	Description
navigationMenuItem	NavigationMenuItem[]	A list of menu items in a NavigationSubMenu. Use navigationMenuItem to create, delete, or update child items under a parent heading.

NetworkAuthApiSettings

Represents the settings that control enablement, access, and security for the Headless Registration Flow, Headless Forgot Password Flow, Headless Passwordless Login Flow, and their associated APIs. Available in API version 60.0 and later.

Field	Field Type	Details
doesForgotPasswordRequireAuth	boolean	Determines whether authentication is required to access Headless Forgot Password API when a password reset is requested. If `true`, an access token issued to an internal integration user in your initial POST request to the /services/auth/headless/forgot_password endpoint is required. The access token must include the `forgot_password` scope.
doesPasswordLoginRequireAuth	boolean	Determines whether reCAPTCHA is required for headless username-password login that uses the OAuth 2.0 for First-Party Applications draft protocol.
doesPwdlessLoginRequireAuth	boolean	Determines whether authentication is required to access Headless Passwordless Login API when user information is submitted to Salesforce. If `true`, an access token issued to an internal integration user is required in your initial POST request to the /services/auth/headless/init/passwordless/login endpoint. The access token must include the `pwdless_login_api` scope.
doesRegistrationRequireAuth	boolean	Determines whether authentication is required to access Headless Registration API when user registration information is submitted to Salesforce. If `true`, an access token issued to an internal integration user in your initial POST request to the /services/auth/headless/init/registration endpoint is required. The access token must include the `user_registration_api` scope.
emailTmplsAllowlist	NetworkEmailTmplAllowlist[]	The email template allowlist for the Headless Registration Flow, Headless Passwordless Login Flow, and Headless Forgot Password Flow. The allowlist defines which email templates can be used for verification emails sent to end users during these flows.
headlessDiscoveryExecutionUser	Id	An integration user account to run a headless user discovery Apex handler.
headlessDiscoveryHandler	string	An Apex class that implements the `Auth.HeadlessUserDiscoveryHandler` interface.
isFirstPartyAppsAllowed	boolean	Determines whether the Experience Cloud site can use headless identity flows that use the OAuth 2.0 for First-Party Applications draft protocol.
isForgotPwdAllowed	boolean	Determines whether the Headless Forgot Password Flow is enabled.
isForgotPwdEmailTemplateAllowlistingEnabled	boolean	Determines whether email template allowlisting is enabled for the Headless Forgot Password Flow. If `true`, the `emailtemplate` parameter in the initial request to Headless Forgot Password API can include only allowlisted email templates.
isHeadlessUserRegistrationAllowed	boolean	Determines whether the Headless Registration Flow is enabled.
IsPwdlessLoginAllowed	boolean	Determines whether the Headless Passwordless Login Flow is enabled (`true`) or not (`false`).
isRecaptchaRequiredForgotPwd	boolean	Determines whether a reCAPTCHA token is required to access Headless Forgot Password API when a password reset is requested. If `true`, a reCAPTCHA token is required in your initial POST request to the /services/auth/headless/forgot_password endpoint.
isRecaptchaRequiredPwdlessLogin	boolean	Determines whether a reCAPTCHA token is required to access Headless Passwordless Login API when user information is submitted to Salesforce. If `true`, a reCAPTCHA token is required in your initial POST request to the /services/auth/headless/init/passwordless/login endpoint.
isRecaptchaRequiredRgstr	boolean	Determines whether a reCAPTCHA token is required to access Headless Registration API when user registration information is submitted to Salesforce. If `true`, a reCAPTCHA token is required in your initial POST request to the /services/auth/headless/init/registration endpoint.
isUniversalClientRgstrAllowed	boolean	Determines whether self-registration and passwordless login via Universal Registration API are enabled.
isUserDisambiguationAllowedForgotPwd	boolean	Determines whether the Headless Forgot Password Flow uses the headless user discovery Apex handler that's specified in the HeadlessDiscoveryHandlerId field. The handler enables users to reset their password with an identifier other than their username, such as an email address, phone number, or order number.
isUserDisambiguationAllowedUsernamePwd	boolean	Determines whether headless login flows use the headless user discovery Apex handler that's specified in the HeadlessDiscoveryHandlerId field. The handler enables users to log in with an identifier other than their username, such as an email address, phone number, or order number. This field applies to the Authorization Code and Credentials Flow and the OAuth 2.0 for First-Party Applications login flow.
maxPasswordResetAttempts	int	The maximum number of password reset attempts you allow for the Headless Forgot Password Flow before the user must request a new one-time password (OTP).
recaptchaScoreThreshold	double	The lowest reCAPTCHA score that is accepted before rejecting a request to access Headless Identity APIs. This value must be between 0.5 and 1. Scores closer to 0.5 are more likely to be bots, while scores closer to 1 are more likely to be valid users. You must set a score threshold if doesForgotPasswordRequireAuth or doesRegistrationRequireAuth fields are set to `true`. reCAPTCHA settings apply to both the Headless Registration Flow and the Headless Forgot Password Flow. Google issues a reCAPTCHA score only for reCAPTCHA v3 implementations. If you implement reCAPTCHA v2, this field doesn’t apply.
recaptchaSecretKey	string	The reCAPTCHA secret key from your API key pair. You get the API key pair from Google when you set up reCAPTCHA. The secret key helps your app securely communicate with Google. You must enter a secret key if doesForgotPasswordRequireAuth or doesRegistrationRequireAuth are set to `true`. reCAPTCHA settings apply to all headless identity flows for which reCAPTCHA is enabled.
registrationExecutionUser	string	The user who runs your headless registration Apex handler.
registrationHandler	string	The headless registration Apex handler.
registrationUserDefaultProfile	string	The default profile that gets assigned to new users when they register.

NetworkEmailTmplAllowlist

Represents the allowlist for one-time password (OTP) email templates sent to end users during the Headless Registration Flow, Headless Passwordless Login Flow, and Headless Forgot Password Flow. Available in API version 60.0 and later.

Field	Field Type	Description
emailTemplate	string	Required. The email templates that can be sent to users during the headless authorization flows for registration, passwordless login, and forgot password. You can list multiple templates. When your app sends its initial request to Headless Registration API or Headless Passwordless Login API, the `emailtemplate` parameter can include only an email template ID from the allowlist. For Headless Forgot Password API, it works the same way, but only if the isForgotPwdEmailTemplateAllowlistingEnabled field on the NetworkAuthApiSettings metadata type is `true`.

NetworkMemberGroup

Represents the profiles and permission sets that are assigned to the Experience Cloud site. Users with one of the profiles or permission sets are members of the site, unless the user is a Chatter customer (from a customer group).

Field	Field Type	Description
permissionSet	string	A permission set that is assigned to the site. If a Chatter customer (from a customer group) is assigned a permission set that is also associated with a site, the Chatter customer isn’t added to the site. Note
profile	string	A profile that is part of the site.

NetworkPageOverride

Represents settings in the Administration area (in Experience Management or Experience Workspaces) that control which page type the Change Password, Forgot Password, Home, and Login pages each point to.

Assigned Visualforce page overrides are specified and deployed via the corresponding CustomSite metadata field.

Note

Field	Field Type	Description
changePasswordPageOverrideSetting	NetworkPageOverrideSetting (enumeration of type string)	Required. Specifies the page type that the Change Password page setting applies to. The valid values are: `Configurable`—a configurable self-registration page `Designer`—an Experience Builder page `Standard`—the default page `VisualForce`—a Visualforce page
forgotPasswordPageOverrideSetting	NetworkPageOverrideSetting (enumeration of type string)	Required. Specifies the page type that the Forgot Password page setting applies to. The valid values are: `Configurable`—a configurable self-registration page `Designer`—an Experience Builder page `Standard`—the default page `VisualForce`—a Visualforce page
homePageOverrideSetting	NetworkPageOverrideSetting (enumeration of type string)	Required. Specifies the page type that the Experience Home page setting applies to. The valid values are: `Configurable`—a configurable self-registration page `Designer`—an Experience Builder page `Standard`—the default page `VisualForce`—a Visualforce page
loginPageOverrideSetting	NetworkPageOverrideSetting (enumeration of type string)	Required. Specifies the page type that the Login page setting applies to. The valid values are: `Configurable`—a configurable self-registration page `Designer`—an Experience Builder page `Standard`—the default page `VisualForce`—a Visualforce page To configure an Experience Builder page for your Home and Login pages, make sure you publish your site. Unpublished pages show up as Default Page from the dropdown menu in Admin settings. Note
selfRegProfilePageOverrideSetting	NetworkPageOverrideSetting (enumeration of type string)	Required. Specifies the page type that the Self Registration page setting applies to. The valid values are: `Configurable`—a configurable self-registration page `Designer`—an Experience Builder page `Standard`—the default page `VisualForce`—a Visualforce page

RecommendationAudience

Creates an audience of new Experience Cloud site members, or can be used to manage customized lists of audience members to organize and target recommendations. Available in API version 41.0 and later.

Field	Field Type	Description
recommendationAudienceDetails	RecommendationAudienceDetail	The specific details of an audience for recommendations.

RecommendationAudienceDetail

The specific details of an audience for recommendations. Available in API version 41.0 and later.

Field	Field Type	Description
audienceCriteriaType	AudienceCriteriaType (enumeration of type string)	The criteria for the recommendation audience type. Values are: `CustomList` `MaxDaysInCommunity`
audienceCriteriaValue	string	For new member criteria, the maximum number of days since a user became a member. Null in case of custom list criteria.
setupName	string	Name of the recommendation audience.

RecommendationDefinition

Represents a list of custom recommendations to drive engagement for an Experience Cloud site. Available in API version 41.0 and later.

Field	Field Type	Description
recommendationDefinitionDetails	RecommendationDefinitionDetail[]	A list of custom recommendations and their details.

RecommendationDefinitionDetail

The specific details of a custom recommendation. Available in API version 41.0 and later.

Field	Field Type	Description
actionUrl	string	The URL for the button that lets users act on the recommendation.
description	string	An explanation of the recommendation that suggests what users can do.
linkText	string	The text label for the button.
scheduledRecommendations	ScheduledRecommendation	A list of scheduled recommendations.
setupName	string	The name of the recommendation, which appears in Setup.
title	string	The title of the recommendation.

ReputationBranding

Branding for the reputation level.

Field	Field Type	Description
smallImage	string	Custom image associated with a reputation level. Use files with these extensions: .jpeg, .png, or .gif. Images are stored as documents. If not specified, the default reputation level image is used. Available in API version 32.0 and later.

ReputationLevelDefinitions

Represents reputation levels members can achieve by performing certain defined actions in an Experience Cloud site.

Field	Field Type	Description
level	ReputationLevel[]	Represents reputation levels.

ReputationLevel

Represents the name and lower value of the reputation level. The application calculates the upper value.

Field	Field Type	Description
branding	ReputationBranding[]	Represents any branding associated with the reputation level, specifically, the custom image for the reputation level. This field is optional. If not specified, the default reputation level image is used. Available in API version 32.0 and later.
label	string	Name of the reputation level. This field is optional. If not specified, one of the 10 defaults is used. Level 1 Level 2 Level 3 Level 4 Level 5 Level 6 Level 7 Level 8 Level 9 Level 10
lowerThreshold	double	Required. The lower value in the range for this reputation level. For example, if this reputation level is for points 1–50, 1 is the lowerThreshold.

Field

Field Type

Description

branding

ReputationBranding[]

Represents any branding associated with the reputation level, specifically, the custom image for the reputation level.

This field is optional. If not specified, the default reputation level image is used. Available in API version 32.0 and later.

label

string

Name of the reputation level.

This field is optional. If not specified, one of the 10 defaults is used.

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Level 7
Level 8
Level 9
Level 10

lowerThreshold

double

Required. The lower value in the range for this reputation level. For example, if this reputation level is for points 1–50, 1 is the lowerThreshold.

ReputationPointsRules

Represents points rules in an Experience Cloud site’s point system.

Field	Field Type	Description
pointsRule	ReputationPointsRule[]	Represents events and their associated points.

ReputationPointsRule

Represents the event and associated point value for a points rule. When a user acts, they accrue the associated points.

Field	Field Type	Description
eventType	string	Required. The type of event a member has to perform to get points. The available values are: `FeedItemWriteAPost` `FeedItemWriteAComment` `FeedItemReceiveAComment` `FeedItemLikeSomething` `FeedItemReceiveALike` `FeedItemMentionSomeone` `FeedItemSomeoneMentionsYou` `FeedItemShareAPost` `FeedItemSomeoneSharesYourPost` `FeedItemPostAQuestion` `FeedItemAnswerAQuestion` `FeedItemReceiveAnAnswer` `FeedItemMarkAnswerAsBest` `FeedItemYourAnswerMarkedBest` `FeedItemEndorseSomeoneForKnowledgeOnATopic` `FeedItemEndorsedForKnowledgeOnATopic`
points	int	Required. The number of points a member gets for performing the event. The default number of points per event is: FeedItemWriteAPost +1 FeedItemWriteAComment: +1 FeedItemReceiveAComment: +5 FeedItemLikeSomething: +1 FeedItemReceiveALike: +5 FeedItemMentionSomeone: +1 FeedItemSomeoneMentionsYou: +5 FeedItemShareAPost: +1 FeedItemSomeoneSharesYourPost: +5 FeedItemPostAQuestion: +1 FeedItemAnswerAQuestion: +5 FeedItemReceiveAnAnswer: +5 FeedItemMarkAnswerAsBest: +5 FeedItemYourAnswerMarkedBest: +20 FeedItemEndorseSomeoneForKnowledgeOnATopic: +5 FeedItemEndorsedForKnowledgeOnATopic: +20

ScheduledRecommendation

Represents a list of scheduled recommendations. Available in API version 41.0 and later.

Field	Field Type	Description
scheduledRecommendationDetails	ScheduledRecommendationDetail[]	A list of scheduled recommendations.

ScheduledRecommendationDetail

The specific details of a scheduled recommendation. Available in API version 41.0 and later.

Field	Field Type	Description
channel	RecommendationChannel (enumeration of type string)	A way to group recommendations together to determine where they show up in the site. The valid values are: `DefaultChannel`—The default recommendation channel. Recommendations in the default channel appear in predefined locations, such as directly in the feed in Salesforce mobile web and on the Home and Question Detail pages of the Customer Service (Napili) template. `CustomChannel1`—A custom recommendation channel. Choose where you want recommendations to appear by adding the Recommendations Carousel component to the page in Experience Builder. `CustomChannel2`—A custom recommendation channel. `CustomChannel3`—A custom recommendation channel. `CustomChannel4`—A custom recommendation channel. `CustomChannel5`—A custom recommendation channel.
enabled	boolean	Indicates whether scheduling is enabled. If `true`, the recommendation is enabled and appears in sites. If `false`, recommendations in feeds in Salesforce mobile web aren’t removed, but no new recommendations appear. In sites, disabled recommendations no longer appear.
rank	int	The rank of the recommendation within the channel, which determines the order in which it’s displayed. The scheduled recommendation is inserted into the position specified by the rank. The rank of all the scheduled recommendations after it is pushed down. If the specified rank is larger than the size of the list, the scheduled recommendation is put at the end of the list. If a rank isn’t specified, the scheduled recommendation is put at the end of the list.
recommendationAudience	string	The name of the audience for this scheduled recommendation.

NetworkTabSet

Field	Field Type	Description
customTab	string	Custom tab that is part of the site.
defaultTab	string	The Home tab for the site. When members log in, this tab is the first page they see.
standardTab	string	Standard tab that is part of the site.

Declarative Metadata Sample Definition

A sample XML definition of a network.

1<?xml version="1.0" encoding="UTF-8"?>
2<Network xmlns="http://soap.sforce.com/2006/04/metadata">
3    <allowMembersToFlag>true</allowMembersToFlag>
4    <changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>
5    <description>Metadata Community</description>
6    <emailSenderAddress>admin@networkMetadata.com</emailSenderAddress>
7    <emailSenderName>Admin User</emailSenderName>
8    <enableInvitation>false</enableInvitation>
9    <enableKnowledgeable>true</enableKnowledgeable>
10    <enableNicknameDisplay>false</enableNicknameDisplay>
11    <enablePrivateMessages>true</enablePrivateMessages>
12    <enableReputation>true</enableReputation>
13    <enableUpDownVote>true</enableUpDownVote>
14    <forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
15    <networkMemberGroups>
16        <permissionSet>Admin</permissionSet>
17        <permissionSet>Standard</permissionSet>
18        <permissionSet>ReadOnly</permissionSet>
19        <profile>Admin</profile>
20        <profile>Standard</profile>
21        <profile>ReadOnly</profile>
22    </networkMemberGroups>
23    <recommendationDefinition>
24        <recommendationDefinitionDetails>
25            <actionUrl>https://www.apple.com/iphone</actionUrl>
26            <description>Better specs and high performance for iPhones</description>
27            <linkText>iPhone 7</linkText>
28            <scheduledRecommendations>
29                <scheduledRecommendationDetails>
30                    <channel>DefaultChannel</channel>
31                    <enabled>false</enabled>
32                    <rank>1</rank>
33                    <recommendationAudience>New Member Audience</recommendationAudience>
34                </scheduledRecommendationDetails>
35            </scheduledRecommendations>
36            <setupName>Apple iPhone</setupName>
37            <title>iPhone7</title>
38        </recommendationDefinitionDetails>
39        <recommendationDefinitionDetails>
40            <actionUrl>https://www.bose.com/qc35</actionUrl>
41            <description>New Amazing Noise cancellation Headphones</description>
42            <linkText>Bose QC35</linkText>
43            <scheduledRecommendations>
44                <scheduledRecommendationDetails>
45                    <channel>DefaultChannel</channel>
46                    <enabled>true</enabled>
47                    <rank>2</rank>
48                    <recommendationAudience>Custom Audience</recommendationAudience>
49                </scheduledRecommendationDetails>
50            </scheduledRecommendations>
51            <setupName>Bose Headphones</setupName>
52            <title>Bose QC35</title>
53        </recommendationDefinitionDetails>
54    </recommendationDefinition>
55    <reputationLevels>
56        <level>
57            <branding> 
58                <smallImage>communities_shared _document_folder/replevel_beginner.png</smallImage>
59            </branding>
60            <label>Beginner</label>
61            <lowerThreshold>0</lowerThreshold>
62        </level>
63        <level>
64            <branding> 
65                <smallImage>communities_shared _document_folder/replevel_apprentice.png</smallImage>
66            </branding>
67            <label>Apprentice</label>
68            <lowerThreshold>51</lowerThreshold>
69        </level>
70        <level>
71            <branding> 
72                <smallImage>communities_shared _document_folder/replevel_gettingthere.png</smallImage>
73            </branding>
74            <label>Getting There</label>
75            <lowerThreshold>101</lowerThreshold>
76        </level>
77        <level>
78            <branding> 
79                <smallImage>communities_shared _document_folder/replevel_skilled.png</smallImage>
80            </branding>
81            <label>Skilled</label>
82            <lowerThreshold>151</lowerThreshold>
83        </level>
84        <level>
85            <branding> 
86                <smallImage>communities_shared _document_folder/replevel_expert.png</smallImage>
87            </branding>
88            <label>Expert</label>
89            <lowerThreshold>201</lowerThreshold>
90        </level>
91        <level>
92            <branding> 
93                <smallImage>communities_shared _document_folder/replevel_mentor.png</smallImage>
94            </branding>
95            <label>Mentor</label>
96            <lowerThreshold>251</lowerThreshold>
97        </level>
98        <level>
99            <branding> 
100                <smallImage>communities_shared _document_folder/replevel_guru.png</smallImage>
101            </branding>
102            <label>Guru</label>
103            <lowerThreshold>301</lowerThreshold>
104        </level>
105    </reputationLevels>
106    <reputationPointsRules>
107        <pointsRule>
108            <eventType>FeedItemWriteAPost</eventType>
109            <points>5</points>
110        </pointsRule>
111        <pointsRule>
112            <eventType>FeedItemWriteAComment</eventType>
113            <points>3</points>
114        </pointsRule>
115        <pointsRule>
116            <eventType>FeedItemReceiveAComment</eventType>
117            <points>10</points>
118        </pointsRule>
119        <pointsRule>
120            <eventType>FeedItemLikeSomething</eventType>
121            <points>3</points>
122        </pointsRule>
123        <pointsRule>
124            <eventType>FeedItemReceiveALike</eventType>
125            <points>5</points>
126        </pointsRule>
127        <pointsRule>
128            <eventType>FeedItemMentionSomeone</eventType>
129            <points>5</points>
130        </pointsRule>
131        <pointsRule>
132            <eventType>FeedItemSomeoneMentionsYou</eventType>
133            <points>10</points>
134        </pointsRule>
135        <pointsRule>
136            <eventType>FeedItemShareAPost</eventType>
137            <points>5</points>
138        </pointsRule>
139        <pointsRule>
140            <eventType>FeedItemSomeoneSharesYourPost</eventType>
141            <points>10</points>
142        </pointsRule>
143    </reputationPointsRules>
144    <selfRegistration>false</selfRegistration>
145    <sendWelcomeEmail>true</sendWelcomeEmail>
146    <site>Network_11</site>
147    <status>UnderConstruction</status>
148    <tabs>
149        <defaultTab>Chatter</defaultTab>
150        <standardTab>Chatter</standardTab>
151        <standardTab>Account</standardTab>
152        <standardTab>Campaign</standardTab>
153        <standardTab>Case</standardTab>
154        <standardTab>Console</standardTab>
155        <standardTab>Contact</standardTab>
156        <standardTab>Contract</standardTab>
157        <standardTab>Dashboard</standardTab>
158        <standardTab>JigsawSearch</standardTab>
159        <standardTab>File</standardTab>
160        <standardTab>CollaborationGroup</standardTab>
161        <standardTab>home</standardTab>
162        <standardTab>Idea</standardTab>
163        <standardTab>Lead</standardTab>
164        <standardTab>Opportunity</standardTab>
165        <standardTab>Product2</standardTab>
166        <standardTab>UserProfile</standardTab>
167        <standardTab>report</standardTab>
168        <standardTab>Solution</standardTab>
169    </tabs>
170    <urlPathPrefix>network1</urlPathPrefix>
171    <welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>
172</Network>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide