Network

Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component.

This type extends Metadata and inherits its fields.

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.

This object is available in API version 28.0 and later.

  • Type: string
  • Required: No
  • Introduced: API version 36.0
  • Description: 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.
  • Type: boolean
  • Required: No
  • Introduced: API version 40.0
  • Description: Determines whether internal users can log in with their internal credentials on the site login page.
  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: Determines whether users in the site can flag posts or comments as inappropriate. Flagged items are sent to a moderator for review.
  • Type: Branding
  • Required: No
  • Version: Deprecated in API version 41.0 and later.
  • Description: The color scheme, header, and footer used in the site. Replaced by the NetworkBranding type.

  • Type: string

  • Required: No

  • Description: 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.

  • Type: string

  • Required: Yes

  • Description: 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.

  • Type: string
  • Required: No
  • Description: 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.
  • Type: string
  • Required: No
  • Description: 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.
  • Type: CommunityRoles
  • Required: No
  • Introduced: API version 41.0
  • Description: Identifies users with Customer, Partner, or Employee roles in a site.
  • Type: string
  • Required: No
  • Description: Description of the site.
  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: The ID of the device activation email template. The template is used to customize the device activation email for community users.

  • Type: boolean

  • Required: No

  • Introduced: API version 67.0

  • Description: 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.

  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: When reputation levels are enabled for the site, determines whether to exclude contributions to records when counting points toward reputation levels.
  • Type: boolean
  • Required: No
  • Introduced: API version 68.0
  • Description: Indicates whether email messages sent on behalf of users with an unverified email domain are sent from the site’s emailSenderAddress (true). If emailDomainSubstitutionEnabled 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 emailDomainSubstitutionEnabled 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.
  • Type: string
  • Required: No
  • Introduced: API version 41.0
  • Description: The document name of the logo that appears in the footer of emails.
  • Type: string
  • Required: No
  • Introduced: API version 41.0
  • Description: The text that appears in the footer of emails.
  • Type: string
  • Required: Yes
  • Description: 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.
  • Type: string
  • Required: Yes
  • Description: Required. Name from which emails are sent.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: Determines whether to use custom Visualforce error pages instead of the default Visualforce error pages.
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: Determines whether site users can send direct messages to start a private conversation with one or more members.
  • Type: boolean
  • Required: No
  • Introduced: API version 52.0
  • Description: Determines whether the Builder-based SNA page is used (true) or not (false) and overrides the existing SNA page when an experience is published.

  • Type: boolean

  • Required: No

  • Description: 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)
  • Type: boolean
  • Required: No
  • Description: Specifies whether guest users can access public Chatter groups in the site without logging in.
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: 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.
  • Type: boolean
  • Required: No
  • Introduced: API version 47.0
  • Description: Determines if unauthenticated guest users can see the authenticated members (true) or not (false).
  • Type: boolean
  • Required: No
  • Introduced: API version 56.0
  • Description: Determines whether to optimize cached images for guest users on all devices when a site uses Salesforce’s CDN for Digital Experiences.
  • Type: boolean
  • Required: No
  • Description: Determines whether users can invite others to the site.
  • Type: boolean
  • Required: No
  • Introduced: API version 30.0
  • Description: Determines if members can see who’s knowledgeable on topics and endorse people for their knowledge on a topic.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Introduced: API version 45.0
  • Description: Controls user visibility on a per-site basis. If true, the See other members of this site preference is enabled for the selected site.
  • Type: boolean
  • Required: No
  • Introduced: API version 32.0
  • Description: Determines if user nicknames display instead of their first and last names in most places in the site. Set to false by default.
  • Type: boolean
  • Required: No
  • Introduced: API version 30.0
  • Description: Determines if members can send and receive private messages.
  • Type: boolean
  • Required: No
  • Introduced: API version 31.0
  • Description: Determines if reputation is calculated and displayed for members. If enabled, reputationLevels and reputationPointsRules are used. If no reputationLevels or reputationPointsRules are defined in the data file, the default values are used.
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: Shows settings that are hidden by default based on how the site is set up.
  • Type: boolean
  • Required: No
  • Description: Determines whether the site is an Experience Builder site (true) or a Salesforce Tabs + Visualforce site (false).
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: 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.
  • Type: boolean
  • Required: No
  • Introduced: API version 40.0
  • Description: 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.
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: Enables topic suggestions when users write posts.
  • Type: boolean
  • Required: No
  • Introduced: API version 41.0
  • Description: Replaces the option to like a question or answer with the option to upvote or downvote.
  • Type: string
  • Required: No
  • Introduced: API version 28.0
  • Description: Displays the feed of all channel program record or group interactions, including posts, questions, and attachments.

  • Type: string

  • Required: Yes

  • Description: Required. The email template used when a user forgets their password.

    Lightning email templates aren’t packageable. We recommend using a Classic email template.

  • Type: boolean
  • Required: No
  • Introduced: API version 40.0
  • Description: Gathers data when a customer looks at articles and cases in sites, for use in the Community 360 feature.
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Introduced: API version 43.0
  • Description: The email template used to communicate with users when they get locked out of their org because of too many failed login attempts. Lightning email templates aren’t packageable. We recommend using a Classic email template.
  • Type: string
  • Required: No
  • Introduced: API version 28.0
  • Description: Specifies the URL that members are redirected to when they log out from your site.
  • Type: int
  • Required: No
  • Introduced: API version 36.0
  • Description: Specifies the maximum file size (in KBs) that members can upload in your site. 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.
  • Type: NavigationLinkSet
  • Required: No
  • Version: This field is available in API versions 37.0 to 46.0.
  • Description: 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. In API version 47.0 and later, use the NavigationMenu type instead.
  • Type: NetworkAuthApiSettings
  • Required: No
  • Introduced: API version 60.0
  • Description: 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.
  • Type: NetworkMemberGroup
  • Required: No
  • Description: 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.
  • Type: NetworkPageOverride
  • Required: No
  • Introduced: API version 40.0
  • Description: 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.
  • Type: string
  • Required: No
  • Description: 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.
  • Type: string
  • Required: No
  • Introduced: API version 67.0
  • Description: The secondary sender email address that’s pending verification. Salesforce doesn’t send emails from this address until it’s verified.
  • Type: string
  • Required: No
  • Description: Name of the site of ChatterNetworkPicasso type that’s linked to the Experience Cloud site.

  • Type: string

  • Required: No

  • Description: 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.

  • Type: RecommendationAudience
  • Required: No
  • Introduced: API version 41.0
  • Description: Creates an audience of new members, or can be used to manage customized lists of audience members to organize and target recommendations.
  • Type: RecommendationDefinition
  • Required: No
  • Introduced: API version 41.0
  • Description: Represents a custom recommendation to drive engagement. Targets a specific audience and uses channels to specify a location for the recommendation.
  • Type: ReputationLevelDefinitions
  • Required: No
  • Description: The reputation levels assigned to members when they accrue points by performing certain actions.
  • Type: ReputationPointsRules
  • Required: No
  • Description: The points members accrue when they perform certain defined actions.
  • Type: boolean
  • Required: No
  • Introduced: API version 67.0
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: Determines whether self-registration is available for the site.
  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: The email template used to communicate with users when their self-registration request, using micro-batching failed.
  • Type: string
  • Required: No
  • Introduced: API version 29.0
  • Description: The profile assigned to users who self-register. This value is used only if selfRegistration is enabled for the site.
  • Type: boolean
  • Required: No
  • Description: Determines whether a welcome email is sent when a new user is added to the site.
  • Type: string
  • Required: Yes
  • Description: Required. The CustomSite associated with the Experience Cloud site.
  • Type: SitesArchiveStatus (enumeration of type string)
  • Required: No
  • Description: Specifies whether the site has been archived. Available values are:
  • Possible values:
    • NotArchived — The site hasn’t been archived.
    • TemporarilyArchived — The site is archived, but can be unarchived in the future.
  • Type: NetworkStatus (enumeration of type string)
  • Required: Yes
  • Description: Required. Status of the site. Available values are:
  • Possible values:

    • 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.

  • Type: NetworkTabSet
  • Required: Yes
  • Description: Required. The tabs that are available in the site. The user that created the site selected these tabs.
  • Type: string
  • Required: No
  • Description: 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.
  • Type: string
  • Required: No
  • Introduced: API version 44.0
  • Description: 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. Lightning email templates aren’t packageable. We recommend using a Classic email template.

  • Type: string

  • Required: Yes

  • Description: The email template used when sending welcome emails to new members.

    Lightning email templates aren’t packageable. We recommend using a Classic email template.

