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. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later.

Supported Calls

describeSObjects(), query(), retrieve(), update()

Special Access Rules

This object is available only when your org has digital experiences enabled.

Fields

Field Name	Details
AllowedExtensions	Type textarea Properties Filter, Nillable, Sort, Update Description Specifies the types of files allowed in your site. This list of file types lets you control what members upload and also prevents spammers from polluting your site with inappropriate files. Available in API version 36.0 and later. Separate file types with a comma (for example: `jpg,docx,txt`). You can enter lowercase and uppercase letters. You can enter up to 1,000 characters. To allow all file types, leave this field empty.
CaseCommentEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when submitting a comment on a case. This field is available in API version 28.0 and later.
ChangePasswordEmailTemplateId	Type reference Properties Filter, Group, Sort, Update Description ID of the email template used when notifying users that their password has been reset.
ChgEmailVerNewEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when notifying users that their email address has been changed. This email is sent to the user’s new email address.
ChgEmailVerOldEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when notifying users that their email address has been changed. This email is sent to the user’s old email address.
Description	Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the site.
DeviceActEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when users log in from an unrecognized browser, app, or IP address. The email contains a one-time password that users enter to verify their identity. This field is available in API version 53.0 and later.
EmailFooterLogoId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the Document object that displays as an image in the footer of Chatter emails.
EmailFooterText	Type string Properties Filter, Nillable, Sort, Update Description Text that displays in the footer of Chatter emails.
EmailSenderAddress	Type email Properties Filter, Group, Sort Description Read only. Email address from which emails are sent. To change the EmailSenderAddress value, you must first specify NewSenderAddress, which triggers the sending of an address change verification email. After you complete the address verification process, EmailSenderAddress changes to the specified NewSenderAddress. Note
EmailSenderName	Type string Properties Filter, Group, Sort, Update Description Name from which emails are sent.
FirstActivationDate	Type date Properties Filter, Group, Nillable, Sort Description The date the site was first activated. This field is available in API version 34.0 and later. If the site was activated or inactive before the release of API version 34.0, this field returns the date that the site was first created.
ForgotPasswordEmailTemplateId	Type reference Properties Filter, Group, Sort, Update Description ID of the email template used when users forget their password.
LockoutEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when users try to reset their password after locking themselves out because of too many login attempts. This field is available in API version 43.0 and later.
MaxFileSizeKb	Type int Properties Filter, Group, Nillable, Sort, Update Description 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.
Name	Type string Properties Filter, Group, idLookup, Sort, Update Description The name of the site.
NewSenderAddress	Type email Properties Filter, Group, Nillable, Sort, Update 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. If verification is pending for a new email address and you set NewSenderAddress to null, the verification request is canceled. NewSenderAddress is automatically set to null after EmailSenderAddress has been set to the new verified address. If verification is pending for a new email address, and you specify a different new address for this field, only the latest value is retained and used for verification. Note
OptionsActionOverrideEnabled	Type boolean Properties Filter, Update Description Override the action that occurs when users click a default button, like New or Edit, with a Lightning component. For example, show a custom window instead of the one that Salesforce provides. Assign action overrides in the Object Manager. In the UI, this setting is available in the Administration Workspace, under Administration \| Preferences under Experience Management This field is available in API version 49.0 and later.
OptionsAllowInternalUserLogin	Type boolean Properties Filter, Update Description Specifies whether internal users can log in with their internal credentials on the site login page. This field is available in API version 37.0 and later.
OptionsAllowMembersToFlag	Type boolean Properties Filter, Update Description Determines whether users can flag posts, comments, or files as inappropriate. This field is available in API version 29.0 and later. The ability to flag files is available in version 30.0 and later.
OptionsApexCDNCachingEnabled	Type boolean Properties Filter, Update Description Determines whether public data from @wire calls to Apex methods is cached only for guest users. This setting applies only to sites using Salesforce's CDN for Digital Experiences. This field is available in API version 55.0 and later.
OptionsDirectMessagesEnabled	Type boolean Properties Filter, Update Description Controls the availability of direct messages in an Experience Builder site. This field is available in API version 39.0 and later.
OptionsEnableTalkingAboutStats	Type boolean Properties Filter, Update Description Determines whether site 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. This field is available in API version 41.0 and later.
OptionsEnableTopicAssignmentRules	Type boolean Properties Filter, Update Description When true, displays knowledgeable people in key areas, for example, on Topic Detail pages.
OptionsExperienceBundleBasedSnaOverrideEnabled	Type boolean Properties Filter, Update Description When true, the Service Not Available Page is an auto-generated Experience Builder-based page. When false, the Service Not Available page uses a static resource page that is set in Workspaces \| Administration \| Pages. The default value is true. Available in API version 52.0 and later.
OptionsGatherCustomerSentimentData	Type boolean Properties Filter, Update Description When true, collects data about user likes, upvotes, and downvotes.
OptionsGuestChatterEnabled	Type boolean Properties Filter, Update Description Specifies whether guest users can access public Chatter groups in the site without logging in.
OptionsGuestFileAccessEnabled	Type boolean Properties Filter, Update Description When true, lets guest users view asset files and CMS content that’s available to the site. Guest users can access shared asset files and published CMS content that’s made for external use, even if it isn’t used. Shared asset files include images that are associated with topics, recognition badges, branding, and account branding. This preference is automatically enabled if public access is enabled at the page or site level in Experience Builder.
OptionsGuestMemberVisibility	Type boolean Properties Filter, Update Description When true, lets guest users see who else is part of the site, including non-guest users. In the UI, this setting appears in the Administration Workspace under Administration \| Preferences . Available in API version 47.0 and later.
OptionsInvitationsEnabled	Type boolean Properties Filter, Update Description Determines whether users can invite others to the site.
OptionsKnowledgeableEnabled	Type boolean Properties Filter, Update Description Determines whether users can see knowledgeable people for topics and endorse people for topics.
OptionsMemberVisibility	Type boolean Properties Filter, Update 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. This field is available in API version 45.0 and later.
OptionsMobileImageOptimizationEnabled	Type boolean Properties Filter, Update Description If true, file asset images are optimized for mobile display. This field is available in API version 45.0 and later.
OptionsNetworkSentimentAnalysis	Type boolean Properties Filter, Update Description If true, enables sentiment analysis in a site. In the UI, this setting is available in the Administration Workspace, under Administration \| Preferences. This field is available in API version 40.0 and later.
OptionsNicknameDisplayEnabled	Type boolean Properties Filter, Update Description Determines whether user nicknames display instead of their first and last names in most places in the site. A few restrictions to keep in mind about nickname display: Records and user lookups on records show full names. Keep in mind, though, that you can control record and user visibility with sharing rules. Mobile notifications in the Salesforce mobile app show full names. You can turn off mobile notifications in the app to avoid this display. Searches by first, last, and full names aren’t restricted and return matches, but the search results display only nicknames. Global search auto-complete recommendations show any first, last, and full names that the user has searched by or accessed via a record or another location. The recent items list also shows first, last, and full under the same conditions.
OptionsPrivateMessagesEnabled	Type boolean Properties Filter, Update Description Determines whether users can send and receive Chatter messages in the site.
OptionsProfileBasedLayoutsForKnowledgeSearchEnabled	Type boolean Properties Filter, Update Description When true, provides a grid layout for Knowledge search results. With grid layout in place, you can edit search profile layouts on the Knowledge object to show and hide different search result fields for different profiles. When you enable the standard grid layout, search-term highlighting isn’t available. This field is available in API version 51.0 and later.
OptionsRecognitionBadgingEnabled	Type boolean Properties Filter, Update Description Determines whether Recognition Badges is enabled for the site.
OptionsReputationEnabled	Type boolean Properties Filter, Update Description Determines if reputation is calculated and displayed for members. This field is available in API version 31.0 and later.
OptionsReputationRecordConversationsDisabled	Type boolean Properties Filter, Update Description Disables the feed on reputation records.
OptionsSelfRegistrationEnabled	Type boolean Properties Filter, Update Description Determines whether customers and partners can self-register to join the site. Customers and partners are users with External Identity, Community, Customer Portal, or partner portal licenses. If `true`, displays a Not a member? link on the login page that points to the default self-registration page. This field is available in API version 28.0 and later.
OptionsSendWelcomeEmail	Type boolean Properties Filter, Update Description Determines whether a welcome email is sent when a new user is added to the site.
OptionsShowAllNetworkSettings	Type boolean Properties Filter, Update Description Determines whether settings in Experience Management that were hidden based on how you set up your site are visible or remain hidden. This field is available in API version 33.0 and later.
OptionsSiteAsContainerEnabled	Type boolean Properties Filter, Update Description Determines whether the site is an Experience Builder site (`true`) or a Salesforce Tabs + Visualforce site (`false`). This field is available in API version 29.0 and later.
OptionsThreadedDiscussionsEnabled	Type boolean Properties Filter Description Indicates whether threaded discussions are enabled for the site. Available in API version 44.0 and later.
OptionsTopicFilteringForKnowledgeSearchEnabled	Type boolean Properties Filter, Update Description Determines whether topic filtering is enabled for Knowledge search. This field is available in API version 55.0 and later.
OptionsTopicSuggestionsEnabled	Type boolean Properties Filter, Update Description Enables topic suggestions when users write posts. This field is available in API version 41.0 and later.
OptionsUpDownVoteEnabled	Type boolean Properties Filter, Update Description Determines whether up and down voting is enabled for the site. This field is available in API version 41.0 and later.
SelfRegMicroBatchSubErrorEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the profile assigned to users who self-register using micro-batchng. Only applies if self-registration using micro-batching is enabled for the site. This field is available in API version 54.0 and later.
SelfRegProfileId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the profile assigned to users who self-register. Only applies if self-registration is enabled for the site. This field is available in API version 29.0 and later.
Status	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Status of the site. Available values are: `Live`—The site is online and members can access it. Label is Published. `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 menu as SiteName (Offline). Label is Offline. `UnderConstruction`—The site hasn’t yet been published. When a user’s profile is associated with the site, and they have Create and Set Up Experiences permission, they can access sites in this status. After a site is published, it can never be in this status again. Label is Preview.
UrlPathPrefix	Type string Properties Filter, Group, Nillable, Sort, Update Description The UrlPathPrefix is a unique string at the end of the URL for the site. For example, in the site URL `MyDomainName`.my.site.com/customers, customers is the UrlPathPrefix. If you’re not using enhanced domains, your org’s Experience Cloud sites URL is different. For details, see My Domain URL Formats in Salesforce Help. Note
VerificationEmailTemplateId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when users must verify their identity, for example, when they log in without a password. This field is available in API version 44.0 and later.
WelcomeEmailTemplateId	Type reference Properties Filter, Group, Sort, Update Description ID of the email template used when sending welcome emails to new members.

Usage

Use this object to find, view, and update sites in your org. If you’re assigned the Modify All Data, View All Data, or Create and Set Up Experiences permission, you can view all sites in the org. Users without these permissions see only the Preview or Published sites that they’re members of. If you’re assigned the Create and Set Up Experiences permission, you can customize site settings.

Object Reference for the Salesforce Platform

Network

Supported Calls

Special Access Rules

Fields

Usage