AboutMe |
- Type
- textarea
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Information about the user, such as areas of interest or skills. This field is available even if Chatter is
disabled.
|
AccountId |
- Type
- reference
- Properties
- Filter, Group,
Nillable, Sort
- Description
- ID of the Account associated with a Customer Portal user.
This field is null for Salesforce
users.
|
Address (beta) |
- Type
- address
- Properties
- Filter, Nillable
- Description
- The compound form of the address. Read-only. See Address Compound Fields for
details on compound address fields.
|
Alias |
- Type
- string
- Properties
- Create, Filter, Group,
Sort,
Update
- Description
- Required. The user’s alias. For example, jsmith.
|
BadgeText |
- Type
- string
- Properties
- Filter, Group,
Nillable, Sort
- Description
- The text description of a user badge that appears over a user’s photo. Users of the
same Chatter user type (internal, external) are badged. Different user types are not
badged.
|
BannerPhotoUrl |
- Type
- string
- Properties
- Filter, Nillable, Sort
- Description
- The URL for the user's banner photo. This field is available in API version 36.0 and
later.
|
CallCenterId |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- If Salesforce CRM Call Center is enabled, represents the call center to which this
user is assigned.
|
City |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The city associated with the user. Up to 40 characters allowed.
|
CommunityNickname |
- Type
- string
- Properties
- Create, Filter, Group,
Sort,
Update
- Description
- Name used to identify this user in the Community application, which includes the ideas
and answers features.
|
CompanyName |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The name of the user’s company.
|
ContactId |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- ID of the Contact associated with this account. The contact must have a value in the
AccountId field or an error occurs.
|
Country |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The country associated with the user. Up to 80 characters allowed.
|
CountryCode |
- Type
- picklist
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The ISO country code associated with the user.
|
CurrentStatus |
- Type
- textarea
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Text that describes what the user is working on.

