---
schema_version: "1"
id: cb755bf45c7aafde3f3009da44e395abe89f124f5d4046d1bdb5bec4b9027339
title: WorkBadge
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_workbadge.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workbadge.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 60232cbb84db66ecc15f84131dbbeacc36c24d791e33107abafc640792334bfc
description: Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition.
---
# WorkBadge

Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Additional Considerations and Related Objects

WorkBadge is a lookup to WorkThanks. Each WorkBadge record must derive a SourceId from WorkThanks. There can be multiple WorkBadge records tied to a single WorkThanks record.

## Fields

| Field Name | Details |
| --- | --- |
| DefinitionId | 
Type

reference

Properties

Create, Filter, Group, Sort

Description

Required. Salesforce unique ID for the given WorkBadgeDefinition record given.

This is a relationship field.

Relationship Name

Definition

Relationship Type

Lookup

Refers To

WorkBadgeDefinition



 |
| Description | 

Type

textarea

Properties

Nillable

Description

The description of the WorkBadgeDefinition.



 |
| GiverId | 

Type

reference

Properties

Filter, Group, Nillable, Sort

Description

The ID of the badge giver. Can’t be the same as RecipientId.

This is a relationship field.

Relationship Name

Giver

Relationship Type

Lookup

Refers To

User



 |
| ImageUrl | 

Type

url

Properties

Filter, Group, Nillable, Sort

Description

The URL of the badge image.



 |
| 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 WorkBadge.



 |
| LastViewedDate | 

Type

dateTime

Properties

Filter, Nillable, Sort

Description

The time stamp that indicates when the current user last viewed this WorkBadge. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.



 |
| Message | 

Type

textarea

Properties

Nillable

Description

The message accompanying the thanks badge.



 |
| NetworkId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The ID of the [community](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_network.htm "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.") that this WorkBadge is associated with. This field is available only if digital experiences is enabled in your org.



 |
| RecipientId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

Required. Salesforce unique ID for User who is the Recipient of Badge. Can’t be the same as GiverId

This is a relationship field.

Relationship Name

Recipient

Relationship Type

Lookup

Refers To

User



 |
| RewardId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Salesforce unique ID for Reward given with badge (if Reward Badge)



 |
| SourceId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

Salesforce unique ID for Thanks record referenced to this badge.

This is a relationship field.

Relationship Name

Source

Relationship Type

Lookup

Refers To

WorkThanks



 |

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[WorkBadgeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0)

Change events are available for the object.