Description |
- Type
- textarea
- Properties
- Create, Update
- Description
- Required. Limit: 4000 characters. The description of the
badge and what it means to receive this badge.
|
GivenBadgeCount |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of badges given per user or across all
users.

Note
This field can’t be added in a list view
or referenced in a formula field.
|
ImageUrl |
- Type
- url
- Properties
- Create, Filter, Group, Sort, Update
- Description
- Required. This is the badge image that will be displayed
in the UI. Use DocumentID or ImageURL.
|
IsActive |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Represents whether a WorkBadgeDefinition is active and available in the UI.
|
IsCompanyWide |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Represents a special class of badges known as Company
Badges. Company badges are visible to the entire company
and visible in specific list view filters.

Note
If this
field is selected, everyone within the user’s
network will be able to give the badge
automatically. If this field is not selected, people
with sharing must be added to the badge’s access
list in order to give the badge.
|
IsLimitPerUser |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Indicates whether the badge limit is per user (true) or across all
users (false). The
default value is false.
|
IsRewardBadge |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the badge is a reward badge (true) or not (false).
|
LastReferencedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The time stamp that indicates when the current user last
viewed a record that is related to this WorkBadgeDefinition.
|
LastViewedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The time stamp that indicates when the current user last
viewed this WorkBadgeDefinition. If this value is null, this record might have been
only referenced
(LastReferencedDate) and not
viewed.
|
LimitNumber |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The badge limit per user or across all users.
|
LimitStartDate |
- Type
- dateTime
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The start date of the badge limit. The date can be reset
to the current date.
|
Name |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- Required. Name of the Badge. Label: Badge
Title.
|
NetworkId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The ID of the community that this WorkBadgeDefinition is associated with. This field is
available only if Salesforce Communities is enabled
in your organization.
|
OwnerId |
- Type
- reference
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Salesforce User ID for User who is the Owner of the WorkBadgeDefinition record (usually the creator of the record)
|
RewardFundId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Salesforce unique ID for the WorkRewardFund that is associated with this WorkBadgeDefinition. WorkBadgeDefinition records with a RewardFundID indicate a Reward
Badge.
|