Note
If you update this field, the
API automatically adds a post of type UserStatus on
the user’s profile in Chatter. This field is deprecated in API version 25.0. To
achieve similar behavior, post to the user directly by creating a FeedItem with the
user’s ParentId.
|
DefaultCurrencyIsoCode |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update
- Description
- The user's default currency setting for new records. For example, a user in France
could have a DefaultCurrencyIsoCode set to Euros, and that would be
their default currency in the application.
Only applicable for organizations that use
multiple currencies.
|
DefaultDivision |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group,
Sort,
Update
- Description
- This record’s default division. Only applicable if
divisions are enabled for your organization.
|
DefaultGroupNotificationFrequency |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group,
Nillable, Restricted picklist, Sort, Update
- Description
- Required. The default frequency for sending the user's Chatter group email
notifications when the user joins groups. The valid values are:
-
P—Email on
every post
-
D—Daily digests
-
W—Weekly digests
-
N—Never
The default value is N. For Professional, Enterprise, Unlimited, and Developer Edition
organizations that existed prior to API version 22.0, the default value remains D.This field is available in API version 21.0 and
later.
|
DelegatedApproverId |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable,Sort, Update
- Description
- Id of the user who is a delegated approver for this user.
|
Department
|
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The company department associated with the user.
|
DigestFrequency
|
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group,
Nillable, Restricted picklist, Sort, Update
- Description
- Required. The frequency at which the system sends the user’s
Chatter personal email
digest. The valid values are:
-
D = Daily
-
W = Weekly
-
N = Never
The default value is D.
|
Division
|
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The division associated with this user, similar to
Department and unrelated to DefaultDivision.
|
Email
|
- Type
- email
- Properties
- Create, Filter, Group,
idLookup, Sort, Update
- Description
- Required. The user’s email address.
|
EmailEncodingKey
|
- Type
- picklist
- Properties
- Create, Filter, Group,
Restricted picklist, Sort, Update
- Description
- Required. The email encoding for the user, such as ISO-8859-1 or UTF-8.
|
EmailPreferencesAutoBcc |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Determines whether the user receives copies of sent emails. This option applies only
if compliance BCC emails are not enabled.
|
EmployeeNumber
|
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s employee number.
|
Extension
|
- Type
- phone
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s phone extension number.
|
Fax
|
- Type
- phone
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s fax number.
|
FederationIdentifier |
- Type
- string
- Properties
- Create, Filter, idLookup, Nillable, Sort, Update
- Description
- Indicates the value that must be listed in the Subject element of a Security Assertion Markup Language (SAML) IDP
certificate to authenticate the user for a client application using single
sign-on. This value must be specified if the SAML User ID Type is
Assertion contains Federation ID from the User record. Otherwise, this field can’t
be edited.
|
FirstName |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s first name.
|
ForecastEnabled
|
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group,
Sort,
Update
- Description
- Indicates whether the user is enabled as a Forecast Manager (true) or not (false)
in customizable forecasting. Forecast managers see forecast rollups from users below them
in the forecast hierarchy.
|
FullPhotoUrl |
- Type
- string
- Properties
- Filter, Nillable, Sort
- Description
- The URL for the user's profile photo. This field is available even if Chatter is
disabled.
The
URL is updated every time a photo is uploaded and reflects the most recent photo. The
URL returned for an older photo is not guaranteed to return a photo if a newer photo
has been uploaded. You should always query this field for the URL of the most recent
photo.
This field is available in API version 20.0 and later.
|
GeocodeAccuracy |
- Type
- picklist
- Properties
- Create, Filter, Group,
Nillable, Restricted picklist, Sort, Update
- Description
- The level of accuracy of a location’s geographical coordinates compared with its
physical address. A geocoding service typically provides this value based on the
address’s latitude and longitude coordinates.
|
IndividualId |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- ID of the data privacy record associated with this user. This field is available if
Data Protection and Privacy is enabled.
|
IsActive
|
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group,
Sort,
Update
- Description
- Indicates whether the user has access to log in (true) or not (false). You can modify a
User's active status from the user interface or via the API.
|
IsPartner |
- Type
- boolean
- Properties
- Defaulted on create, Filter
- Description
- Indicates whether the user is a partner who has access to the partner portal (true) or not (false).
This field is not available for release 9.0 and later. Instead, use UserType with
the value Partner or Power Partner.
|
IsPortalEnabled |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group,
Sort,
Update
- Description
- Indicates whether the user has access to Communities or portals
(true) or not (false).
This field is only available if one of the following conditions is true:
- Communities
are enabled in your organization and you have community
or portal user licenses
- Portals are enabled in your organization
|
IsPortalSelfRegistered |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group,
Sort
- Description
- Indicates whether the user is a Customer Portal user who self-registered
for your organization's Customer Portal (true) or not (false). This field is not available for release 9.0 and earlier.
|
IsPrmSuperUser |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group,
Sort,
Update
- Description
- Available for partner portal users only. Indicates whether the user has super user
access in the partner portal
(true) or not (false).
-
This field is available in API version 24.0 and later.

