DigitalPass

Represents a user-facing representation generated from a digital pass template. It contains specific, relevant data, such as a membership number or voucher details, making each pass unique to the user. This pass can be optionally stored in a mobile or digital wallet. 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
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account ID associated with the digital pass. This field is a relationship field. Relationship Name Account Refers To Account
ContactId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact ID associated with the digital pass. This field is a relationship field. Relationship Name Contact Refers To Contact
DigitalPassTemplateId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the digital pass template. This field is a relationship field. Relationship Name DigitalPassTemplate Refers To DigitalPassTemplate
ExpiryDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when the digital pass expires.
ExternalUniqueIdentifier	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The unique identifier of the digital pass at the service provider's end.
InputPayload	Type textarea Properties Create, Nillable, Update Description The specific data or parameters provided to issue a digital pass, such as a loyalty program member ID.
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.
LastSyncDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The latest date when the digital pass was synchronized.
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.
LoyaltyProgramMemberId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the loyalty program member associated with the digital pass. This field is a relationship field. Relationship Name LoyaltyProgramMember Refers To LoyaltyProgramMember
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the digital pass.
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
PartyId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. The entity or individual to whom the digital pass is issued. It can be an account, or contact or a loyalty program member. This field is a polymorphic relationship field. Relationship Name Party Refers To Account, Contact, LoyaltyProgramMember
SourceRecordReferenceId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. The activity or a transaction associated with the digital pass. A digital pass can be associated to a voucher, event or loyalty program enrollment. This field is a polymorphic relationship field. Relationship Name SourceRecordReference Refers To LoyaltyProgramMember, Voucher
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies the current state of the digital pass in the lifecycle of issuance and usage Possible values are: `Active` `Expired` `Inactive` `SyncError`
SyncErrorMessage	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The message displayed when there is an error in synchronization.

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.

DigitalPassChangeEvent: Change events are available for the object.
DigitalPassHistory: History is available for tracked fields of the object.
DigitalPassOwnerSharingRule: Sharing rules are available for the object.
DigitalPassShare: Sharing is available for the object.

Loyalty Management Developer Guide

DigitalPass

Supported Calls

Fields

Associated Objects