The labels used to identify users with Customer, Partner, or Employee roles in an Experience Cloud site.

Introduced in API version 41.0.

  • Type: string
  • Required: No
  • Description: The label for the Customer user role.
  • Type: string
  • Required: No
  • Description: The label for the Employee user role.
  • Type: string
  • Required: No
  • Description: The label for the Partner user role.

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. In API version 47.0, use NavigationMenu instead.

Available in API versions 37.0 to 46.0.

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

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.

  • Type: string
  • Required: No
  • Description: If the value of the type field is SalesforceObject, the value is the ID of the default list view for the object.
  • Type: string
  • Required: Yes
  • Description: Required. The text that appears in the navigation menu for this item.
  • Type: int
  • Required: Yes
  • Description: Required. The location of the menu item in the navigation menu.
  • Type: boolean
  • Required: No
  • Description: When set to true, gives access to guest users.
  • Type: NavigationSubMenu
  • Required: No
  • Description: A list of child menu items. This field is available in API 39.0 and later.
  • Type: string
  • Required: No
  • Description: 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.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Backed by a picklist that includes preferences for the target field.
  • Possible values:
    • None
    • OpenInExternalTab — Used for external links to determine whether to open in an external tab.

  • Type: string (enumeration of type string)

  • Required: Yes

  • Description: Required. The type of navigation menu item.

    You can’t nest other items of type MenuLabel or NavigationalTopic under MenuLabel.

  • Possible values:

    • 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.

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.

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

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.