Note
This field is not automatically enabled. Contact Salesforce to enable this
field.
|
IsProfilePhotoActive |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group,
Sort
- Description
- Indicates whether a user has a profile photo (true) or not (false). This field is
available in API version 36.0 and later.
|
JigsawImportLimitOverride |
- Type
- int
- Properties
- Create, Filter, Group
Nillable, Sort, Update
- Description
- The Data.com user’s monthly addition limit. The value must be between zero and
the organization’s monthly addition limit. Label is Data.com Monthly
Addition Limit. This field is available in API version
27.0 and later.
|
LanguageLocaleKey
|
- Type
- picklist
- Properties
- Create, Filter, Group,
Restricted picklist, Sort, Update
- Description
- Required. The user’s language, such as “French” or
“Chinese (Traditional).” Label is Language.
|
LastLoginDate
|
- Type
- dateTime
- Properties
- Filter, Sort, Nillable
- Description
- The date and time when the user last successfully logged in. This value is updated if
60 seconds have elapsed since the user’s last login.
|
LastName |
- Type
- string
- Properties
- Create, Filter, Group,
Sort,
Update
- Description
- Required. The user’s last name.
|
LastReferencedDate |
- Type
- date
- Properties
- Filter, Nillable, Sort, Update
- Description
- The timestamp for when the current user last viewed a
record related to this record.
|
LastViewedDate |
- Type
- date
- Properties
- Filter, Nillable, Sort, Update
- Description
- The timestamp for when the current user last viewed
this record. If this value is null, this
record might only have been referenced
(LastReferencedDate) and not viewed.
|
Latitude |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Used with Longitude
to specify the precise geolocation of an address.
Acceptable values are numbers between –90 and
90 up to 15 decimal places. For details on
geolocation compound fields, see Compound Field Considerations and Limitations.
|
LocaleSidKey
|
- Type
- picklist
- Properties
- Create, Filter, Group,
Restricted picklist, Sort, Update
- Description
- Required. This field is a restricted picklist field. The value of the field affects
formatting and parsing of values, especially numeric values, in the user interface. It
does not affect the API.
The field values are named according to the language, and
country if necessary, using two-letter ISO codes. The set of names is based on the ISO
standard. It can often be more convenient to manually set a user’s locale in the
user interface, and then use that value for inserting or updating other users via the
API.
|
Longitude |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Used with Latitude
to specify the precise geolocation of an address.
Acceptable values are numbers between –180
and 180 up to 15 decimal places. For details on
geolocation compound fields, see Compound Field Considerations and Limitations.
|
Manager |
- Type
- picklist
- Properties
- Create, Filter, Restricted picklist, Update
- Description
- User lookup field used to select the user's manager. This establishes a hierarchical
relationship, preventing you from selecting a user that directly or indirectly reports to
itself.
|
ManagerId |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The Id of the user who manages this user.
|
MediumBannerPhotoUrl |
- Type
- url
- Properties
- Filter, Nillable, Sort
- Description
- The URL for the medium sized user profile banner photo.
|
MiddleName |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s middle name. Maximum size is 40 characters. Contact Salesforce Customer Support to
enable this field.
|
MobilePhone |
- Type
- phone
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s mobile or cellular phone number.
|
Name |
- Type
- string
- Properties
- Filter, Group,
Sort
- Description
- Concatenation of FirstName and
LastName.
Limited to 121 characters.
|
OfflineTrialExpirationDate
|
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The date and time when the user’s Connect Offline trial expires.
|
Phone
|
- Type
- phone
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s phone number.
|
PortalRole |
- Type
- picklist
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The role of the user in the Customer Portal (either Executive,
Manager, User, or PersonAcount).
Prior to API version 16.0, you could set this field to
null and the system automatically included a portal role. In API version 16.0 and above,
when you set this field to null, a portal role is not automatically created. When this
field is null and a ContactId is provided, the user is assigned to
the User role.
The Update property is
available in API version 43.0 and later.
The field is available if Customer Portal is enabled OR Communities is
enabled and have available partner portal, Customer Portal, or High-Volume Portal
User licenses.
|
PostalCode |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s postal or ZIP code. Label is Zip/Postal
Code.
|
ProfileId |
- Type
- reference
- Properties
- Create, Filter, Group,
Sort,
Update
- Description
- Required. ID of the user’s Profile. Use this value to cache metadata based on profile. In earlier releases, this was
RoleId.
|
ReceivesAdminInfoEmails |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group,
Sort,
Update
- Description
- Indicates whether the user receives email for administrators from Salesforce (true) or not (false).
|
ReceivesInfoEmails |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group,
Sort,
Update
- Description
- Indicates whether the user receives informational email from Salesforce (true) or not (false).
|
SenderEmail |
- Type
- email
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The email address used as the From address when the user sends emails. This is the
same value shown in Setup on the My Email Settings page.
|
SenderName |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The name used as the email sender when the user sends emails. This is the same value
shown in Setup on the My Email Settings page.
|
Signature |
- Type
- string
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The signature text added to emails. This is the same value shown in Setup on the My
Email Settings page.
|
SmallBannerPhotoUrl |
- Type
- url
- Properties
- Filter, Nillable, Sort
- Description
- The URL for the small user profile banner photo.
|
SmallPhotoUrl |
- Type
- string
- Properties
- Filter, Nillable, Sort
- Description
- The URL for a thumbnail of the user's profile photo. This field is available even if Chatter is
disabled.
The
URL is updated every time a photo is uploaded and reflects the most recent photo. The
URL returned for an older photo is not guaranteed to return a photo if a newer photo
has been uploaded. You should always query this field for the URL of the most recent
photo.
This field is available in
API version 20.0 and later.
|
State |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The state associated with the User.
Up to 80 characters allowed.
|
StateCode |
- Type
- picklist
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The ISO state code associated with the user.
|
Street |
- Type
- textarea
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The street address associated with the User.
|
Suffix |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s name suffix. Maximum size is 40 characters. Contact Salesforce Customer Support to
enable this field.
|
TimeZoneSidKey |
- Type
- picklist
- Properties
- Create, Filter, Group,
Restricted picklist, Sort, Update
- Description
- Required. This field is a restricted picklist field. A User time zone affects the
offset used when displaying or entering times in the user interface. However, the API
does not use a User time zone when querying or setting values.
Values for this field
are named using region and key city, according to ISO standards. It can often be more
convenient to manually set one User time zone in the user interface, and then use that
value for creating or updating other User records via the API.
|
Title |
- Type
- string
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- The user’s business title, such as “Vice President.”
|
Username |
- Type
- string
- Properties
- Create, Filter, Group,
idLookup, Sort, Update
- Description
- Required. Contains the name that a user enters to log in to the API or the user
interface. The value for this field must be in the form of an email address, and all
characters should be lowercase. It must also be unique across all organizations. If you
try to create or update a User with a duplicate value for this field, the operation is
rejected.
Each inserted User also counts as a license. Every organization has a
maximum number of licenses. If you attempt to exceed the maximum number of licenses by
inserting User records, the create is rejected.
|
UserPermissionsCallCenterAutoLogin |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Required if Salesforce CRM Call Center is
enabled. Indicates whether the user is enabled to use the auto login feature of the call
center (true) or not (false).
|
UserPermissionsChatterAnswersUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the portal user is enabled to use the Chatter Answers feature (true) or not (false).
This field defaults to false when a Customer Portal user is created from the
API.
|
UserPermissionsInteractionUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user can run flows or not. Label is Lightning
Platform Flow User.
|
UserPermissionsJigsawProspectingUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user is allocated one Data.com user license (true) or not (false).
The Data.com user license lets the user add Data.com contact and lead records to Salesforce in supported editions.
Label is Data.com User.
|
UserPermissionsKnowledgeUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user is enabled to use Salesforce Knowledge (true) or not (false).
Label is Knowledge User.
|
UserPermissionsLiveAgentUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user is enabled to use Life Agent (true) or not (false). Label is
Life Agent User.
|
UserPermissionsMarketingUser
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Required. Indicates whether the user is enabled to manage campaigns in the user
interface (true) or not (false). Label is Marketing User.
|
UserPermissionsOfflineUser
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Required. Indicates whether the user is enabled to use Offline Edition (true) or not (false).
Label is Offline User.
|
UserPermissionsSFContentUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user is allocated one Salesforce CRM Content User License (true) or not (false).
Label is Salesforce CRM Content
User. The Salesforce CRM Content
User license grants the user access to the Salesforce CRM Content application.
|
UserPermissionsSiteforceContributorUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user is allocated one Site.com Contributor feature
license (true) or not (false). Label is Site.com Contributor
User. The Site.com
Contributor feature license grants the user access to the Site.com application. Users with a
Contributor license can use Site.com Studio to edit site content only.
|
UserPermissionsSiteforcePublisherUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the user is allocated one Site.com Publisher feature license
(true) or not (false). Label is Site.com Publisher
User. The Site.com
Publisher feature license grants the user access to the Site.com application. Users with a
Publisher license can build and style websites, control the layout and functionality of
pages and page elements, and add and edit content.
|
UserPermissionsSupportUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, the user can use the Salesforce console.
|
UserPermissionsWirelessUser |
- Type
- boolean
- Properties
- Create, Update
- Description
- Required if the Wireless permission is enabled for your organization. Indicates
whether the user is enabled to use Wireless Edition (true) or not (false). Label is
Wireless User.

