Network

Represents a community. Communities are branded spaces for your employees, customers, and partners to connect. You can customize and create communities to meet your business needs, then transition seamlessly between them.Communities let you share information, records, and files with coworkers and external 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 if Salesforce Communities are enabled in your org.

Fields

Field Name	Details
AllowedExtensions	Type textarea Properties Filter, Nillable, Sort, Update Description Specifies the types of files allowed in your community. This whitelist of file types lets you control what your community members upload and also prevents spammers from polluting your community 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.
Description	Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the community.
EmailFooterLogoId	Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the Document object that displays as an image in the footer of community Chatter emails.
EmailFooterText	Type string Properties Filter, Nillable, Sort, Update Description Text that displays in the footer of community Chatter emails.
EmailSenderAddress	Type email Properties Filter, Group, Sort Description Read only. Email address from which community 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 community emails are sent.
FirstActivationDate	Type date Properties Filter, Group, Nillable, Sort Description The date the community was first activated. This field is available in API version 34.0 and later. If the community was activated or inactive before the release of API version 34.0, this field returns the date that the community 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 of their community from 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 community. 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, Sort, Update Description The name of the community.
NewSenderAddress	Type email Properties Filter, Group, Nillable, Sort, Update Description Email address that has been entered as the new value for EmailSenderAddress but has not 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 community 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
OptionsAllowInternalUserLogin	Type boolean Properties Filter, Update Description Specifies whether internal users can log in with their internal credentials on the community 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 in the community. This field is available in API version 29.0 and later. The ability to flag files is available in version 30.0 and later.
OptionsEnableTalkingAboutStats	Type boolean Properties Filter, Update Description Determines whether community 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. The ability to flag files is available in version 30.0 and later.
OptionsGuestChatterEnabled	Type boolean Properties Filter, Update Description Specifies whether guest users can access public Chatter groups in the community without logging in.
OptionsInvitationsEnabled	Type boolean Properties Filter, Update Description Determines whether users can invite others to the community.
OptionsKnowledgeableEnabled	Type boolean Properties Filter, Update Description Determines whether users can see knowledgeable people for topics and endorse people for topics.
OptionsNicknameDisplayEnabled	Type boolean Properties Filter, Update Description Determines whether user nicknames display instead of their first and last names in most places in the community. A few restrictions to keep in mind about nickname display: Private messages display full names. You can choose to turn off private messages to avoid this 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 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 community.
OptionsRecognitionBadgingEnabled	Type boolean Properties Filter, Update Description Determines whether Recognition Badges is enabled for the community.
OptionsReputationEnabled	Type boolean Properties Filter, Update Description Determines if reputation is calculated and displayed for community members. This field is available in API version 31.0 and later.
OptionsSelfRegistrationEnabled	Type boolean Properties Filter, Update Description Determines whether external users can self-register to join the community. External users 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 community.
OptionsShowAllNetworkSettings	Type boolean Properties Filter, Update Description Determines whether settings in Community Management Community Management that were hidden based on how you set up your community 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 community uses Site.com pages instead of Visualforce tabs. 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 community. Available in API version 44.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. The ability to flag files is available in version 30.0 and later.
OptionsUpDownVoteEnabled	Type boolean Properties Filter, Update Description Determines whether up and down voting is enabled for the community. This field is available in API version 41.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 community. 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 community. Available values are: `Live`—The community is online and members can access it. Label is Published. `DownForMaintenance`—The community was previously published, but was taken offline. Members with “Create and Set Up Communities” can still access the setup for offline communities regardless of profile or membership. Members are not able to access offline communities, but they still appear in the user interface dropdown menu as CommunityName (Offline). Label is Offline. `UnderConstruction`—The community has not yet been published. Users with “Create and Set Up Communities” can access communities in this status if their profile is associated with the community. After a community is published, it can never be in this status again. Label is Preview.
UrlPathPrefix	Type string Properties Filter, Group, Sort, Update Description The UrlPathPrefix is a unique string at the end of the URL for this community. For example, in the community URL UniversalTelco.force.com/customers, customers is the UrlPathPrefix.
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 or from a new device. 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 community members.

Usage

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

Object Reference for Salesforce and Lightning Platform

Network

Supported Calls

Special Access Rules

Fields

Usage