Introduced in API version 60.0.

  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: Determines whether reCAPTCHA is required for headless username-password login that uses the OAuth 2.0 for First-Party Applications draft protocol.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: NetworkEmailTmplAllowlist[]
  • Required: No
  • Description: 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.
  • Type: string
  • Required: No
  • Description: An integration user account to run a headless user discovery Apex handler.
  • Type: string
  • Required: No
  • Description: An Apex class that implements the Auth.HeadlessUserDiscoveryHandler interface.
  • Type: boolean
  • Required: No
  • Description: Determines whether the Experience Cloud site can use headless identity flows that use the OAuth 2.0 for First-Party Applications draft protocol.
  • Type: boolean
  • Required: No
  • Description: Determines whether the Headless Forgot Password Flow is enabled.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: Determines whether the Headless Registration Flow is enabled.
  • Type: boolean
  • Required: No
  • Description: Determines whether the Headless Passwordless Login Flow is enabled (true) or not (false).
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: Determines whether self-registration and passwordless login via Universal Registration API are enabled.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: int
  • Required: No
  • Description: 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).

  • Type: double

  • Required: No

  • Description: 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.

  • Type: string
  • Required: No
  • Description: 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.
  • Type: string
  • Required: No
  • Description: The user who runs your headless registration Apex handler.
  • Type: string
  • Required: No
  • Description: The headless registration Apex handler.
  • Type: string
  • Required: No
  • Description: The default profile that gets assigned to new users when they register.

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.

Introduced in API version 60.0.

  • Type: string
  • Required: Yes
  • Description: 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.

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).

  • Type: string[]
  • Required: No
  • Description: 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.
  • Type: string[]
  • Required: No
  • Description: A profile that is part of the site.

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.

