{"id":"sforce_api_objects_folder","title":"Folder","content":"

Folder

\n
Represents a repository for a Dashboard, Document, EmailTemplate,\n Macro, QuickText, or Report. Only one type of item can be contained in a folder.
\n\n
\n

Supported Calls

\n\n \n

create(), delete(),\n describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()

\n\n
\n\n
\n

Special Access Rules

\n\n \n \n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
FieldDetails
\nAccessType\n \n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Restricted picklist, Sort, Update
\n\n \n \n
Description
\n\n
Required. Indicates who can access the Folder. Available values include:
    \n
  • \nHidden—Folder is hidden from\n everyone.
    • \n\n
  • \nPublic—Folder is accessible by all\n users.
    • \n\n
  • \nShared—Folder is accessible only by a\n User in a particular Group or UserRole. The API doesn’t allow you to view,\n insert, or update which group or Role the Folder is shared with.
    • \n\n
\n
\n\"Note\"
\n

Note

\n

If analytics folder sharing is turned on for your organization, then this\n field is present but not used.

\n
\n
\n
\n\n \n
\n\n
\nDeveloperName\n \n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort, Update
\n\n \n \n
Description
\n\n
The unique name of the object in the API. This name can contain only underscores and\n alphanumeric characters, and must be unique in your org. It must begin with a letter, not\n include spaces, not end with an underscore, and not contain two consecutive underscores.\n In managed packages, this field prevents naming conflicts on package installations. With\n this field, a developer can change the object’s name in a managed package and the changes\n are reflected in a subscriber’s organization. Label is Folder Unique\n Name.
\n\"Note\"
\n

Note

\n

When creating large sets of data, always specify a unique\n DeveloperName for each record. If no\n DeveloperName is specified, performance slows down while\n Salesforce generates one for each record.

\n
\n
\n
\n\n \n
\n\n
\nIsReadonly\n \n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Create, Defaulted on create, Filter, Group, Sort, Update
\n\n \n \n
Description
\n\n
Indicates whether this Folder is read-only (true)\n or editable (false). Label is Read\n Only.
\n\"Note\"
\n

Note

\n

If analytics folder sharing is turned on for your organization,\n then this field is present but not used.

\n
\n
\n
\n\n \n
\n\n
\nName\n \n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Create, Filter, Group, idLookup, Sort, Update
\n\n \n \n
Description
\n\n
Label of the folder as it appears in the user interface. Label is Document\n Folder Label.
\n\n \n
\n\n
NamespacePrefix\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The namespace prefix that is associated with this object. Each Developer Edition org\n that creates a managed package has a unique namespace prefix. Limit: 15 characters. You\n can refer to a component in a managed package by using the namespacePrefix__componentName\n notation.

The namespace prefix can have one of the following values.

\n
    \n
  • In Developer Edition orgs, NamespacePrefix is set to the\n namespace prefix of the org for all objects that support it, unless an object is in an\n installed managed package. In that case, the object has the namespace prefix of the\n installed managed package. This field’s value is the namespace prefix of the Developer\n Edition org of the package developer.
    • \n\n
  • In orgs that are not Developer Edition orgs, NamespacePrefix is\n set only for objects that are part of an installed managed package. All other objects\n have no namespace prefix.
    • \n\n
\n
\n\n \n
\n\n
ParentId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
ID of the parent object, if any.
\n\n \n
\n\n
\nType\n \n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
Required. Type of objects contained in the Folder. This field can’t be updated.\n Available values include:
    \n
  • Dashboard
    • \n\n
  • Document
    • \n\n
  • \nEmail (for Salesforce Classic email\n templates)
    • \n\n
  • \nEmailTemplate (for Lightning email\n templates)
    • \n\n
  • Macro
    • \n\n
  • QuickText
    • \n\n
  • Report
    • \n\n
\n\n
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n

Only one type of item can be contained in a folder, either Dashboard, Document, EmailTemplate,\n Macro, QuickText, or Report.

\n\n
\n\n
\n
\n

See Also

\n\n
\n
"}