Note
As of November 2005, Salesforce Wireless Edition is no
longer available for purchase. If you are a Professional Edition customer and purchased
Wireless Edition prior to November 7, 2005 or are an Enterprise Edition customer who has
signed or renewed your Salesforce
contract prior to November 7, 2005, you may continue using Wireless Edition through the
end of your existing contract term.
|
UserPermissionsWorkDotComUserFeature |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Indicates whether the Work.com
feature is enabled for the user (true) or not
(false).
|
UserPreferencesActivityRemindersPopup |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, a
reminder popup window automatically opens when an activity reminder is due. Corresponds
to the Trigger alert when reminder comes due checkbox at the
Reminders page in the personal settings in the user interface.
|
UserPreferencesApexPagesDeveloperMode |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true,
indicates the user has enabled developer mode for editing Visualforce pages and
controllers.
|
UserPreferencesContentEmailAsAndWhen |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When false, a user with Salesforce CRM Content subscriptions receives a
once daily email summary if activity occurs on his or her subscribed content, libraries,
tags, or authors. To receive email, the UserPreferencesContentNoEmail field must also be
false.
The
default value is false.

Note
This field is only visible when Salesforce CRM Content is enabled for your
organization.
|
UserPreferencesContentNoEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When false, a user with Salesforce CRM Content subscriptions receives
email notifications if activity occurs on his or her subscribed content, libraries, tags,
or authors. To receive real-time email alerts, set this field to false and set the UserPreferencesContentEmailAsAndWhen field to true.
The
default value is false.

