DigitalPassTemplate

Represents a template for creating digital passes, such as loyalty membership cards or coupons. It outlines the pass's design, data fields, and functionality, enabling the generation of multiple unique passes from a single, reusable template. This object is available in API version 66.0 and later.

Supported Calls

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

Fields

Field	Details
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the digital pass template.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the digital pass template.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User
ServiceProvider	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The organization that develops the digital pass. Possible values are: `Google`
ServicePrvdTmplIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the external template used by the digital pass.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the digital pass template. Possible values are: `ActivationInProgress` `Active` `Draft` `Inactive` The default value is `Draft`.
StatusReason	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for the current status of the digital pass template. Displays the detailed error message from the system in case of digital wallet activation failure.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies the type of the digital pass template. Possible values are: `GiftCard` `Loyalty`

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.

DigitalPassTemplateChangeEvent: Change events are available for the object.
DigitalPassTemplateHistory: History is available for tracked fields of the object.
DigitalPassTemplateOwnerSharingRule: Sharing rules are available for the object.
DigitalPassTemplateShare: Sharing is available for the object.

Loyalty Management Developer Guide

DigitalPassTemplate

Supported Calls

Fields

Associated Objects