Assigned Visualforce page overrides are specified and deployed via the corresponding CustomSite metadata field.
  • Type: NetworkPageOverrideSetting (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the page type that the Change Password page setting applies to.
  • Possible values:
    • Configurable — a configurable self-registration page
    • Designer — an Experience Builder page
    • Standard — the default page
    • VisualForce — a Visualforce page
  • Type: NetworkPageOverrideSetting (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the page type that the Forgot Password page setting applies to.
  • Possible values:
    • Configurable — a configurable self-registration page
    • Designer — an Experience Builder page
    • Standard — the default page
    • VisualForce — a Visualforce page
  • Type: NetworkPageOverrideSetting (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the page type that the Experience Home page setting applies to.
  • Possible values:
    • Configurable — a configurable self-registration page
    • Designer — an Experience Builder page
    • Standard — the default page
    • VisualForce — a Visualforce page
  • Type: NetworkPageOverrideSetting (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the page type that the Login page setting applies to.
  • Possible values:
    • 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.
  • Type: NetworkPageOverrideSetting (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the page type that the Self Registration page setting applies to. The
  • Possible values:
    • Configurable — a configurable self-registration page
    • Designer — an Experience Builder page
    • Standard — the default page
    • VisualForce — a Visualforce page
  • Type: string[]
  • Required: No
  • Description: Custom tab that is part of the site.
  • Type: string
  • Required: Yes
  • Description: The Home tab for the site. When members log in, this tab is the first page they see.
  • Type: string[]
  • Required: No
  • Description: Standard tab that is part of the site.

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.

Introduced in API version 41.0.

The specific details of an audience for recommendations.

Introduced in API version 41.0.

  • Type: AudienceCriteriaType (enumeration of type string)
  • Required: No
  • Description: The criteria for the recommendation audience type. Values are:
  • Possible values:
    • CustomList
    • MaxDaysInCommunity
  • Type: string
  • Required: No
  • Description: For new member criteria, the maximum number of days since a user became a member. Null in case of custom list criteria.
  • Type: string
  • Required: No
  • Description: Name of the recommendation audience.

Represents a list of custom recommendations to drive engagement for an Experience Cloud site.

Introduced in API version 41.0.

The specific details of a custom recommendation.

Introduced in API version 41.0.

  • Type: string
  • Required: No
  • Description: The URL for the button that lets users act on the recommendation.
  • Type: string
  • Required: No
  • Description: An explanation of the recommendation that suggests what users can do.
  • Type: string
  • Required: No
  • Description: The text label for the button.
  • Type: string
  • Required: No
  • Description: The name of the recommendation, which appears in Setup.
  • Type: string
  • Required: No
  • Description: The title of the recommendation.

Branding for the reputation level.

  • Type: string
  • Required: No
  • Introduced: API version 32.0
  • Description: 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.

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

  • Type: ReputationBranding

  • Required: No

  • Introduced: API version 32.0

  • Description: 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.

  • Type: string

  • Required: No

  • Description: 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
  • Type: double
  • Required: Yes
  • Description: 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.

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

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

  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of event a member has to perform to get points. The available values are:
  • Possible values:
    • FeedItemWriteAPost
    • FeedItemWriteAComment
    • FeedItemReceiveAComment
    • FeedItemLikeSomething
    • FeedItemReceiveALike
    • FeedItemMentionSomeone
    • FeedItemSomeoneMentionsYou
    • FeedItemShareAPost
    • FeedItemSomeoneSharesYourPost
    • FeedItemPostAQuestion
    • FeedItemAnswerAQuestion
    • FeedItemReceiveAnAnswer
    • FeedItemMarkAnswerAsBest
    • FeedItemYourAnswerMarkedBest
    • FeedItemEndorseSomeoneForKnowledgeOnATopic
    • FeedItemEndorsedForKnowledgeOnATopic

  • Type: int

  • Required: Yes

  • Description: 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

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

Represents a list of scheduled recommendations.

Introduced in API version 41.0.

The specific details of a scheduled recommendation.

Introduced in API version 41.0.

  • Type: RecommendationChannel (enumeration of type string)
  • Required: No
  • Description: A way to group recommendations together to determine where they show up in the site.
  • Possible values:
    • 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.

  • Type: boolean

  • Required: No

  • Description: 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.

  • Type: int

  • Required: No

  • Description: 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.

  • Type: string
  • Required: No
  • Description: The name of the audience for this scheduled recommendation.

A sample XML definition of a network.

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.

FieldField TypeDescription
loginFooterTextstringThe text that appears in the footer of the login page.
loginLogostringThe logo that appears on the login page for external users.
pageFooterstringAn image that appears on the footer of the pages. Must be an .html file.
pageHeaderstringAn image that appears on the header of the pages. Can be an .html, .gif, .jpg, or .png file.
primaryColorstringThe color used for the active tab.
primaryComplementColorstringFont color used with primaryColor.
quaternaryColorstringThe background color for pages.
quaternaryComplementColorstringFont color used with quaternaryColor.
secondaryColorstringThe color used for the top borders of lists and tables.
tertiaryColorstringThe background color for section headers on edit and detail pages.
tertiaryComplementColorstringFont color used with tertiaryColor.
zeronaryColorstringThe background color for the header.
zeronaryComplementColorstringFont color used with zeronaryColor.

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.