Note
This field is only visible when Salesforce CRM Content is enabled for your
organization.
|
UserPreferencesEnableAutoSubForFeeds |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When true,
the user automatically subscribes to feeds for any objects that the user creates.
This field is available in API version 25.0 and later.
|
UserPreferencesDisableAllFeedsEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false,
the user automatically receives email for all updates to Chatter feeds, based on the
types of feed emails and digests the user has enabled.
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableAutoSubForFeeds |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When false, the user automatically subscribes to
feeds for any objects that the user creates. This field is deprecated in API version 25.0
and later. Starting with API version 25.0, use
UserPreferencesEnableAutoSubForFeeds to enable or disable
auto-follow for objects a user creates.
|
UserPreferencesDisableBookmarkEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false,
the user automatically receives email every time someone comments on a Chatter feed item
after the user has bookmarked it.
This field is available in API version 24.0 and
later.
|
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableEndorsementEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When false, the member automatically receives
email every time someone endorses them for a topic.
|
UserPreferencesDisableFileShareNotificationsForApi |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false, email
notifications are sent from the person who has shared a file to the users with whom the
file has been shared. This field is available in API version 25.0 and later.
|
UserPreferencesDisableFollowersEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false,
the user automatically receives email every time someone starts following the user in
Chatter.This field is available in API version 24.0 and
later.
|
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableLikeEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false, the
user automatically receives email every time someone likes a post or comment the user
has made.
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableMentionsPostEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false, the user automatically receives email every time the user is mentioned
in posts.
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableProfilePostEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false, the user automatically receives email every time someone posts to the
user’s profile.
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableSharePostEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false, the user automatically receives email every time the user’s post
is shared.
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableFeedbackEmail |
- Type
- boolean
- Properties
- Filter
- Description
- When false, the user automatically receives
emails related to Work.com
feedback. This includes when someone requests or offers feedback, shares feedback with
the user, or reminds the user to answer a feedback request.
|
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
This field is available in API version 24.0 and
later.
|
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableMessageEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When false,
the user automatically receives email for Chatter messages sent to the user.
This field is available in API version 24.0 and
later.
|
UserPreferencesDisableRewardEmail |
- Type
- boolean
- Properties
- Filter
- Description
- When false, the user automatically receives
emails related to Work.com
rewards. This includes when someone gives a reward to the user.
|
UserPreferencesDisableWorkEmail |
- Type
- boolean
- Properties
- Filter
- Description
- When false, the user receives emails related to
Work.com feedback, goals, and
coaching. The user must also sign up for individual emails listed on the Work.com email settings page. When
true, the user doesn’t receive any emails related
to Work.com feedback, goals, or
coaching even if they are signed up for individual emails.
|
UserPreferencesDisProfPostCommentEmail |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
This field is available in API version 24.0 and
later.
|
UserPreferencesEventRemindersCheckboxDefault |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, a reminder popup is automatically set on the user's events. Corresponds
to the By default, set reminder on Events to... checkbox on the
Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders.
|
UserPreferencesHideBiggerPhotoCallout |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, users can choose to hide the callout
text below the large profile photo.
|
UserPreferencesHideChatterOnboardingSplash |
- Type
- boolean
- Properties
- Filter
- Description
- When true, the initial Chatter onboarding prompts do
not appear.
|
UserPreferencesHideCSNDesktopTask |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When true,
the Chatter
recommendations panel never displays the recommendation to install Chatter Desktop.
This field is available in API version 26.0 and later.
|
UserPreferencesHideCSNGetChatterMobileTask |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When true, the Chatter recommendations
panel never displays the recommendation to install Chatter Mobile.
This field is available in API version 26.0 and later.
|
UserPreferencesHideEndUserOnboardingAssistantModal |
- Type
- boolean
- Properties
- CreateFilterUpdate
- Description
- Reserved for future use.
|
UserPreferencesHideLightningMigrationModal |
- Type
- boolean
- Properties
- CreateFilterUpdate
- Description
- Reserved for future use.
|
UserPreferencesHideSecondChatterOnboardingSplash |
- Type
- boolean
- Properties
- Filter
- Description
- When true, the secondary Chatter onboarding prompts do
not appear.
|
UserPreferencesHideS1BrowserUI |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Controls the interface that the
user sees when logging in to Salesforce from a supported mobile browser. If false, the user is automatically redirected to the Salesforce mobile web. If true, the user sees the full Salesforce site. The default
value is false. Label is Salesforce
User.
This field is
available in API version 29.0 or later.
|
UserPreferencesHideSfxWelcomeMat |
- Type
- boolean
- Properties
- CreateFilterUpdate
- Description
- Controls whether a user sees the Lightning Experience new user message. That
message welcomes users to the new interface and provides step-by-step instructions that
describe how to return to Salesforce Classic.
|
UserPreferencesJigsawListUser |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, the user is a Data.com List user and,
therefore, shares record additions from a pool. UserPermissionsJigsawProspectingUser must
also be set to true. Label is Data.com
List User. This field is available in API version
27.0 and later.
|
UserPreferencesLightningExperiencePreferred |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, redirects the user to the Lightning Experience interface. Label is
Switch to Lightning Experience. This
field is available in API version 35.0 and later.
|
UserPreferencesOptOutOfTouch |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- This field is deprecated in API version 29.0. When
false, the user automatically accesses the Salesforce Touch app when logging
in to Salesforce from an iPad. If true, automatic
access to the Salesforce Touch
app is turned off and the user’s iPad is directed to the full Salesforce site
instead. The default value is false.

