LoyaltyProgramWidget

Represents the configuration of a widget that a user can apply to the out-of-the-box widget templates and FlexCards provided by Omnistudio. The configuration helps implement custom UI changes, such as promotion type, promotion tag line, and so on for a user. This object is available in API version 57.0 and later.

Supported Calls

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

Fields

Field	Details
CustomizedContent	Type textarea Properties Create, Nillable, Update Description The detail about the customization that’s applied to a widget. For example, promotion_title: Great Times
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the widget.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the widget.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the widget. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
ProgramId	Type reference Properties Create, Filter, Group, Sort Description Required. The identifier of the loyalty program that's associated with the widget. This field is a relationship field. Relationship Name Program Relationship Type Lookup Refers To LoyaltyProgram
PromotionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the promotion that the widget is associated with. This field is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion
PromotionStageId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the promotion stage that the widget is associated with. This field is a relationship field. Relationship Name PromotionStage Relationship Type Lookup Refers To PromotionStage
TemplateName	Type string Properties Create, Filter, Group, Sort Description Required. The name of the widget template.
TemplateVersion	Type int Properties Create, Filter, Group, Sort Description Required. The version of the widget template.

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.

LoyaltyProgramWidgetShare: Sharing is available for the object.

Loyalty Management Developer Guide

LoyaltyProgramWidget

Supported Calls

Fields

Associated Objects