Note
Salesforce Touch must be
enabled before this field is visible.
|
UserPreferencesPathAssistantCollapsed |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When true, Sales Path appears collapsed or hidden to the user. This field is
available in API version 35.0 and later.
|
UserPreferencesProcessAssistantCollapsed |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
When true,
Sales Path appears collapsed or hidden to the user. This field is available in API
versions 33.0 and 34.0 only. In API versions 35.0 and later, use
UserPreferencesPathAssistantCollapsed.
|
UserPreferencesReminderSoundOff |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, a
sound automatically plays when an activity reminder is due. Corresponds to the
Play a reminder sound checkbox on the Reminders page in the user
interface.
|
UserPreferencesShowCityToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the city field in the
user’s contact information. City is visible only to internal members of the
user’s organization when:
- This field is false. When false, this field returns the value #N/A.
City is visible to external members in a community when:
- This field is true, or
- This field is false but UserPreferencesShowCityToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal
licenses.The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowCityToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the city field in the
user’s contact information. When true, city
is visible to guest users. Guest users can access public Site.com and Salesforce sites,
and public pages in Communities, via the Guest User license associated with each site or
community. When false, this field returns the value #N/A.
When true, this field overrides the value false in UserPreferencesShowCityToExternalUsers, making the user’s
city visible to external members.
The default value is false.
This field is available in API version 28.0 and
later.
|
UserPreferencesShowCountryToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the country field in the
user’s contact information. Country is visible only to internal members of the
user’s organization when:
- This field is false. When false, this field returns the value #N/A.
Country is visible to external members in a community when:
- This field is true, or
- This field is false but UserPreferencesShowCountryToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal
licenses. The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowCountryToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the country field in the
user’s contact information. When true,
country is visible to guest users. Guest users can access public Site.com and Salesforce
sites, and public pages in Communities, via the Guest User license associated with each
site or community. When false, this field returns the value #N/A.
When true, this field overrides the value false in UserPreferencesShowCountryToExternalUsers, making the
user’s country visible to external members.
The default value is false.
This field is available in API version 28.0 and
later.
|
UserPreferencesShowEmailToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the email address field in
the user’s contact information. Email address is visible only to internal members
of the user’s organization when this field is false. Email address is visible to external members in a community when
this field is true. External users are users with
Community, Customer Portal, or partner portal licenses.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowEmailToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the email address field in the
user’s contact information. When true, the
email address is visible to guest users. Guest users can access public Site.com and
Salesforce sites, and public pages in Communities, via the Guest User license associated
with each site or community.
When true, this
field overrides the value false in
UserPreferencesShowEmailToExternalUsers, making the
user’s email address visible to guests.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 34.0 and
later.
|
UserPreferencesShowFaxToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the fax number field in the
user’s contact information. Fax number is visible only to internal members of the
user’s organization when this field is false.
Fax number is visible to external members in a community when
this field is true. External users are users with
Community, Customer Portal, or partner portal licenses.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowFaxToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the fax number field in the
user’s contact information. When true, the
fax number field is visible to guest users. Guest users can access public Site.com and
Salesforce sites, and public pages in Communities, via the Guest User license associated
with each site or community.
When true, this
field overrides the value false in
UserPreferencesShowFaxToExternalUsers, making the
user’s fax number visible to guests.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 34.0 and
later.
|
UserPreferencesShowManagerToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the manager field in the
user’s contact information. Manager is visible only to internal members of the
user’s organization when this field is false.
Manager is visible to external members in a community when
this field is true. External users are users with
Community, Customer Portal, or partner portal licenses.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowManagerToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the manager field in the
user’s contact information. When true, the
manager field is visible to guest users. Guest users can access public Site.com and
Salesforce sites, and public pages in Communities, via the Guest User license associated
with each site or community.
When true, this
field overrides the value false in
UserPreferencesShowManagerToExternalUsers, making the
user’s manager visible to guests.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 34.0 and
later.
|
UserPreferencesShowMobilePhoneToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the mobile or
cellular phone number field in the user’s contact information. The number is
visible only to internal members of the user’s organization when this field is
false. The number is visible to external members in
a community
when this field is true. External users are users
with Community, Customer Portal, or partner portal licenses.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowMobilePhoneToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the mobile phone field
in the user’s contact information. When true,
the mobile phone field is visible to guest users. Guest users can access public Site.com
and Salesforce sites, and public pages in Communities, via the Guest User license
associated with each site or community.
When true, this field overrides the value false in UserPreferencesShowMobilePhoneToExternalUsers, making the
user’s mobile phone visible to guests.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 34.0 and
later.
|
UserPreferencesShowPostalCodeToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the postal or ZIP code
field in the user’s contact information. Postal code is visible only to internal
members of the user’s organization when:
- This field is false. When false, this field returns the value #N/A.
Postal code is visible to external members in a community when:
- This field is true, or
- This field is false but UserPreferencesShowPostalCodeToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal
licenses.The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowPostalCodeToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the postal or ZIP code
field in the user’s contact information. When true, postal code is visible to guest users. Guest users can access public
Site.com and Salesforce sites, and public pages in Communities, via the Guest User
license associated with each site or community. When false, this field returns the value #N/A.
When true, this field overrides the value
false in UserPreferencesShowPostalCodeToExternalUsers, making the
user’s postal code visible to external members.
The default value is false.
This field is available in API version 28.0 and
later.
|
UserPreferencesShowProfilePicToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the user’s profile
photo. When true, the photo is visible to guest
users in a community.
Guest users can access public Site.com and Salesforce sites, and public pages in
Communities, via the Guest User license associated with each site or community.
When
false, this field returns the stock photo. The default value is false.
This field is available in API version 28.0 and
later.
|
UserPreferencesShowStateToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the state field in the
user’s contact information. State is visible only to internal members of the
user’s organization when:
- This field is false. When false, this field returns the value #N/A.
State is visible to external members in a community when:
- This field is true, or
- This field is false but UserPreferencesShowStateToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal
licenses.When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowStateToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the state field in the
user’s contact information. When true, state
is visible to guest users. Guest users can access public Site.com and Salesforce sites,
and public pages in Communities, via the Guest User license associated with each site or
community. When false, this field returns the value #N/A.
When true, this field overrides the value false in UserPreferencesShowStateToExternalUsers, making the user’s
state visible to external members.
The default value is false.
This field is available in API version 28.0 and
later.
|
UserPreferencesShowStreetAddressToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the street address
field in the user’s contact information. The address is visible only to internal
members of the user’s organization when this field is false. The address is visible to external members in a community when
this field is true. External users are users with
Community, Customer Portal, or partner portal licenses.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowStreetAddressToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the street address
field in the user’s contact information. When true, the street address field is visible to guest users. Guest users can
access public Site.com and Salesforce sites, and public pages in Communities, via the
Guest User license associated with each site or community.
When true, this field overrides the value false in UserPreferencesShowStreetAddressToExternalUsers, making the
user’s street address visible to guests.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 34.0 and
later.
|
UserPreferencesShowTitleToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the business title field in
the user’s contact information. Title is visible only to internal members of the
user’s organization when:
- This field is false. When false, this field returns the value #N/A.
Title is visible to external members in a community when:
- This field is true, or
- This field is false but UserPreferencesShowTitleToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal
licenses.The default value is true. This field is available in API version 26.0 and
later.
|
UserPreferencesShowTitleToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the business title field in the
user’s contact information. When true, title
is visible to guest users. Guest users can access public Site.com and Salesforce sites,
and public pages in Communities, via the Guest User license associated with each site or
community. When false, this field returns the value #N/A.
When true, this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making the user’s
title visible to external members.
The default value is false.
This field is available in API version 28.0 and
later.
|
UserPreferencesShowWorkPhoneToExternalUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the work phone number
field in the user’s contact information. The number is visible only to internal
members of the user’s organization when this field is false. The number is visible to external members in a community when
this field is true. External users are users with
Community, Customer Portal, or partner portal licenses.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 26.0 and
later.
|
UserPreferencesShowWorkPhoneToGuestUsers |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
-
Indicates the visibility of the work phone field in
the user’s contact information. When true,
the work phone field is visible to guest users. Guest users can access public Site.com
and Salesforce sites, and public pages in Communities, via the Guest User license
associated with each site or community.
When true, this field overrides the value false in UserPreferencesShowWorkPhoneToExternalUsers, making the
user’s work phone visible to guests.
When false, this field returns the value #N/A.
The default value is false.
This field is available in API version 34.0 and
later.
|
|
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
|
UserPreferencesSuppressEventSFXReminders |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, event reminders don’t appear. Corresponds to the Show event
reminders in Lightning Experience checkbox on the Activity Reminders page
in the user interface. This field is
related
to UserPreference and customizing activity reminders.
|
UserPreferencesSuppressTaskSFXReminders |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, task reminders don’t appear. Corresponds to the Show task
reminders in Lightning Experience. checkbox on the Activity Reminders page
in the user interface. This field is related to UserPreference and customizing activity reminders.
|
UserPreferencesTaskRemindersCheckboxDefault |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, a reminder popup is automatically set on the user's tasks. Corresponds
to the By default, set reminder on Tasks to... checkbox on the
Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders.
|
UserPreferencesUserDebugModePref |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- When true, the Lightning Component framework
executes in debug mode for the user. Corresponds to the Debug Mode
checkbox on the Advanced User Details page of personal settings in the user
interface.
|
UserRoleId |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
- ID of the user’s UserRole.
Label is Role ID.
|
UserType |
- Type
- picklist
- Properties
- Filter, Group,
Nillable, Sort, Restricted picklist
- Description
-
The category of user license. Each
UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later,
valid values include:
|
WirelessEmail |
- Type
- email
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Wireless email address associated with this user. For use with Salesforce Wireless Edition. This
field is available only if the Wireless and Email permissions are enabled for your
organization.

Note
As of November 2005, Salesforce Wireless Edition is no
longer available for purchase. If you are a Professional Edition customer and purchased
Wireless Edition prior to November 7, 2005 or are an Enterprise Edition customer who has
signed or renewed your Salesforce
contract prior to November 7, 2005, you may continue using Wireless Edition through the
end of your existing contract term.
|